root/trunk/grails-app/conf/DatabaseUpgrade.groovy @ 1635

Revision 1635, 10.2 KB (checked in by work@…, 3 years ago)

- added checks to Grom calls if Grom is available so we can uninstall the plugin on packaging time... resolves issue #359

  • Property svn:keywords set to Rev Author Date
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$
13 * $Author$
14 * $Date$
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)        // r1525
36                makeMappingColumnValueNullable(sql, db)         // r1525
37                alterStudyAndAssay(sql, db)                                     // r1594
38        }
39
40        /**
41         * execute database change r1245 / r1246 if required
42         * @param sql
43         * @param db
44         */
45        public static void changeStudyDescription(sql, db) {
46                // check if we need to perform this upgrade
47                if (sql.firstRow("SELECT count(*) as total FROM template_field WHERE templatefieldentity='dbnp.studycapturing.Study' AND templatefieldname='Description'").total > 0) {
48                        // grom that we are performing the upgrade
49                        if (String.metaClass.getMetaMethod("grom")) "performing database upgrade: study description".grom()
50
51                        // database upgrade required
52                        try {
53                                // get the template field id
54                                def id = sql.firstRow("SELECT id FROM template_field WHERE templatefieldentity='dbnp.studycapturing.Study' AND templatefieldname='Description'").id
55
56                                // iterate through all obsolete study descriptions
57                                sql.eachRow("SELECT study_id, template_text_fields_elt as description FROM study_template_text_fields WHERE template_text_fields_idx='Description'") { row ->
58                                        // migrate the template description to the study object itself
59                                        // so we don't have to bother with sql injections, etc
60                                        def study = Study.findById(row.study_id)
61                                        study.setFieldValue('description', row.description)
62                                        if (!(study.validate() && study.save())) {
63                                                throw new Exception("could not save study with id ${row.study_id}")
64                                        }
65                                }
66
67                                // delete all obsolete descriptions
68                                sql.execute("DELETE FROM study_template_text_fields WHERE template_text_fields_idx='Description'")
69
70                                // find all template id's where this field is used
71                                sql.eachRow("SELECT DISTINCT template_fields_id, fields_idx FROM template_template_field WHERE template_field_id=${id}") { row ->
72                                        // delete the template_template_field reference
73                                        sql.execute("DELETE FROM template_template_field WHERE template_field_id=${id} AND template_fields_id=${row.template_fields_id}")
74
75                                        // and lower the idx-es of the remaining fields
76                                        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}")
77                                }
78
79                                // and delete the obsolete template field
80                                sql.execute("DELETE FROM template_field WHERE id=${id}")
81                        } catch (Exception e) {
82                                println "changeStudyDescription database upgrade failed: " + e.getMessage()
83                        }
84                }
85        }
86
87        /**
88         * execute database change r1327 if required
89         * @param sql
90         * @param db
91         */
92        public static void changeStudyDescriptionToText(sql, db) {
93                // are we running postgreSQL ?
94                if (db == "org.postgresql.Driver") {
95                        // check if column 'description' in table 'study' is not of type 'text'
96                        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) {
97                                // grom that we are performing the upgrade
98                                if (String.metaClass.getMetaMethod("grom")) "performing database upgrade: study description to text".grom()
99
100                                // database upgrade required
101                                try {
102                                        // change the datatype of study::description to text
103                                        sql.execute("ALTER TABLE study ALTER COLUMN description TYPE text")
104                                } catch (Exception e) {
105                                        println "changeStudyDescriptionToText database upgrade failed: " + e.getMessage()
106                                }
107                        }
108                }
109        }
110
111        /**
112         * it appears that some TEXT template fields are not of type 'text'
113         * due to an issue in how Grails' GORM works with domain inheritance
114         * (see http://jira.codehaus.org/browse/GRAILS-6754)
115         * @param sql
116         * @param db
117         */
118        public static void changeTemplateTextFieldSignatures(sql, db) {
119                if (db == "org.postgresql.Driver") {
120                        // check if any TEXT template fields are of type 'text'
121                        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';")
122                                { row ->
123                                        if (String.metaClass.getMetaMethod("grom")) "performing database upgrade: ${row.tablename} template_text_fields_string/elt to text".grom()
124                                        try {
125                                                // change the datatype of text fields to text
126                                                sql.execute(sprintf("ALTER TABLE %s ALTER COLUMN template_text_fields_elt TYPE text", row.tablename))
127                                                sql.execute(sprintf("ALTER TABLE %s ALTER COLUMN template_text_fields_string TYPE text", row.tablename))
128
129                                        } catch (Exception e) {
130                                                println "changeTemplateTextFieldSignatures database upgrade failed: " + e.getMessage()
131                                        }
132                                }
133                }
134        }
135
136        /**
137         * The fields 'notify' and 'openInFrame' have been added to AssayModule. However, there
138         * seems to be no method to setting the default values of these fields in the database. They
139         * are set to NULL by default, so all existing fields have 'NULL' set.
140         * This method sets the default values
141         * @param sql
142         * @param db
143         */
144        public static void setAssayModuleDefaultValues(sql, db) {
145                // do we need to perform this upgrade?
146                if ((db == "org.postgresql.Driver" || db == "com.mysql.jdbc.Driver") &&
147                        (sql.firstRow("SELECT * FROM assay_module WHERE notify IS NULL") || sql.firstRow("SELECT * FROM assay_module WHERE open_in_frame IS NULL"))
148                ) {
149                        if (String.metaClass.getMetaMethod("grom")) "performing database upgrade: assay_module default values for boolean fields".grom()
150
151                        try {
152                                sql.execute("UPDATE assay_module SET notify=" + ((db == "org.postgresql.Driver") ? 'FALSE' : '0') + " WHERE notify IS NULL")
153                        } catch (Exception e) {
154                                println "setAssayModuleDefaultValues database upgrade failed, notify field couldn't be set to default value: " + e.getMessage()
155                        }
156
157                        // set open_in_frame?
158                        try {
159                                sql.execute("UPDATE assay_module SET open_in_frame=" + ((db == "org.postgresql.Driver") ? 'TRUE' : '1') + " WHERE open_in_frame IS NULL")
160                        } catch (Exception e) {
161                                // Maybe gdt plugin is not updated yet after revision 109 ?
162                                println "setAssayModuleDefaultValues database upgrade failed, openInFrame field couldn't be set to default value: " + e.getMessage()
163                        }
164                }
165        }
166
167        /**
168         * Drop the unique constraint for the "name" column in the MappingColumn domain
169         *
170         * @param sql
171         * @param db
172         */
173        public static void dropMappingColumnNameConstraint(sql, db) {
174                // are we running postgreSQL ?
175                if (db == "org.postgresql.Driver") {
176                        if (sql.firstRow("SELECT * FROM pg_constraint WHERE contype='mapping_column_name_key'")) {
177                                if (String.metaClass.getMetaMethod("grom")) "performing database upgrade: mapping column name constraint".grom()
178                                try {
179                                        // Check if constraint still exists
180                                        sql.execute("ALTER TABLE mapping_column DROP CONSTRAINT mapping_column_name_key")
181                                } catch (Exception e) {
182                                        println "dropMappingColumnNameConstraint database upgrade failed, `name` field unique constraint couldn't be dropped: " + e.getMessage()
183                                }
184                        }
185                }
186        }
187
188        /**
189         * the importer requires the value field to be nullable
190         * @param sql
191         * @param db
192         */
193        public static void makeMappingColumnValueNullable(sql, db) {
194                // are we running postgreSQL?
195                if (db == "org.postgresql.Driver") {
196                        // do we need to perform this update?
197                        if (sql.firstRow("SELECT * FROM information_schema.columns WHERE columns.table_name='mapping_column' AND columns.column_name='value' AND is_nullable='NO'")) {
198                                if (String.metaClass.getMetaMethod("grom")) "performing database upgrade: making mapping_column::value nullable".grom()
199
200                                try {
201                                        sql.execute("ALTER TABLE mapping_column ALTER COLUMN value DROP NOT NULL")
202                                } catch (Exception e) {
203                                        println "makeMappingColumnValueNullable database upgrade failed: " + e.getMessage()
204                                }
205                        }
206                }
207        }
208
209        /**
210         * The field study.code has been set to be nullable
211         * The field assay.externalAssayId has been removed
212         * @param sql
213         * @param db
214         */
215        public static void alterStudyAndAssay(sql, db) {
216                def updated = false
217
218                // are we running postgreSQL ?
219                if (db == "org.postgresql.Driver") {
220                        // see if table assay contains a column external_assayid
221                        if (sql.firstRow("SELECT * FROM information_schema.columns WHERE columns.table_name='assay' AND columns.column_name='external_assayid'")) {
222                                if (String.metaClass.getMetaMethod("grom")) "performing database upgrade: dropping column 'external_assayid' from table 'assay'".grom()
223
224                                try {
225                                        sql.execute("ALTER TABLE assay DROP COLUMN external_assayid")
226                                        updated = true
227                                } catch (Exception e) {
228                                        println "alterStudyAndAssay database upgrade failed, externalAssayId could not be removed from assay: " + e.getMessage()
229                                }
230
231                        }
232
233                        // see if table study contains a column code which is not nullable
234                        if (sql.firstRow("SELECT * FROM information_schema.columns WHERE columns.table_name='study' AND columns.column_name='code' AND is_nullable='NO'")) {
235                                if (String.metaClass.getMetaMethod("grom")) "performing database upgrade: dropping column 'code' from table 'study'".grom()
236
237                                try {
238                                        sql.execute("ALTER TABLE study ALTER COLUMN code DROP NOT NULL")
239                                        updated = true
240                                } catch (Exception e) {
241                                        println "alterStudyAndAssay database upgrade failed, study.code could not be set to accept null values: " + e.getMessage()
242                                }
243                        }
244
245                        // Load all studies and save them again. This prevents errors on saving later
246                        if (updated) {
247                                if (String.metaClass.getMetaMethod("grom")) "re-saving studies...".grom()
248
249                                Study.list().each { study ->
250                                        if (String.metaClass.getMetaMethod("grom")) "re-saving study: ${study}".grom()
251                                        study.save()
252                                }
253                        }
254                }
255        }
256}
Note: See TracBrowser for help on using the browser.