-
Notifications
You must be signed in to change notification settings - Fork 19
/
dbmigrate.cfc
242 lines (225 loc) · 11.4 KB
/
dbmigrate.cfc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
<cfcomponent output="false" mixin="none" environment="design,development,maintenance">
<cffunction name="init">
<cfset this.version = "1.0,1.0.1,1.0.2,1.0.3,1.0.4,1.0.5,1.1,1.1.3,1.1.4,1.1.5,1.1.6,1.1.7,1.1.8,1.3.3,1.3.4">
<cfreturn this>
</cffunction>
<cffunction name="migrateTo" access="public" returntype="string" hint="migrates database to a specified version">
<cfargument name="version" type="string" required="false" default="">
<cfset var loc = {}>
<cfset loc.feedback = "">
<cfset loc.versionsCurrentlyMigrated = $getVersionsPreviouslyMigrated()>
<cfset loc.currentVersion = ListLast(loc.versionsCurrentlyMigrated)>
<cfif loc.currentVersion eq arguments.version>
<cfset loc.feedback = "Database is currently at version #arguments.version#. No migration required.#chr(13)#">
<cfelse>
<cfset loc.sqlPath = expandPath("db/sql")>
<cfif not DirectoryExists(loc.sqlPath)>
<cfdirectory action="create" directory="#loc.sqlPath#">
</cfif>
<cfset loc.migrations = getAvailableMigrations()>
<cfif loc.currentVersion gt arguments.version>
<cfset loc.feedback = "Migrating from #loc.currentVersion# down to #arguments.version#.#chr(13)#">
<cfloop index="loc.i" from="#ArrayLen(loc.migrations)#" to="1" step="-1">
<cfset loc.migration = loc.migrations[loc.i]>
<cfif loc.migration.version lte arguments.version><cfbreak></cfif>
<cfif loc.migration.status eq "migrated">
<cftransaction action="begin">
<cftry>
<cfset loc.feedback = loc.feedback & "#chr(13)#------- " & loc.migration.cfcfile & " #RepeatString("-",Max(5,50-Len(loc.migration.cfcfile)))##chr(13)#">
<cfset Request.migrationOutput = "">
<cfset Request.migrationSQLFile = "#loc.sqlPath#/#loc.migration.cfcfile#_down.sql">
<cffile action="write" file="#Request.migrationSQLFile#" output="">
<cfset loc.migration.cfc.down()>
<cfset loc.feedback = loc.feedback & Request.migrationOutput>
<cfset $removeVersionAsMigrated(loc.migration.version)>
<cfcatch type="any">
<cfset loc.feedback = loc.feedback & "Error migrating to #loc.migration.version#.#chr(13)##CFCATCH.Message##chr(13)##CFCATCH.Detail##chr(13)#">
<cftransaction action="rollback" />
<cfbreak>
</cfcatch>
</cftry>
<cftransaction action="commit" />
</cftransaction>
</cfif>
</cfloop>
<cfelse>
<cfset loc.feedback = "Migrating from #loc.currentVersion# up to #arguments.version#.#chr(13)#">
<cfloop index="loc.i" from="1" to="#ArrayLen(loc.migrations)#">
<cfset loc.migration = loc.migrations[loc.i]>
<cfif loc.migration.version lte arguments.version and loc.migration.status neq "migrated">
<cftransaction action="begin">
<cftry>
<cfset loc.feedback = loc.feedback & "#chr(13)#-------- " & loc.migration.cfcfile & " #RepeatString("-",Max(5,50-Len(loc.migration.cfcfile)))##chr(13)#">
<cfset Request.migrationOutput = "">
<cfset Request.migrationSQLFile = "#loc.sqlPath#/#loc.migration.cfcfile#_up.sql">
<cffile action="write" file="#Request.migrationSQLFile#" output="">
<cfset loc.migration.cfc.up()>
<cfset loc.feedback = loc.feedback & Request.migrationOutput>
<cfset $setVersionAsMigrated(loc.migration.version)>
<cfcatch type="any">
<cfset loc.feedback = loc.feedback & "Error migrating to #loc.migration.version#.#chr(13)##CFCATCH.Message##chr(13)##CFCATCH.Detail##chr(13)#">
<cftransaction action="rollback" />
<cfbreak>
</cfcatch>
</cftry>
<cftransaction action="commit" />
</cftransaction>
<cfelseif loc.migration.version gt arguments.version>
<cfbreak>
</cfif>
</cfloop>
</cfif>
</cfif>
<cfreturn loc.feedback>
</cffunction>
<cffunction name="getCurrentMigrationVersion" access="public" returntype="string" hint="returns current database version">
<cfset var loc = {}>
<cfset loc.listPreviouslyMigratedVersions = $getVersionsPreviouslyMigrated()>
<cfreturn ListLast(loc.listPreviouslyMigratedVersions)>
</cffunction>
<cffunction name="getAvailableMigrations" access="public" returntype="array" hint="searches db/migrate folder for migrations">
<cfset var loc = {}>
<cfset loc.listVersionsPreviouslyMigrated = $getVersionsPreviouslyMigrated()>
<cfset loc.migrations = ArrayNew(1)>
<cfset loc.migrationRE = "^([\d]{3,14})_([^\.]*)\.cfc$">
<cfset loc.migrationsPath = expandPath("db/migrate")>
<cfif not DirectoryExists(loc.migrationsPath)>
<cfdirectory action="create" directory="#loc.migrationsPath#">
</cfif>
<cfdirectory action="list" name="qMigrationFiles" directory="#loc.migrationsPath#" sort="Name" filter="*.cfc" type="file" />
<cfloop query="qMigrationFiles">
<cfif REFind(loc.migrationRE,Name)>
<cfset loc.migration = {}>
<cfset loc.migration.version = REReplace(Name,loc.migrationRE,"\1")>
<cfset loc.migration.name = REReplace(Name,loc.migrationRE,"\2")>
<cfset loc.migration.cfcfile = REReplace(Name,loc.migrationRE,"\1_\2")>
<cfset loc.migration.loadError = "">
<cfset loc.migration.details = "description unavailable">
<cfset loc.migration.status = "">
<cftry>
<cfset loc.migration.cfc = $createObjectFromRoot(path="db.migrate",fileName=loc.migration.cfcfile, method="init")>
<cfset loc.metaData = GetMetaData(loc.migration.cfc)>
<cfif structKeyExists(loc.metaData,"hint")>
<cfset loc.migration.details = loc.metaData.hint>
</cfif>
<cfif ListFind(loc.listVersionsPreviouslyMigrated, loc.migration.version) neq 0>
<cfset loc.migration.status = "migrated">
</cfif>
<cfcatch type="any"><cfset loc.migration.loadError = CFCATCH.Message></cfcatch>
</cftry>
<cfset ArrayAppend(loc.migrations,loc.migration)>
</cfif>
</cfloop>
<cfreturn loc.migrations>
</cffunction>
<cffunction name="createMigration" access="public" returntype="string">
<cfargument name="migrationName" type="string" required="true" />
<cfargument name="templateName" type="string" required="false" default="blank" />
<cfargument name="migrationPrefix" type="string" required="false" default="timestamp" />
<cfif len(trim(arguments.migrationName)) gt 0>
<cfreturn $copyTemplateMigrationAndRename(argumentCollection=arguments)>
<cfelse>
<cfreturn "You must supply a migration name (e.g. 'creates member table')">
</cfif>
</cffunction>
<cffunction name="$setVersionAsMigrated" access="private">
<cfargument name="version" required="true" type="string">
<cfquery datasource="#application.wheels.dataSourceName#">
INSERT INTO schemainfo (version) VALUES (<cfqueryparam cfsqltype="cf_sql_varchar" value="#arguments.version#">)
</cfquery>
</cffunction>
<cffunction name="$removeVersionAsMigrated" access="private">
<cfargument name="version" required="true" type="string">
<cfquery datasource="#application.wheels.dataSourceName#" >
DELETE FROM schemainfo WHERE version = <cfqueryparam cfsqltype="cf_sql_varchar" value="#arguments.version#">
</cfquery>
</cffunction>
<cffunction name="$createObjectFromRoot" returntype="any" access="public" output="false">
<cfargument name="path" type="string" required="true">
<cfargument name="fileName" type="string" required="true">
<cfargument name="method" type="string" required="true">
<cfscript>
var returnValue = "";
var loc = {};
loc.returnVariable = "returnValue";
loc.method = arguments.method;
loc.component = ListChangeDelims(arguments.path, ".", "/") & "." & ListChangeDelims(arguments.fileName, ".", "/");
loc.argumentCollection = arguments;
</cfscript>
<cfinclude template="../../root.cfm">
<cfreturn returnValue>
</cffunction>
<cffunction name="$copyTemplateMigrationAndRename" displayname="$copyTemplateMigrationAndRename" access="private" returntype="string">
<cfargument name="migrationName" type="string" required="true" />
<cfargument name="templateName" type="string" required="true" />
<cfargument name="migrationPrefix" type="string" required="false" default="" />
<cfset var loc = {}/>
<cfset loc.migrationsPath = expandPath("db/migrate")/>
<cfset loc.templateFile = expandPath("plugins/dbmigrate/templates") & "/" & arguments.templateName & ".cfc"/>
<cfset loc.extendsPath = "plugins.dbmigrate.Migration"/>
<cfif not FileExists(loc.templateFile)>
<cfreturn "Template #arguments.templateName# could not be found">
</cfif>
<cfif not DirectoryExists(loc.migrationsPath)>
<cfdirectory action="create" directory="#loc.migrationsPath#">
</cfif>
<cftry>
<cffile action="read" file="#loc.templateFile#" variable="loc.templateContent">
<cfif Len(Trim(application.wheels.rootcomponentpath)) GT 0>
<cfset loc.extendsPath = application.wheels.rootcomponentpath & ".plugins.dbmigrate.Migration"/>
</cfif>
<cfset loc.templateContent = replace(loc.templateContent, "[extends]", loc.extendsPath)>
<cfset loc.templateContent = replace(loc.templateContent, "[description]", replace(arguments.migrationName,'"','"','ALL'))>
<cfset loc.migrationFile = REREplace(arguments.migrationName,"[^A-z0-9]+"," ","ALL")>
<cfset loc.migrationFile = REREplace(Trim(loc.migrationFile),"[\s]+","_","ALL")>
<cfset loc.migrationFile = $getNextMigrationNumber(arguments.migrationPrefix) & "_#loc.migrationFile#.cfc">
<cffile action="write" file="#loc.migrationsPath#/#loc.migrationFile#" output="#loc.templateContent#">
<cfcatch type="any">
<cfreturn "There was an error when creating the migration: #cfcatch.message#">
</cfcatch>
</cftry>
<cfreturn "The migration #loc.migrationFile# file was created" />
</cffunction>
<cffunction name="$getNextMigrationNumber" returntype="string">
<cfargument name="migrationPrefix" type="string" required="false" default="" />
<cfscript>
var loc = {};
loc.migrationNumber = dateformat(now(),'yyyymmdd') & timeformat(now(),'HHMMSS');
if(arguments.migrationPrefix != "timestamp") {
loc.migrations = getAvailableMigrations();
if(ArrayLen(loc.migrations) eq 0) {
if(arguments.migrationPrefix == "numeric") {
loc.migrationNumber = "001";
}
} else {
// determine current numbering system
loc.lastMigration = loc.migrations[ArrayLen(loc.migrations)];
if(Len(loc.lastMigration.version) eq 3) {
// use numeric numbering
loc.migrationNumber = NumberFormat(Val(loc.lastMigration.version)+1,"009");
}
}
}
</cfscript>
<cfreturn loc.migrationNumber>
</cffunction>
<cffunction name="$getVersionsPreviouslyMigrated" access="private" returntype="string">
<cfset var loc = {}>
<cftry>
<cfquery name="loc.qMigratedVersions" datasource="#application.wheels.dataSourceName#" >
SELECT version FROM schemainfo ORDER BY version ASC
</cfquery>
<cfcatch type="database">
<cfquery datasource="#application.wheels.dataSourceName#" >
CREATE TABLE schemainfo (version VARCHAR(25))
</cfquery>
<cfreturn "0">
</cfcatch>
</cftry>
<cfif loc.qMigratedVersions.recordcount eq 0>
<cfreturn "0">
<cfelse>
<cfreturn ValueList(loc.qMigratedVersions.version)>
</cfif>
</cffunction>
</cfcomponent>