Package liquibase.change.core

Class LoadDataChange

java.lang.Object

liquibase.AbstractExtensibleObject

liquibase.plugin.AbstractPlugin

liquibase.change.AbstractChange

liquibase.change.AbstractTableChange

liquibase.change.core.LoadDataChange

All Implemented Interfaces:

Cloneable, Change, ChangeWithColumns<LoadDataColumnConfig>, ExtensibleObject, Plugin, LiquibaseSerializable

Direct Known Subclasses:

LoadUpdateDataChange

public class LoadDataChange
extends AbstractTableChange
implements ChangeWithColumns<LoadDataColumnConfig>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoadDataChange.LOAD_DATA_TYPE
protected static class	LoadDataChange.LoadDataRowConfig

Nested classes/interfaces inherited from interface liquibase.serializer.LiquibaseSerializable

LiquibaseSerializable.SerializationType

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	BASE64_PATTERN
static String	DEFAULT_COMMENT_PATTERN	CSV Lines starting with that sign(s) will be treated as comments by default

Fields inherited from class liquibase.change.AbstractTableChange

catalogName, schemaName, tableName

Fields inherited from class liquibase.change.AbstractChange

NODENAME_COLUMN

Fields inherited from interface liquibase.change.Change

EMPTY_CHANGE, SHOULD_EXECUTE

Fields inherited from interface liquibase.serializer.LiquibaseSerializable

GENERIC_CHANGELOG_EXTENSION_NAMESPACE, GENERIC_SNAPSHOT_EXTENSION_NAMESPACE, STANDARD_CHANGELOG_NAMESPACE, STANDARD_SNAPSHOT_NAMESPACE

Fields inherited from interface liquibase.plugin.Plugin

PRIORITY_DATABASE, PRIORITY_DEFAULT, PRIORITY_NOT_APPLICABLE, PRIORITY_SPECIALIZED

Constructor Summary

Constructors

Constructor	Description
LoadDataChange()

Method Summary

Modifier and Type	Method	Description
void	addColumn(LoadDataColumnConfig column)	Add a column configuration to the Change.
ChangeStatus	checkStatus(Database database)	Validate that this change executed successfully against the given database.
protected LoadDataColumnConfig	columnConfigFromName(String name, Integer idx)	Get the column using the name, index or the header
protected String	columnIdString(int index, LoadDataColumnConfig columnConfig)	Returns a unique string for the column for better identification.
protected ExecutablePreparedStatementBase	createPreparedStatement(Database database, String catalogName, String schemaName, String tableName, List<LoadDataColumnConfig> columns, ChangeSet changeSet, ResourceAccessor resourceAccessor)
protected InsertStatement	createStatement(String catalogName, String schemaName, String tableName)
protected InsertSetStatement	createStatementSet(String catalogName, String schemaName, String tableName)
CheckSum	generateCheckSum()	Implementation generates checksum by serializing the change with StringChangeLogSerializer
boolean	generateRollbackStatementsVolatile(Database database)	Implementation delegates logic to the SqlGenerator.generateRollbackStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database) If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.
SqlStatement[]	generateStatements(Database database)	Generates the SqlStatement objects required to run the change for the given database.
protected SqlStatement[]	generateStatementsFromRows(Database database, List<LoadDataChange.LoadDataRowConfig> rows)
boolean	generateStatementsVolatile(Database database)	Implementation delegates logic to the SqlGenerator.generateStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database).
protected LoadDataColumnConfig	getColumnConfig(int index, String header)
List<LoadDataColumnConfig>	getColumns()	Return all the ColumnConfig objects defined for this Change
String	getCommentLineStartsWith()
String	getConfirmationMessage()	Confirmation message to be displayed after the change is executed.
CSVReader	getCSVReader()
String	getEncoding()
String	getFile()
String	getQuotchar()
protected String	getRelativeTo()
String	getSeparator()
String	getSerializedObjectNamespace()
String	getTableName()
Boolean	getUsePreparedStatements()
protected static String	getValueToWrite(Object value)	Transform a value read from a CSV file into a string to be written into the database if the column type is not known.
protected boolean	hasPreparedStatementsImplemented()
Boolean	isRelativeToChangelogFile()
void	setColumns(List<LoadDataColumnConfig> columns)
void	setCommentLineStartsWith(String commentLineStartsWith)
void	setEncoding(String encoding)
void	setFile(String file)
void	setQuotchar(String quotchar)
void	setRelativeToChangelogFile(Boolean relativeToChangelogFile)
void	setSeparator(String separator)
void	setUsePreparedStatements(Boolean usePreparedStatements)
boolean	supports(Database database)	Implementation delegates logic to the SqlGenerator.supports(liquibase.statement.SqlStatement, liquibase.database.Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database).
protected boolean	supportsBatchUpdates(Database database)
ValidationErrors	validate(Database database)	Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the SqlGenerator.validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database).
void	validateColumn(LoadDataColumnConfig columnConfig, ValidationErrors validationErrors, String columnIDString)
protected ValidationErrors	validateColumns(ValidationErrors validationErrors)	Validate all columns and collect errors in 'validationErrors'
Warnings	warn(Database database)	Implementation delegates logic to the SqlGenerator.warn(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database).

