Liquibase 4.26.0 · liquibase.snapshot.DatabaseSnapshot

Modifier and Type	Field and Description
public static final String	ALL_CATALOGS_STRING_SCRATCH_KEY
private final DatabaseObjectCollection	allFound
private final Database	database
private final Map<Class<? extends DatabaseObject>, Set<DatabaseObject>>	knownNull
private static final Logger	LOGGER
private Map<String, Object>	metadata
private final DatabaseObject[]	originalExamples
private final DatabaseObjectCollection	referencedObjects
private final Map<String, ResultSetCache>	resultSetCaches
private CompareControl.SchemaComparison[]	schemaComparisons
private final HashSet<String>	serializableFields
private final SnapshotControl	snapshotControl
private final Map<String, Object>	snapshotScratchPad

Access	Constructor and Description
pack-priv	DatabaseSnapshot(DatabaseObject[] examples, Database database, SnapshotControl snapshotControl)
public	DatabaseSnapshot(DatabaseObject[] examples, Database database)

Method Summary

Modifier and Type	Method and Description
public DatabaseSnapshot	Returns: a new DatabaseSnapshot object with the clones of the desired objects. If no object is found, an empty DatabaseSnapshot will be returned. clone(DatabaseObject[] The array of snapshot objects to search and clone examples) Searches the current snapshot content for the given examples.
protected SnapshotGeneratorChain	createGeneratorChain(Class<? extends DatabaseObject> databaseObjectType, Database database)
private boolean	descendingColumnExists(Collection<Column> fieldValue)
public <DatabaseObjectType extends DatabaseObject> DatabaseObjectType	get(DatabaseObjectType example) Returns the object described by the passed example if it is already included in this snapshot.
public <DatabaseObjectType extends DatabaseObject> Set<DatabaseObjectType>	get(Class<DatabaseObjectType> type) Returns all objects of the given type that are already included in this snapshot.
public Database	getDatabase()
public Map<String, Object>	getMetadata()
public ResultSetCache	getResultSetCache(String key)
public CompareControl.SchemaComparison[]	getSchemaComparisons()
public Object	getScratchData(String key) Deprecated Will be removed with 4.0 Used to get and store misc data that should be scoped to the snapshot.
public String	getSerializableFieldNamespace(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldNamespace.
public Set<String>	getSerializableFields() Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields.
public LiquibaseSerializable.SerializationType	getSerializableFieldType(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType.
public Object	getSerializableFieldValue(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.
public String	getSerializedObjectName() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName.
public String	getSerializedObjectNamespace() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public SnapshotControl	getSnapshotControl()
protected <T extends DatabaseObject> T	include(T example) Include the object described by the passed example object in this snapshot.
private void	includeNestedObjects(DatabaseObject object)
protected void	init(DatabaseObject[] examples)
private boolean	isKnownNull(DatabaseObject example)
protected boolean	isWrongCatalog(DatabaseObject fieldValue)
protected boolean	isWrongSchema(DatabaseObject fieldValue)
public void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) Implements liquibase.serializer.LiquibaseSerializable.load.
protected void	loadObjects(Map<String, DatabaseObject> objectMap, Map<String, DatabaseObject> allObjects, ParsedNode node, ResourceAccessor resourceAccessor)
public DatabaseSnapshot	Returns: DatabaseSnapshot Merged object model merge(DatabaseSnapshot Another object snapshot model snapshotToMerge) Method which merges two object snapshot models into one
private Object	replaceObject(Object fieldValue)
public ParsedNode	serialize() Implements liquibase.serializer.LiquibaseSerializable.serialize.
public void	setMetadata(Map<String, Object> metadata)
public void	setSchemaComparisons(CompareControl.SchemaComparison[] schemaComparisons)
public Object	setScratchData(String key, Object data)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ALL_CATALOGS_STRING_SCRATCH_KEY	back to summary
public static final String ALL_CATALOGS_STRING_SCRATCH_KEY

allFound	back to summary
private final DatabaseObjectCollection allFound

database	back to summary
private final Database database

knownNull	back to summary
private final Map<Class<? extends DatabaseObject>, Set<DatabaseObject>> knownNull

LOGGER	back to summary
private static final Logger LOGGER

originalExamples	back to summary
private final DatabaseObject[] originalExamples

referencedObjects	back to summary
private final DatabaseObjectCollection referencedObjects

resultSetCaches	back to summary
private final Map<String, ResultSetCache> resultSetCaches

schemaComparisons	back to summary
private CompareControl.SchemaComparison[] schemaComparisons

serializableFields	back to summary
private final HashSet<String> serializableFields

snapshotControl	back to summary
private final SnapshotControl snapshotControl

snapshotScratchPad	back to summary
private final Map<String, Object> snapshotScratchPad

DatabaseSnapshot	back to summary
pack-priv DatabaseSnapshot(DatabaseObject[] examples, Database database, SnapshotControl snapshotControl) throws DatabaseException, InvalidExampleException

DatabaseSnapshot	back to summary
public DatabaseSnapshot(DatabaseObject[] examples, Database database) throws DatabaseException, InvalidExampleException

Method Detail

clone	back to summary
public DatabaseSnapshot clone(DatabaseObject[] examples) Searches the current snapshot content for the given examples. Returns a new DatabaseSnapshot containing a clone of every object from the examples array that was found. Parameters examples:DatabaseObject[] The array of snapshot objects to search and clone Returns:DatabaseSnapshot a new DatabaseSnapshot object with the clones of the desired objects. If no object is found, an empty DatabaseSnapshot will be returned.

clone

back to summary

public DatabaseSnapshot clone(DatabaseObject[] examples)

Searches the current snapshot content for the given examples. Returns a new DatabaseSnapshot containing a clone of every object from the examples array that was found.

Parameters

examples:DatabaseObject[]: The array of snapshot objects to search and clone

Returns:DatabaseSnapshot

a new DatabaseSnapshot object with the clones of the desired objects. If no object is found, an empty DatabaseSnapshot will be returned.

createGeneratorChain	back to summary
protected SnapshotGeneratorChain createGeneratorChain(Class<? extends DatabaseObject> databaseObjectType, Database database)

descendingColumnExists	back to summary
private boolean descendingColumnExists(Collection<Column> fieldValue)

get	back to summary
public <DatabaseObjectType extends DatabaseObject> DatabaseObjectType get(DatabaseObjectType example) Returns the object described by the passed example if it is already included in this snapshot.

get	back to summary
public <DatabaseObjectType extends DatabaseObject> Set<DatabaseObjectType> get(Class<DatabaseObjectType> type) Returns all objects of the given type that are already included in this snapshot.

getDatabase	back to summary
public Database getDatabase()

getMetadata	back to summary
public Map<String, Object> getMetadata()

getResultSetCache	back to summary
public ResultSetCache getResultSetCache(String key)

getSchemaComparisons	back to summary
public CompareControl.SchemaComparison[] getSchemaComparisons()

getScratchData	back to summary
public Object getScratchData(String key) Deprecated Will be removed with 4.0 Used to get and store misc data that should be scoped to the snapshot. Helpful for caching snapshot results.

getSerializableFieldNamespace	back to summary
public String getSerializableFieldNamespace(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldNamespace. Annotations @Override

getSerializableFieldNamespace

back to summary

public String getSerializableFieldNamespace(String field)

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldNamespace.

Annotations

@Override

getSerializableFields	back to summary
public Set<String> getSerializableFields() Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields. Annotations @Override

getSerializableFields

back to summary

public Set<String> getSerializableFields()

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields.

Annotations

@Override

getSerializableFieldType	back to summary
public LiquibaseSerializable.SerializationType getSerializableFieldType(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType. Annotations @Override

getSerializableFieldType

back to summary

public LiquibaseSerializable.SerializationType getSerializableFieldType(String field)

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType.

Annotations

@Override

getSerializableFieldValue	back to summary
public Object getSerializableFieldValue(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue. Annotations @Override

getSerializableFieldValue

back to summary

public Object getSerializableFieldValue(String field)

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.

Annotations

@Override

getSerializedObjectName	back to summary
public String getSerializedObjectName() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName. Annotations @Override

getSerializedObjectName

back to summary

public String getSerializedObjectName()

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName.

Annotations

@Override

getSerializedObjectNamespace	back to summary
public String getSerializedObjectNamespace() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace. Annotations @Override

getSerializedObjectNamespace

back to summary

public String getSerializedObjectNamespace()

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations

@Override

getSnapshotControl	back to summary
public SnapshotControl getSnapshotControl()

include	back to summary
protected <T extends DatabaseObject> T include(T example) throws DatabaseException, InvalidExampleException Include the object described by the passed example object in this snapshot. Returns the object snapshot or null if the object does not exist in the database. If the same object was returned by an earlier include() call, the same object instance will be returned.

includeNestedObjects	back to summary
private void includeNestedObjects(DatabaseObject object) throws DatabaseException, InvalidExampleException, ReflectiveOperationException

init	back to summary
protected void init(DatabaseObject[] examples) throws DatabaseException, InvalidExampleException

isKnownNull	back to summary
private boolean isKnownNull(DatabaseObject example)

isWrongCatalog	back to summary
protected boolean isWrongCatalog(DatabaseObject fieldValue)

isWrongSchema	back to summary
protected boolean isWrongSchema(DatabaseObject fieldValue)

load	back to summary
public void load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException Implements liquibase.serializer.LiquibaseSerializable.load. Annotations @Override

load

back to summary

public void load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException

Implements liquibase.serializer.LiquibaseSerializable.load.

Annotations

@Override

loadObjects	back to summary
protected void loadObjects(Map<String, DatabaseObject> objectMap, Map<String, DatabaseObject> allObjects, ParsedNode node, ResourceAccessor resourceAccessor) throws ReflectiveOperationException, ParsedNodeException

merge	back to summary
public DatabaseSnapshot merge(DatabaseSnapshot snapshotToMerge) Method which merges two object snapshot models into one Parameters snapshotToMerge:DatabaseSnapshot Another object snapshot model Returns:DatabaseSnapshot DatabaseSnapshot Merged object model

merge

back to summary

public DatabaseSnapshot merge(DatabaseSnapshot snapshotToMerge)

Method which merges two object snapshot models into one

Parameters

snapshotToMerge:DatabaseSnapshot: Another object snapshot model

Returns:DatabaseSnapshot

DatabaseSnapshot Merged object model

replaceObject	back to summary
private Object replaceObject(Object fieldValue) throws DatabaseException, InvalidExampleException, ReflectiveOperationException

serialize	back to summary
public ParsedNode serialize() Implements liquibase.serializer.LiquibaseSerializable.serialize. Annotations @Override

serialize

back to summary

public ParsedNode serialize()

Implements liquibase.serializer.LiquibaseSerializable.serialize.

Annotations

@Override

setMetadata	back to summary
public void setMetadata(Map<String, Object> metadata)

setSchemaComparisons	back to summary
public void setSchemaComparisons(CompareControl.SchemaComparison[] schemaComparisons)

setScratchData	back to summary
public Object setScratchData(String key, Object data)

public abstract Class DatabaseSnapshot

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail