Package org.pgcodekeeper.core.database.pg.schema

Class PgDatabase

java.lang.Object

org.pgcodekeeper.core.database.base.schema.AbstractStatement

org.pgcodekeeper.core.database.pg.schema.PgAbstractStatement

org.pgcodekeeper.core.database.pg.schema.PgDatabase

All Implemented Interfaces:

IDatabase, IStatement, IStatementContainer, IHashable

public class PgDatabase
extends PgAbstractStatement
implements IDatabase

PostgreSQL database implementation. Manages database-level objects such as schemas, extensions, event triggers, foreign data wrappers, servers, user mappings, and casts.

Author:

fordfrog

Constructor Summary

Constructors

Constructor	Description
PgDatabase()	Creates a new PostgreSQL database.

Method Summary

Modifier and Type	Method	Description
void	addAnalysisLauncher(IAnalysisLauncher launcher)	Add 'analysis launcher' for deferred analyze.
void	addChild(IStatement st)	Adds a child statement to this container.
void	addOverride(ObjectOverride override)	Adds object override
void	addReference(String fileName, ObjectLocation loc)	Adds an object reference to the specified file.
void	clearAnalysisLaunchers()	Clears all analysis launchers and trims the internal list to size.
boolean	compare(IStatement obj)	This method does not account for nested child PgStatements.
boolean	compareChildren(AbstractStatement obj)	Deep part of AbstractStatement.equals(Object).
void	computeChildrenHash(Hasher hasher)
void	computeHash(Hasher hasher)	Computes the hash of the implementing object using the provided hasher.
void	concat(IStatement st)	Adds library object to database with override
void	fillChildrenList(List<Collection<? extends AbstractStatement>> l)
void	fillDescendantsList(List<Collection<? extends AbstractStatement>> l)
List<IAnalysisLauncher>	getAnalysisLaunchers()
PgCast	getCast(String name)	Returns cast of given name or null if the cast has not been found.
AbstractStatement	getChild(String name, DbObjType type)	Gets a child statement by name and type.
Collection<IStatement>	getChildrenByType(DbObjType type)	get all children by type
PgSchema	getDefaultSchema()
PgEventTrigger	getEventTrigger(String name)
PgExtension	getExtension(String name)	Returns extension of given name or null if the extension has not been found.
PgForeignDataWrapper	getForeignDW(String name)	Returns foreign data wrapper of given name or null if the foreign data wrapper has not been found.
Map<String,Set<ObjectLocation>>	getObjReferences()
List<ObjectOverride>	getOverrides()	Gets the list of object overrides for this database.
PgSchema	getSchema(String name)	Returns schema of given name or null if the schema has not been found.
Collection<PgSchema>	getSchemas()	Getter for schemas.
PgServer	getServer(String name)
final AbstractStatement	getStatement(ObjectReference reference)
ISupportedVersion	getVersion()
void	setDefaultSchema(String name)
void	setVersion(PgSupportedVersion version)
void	sortColumns()	Sorts columns in all tables within all schemas of this database.

Methods inherited from class org.pgcodekeeper.core.database.pg.schema.PgAbstractStatement

addPrivilege, appendDefaultPrivileges, appendOwnerSQL, formatSql, getQuoter, getRenameCommand, isOwned

Methods inherited from class org.pgcodekeeper.core.database.base.schema.AbstractStatement

addDependency, appendAlterComments, appendComments, appendPrivileges, canDrop, canDropBeforeCreate, checkComments, clearPrivileges, deepCopy, equals, getAuthor, getBareName, getChildren, getComment, getDependencies, getDescendants, getDropSQL, getDropSQL, getLibName, getLocation, getName, getObjectState, getObjectState, getOwner, getParent, getPrivileges, getQualifiedName, getSeparator, getSQL, getTwin, hasChildren, hashCode, isLib, setAuthor, setComment, setLibName, setLocation, setOwner, setParent, shallowCopy, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.IDatabase

addLib, appendAlterSQL, containsSchema, getCreationSQL, getDatabase, getDropSQL, getStatementType, listObjects

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.IStatement

addDependency, appendOwnerSQL, canDrop, canDropBeforeCreate, clearPrivileges, deepCopy, formatSql, getAuthor, getBareName, getChildren, getComment, getDependencies, getDescendants, getLibName, getLocation, getName, getOwner, getParent, getPrivileges, getQualifiedName, getQuotedName, getQuoter, getRenameCommand, getSeparator, getSQL, getTwin, getTypeName, hasChildren, isLib, isOwned, quote, setComment, setLibName, setLocation, setOwner, shallowCopy, toObjectReference

Constructor Details

PgDatabase

public PgDatabase()

Creates a new PostgreSQL database.

Method Details

concat

public void concat(IStatement st)

Description copied from interface: IDatabase

Adds library object to database with override

Specified by:

concat in interface IDatabase

Parameters:

st - the library object to add

sortColumns

public void sortColumns()

Sorts columns in all tables within all schemas of this database. This is used to ensure consistent column ordering in inherited tables.

getStatement

public final AbstractStatement getStatement(ObjectReference reference)

Specified by:

getStatement in interface IDatabase

Parameters:

reference - - object reference

Returns:

object from database by reference, or null if not found

fillDescendantsList

public void fillDescendantsList(List<Collection<? extends AbstractStatement>> l)

Overrides:

fillDescendantsList in class AbstractStatement

fillChildrenList

public void fillChildrenList(List<Collection<? extends AbstractStatement>> l)

Overrides:

fillChildrenList in class AbstractStatement

getChild

public AbstractStatement getChild(String name,
 DbObjType type)

Description copied from interface: IStatementContainer

Gets a child statement by name and type.

Specified by:

getChild in interface IStatementContainer

Parameters:

name - the name of the child to find

type - the type of the child to find

Returns:

the child statement, or null if not found

getChildrenByType

public Collection<IStatement> getChildrenByType(DbObjType type)

Description copied from interface: IStatementContainer

get all children by type

Specified by:

getChildrenByType in interface IStatementContainer

Parameters:

type - the type of the children

Returns:

unmodifiable collection of child statement, or empty list

getSchema

public PgSchema getSchema(String name)

Returns schema of given name or null if the schema has not been found. If schema name is null then default schema is returned.

Specified by:

getSchema in interface IDatabase

Parameters:

name - schema name or null which means default schema

Returns:

found schema or null

getDefaultSchema

public PgSchema getDefaultSchema()

Specified by:

getDefaultSchema in interface IDatabase

setDefaultSchema

public void setDefaultSchema(String name)

Specified by:

setDefaultSchema in interface IDatabase

addChild

public void addChild(IStatement st)

Description copied from interface: IStatementContainer

Adds a child statement to this container.

Specified by:

addChild in interface IStatementContainer

Parameters:

st - the child statement to add

getExtension

public PgExtension getExtension(String name)

Returns extension of given name or null if the extension has not been found.

Parameters:

name - extension name

Returns:

found extension or null

getEventTrigger

public PgEventTrigger getEventTrigger(String name)

getForeignDW

public PgForeignDataWrapper getForeignDW(String name)

Returns foreign data wrapper of given name or null if the foreign data wrapper has not been found.

Parameters:

name - foreign data wrapper name

Returns:

found foreign data wrapper or null

getServer

public PgServer getServer(String name)

getCast

public PgCast getCast(String name)

Returns cast of given name or null if the cast has not been found.

Parameters:

name - cast name

Returns:

found cast or null

getSchemas

public Collection<PgSchema> getSchemas()

Getter for schemas. The list cannot be modified.

Specified by:

getSchemas in interface IDatabase

Returns:

schemas

setVersion

public void setVersion(PgSupportedVersion version)

getVersion

public ISupportedVersion getVersion()

Specified by:

getVersion in interface IDatabase

Returns:

database version

addOverride

public void addOverride(ObjectOverride override)

Description copied from interface: IDatabase

Adds object override

Specified by:

addOverride in interface IDatabase

Parameters:

override - object override

getOverrides

public List<ObjectOverride> getOverrides()

Description copied from interface: IDatabase

Gets the list of object overrides for this database.

Specified by:

getOverrides in interface IDatabase

Returns:

the list of overrides

getObjReferences

public Map<String,Set<ObjectLocation>> getObjReferences()

Specified by:

getObjReferences in interface IDatabase

Returns:

all object references for this database

getAnalysisLaunchers

public List<IAnalysisLauncher> getAnalysisLaunchers()

Specified by:

getAnalysisLaunchers in interface IDatabase

Returns:

all analysis launcher for this database

addAnalysisLauncher

public void addAnalysisLauncher(IAnalysisLauncher launcher)

Description copied from interface: IDatabase

Add 'analysis launcher' for deferred analyze.

Specified by:

addAnalysisLauncher in interface IDatabase

Parameters:

launcher - launcher that contains almost everything needed to analyze a statement contained in it

addReference

public void addReference(String fileName,
 ObjectLocation loc)

Description copied from interface: IDatabase

Adds an object reference to the specified file.

Specified by:

addReference in interface IDatabase

Parameters:

fileName - the file name to associate with the location

loc - the object location to add

clearAnalysisLaunchers

public void clearAnalysisLaunchers()

Clears all analysis launchers and trims the internal list to size.

Specified by:

clearAnalysisLaunchers in interface IDatabase

computeHash

public void computeHash(Hasher hasher)

Description copied from interface: IHashable

Computes the hash of the implementing object using the provided hasher. The implementation should call appropriate put methods on the hasher for all fields that should contribute to the hash value.

Specified by:

computeHash in interface IHashable

Parameters:

hasher - the hasher instance to use for hash computation

computeChildrenHash

public void computeChildrenHash(Hasher hasher)

compare

public boolean compare(IStatement obj)

Description copied from class: AbstractStatement

This method does not account for nested child PgStatements. Shallow version of AbstractStatement.equals(Object)

Specified by:

compare in interface IStatement

Overrides:

compare in class AbstractStatement

compareChildren

public boolean compareChildren(AbstractStatement obj)

Description copied from class: AbstractStatement

Deep part of AbstractStatement.equals(Object). Compares all object's child PgStatements for equality.

Overrides:

compareChildren in class AbstractStatement