Methods inherited from class liquibase.change.AbstractTableChange

getCatalogName, getSchemaName, setCatalogName, setSchemaName, setTableName

Methods inherited from class liquibase.change.AbstractChange

createChangeMetaData, createChangeParameterMetadata, createDescriptionMetaData, createEmptyColumnConfig, createExampleValueMetaData, createInverses, createMustEqualExistingMetaData, createRequiredDatabasesMetaData, createSerializationTypeMetaData, createSinceMetaData, createSupportedDatabasesMetaData, customLoadLogic, equals, finishInitialization, generateRollbackStatements, getAffectedDatabaseObjects, getChangeSet, getDescription, getExcludedFieldFilters, getResourceAccessor, getSerializableFieldNamespace, getSerializableFields, getSerializableFieldType, getSerializableFieldValue, getSerializedObjectName, hashCode, isInvalidProperty, load, serialize, serializeValue, setChangeSet, setResourceAccessor, shouldExecuteChange, supportsRollback, toString

Methods inherited from class liquibase.AbstractExtensibleObject

clone, describe, get, get, get, getAttributes, getFieldValue, getObjectMetaData, getValuePath, has, set

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface liquibase.ExtensibleObject

clone, describe, get, get, getAttributes, getObjectMetaData, getValuePath, has, set

Field Detail

DEFAULT_COMMENT_PATTERN

public static final String DEFAULT_COMMENT_PATTERN

CSV Lines starting with that sign(s) will be treated as comments by default

See Also:

Constant Field Values

BASE64_PATTERN

public static final Pattern BASE64_PATTERN

Constructor Detail

LoadDataChange

public LoadDataChange()

Method Detail

getValueToWrite

protected static String getValueToWrite(Object value)

Transform a value read from a CSV file into a string to be written into the database if the column type is not known.

Parameters:

value - the value to transform

Returns:

if the value is empty or the string "NULL" (case-insensitive), return the empty string. If not, the value "toString()" representation (trimmed of spaces left and right) is returned.

hasPreparedStatementsImplemented

protected boolean hasPreparedStatementsImplemented()

supports

public boolean supports(Database database)

Description copied from class: AbstractChange

Implementation delegates logic to the SqlGenerator.supports(liquibase.statement.SqlStatement, liquibase.database.Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database). If no or null SqlStatements are returned by generateStatements then this method returns true. If AbstractChange.generateStatementsVolatile(liquibase.database.Database) returns true, we cannot call generateStatements and so assume true.

Specified by:

supports in interface Change

Overrides:

supports in class AbstractChange

generateRollbackStatementsVolatile

public boolean generateRollbackStatementsVolatile(Database database)

Description copied from class: AbstractChange

Implementation delegates logic to the SqlGenerator.generateRollbackStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database) If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.

Specified by:

generateRollbackStatementsVolatile in interface Change

Overrides:

generateRollbackStatementsVolatile in class AbstractChange

getTableName

public String getTableName()

Overrides:

getTableName in class AbstractTableChange

getFile

public String getFile()

setFile

public void setFile(String file)

getUsePreparedStatements

public Boolean getUsePreparedStatements()

setUsePreparedStatements

public void setUsePreparedStatements(Boolean usePreparedStatements)

getCommentLineStartsWith

public String getCommentLineStartsWith()

setCommentLineStartsWith

public void setCommentLineStartsWith(String commentLineStartsWith)

isRelativeToChangelogFile

public Boolean isRelativeToChangelogFile()

setRelativeToChangelogFile

public void setRelativeToChangelogFile(Boolean relativeToChangelogFile)

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getSeparator

public String getSeparator()

setSeparator

public void setSeparator(String separator)

getQuotchar

public String getQuotchar()

setQuotchar

public void setQuotchar(String quotchar)

addColumn

public void addColumn(LoadDataColumnConfig column)

Description copied from interface: ChangeWithColumns

Add a column configuration to the Change.

Specified by:

addColumn in interface ChangeWithColumns<LoadDataColumnConfig>

getColumns

public List<LoadDataColumnConfig> getColumns()

Description copied from interface: ChangeWithColumns

Return all the ColumnConfig objects defined for this Change

Specified by:

getColumns in interface ChangeWithColumns<LoadDataColumnConfig>

setColumns

public void setColumns(List<LoadDataColumnConfig> columns)

Specified by:

setColumns in interface ChangeWithColumns<LoadDataColumnConfig>

columnIdString

protected String columnIdString(int index,
                                LoadDataColumnConfig columnConfig)

Returns a unique string for the column for better identification. The returned string includes the index of the column and, if available, its name.

Parameters:

index - the index of the column

columnConfig - the column configuration

Returns:

a string in the format " / column[index] (name:'columnName')" or " / column[index]" if the column name is not available.

validateColumns

protected ValidationErrors validateColumns(ValidationErrors validationErrors)

Validate all columns and collect errors in 'validationErrors'

Parameters:

validationErrors - ValidationErrors to collect errors

Returns:

validationErrors

generateStatements

public SqlStatement[] generateStatements(Database database)

Description copied from interface: Change

Generates the SqlStatement objects required to run the change for the given database.

NOTE: This method may be called multiple times throughout the changelog execution process and may be called in documentation generation and other integration points as well.

If this method reads from the current database state or uses any other logic that will be affected by whether previous changeSets have ran or not, you must return true from Change.generateStatementsVolatile(liquibase.database.Database).

Specified by:

generateStatements in interface Change

supportsBatchUpdates

protected boolean supportsBatchUpdates(Database database)

validate

public ValidationErrors validate(Database database)

Description copied from class: AbstractChange

Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the SqlGenerator.validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database). If no or null SqlStatements are returned by generateStatements then this method returns no errors. If there are no parameters than this method returns no errors

Specified by:

validate in interface Change

Overrides:

validate in class AbstractChange

validateColumn

public void validateColumn(LoadDataColumnConfig columnConfig,
                           ValidationErrors validationErrors,
                           String columnIDString)

columnConfigFromName

protected LoadDataColumnConfig columnConfigFromName(String name,
                                                    Integer idx)

Get the column using the name, index or the header

Parameters:

name - name or header of the column searched

idx - the index of the column searched

Returns:

The column having the name or header equal to "name" or the index equal to idx or a new LoadDataColumnConfig if not found

generateStatementsVolatile

public boolean generateStatementsVolatile(Database database)

Description copied from class: AbstractChange

Implementation delegates logic to the SqlGenerator.generateStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database). If zero or null SqlStatements are returned by generateStatements then this method returns false.

Specified by:

generateStatementsVolatile in interface Change

Overrides:

generateStatementsVolatile in class AbstractChange

getCSVReader

public CSVReader getCSVReader()
                       throws IOException,
                              LiquibaseException

Throws:

IOException

LiquibaseException

getRelativeTo

protected String getRelativeTo()

createPreparedStatement

protected ExecutablePreparedStatementBase createPreparedStatement(Database database,
                                                                  String catalogName,
                                                                  String schemaName,
                                                                  String tableName,
                                                                  List<LoadDataColumnConfig> columns,
                                                                  ChangeSet changeSet,
                                                                  ResourceAccessor resourceAccessor)

createStatement

protected InsertStatement createStatement(String catalogName,
                                          String schemaName,
                                          String tableName)

createStatementSet

protected InsertSetStatement createStatementSet(String catalogName,
                                                String schemaName,
                                                String tableName)

getColumnConfig

protected LoadDataColumnConfig getColumnConfig(int index,
                                               String header)

checkStatus

public ChangeStatus checkStatus(Database database)

Description copied from interface: Change

Validate that this change executed successfully against the given database. This will check that the update completed at a high level plus check details of the change. For example, a change to add a column will check that the column exists plus data type, default values, etc.

Specified by:

checkStatus in interface Change

Overrides:

checkStatus in class AbstractChange

getConfirmationMessage

public String getConfirmationMessage()

Description copied from interface: Change

Confirmation message to be displayed after the change is executed. Should include relevant configuration settings to make it as helpful as possible. This method may be called outside the changelog execution process, such as in documentation generation.

Specified by:

getConfirmationMessage in interface Change

generateCheckSum

public CheckSum generateCheckSum()

Description copied from class: AbstractChange

Implementation generates checksum by serializing the change with StringChangeLogSerializer

Specified by:

generateCheckSum in interface Change

Overrides:

generateCheckSum in class AbstractChange

warn

public Warnings warn(Database database)

Description copied from class: AbstractChange

Implementation delegates logic to the SqlGenerator.warn(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database). If a generated statement is not supported for the given database, no warning will be added since that is a validation error. If no or null SqlStatements are returned by generateStatements then this method returns no warnings.

Specified by:

warn in interface Change

Overrides:

warn in class AbstractChange

getSerializedObjectNamespace

public String getSerializedObjectNamespace()

Specified by:

getSerializedObjectNamespace in interface LiquibaseSerializable

Overrides:

getSerializedObjectNamespace in class AbstractChange

generateStatementsFromRows

protected SqlStatement[] generateStatementsFromRows(Database database,
                                                    List<LoadDataChange.LoadDataRowConfig> rows)