Package liquibase.snapshot

Class DatabaseSnapshot

java.lang.Object

liquibase.snapshot.DatabaseSnapshot

All Implemented Interfaces:

LiquibaseSerializable

Direct Known Subclasses:

EmptyDatabaseSnapshot, JdbcDatabaseSnapshot, RestoredDatabaseSnapshot

public abstract class DatabaseSnapshot
extends Object
implements LiquibaseSerializable

Nested Class Summary

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

LiquibaseSerializable.SerializationType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_CATALOGS_STRING_SCRATCH_KEY

Fields inherited from interface liquibase.serializer.LiquibaseSerializable

GENERIC_CHANGELOG_EXTENSION_NAMESPACE, GENERIC_SNAPSHOT_EXTENSION_NAMESPACE, STANDARD_CHANGELOG_NAMESPACE, STANDARD_SNAPSHOT_NAMESPACE

Constructor Summary

Constructors

Constructor	Description
DatabaseSnapshot(DatabaseObject[] examples, Database database)

Method Summary

Modifier and Type	Method	Description
DatabaseSnapshot	clone(DatabaseObject[] examples)	Searches the current snapshot content for the given examples.
protected SnapshotGeneratorChain	createGeneratorChain(Class<? extends DatabaseObject> databaseObjectType, Database database)
<DatabaseObjectType extends DatabaseObject> DatabaseObjectType	get(DatabaseObjectType example)	Returns the object described by the passed example if it is already included in this snapshot.
<DatabaseObjectType extends DatabaseObject> Set<DatabaseObjectType>	get(Class<DatabaseObjectType> type)	Returns all objects of the given type that are already included in this snapshot.
Database	getDatabase()
ResultSetCache	getResultSetCache(String key)
Object	getScratchData(String key)	Used to get and store misc data that should be scoped to the snapshot.
String	getSerializableFieldNamespace(String field)
Set<String>	getSerializableFields()
LiquibaseSerializable.SerializationType	getSerializableFieldType(String field)
Object	getSerializableFieldValue(String field)
String	getSerializedObjectName()
String	getSerializedObjectNamespace()
SnapshotControl	getSnapshotControl()
protected <T extends DatabaseObject> T	include(T example)	Include the object described by the passed example object in this snapshot.
protected void	init(DatabaseObject[] examples)
protected boolean	isWrongCatalog(DatabaseObject fieldValue)
protected boolean	isWrongSchema(DatabaseObject fieldValue)
void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor)
protected void	loadObjects(Map<String,DatabaseObject> objectMap, Map<String,DatabaseObject> allObjects, ParsedNode node, ResourceAccessor resourceAccessor)
DatabaseSnapshot	merge(DatabaseSnapshot snapshotToMerge)	Method which merges two object snapshot models into one
ParsedNode	serialize()
Object	setScratchData(String key, Object data)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ALL_CATALOGS_STRING_SCRATCH_KEY

public static final String ALL_CATALOGS_STRING_SCRATCH_KEY

See Also:

• Constant Field Values

Constructor Details

DatabaseSnapshot

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

Throws:

DatabaseException

InvalidExampleException

Method Details

init

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

Throws:

DatabaseException

InvalidExampleException

clone

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 - The array of snapshot objects to search and clone

Returns:

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

merge

public DatabaseSnapshot merge(DatabaseSnapshot snapshotToMerge)

Method which merges two object snapshot models into one

Parameters:

snapshotToMerge - Another object snapshot model

Returns:

DatabaseSnapshot Merged object model

getSnapshotControl

public SnapshotControl getSnapshotControl()

getSerializedObjectName

public String getSerializedObjectName()

Specified by:

getSerializedObjectName in interface LiquibaseSerializable

getSerializedObjectNamespace

public String getSerializedObjectNamespace()

Specified by:

getSerializedObjectNamespace in interface LiquibaseSerializable

getSerializableFieldNamespace

public String getSerializableFieldNamespace(String field)

Specified by:

getSerializableFieldNamespace in interface LiquibaseSerializable

getSerializableFields

public Set<String> getSerializableFields()

Specified by:

getSerializableFields in interface LiquibaseSerializable

getSerializableFieldValue

public Object getSerializableFieldValue(String field)

Specified by:

getSerializableFieldValue in interface LiquibaseSerializable

getSerializableFieldType

public LiquibaseSerializable.SerializationType getSerializableFieldType(String field)

Specified by:

getSerializableFieldType in interface LiquibaseSerializable

getDatabase

public Database getDatabase()

getResultSetCache

public ResultSetCache getResultSetCache(String key)

include

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.

Throws:

DatabaseException

InvalidExampleException

isWrongSchema

protected boolean isWrongSchema(DatabaseObject fieldValue)

isWrongCatalog

protected boolean isWrongCatalog(DatabaseObject fieldValue)

get

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

public <DatabaseObjectType extends DatabaseObject>
Set<DatabaseObjectType> get(Class<DatabaseObjectType> type)

Returns all objects of the given type that are already included in this snapshot.

createGeneratorChain

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

load

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

Specified by:

load in interface LiquibaseSerializable

Throws:

ParsedNodeException

loadObjects

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

Throws:

ReflectiveOperationException

ParsedNodeException

serialize

public ParsedNode serialize()

Specified by:

serialize in interface LiquibaseSerializable

getScratchData

public Object getScratchData(String key)

Used to get and store misc data that should be scoped to the snapshot. Helpful for caching snapshot results.

setScratchData

public Object setScratchData(String key,
 Object data)