forked from liquibase/liquibase
/
ChangedColumnChangeGenerator.java
306 lines (271 loc) · 15.4 KB
/
ChangedColumnChangeGenerator.java
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
package liquibase.diff.output.changelog.core;
import liquibase.Scope;
import liquibase.change.AddColumnConfig;
import liquibase.change.Change;
import liquibase.change.core.*;
import liquibase.database.Database;
import liquibase.database.core.MSSQLDatabase;
import liquibase.database.core.OracleDatabase;
import liquibase.database.core.PostgresDatabase;
import liquibase.datatype.DataTypeFactory;
import liquibase.datatype.LiquibaseDataType;
import liquibase.datatype.core.BooleanType;
import liquibase.diff.Difference;
import liquibase.diff.ObjectDifferences;
import liquibase.diff.output.DiffOutputControl;
import liquibase.diff.output.changelog.AbstractChangeGenerator;
import liquibase.diff.output.changelog.ChangeGeneratorChain;
import liquibase.diff.output.changelog.ChangedObjectChangeGenerator;
import liquibase.statement.DatabaseFunction;
import liquibase.structure.DatabaseObject;
import liquibase.structure.core.*;
import liquibase.util.ISODateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.List;
public class ChangedColumnChangeGenerator extends AbstractChangeGenerator implements ChangedObjectChangeGenerator {
@Override
public int getPriority(Class<? extends DatabaseObject> objectType, Database database) {
if (Column.class.isAssignableFrom(objectType)) {
return PRIORITY_DEFAULT;
}
return PRIORITY_NONE;
}
@Override
public Class<? extends DatabaseObject>[] runAfterTypes() {
return new Class[] {
Table.class
};
}
@Override
public Class<? extends DatabaseObject>[] runBeforeTypes() {
return new Class[] {
PrimaryKey.class
};
}
@Override
public Change[] fixChanged(DatabaseObject changedObject, ObjectDifferences differences, DiffOutputControl control, Database referenceDatabase, Database comparisonDatabase, ChangeGeneratorChain chain) {
Column column = (Column) changedObject;
if (column.getRelation() instanceof View) {
return null;
}
if (column.getRelation().getSnapshotId() == null) { //not an actual table, maybe an alias, maybe in a different schema. Don't fix it.
return null;
}
List<Change> changes = new ArrayList<>();
handleTypeDifferences(column, differences, control, changes, referenceDatabase, comparisonDatabase);
handleNullableDifferences(column, differences, control, changes, referenceDatabase, comparisonDatabase);
handleDefaultValueDifferences(column, differences, control, changes, referenceDatabase, comparisonDatabase);
handleAutoIncrementDifferences(column, differences, control, changes, referenceDatabase, comparisonDatabase);
Difference remarksDiff = differences.getDifference("remarks");
if (remarksDiff != null) {
SetColumnRemarksChange change = new SetColumnRemarksChange();
if (control.getIncludeCatalog()) {
change.setCatalogName(column.getSchema().getCatalogName());
}
if (control.getIncludeSchema()) {
change.setSchemaName(column.getSchema().getName());
}
change.setTableName(column.getRelation().getName());
change.setColumnName(column.getName());
change.setRemarks(column.getRemarks());
LiquibaseDataType columnDataType = DataTypeFactory.getInstance().from(column.getType(), comparisonDatabase);
if (columnDataType != null) {
change.setColumnDataType(columnDataType.toString());
}
changes.add(change);
}
return changes.toArray(new Change[changes.size()]);
}
protected void handleNullableDifferences(Column column, ObjectDifferences differences, DiffOutputControl control, List<Change> changes, Database referenceDatabase, Database comparisonDatabase) {
Difference nullableDifference = differences.getDifference("nullable");
if ((nullableDifference != null) && (nullableDifference.getReferenceValue() != null)) {
boolean nullable = (Boolean) nullableDifference.getReferenceValue();
if (nullable) {
DropNotNullConstraintChange change = new DropNotNullConstraintChange();
if (control.getIncludeCatalog()) {
change.setCatalogName(column.getRelation().getSchema().getCatalog().getName());
}
if (control.getIncludeSchema()) {
change.setSchemaName(column.getRelation().getSchema().getName());
}
change.setTableName(column.getRelation().getName());
change.setColumnName(column.getName());
change.setColumnDataType(DataTypeFactory.getInstance().from(column.getType(), comparisonDatabase).toString());
changes.add(change);
} else {
AddNotNullConstraintChange change = new AddNotNullConstraintChange();
if (control.getIncludeCatalog()) {
change.setCatalogName(column.getRelation().getSchema().getCatalog().getName());
}
if (control.getIncludeSchema()) {
change.setSchemaName(column.getRelation().getSchema().getName());
}
change.setTableName(column.getRelation().getName());
change.setColumnName(column.getName());
change.setColumnDataType(DataTypeFactory.getInstance().from(column.getType(), comparisonDatabase).toString());
change.setValidate(column.getValidate());
change.setConstraintName(column.getAttribute("notNullConstraintName", String.class));
changes.add(change);
}
}
}
protected void handleAutoIncrementDifferences(Column column, ObjectDifferences differences, DiffOutputControl control, List<Change> changes, Database referenceDatabase, Database comparisonDatabase) {
Difference difference = differences.getDifference("autoIncrementInformation");
if (difference != null) {
if (difference.getReferenceValue() == null) {
Scope.getCurrentScope().getLog(getClass()).info("ChangedColumnChangeGenerator cannot fix dropped auto increment values");
//todo: Support dropping auto increments
} else {
AddAutoIncrementChange change = new AddAutoIncrementChange();
if (control.getIncludeCatalog()) {
change.setCatalogName(column.getRelation().getSchema().getCatalog().getName());
}
if (control.getIncludeSchema()) {
change.setSchemaName(column.getRelation().getSchema().getName());
}
change.setTableName(column.getRelation().getName());
change.setColumnName(column.getName());
change.setColumnDataType(DataTypeFactory.getInstance().from(column.getType(), comparisonDatabase).toString());
changes.add(change);
}
}
}
protected void handleTypeDifferences(Column column, ObjectDifferences differences, DiffOutputControl control, List<Change> changes, Database referenceDatabase, Database comparisonDatabase) {
Difference typeDifference = differences.getDifference("type");
if (typeDifference != null) {
String catalogName = null;
String schemaName = null;
if (control.getIncludeCatalog()) {
catalogName = column.getRelation().getSchema().getCatalog().getName();
}
if (control.getIncludeSchema()) {
schemaName = column.getRelation().getSchema().getName();
}
String tableName = column.getRelation().getName();
if ((comparisonDatabase instanceof OracleDatabase) && ("clob".equalsIgnoreCase(((DataType) typeDifference
.getReferenceValue()).getTypeName()) || "clob".equalsIgnoreCase(((DataType) typeDifference
.getComparedValue()).getTypeName()))) {
String tempColName = "TEMP_CLOB_CONVERT";
OutputChange outputChange = new OutputChange();
outputChange.setMessage("Cannot convert directly from " + ((DataType) typeDifference.getComparedValue()).getTypeName()+" to "+((DataType) typeDifference.getReferenceValue()).getTypeName()+". Instead a new column will be created and the data transferred. This may cause unexpected side effects including constraint issues and/or table locks.");
changes.add(outputChange);
AddColumnChange addColumn = new AddColumnChange();
addColumn.setCatalogName(catalogName);
addColumn.setSchemaName(schemaName);
addColumn.setTableName(tableName);
AddColumnConfig addColumnConfig = new AddColumnConfig(column);
addColumnConfig.setName(tempColName);
addColumnConfig.setType(typeDifference.getReferenceValue().toString());
addColumnConfig.setAfterColumn(column.getName());
addColumn.setColumns(Arrays.asList(addColumnConfig));
changes.add(addColumn);
changes.add(new RawSQLChange("UPDATE "+referenceDatabase.escapeObjectName(tableName, Table.class)+" SET "+tempColName+"="+referenceDatabase.escapeObjectName(column.getName(), Column.class)));
DropColumnChange dropColumnChange = new DropColumnChange();
dropColumnChange.setCatalogName(catalogName);
dropColumnChange.setSchemaName(schemaName);
dropColumnChange.setTableName(tableName);
dropColumnChange.setColumnName(column.getName());
changes.add(dropColumnChange);
RenameColumnChange renameColumnChange = new RenameColumnChange();
renameColumnChange.setCatalogName(catalogName);
renameColumnChange.setSchemaName(schemaName);
renameColumnChange.setTableName(tableName);
renameColumnChange.setOldColumnName(tempColName);
renameColumnChange.setNewColumnName(column.getName());
changes.add(renameColumnChange);
} else {
if ((comparisonDatabase instanceof MSSQLDatabase) && (column.getDefaultValue() != null)) { //have to drop the default value, will be added back with the "data type changed" logic.
DropDefaultValueChange dropDefaultValueChange = new DropDefaultValueChange();
dropDefaultValueChange.setCatalogName(catalogName);
dropDefaultValueChange.setSchemaName(schemaName);
dropDefaultValueChange.setTableName(tableName);
dropDefaultValueChange.setColumnName(column.getName());
changes.add(dropDefaultValueChange);
}
ModifyDataTypeChange change = new ModifyDataTypeChange();
change.setCatalogName(catalogName);
change.setSchemaName(schemaName);
change.setTableName(tableName);
change.setColumnName(column.getName());
DataType referenceType = (DataType) typeDifference.getReferenceValue();
change.setNewDataType(DataTypeFactory.getInstance().from(referenceType, comparisonDatabase).toString());
changes.add(change);
}
}
}
protected void handleDefaultValueDifferences(Column column, ObjectDifferences differences, DiffOutputControl control, List<Change> changes, Database referenceDatabase, Database comparisonDatabase) {
Difference difference = differences.getDifference("defaultValue");
if (difference != null) {
Object value = difference.getReferenceValue();
LiquibaseDataType columnDataType = DataTypeFactory.getInstance().from(column.getType(), comparisonDatabase);
if (value == null) {
DropDefaultValueChange change = new DropDefaultValueChange();
if (control.getIncludeCatalog()) {
change.setCatalogName(column.getRelation().getSchema().getCatalog().getName());
}
if (control.getIncludeSchema()) {
change.setSchemaName(column.getRelation().getSchema().getName());
}
change.setTableName(column.getRelation().getName());
change.setColumnName(column.getName());
change.setColumnDataType(columnDataType.toString());
changes.add(change);
} else if (shouldTriggerAddDefaultChange(column, difference, comparisonDatabase)) {
AddDefaultValueChange change = new AddDefaultValueChange();
if (control.getIncludeCatalog()) {
change.setCatalogName(column.getRelation().getSchema().getCatalog().getName());
}
if (control.getIncludeSchema()) {
change.setSchemaName(column.getRelation().getSchema().getName());
}
change.setTableName(column.getRelation().getName());
change.setColumnName(column.getName());
change.setColumnDataType(columnDataType.toString());
//
// Make sure we handle BooleanType values which are not Boolean
//
if (value instanceof Boolean || columnDataType instanceof BooleanType) {
if (value instanceof Boolean) {
change.setDefaultValueBoolean((Boolean) value);
}
else if (columnDataType instanceof BooleanType) {
if (value instanceof DatabaseFunction) {
if (value.equals(new DatabaseFunction("'false'"))) {
change.setDefaultValueBoolean(false);
} else if (value.equals(new DatabaseFunction("'true'"))) {
change.setDefaultValueBoolean(true);
} else {
change.setDefaultValueComputed(((DatabaseFunction) value));
}
}
}
} else if (value instanceof Date) {
change.setDefaultValueDate(new ISODateFormat().format(((Date) value)));
} else if (value instanceof Number) {
change.setDefaultValueNumeric(value.toString());
} else if (value instanceof DatabaseFunction) {
change.setDefaultValueComputed(((DatabaseFunction) value));
} else {
change.setDefaultValue(value.toString());
}
change.setDefaultValueConstraintName(column.getDefaultValueConstraintName());
changes.add(change);
}
}
}
/**
* For {@link PostgresDatabase} if column is of autoIncrement/SERIAL type we can ignore 'defaultValue' differences
* (because its execution of sequence.next() anyway)
*/
private boolean shouldTriggerAddDefaultChange(Column column, Difference difference, Database comparisonDatabase) {
if (!(comparisonDatabase instanceof PostgresDatabase)) {
return true;
}
if (column.getAutoIncrementInformation() != null && difference.getReferenceValue() instanceof DatabaseFunction) {
return false;
}
return true;
}
}