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

Last change on this file since 1595 was 1595, checked in by work@…, 9 years ago
  • some database upgrade scripts were always being executed, introduced checks to see if they needed to be executed at all
  • Property svn:keywords set to Rev Author Date
File size: 9.0 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: 1595 $
13 * $Author: work@osx.eu $
14 * $Date: 2011-03-07 17:31:52 +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)            // r1490
35                dropMappingColumnNameConstraint(sql, db)
36                alterStudyAndAssay(sql, db)                                     // r1594
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                                println "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                                        println "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                                                println "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                // do we need to perform this upgrade?
145                if ((db == "org.postgresql.Driver" || db == "com.mysql.jdbc.Driver") &&
146                        (sql.firstRow("SELECT * FROM assay_module WHERE notify IS NULL") || sql.firstRow("SELECT * FROM assay_module WHERE open_in_frame IS NULL"))
147                ) {
148                        "performing database upgrade: assay_module default values for boolean fields".grom()
149
150                        try {
151                                sql.execute("UPDATE assay_module SET notify=" + ((db == "org.postgresql.Driver") ? 'FALSE' : '0') + " WHERE notify IS NULL")
152                        } catch (Exception e) {
153                                println "setAssayModuleDefaultValues database upgrade failed, notify field couldn't be set to default value: " + e.getMessage()
154                        }
155
156                        // set open_in_frame?
157                        try {
158                                sql.execute("UPDATE assay_module SET open_in_frame=" + ((db == "org.postgresql.Driver") ? 'TRUE' : '1') + " WHERE open_in_frame IS NULL")
159                        } catch (Exception e) {
160                                // Maybe gdt plugin is not updated yet after revision 109 ?
161                                println "setAssayModuleDefaultValues database upgrade failed, openInFrame field couldn't be set to default value: " + e.getMessage()
162                        }
163                }
164        }
165
166        /**
167         * Drop the unique constraint for the "name" column in the MappingColumn domain
168         *
169         * @param sql
170         * @param db
171         */
172        public static void dropMappingColumnNameConstraint(sql, db) {
173                // are we running postgreSQL ?
174                if (db == "org.postgresql.Driver") {
175                        if (sql.firstRow("SELECT * FROM pg_constraint WHERE contype='mapping_column_name_key'")) {
176                                "performing database upgrade: mapping column name constraint".grom()
177                                try {
178                                        // Check if constraint still exists
179                                        sql.execute("ALTER TABLE mapping_column DROP CONSTRAINT mapping_column_name_key")
180                                } catch (Exception e) {
181                                        println "dropMappingColumnNameConstraint database upgrade failed, `name` field unique constraint couldn't be dropped: " + e.getMessage()
182                                }
183                        }
184                }
185        }
186
187        /**
188         * The field study.code has been set to be nullable
189         * The field assay.externalAssayId has been removed
190         * @param sql
191         * @param db
192         */
193        public static void alterStudyAndAssay(sql, db) {
194                def updated = false
195
196                // are we running postgreSQL ?
197                if (db == "org.postgresql.Driver") {
198                        // see if table assay contains a column external_assayid
199                        if (sql.firstRow("SELECT * FROM information_schema.columns WHERE columns.table_name='assay' AND columns.column_name='external_assayid'")) {
200                                "performing database upgrade: dropping column 'external_assayid' from table 'assay'".grom()
201
202                                try {
203                                        sql.execute("ALTER TABLE assay DROP COLUMN external_assayid")
204                                        updated = true
205                                } catch (Exception e) {
206                                        println "alterStudyAndAssay database upgrade failed, externalAssayId could not be removed from assay: " + e.getMessage()
207                                }
208
209                        }
210
211                        // see if table study contains a column code which is not nullable
212                        if (sql.firstRow("SELECT * FROM information_schema.columns WHERE columns.table_name='study' AND columns.column_name='code' AND is_nullable='NO'")) {
213                                "performing database upgrade: dropping column 'code' from table 'study'".grom()
214
215                                try {
216                                        sql.execute("ALTER TABLE study ALTER COLUMN code DROP NOT NULL")
217                                        updated = true
218                                } catch (Exception e) {
219                                        println "alterStudyAndAssay database upgrade failed, study.code could not be set to accept null values: " + e.getMessage()
220                                }
221                        }
222
223                        // Load all studies and save them again. This prevents errors on saving later
224                        if (updated) {
225                                "re-saving studies...".grom()
226
227                                Study.list().each { study ->
228                                        "re-saving study: ${study}".grom()
229                                        study.save()
230                                }
231                        }
232                }
233        }
234}
Note: See TracBrowser for help on using the repository browser.