liquibase.statement.core.CreateTableStatement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of liquibase-core Show documentation
Show all versions of liquibase-core Show documentation
Liquibase is a tool for managing and executing database changes.
package liquibase.statement.core;
import liquibase.datatype.LiquibaseDataType;
import liquibase.statement.*;
import java.util.*;
public class CreateTableStatement extends AbstractSqlStatement implements CompoundStatement {
/** Table type used by some RDBMS (Snowflake, SAP HANA) supporting different ... types ... of tables (e.g. column- vs. row-based) */
private String tableType;
private final String catalogName;
private String schemaName;
private final String tableName;
private String tablespace;
private String remarks;
private final List columns = new ArrayList<>();
private final Set autoIncrementConstraints = new HashSet<>();
private final Map columnTypes = new HashMap<>();
private final Map defaultValues = new HashMap<>();
private final Map defaultValueConstraintNames = new HashMap<>();
private final Map columnRemarks = new HashMap<>();
private PrimaryKeyConstraint primaryKeyConstraint;
private final Map notNullConstraints = new HashMap<>();
private final Set foreignKeyConstraints = new HashSet<>();
/* NOT NULL constraints in RDBMSs are curious beasts. In some RDBMS, they do not exist as constraints at all, i.e.
they are merely a property of the column. In others, like Oracle DB, they can exist in both forms, and to be
able to give the NN constraint a name in CREATE TABLE, we need to save both the NN property as well as the NN constraint. To make things even more complicated, you cannot just add a NN constraint after the list
of columns, like you could do with UNIQUE, CHECK or FOREIGN KEY constraints. They must be defined
in line with the column (this implies that a NN constraint can always affects exactly one column). */
private final HashMap notNullColumns = new HashMap<>();
private final Set uniqueConstraints = new LinkedHashSet<>();
private final Set computedColumns = new HashSet<>();
private boolean ifNotExists;
public CreateTableStatement(String catalogName, String schemaName, String tableName) {
this(catalogName, schemaName, tableName, null, null);
}
public CreateTableStatement(String catalogName, String schemaName, String tableName, String remarks) {
this(catalogName, schemaName, tableName, remarks, null);
}
public CreateTableStatement(String catalogName, String schemaName, String tableName, String remarks, String tableType) {
this.catalogName = catalogName;
this.schemaName = schemaName;
this.tableName = tableName;
this.remarks = remarks;
this.tableType = tableType;
}
public CreateTableStatement(String catalogName, String schemaName, String tableName, boolean ifNotExists) {
this(catalogName, schemaName, tableName);
this.ifNotExists = ifNotExists;
}
public CreateTableStatement(String catalogName, String schemaName, String tableName, String remarks, String tableType, boolean ifNotExists) {
this(catalogName, schemaName, tableName, remarks, tableType);
this.ifNotExists = ifNotExists;
}
public String getCatalogName() {
return catalogName;
}
public String getSchemaName() {
return schemaName;
}
public String getTableName() {
return tableName;
}
public List getColumns() {
return columns;
}
public String getTablespace() {
return tablespace;
}
public CreateTableStatement setTablespace(String tablespace) {
this.tablespace = tablespace;
return this;
}
public String getRemarks() {
return remarks;
}
public void setRemarks(String remarks) {
this.remarks = remarks;
}
public PrimaryKeyConstraint getPrimaryKeyConstraint() {
return primaryKeyConstraint;
}
public Set getForeignKeyConstraints() {
return foreignKeyConstraints;
}
public Set getUniqueConstraints() {
return uniqueConstraints;
}
@java.lang.SuppressWarnings("squid:S4275")
public Map getNotNullColumns() {
return notNullConstraints;
}
public CreateTableStatement addPrimaryKeyColumn(String columnName, LiquibaseDataType columnType, Object defaultValue, String keyName,
String tablespace, ColumnConstraint... constraints) {
PrimaryKeyConstraint pkConstraint = new PrimaryKeyConstraint(keyName);
pkConstraint.addColumns(columnName);
pkConstraint.setTablespace(tablespace);
List allConstraints = new ArrayList<>(Arrays.asList(constraints));
allConstraints.add(new NotNullConstraint(columnName));
allConstraints.add(pkConstraint);
addColumn(columnName, columnType, defaultValue, allConstraints.toArray(new ColumnConstraint[0]));
return this;
}
public CreateTableStatement addPrimaryKeyColumn(String columnName, LiquibaseDataType columnType, Object defaultValue,
Boolean validate, String keyName, String tablespace, ColumnConstraint... constraints) {
return addPrimaryKeyColumn(columnName, columnType, defaultValue, validate, false, false, keyName, tablespace, constraints);
}
public CreateTableStatement addPrimaryKeyColumn(String columnName, LiquibaseDataType columnType, Object defaultValue,
Boolean validate, boolean deferrable, boolean initiallyDeferred, String keyName, String tablespace, ColumnConstraint... constraints) {
return addPrimaryKeyColumn(columnName, columnType, defaultValue, validate, deferrable, initiallyDeferred, keyName, tablespace, null, constraints);
}
public CreateTableStatement addPrimaryKeyColumn(String columnName, LiquibaseDataType columnType, Object defaultValue,
Boolean validate, boolean deferrable, boolean initiallyDeferred, String keyName, String tablespace, String remarks, ColumnConstraint... constraints) {
PrimaryKeyConstraint pkConstraint = new PrimaryKeyConstraint(keyName);
if (validate != null) {
pkConstraint.setValidatePrimaryKey(validate);
}
pkConstraint.addColumns(columnName);
pkConstraint.setTablespace(tablespace);
pkConstraint.setDeferrable(deferrable);
pkConstraint.setInitiallyDeferred(initiallyDeferred);
List allConstraints = new ArrayList<>(Arrays.asList(constraints));
allConstraints.add(new NotNullConstraint(columnName));
allConstraints.add(pkConstraint);
addColumn(columnName, columnType, defaultValue, remarks, allConstraints.toArray(new ColumnConstraint[0]));
return this;
}
public CreateTableStatement addColumn(String columnName, LiquibaseDataType columnType) {
return addColumn(columnName, columnType, null, new ColumnConstraint[0]);
}
public CreateTableStatement addColumn(String columnName, LiquibaseDataType columnType, Object defaultValue) {
if (defaultValue instanceof ColumnConstraint) {
return addColumn(columnName, columnType, null, new ColumnConstraint[]{(ColumnConstraint) defaultValue});
}
return addColumn(columnName, columnType, defaultValue, new ColumnConstraint[0]);
}
public CreateTableStatement addColumn(String columnName, LiquibaseDataType columnType, ColumnConstraint[] constraints) {
return addColumn(columnName, columnType, null, constraints);
}
public CreateTableStatement addColumn(String columnName, LiquibaseDataType columnType, Object defaultValue, ColumnConstraint[] constraints) {
return addColumn(columnName, columnType, defaultValue, null, constraints);
}
public CreateTableStatement addColumn(String columnName, LiquibaseDataType columnType, Object defaultValue, String remarks, ColumnConstraint... constraints) {
return addColumn(columnName, columnType, null, defaultValue, remarks, constraints);
}
public CreateTableStatement addColumn(String columnName, LiquibaseDataType columnType, String defaultValueConstraintName, Object defaultValue, String remarks, ColumnConstraint... constraints) {
this.getColumns().add(columnName);
this.columnTypes.put(columnName, columnType);
if (defaultValue != null) {
defaultValues.put(columnName, defaultValue);
}
if (defaultValueConstraintName != null) {
defaultValueConstraintNames.put(columnName, defaultValueConstraintName);
}
if (remarks != null) {
this.columnRemarks.put(columnName, remarks);
}
if (constraints != null) {
for (ColumnConstraint constraint : constraints) {
if (constraint == null) {
continue;
}
if (constraint instanceof PrimaryKeyConstraint) {
if (this.getPrimaryKeyConstraint() == null) {
this.primaryKeyConstraint = (PrimaryKeyConstraint) constraint;
} else {
for (String column : ((PrimaryKeyConstraint) constraint).getColumns()) {
this.getPrimaryKeyConstraint().addColumns(column);
}
}
} else if (constraint instanceof NotNullConstraint) {
((NotNullConstraint) constraint).setColumnName(columnName);
getNotNullColumns().put(columnName, (NotNullConstraint) constraint);
} else if (constraint instanceof ForeignKeyConstraint) {
((ForeignKeyConstraint) constraint).setColumn(columnName);
getForeignKeyConstraints().add(((ForeignKeyConstraint) constraint));
} else if (constraint instanceof UniqueConstraint) {
((UniqueConstraint) constraint).addColumns(columnName);
getUniqueConstraints().add(((UniqueConstraint) constraint));
} else if (constraint instanceof AutoIncrementConstraint) {
autoIncrementConstraints.add((AutoIncrementConstraint) constraint);
} else {
throw new RuntimeException("Unknown constraint type: " + constraint.getClass().getName());
}
}
}
return this;
}
public Object getDefaultValue(String column) {
return defaultValues.get(column);
}
public String getDefaultValueConstraintName(String column) {
return defaultValueConstraintNames.get(column);
}
public String getColumnRemarks(String column) {
return columnRemarks.get(column);
}
public CreateTableStatement addColumnConstraint(NotNullConstraint notNullConstraint) {
getNotNullColumns().put(notNullConstraint.getColumnName(), notNullConstraint);
return this;
}
public CreateTableStatement addColumnConstraint(ForeignKeyConstraint fkConstraint) {
getForeignKeyConstraints().add(fkConstraint);
return this;
}
public CreateTableStatement addColumnConstraint(UniqueConstraint uniqueConstraint) {
getUniqueConstraints().add(uniqueConstraint);
return this;
}
public CreateTableStatement addColumnConstraint(AutoIncrementConstraint autoIncrementConstraint) {
getAutoIncrementConstraints().add(autoIncrementConstraint);
return this;
}
public Set getAutoIncrementConstraints() {
return autoIncrementConstraints;
}
public Map getColumnTypes() {
return columnTypes;
}
public Map getDefaultValues() {
return defaultValues;
}
public Map getDefaultValueConstraintNames() {
return defaultValueConstraintNames;
}
public void setSchemaName(String schemaName) {
this.schemaName = schemaName;
}
public void setComputed(String columnName) {
this.computedColumns.add(columnName);
}
public boolean isComputed(String columnName) {
return this.computedColumns.contains(columnName);
}
public String getTableType() {
return tableType;
}
public void setTableType(String tableType) {
this.tableType = tableType;
}
public boolean isIfNotExists() {
return ifNotExists;
}
public void setIfNotExists(boolean ifNotExists) {
this.ifNotExists = ifNotExists;
}
}