source: trunk/grails-app/conf/DatabaseUpgrade.groovy @ 1594

Last change on this file since 1594 was 1594, checked in by robert@…, 9 years ago

Finishing touch after refactoring entity tokens (#329)

  • Property svn:keywords set to Rev Author Date
File size: 8.6 KB
Line 
1import groovy.sql.Sql
2import dbnp.studycapturing.Study
3import org.codehaus.groovy.grails.commons.ConfigurationHolder
4
5/**
6 * A script to automatically perform database changes
7 *
8 * @Author      Jeroen Wesbeek
9 * @Since       20101209
10 *
11 * Revision information:
12 * $Rev: 1594 $
13 * $Author: robert@isdat.nl $
14 * $Date: 2011-03-07 14:28:25 +0000 (ma, 07 mrt 2011) $
15 */
16class DatabaseUpgrade {
17        /**
18         * handle database upgrades
19         *
20         * @param dataSource
21         */
22        public static void handleUpgrades(dataSource) {
23                // get a sql instance
24                groovy.sql.Sql sql = new groovy.sql.Sql(dataSource)
25
26                // get configuration
27                def config = ConfigurationHolder.config
28                def db = config.dataSource.driverClassName
29
30                // execute per-change check and upgrade code
31                changeStudyDescription(sql, db)                         // r1245 / r1246
32                changeStudyDescriptionToText(sql, db)           // r1327
33                changeTemplateTextFieldSignatures(sql, db)      // prevent Grails issue, see http://jira.codehaus.org/browse/GRAILS-6754
34                setAssayModuleDefaultValues(sql, db)            // 1490
35        dropMappingColumnNameConstraint(sql, db)
36                alterStudyAndAssay(sql, db)                                     // 1594
37        }
38
39        /**
40         * execute database change r1245 / r1246 if required
41         * @param sql
42         * @param db
43         */
44        public static void changeStudyDescription(sql, db) {
45                // check if we need to perform this upgrade
46                if (sql.firstRow("SELECT count(*) as total FROM template_field WHERE templatefieldentity='dbnp.studycapturing.Study' AND templatefieldname='Description'").total > 0) {
47                        // grom that we are performing the upgrade
48                        "performing database upgrade: study description".grom()
49
50                        // database upgrade required
51                        try {
52                                // get the template field id
53                                def id = sql.firstRow("SELECT id FROM template_field WHERE templatefieldentity='dbnp.studycapturing.Study' AND templatefieldname='Description'").id
54
55                                // iterate through all obsolete study descriptions
56                                sql.eachRow("SELECT study_id, template_text_fields_elt as description FROM study_template_text_fields WHERE template_text_fields_idx='Description'") { row ->
57                                        // migrate the template description to the study object itself
58                                        // so we don't have to bother with sql injections, etc
59                                        def study = Study.findById( row.study_id )
60                                        study.setFieldValue('description', row.description)
61                                        if (!(study.validate() && study.save())) {
62                                                throw new Exception("could not save study with id ${row.study_id}")
63                                        }
64                                }
65
66                                // delete all obsolete descriptions
67                                sql.execute("DELETE FROM study_template_text_fields WHERE template_text_fields_idx='Description'")
68
69                                // find all template id's where this field is used
70                                sql.eachRow("SELECT DISTINCT template_fields_id, fields_idx FROM template_template_field WHERE template_field_id=${id}") { row ->
71                                        // delete the template_template_field reference
72                                        sql.execute("DELETE FROM template_template_field WHERE template_field_id=${id} AND template_fields_id=${row.template_fields_id}")
73
74                                        // and lower the idx-es of the remaining fields
75                                        sql.execute("UPDATE template_template_field SET fields_idx=fields_idx-1 WHERE fields_idx>${row.fields_idx} AND template_fields_id=${row.template_fields_id}")
76                                }
77
78                                // and delete the obsolete template field
79                                sql.execute("DELETE FROM template_field WHERE id=${id}")
80                        } catch (Exception e) {
81                                "changeStudyDescription database upgrade failed: " + e.getMessage()
82                        }
83                }
84        }
85
86        /**
87         * execute database change r1327 if required
88         * @param sql
89         * @param db
90         */
91        public static void changeStudyDescriptionToText(sql, db) {
92                // are we running postgreSQL ?
93                if (db == "org.postgresql.Driver") {
94                        // check if column 'description' in table 'study' is not of type 'text'
95                        if (sql.firstRow("SELECT count(*) as total FROM information_schema.columns WHERE columns.table_schema::text = 'public'::text AND columns.table_name='study' AND column_name='description' AND data_type != 'text'").total > 0) {
96                                // grom that we are performing the upgrade
97                                "performing database upgrade: study description to text".grom()
98
99                                // database upgrade required
100                                try {
101                                        // change the datatype of study::description to text
102                                        sql.execute("ALTER TABLE study ALTER COLUMN description TYPE text")
103                                } catch (Exception e) {
104                                        "changeStudyDescriptionToText database upgrade failed: " + e.getMessage()
105                                }
106                        }
107                }
108        }
109
110        /**
111         * it appears that some TEXT template fields are not of type 'text'
112         * due to an issue in how Grails' GORM works with domain inheritance
113         * (see http://jira.codehaus.org/browse/GRAILS-6754)
114         * @param sql
115         * @param db
116         */
117        public static void changeTemplateTextFieldSignatures(sql, db) {
118                if (db == "org.postgresql.Driver") {
119                        // check if any TEXT template fields are of type 'text'
120                        sql.eachRow("SELECT columns.table_name as tablename FROM information_schema.columns WHERE columns.table_schema::text = 'public'::text AND column_name='template_text_fields_elt' AND data_type != 'text';")
121                        { row ->
122                                "performing database upgrade: ${row.tablename} template_text_fields_string/elt to text".grom()
123                                try {
124                                        // change the datatype of text fields to text
125                                        sql.execute(sprintf("ALTER TABLE %s ALTER COLUMN template_text_fields_elt TYPE text", row.tablename))
126                                        sql.execute(sprintf("ALTER TABLE %s ALTER COLUMN template_text_fields_string TYPE text", row.tablename))
127
128                                } catch (Exception e) {
129                                        "changeTemplateTextFieldSignatures database upgrade failed: " + e.getMessage()
130                                }
131                        }
132                }
133        }
134       
135        /**
136        * The fields 'notify' and 'openInFrame' have been added to AssayModule. However, there
137        * seems to be no method to setting the default values of these fields in the database. They
138        * are set to NULL by default, so all existing fields have 'NULL' set.
139        * This method sets the default values
140        * @param sql
141        * @param db
142        */
143   public static void setAssayModuleDefaultValues(sql, db) {
144           "performing database upgrade: assay_module default values for boolean fields".grom()
145
146           // are we running postgreSQL ?
147           if (db == "org.postgresql.Driver") {
148                   try {
149                           sql.execute("UPDATE assay_module SET notify = FALSE WHERE notify IS NULL")
150                   } catch (Exception e) {
151                           println "setAssayModuleDefaultValues notify field couldn't be set to default value: " + e.getMessage()
152                   }
153                   try {
154                           sql.execute("UPDATE assay_module SET open_in_frame = TRUE WHERE open_in_frame IS NULL")
155                   } catch (Exception e) {
156                           println "setAssayModuleDefaultValues openInFrame field couldn't be set to default value: " + e.getMessage()
157                           println "Maybe gdt plugin is not updated yet after revision 109"
158                   }
159           }
160           
161           // Are we running MySQL
162           if( db == "com.mysql.jdbc.Driver" ) {
163                   try {
164                           sql.execute("UPDATE assay_module SET notify = 0 WHERE notify IS NULL")
165                   } catch (Exception e) {
166                           println "setAssayModuleDefaultValues notify field couldn't be set to default value: " + e.getMessage()
167                   }
168                   try {
169                           sql.execute("UPDATE assay_module SET open_in_frame = 1 WHERE open_in_frame IS NULL")
170                   } catch (Exception e) {
171                           println "setAssayModuleDefaultValues openInFrame field couldn't be set to default value: " + e.getMessage()
172                           println "Maybe gdt plugin is not updated yet after revision 109"
173                   }
174           }
175   }
176   
177    /**
178         * Drop the unique constraint for the "name" column in the MappingColumn domain
179     *
180         * @param sql
181         * @param db
182         */
183    public static void dropMappingColumnNameConstraint(sql, db) {
184        // are we running postgreSQL ?
185           if (db == "org.postgresql.Driver") {
186                   try {
187                // Check if constraint still exists
188                if (sql.firstRow("SELECT * FROM pg_constraint WHERE contype='mapping_column_name_key'")) {
189                        println "performing database upgrade: mapping column name constraint"
190                    sql.execute("ALTER TABLE mapping_column DROP CONSTRAINT mapping_column_name_key")
191                                }
192                   } catch (Exception e) {
193                           println "changeMappingColumnNameConstraint `name` field unique constraint couldn't be dropped: " + e.getMessage()
194                   }
195       }
196    }
197       
198        /**
199        * The field study.code has been set to be nullable
200        * The field assay.externalAssayId has been removed
201        * @param sql
202        * @param db
203        */
204   public static void alterStudyAndAssay(sql, db) {
205           // are we running postgreSQL ?
206           if (db == "org.postgresql.Driver") {
207                   try {
208                           sql.execute("ALTER TABLE assay DROP COLUMN external_assayid")
209                   } catch (Exception e) {
210                           println "alterStudyAndAssay externalAssayId could not be removed from assay: " + e.getMessage()
211                   }
212                   try {
213                           sql.execute("ALTER TABLE study ALTER COLUMN code DROP NOT NULL")
214                   } catch (Exception e) {
215                           println "alterStudyAndAssay study.code could not be set to accept null values: " + e.getMessage()
216                   }
217           }
218           
219           // Load all studies and save them again. This prevents errors on saving later
220           Study.list().each {
221                   it.save();
222           }
223   }
224
225}
Note: See TracBrowser for help on using the repository browser.