Package org.pgcodekeeper.core.database.ch.schema

Class ChDatabase

java.lang.Object

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

org.pgcodekeeper.core.database.ch.schema.ChAbstractStatement

org.pgcodekeeper.core.database.ch.schema.ChDatabase

All Implemented Interfaces:

IDatabase, IStatement, IStatementContainer, IHashable

public class ChDatabase
extends ChAbstractStatement
implements IDatabase

Represents a ClickHouse database with its schema objects. Contains collections of ClickHouse-specific objects like functions, policies, users, and roles in addition to the standard schemas.

Constructor Summary

Constructors

Constructor	Description
ChDatabase()

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	copyLaunchers(ChDatabase db)	Copies analysis launchers from another database to this one.
void	fillChildrenList(List<Collection<? extends AbstractStatement>> l)
void	fillDescendantsList(List<Collection<? extends AbstractStatement>> l)
List<IAnalysisLauncher>	getAnalysisLaunchers()
AbstractStatement	getChild(String name, DbObjType type)	Gets a child statement by name and type.
Collection<IStatement>	getChildrenByType(DbObjType type)	get all children by type
ChSchema	getDefaultSchema()
Map<String,Set<ObjectLocation>>	getObjReferences()
List<ObjectOverride>	getOverrides()	Gets the list of object overrides for this database.
ChSchema	getSchema(String name)	Gets a schema by name.
Collection<? extends ISchema>	getSchemas()	Gets all schemas in this database.
final IStatement	getStatement(ObjectReference reference)
ISupportedVersion	getVersion()
void	setDefaultSchema(String name)

Methods inherited from class org.pgcodekeeper.core.database.ch.schema.ChAbstractStatement

appendComments, appendOwnerSQL, formatSql, getQuoter, getRenameCommand

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

addDependency, addPrivilege, appendAlterComments, 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, concat, 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

ChDatabase

public ChDatabase()

Method Details

clearAnalysisLaunchers

public void clearAnalysisLaunchers()

Description copied from interface: IDatabase

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

Specified by:

clearAnalysisLaunchers in interface IDatabase

getStatement

public final IStatement getStatement(ObjectReference reference)

Specified by:

getStatement in interface IDatabase

Parameters:

reference - - object reference

Returns:

object from database by reference, or null if not found

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

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

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

getVersion

public ISupportedVersion getVersion()

Specified by:

getVersion in interface IDatabase

Returns:

default database version

getObjReferences

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

Specified by:

getObjReferences in interface IDatabase

Returns:

all object references for this database

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

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

fillDescendantsList

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

Overrides:

fillDescendantsList in class AbstractStatement

setDefaultSchema

public void setDefaultSchema(String name)

Specified by:

setDefaultSchema in interface IDatabase

getDefaultSchema

public ChSchema getDefaultSchema()

Specified by:

getDefaultSchema in interface IDatabase

getSchemas

public Collection<? extends ISchema> getSchemas()

Description copied from interface: IDatabase

Gets all schemas in this database.

Specified by:

getSchemas in interface IDatabase

Returns:

a collection of schemas

getSchema

public ChSchema getSchema(String name)

Description copied from interface: IDatabase

Gets a schema by name.

Specified by:

getSchema in interface IDatabase

Parameters:

name - the schema name

Returns:

the schema with the given name, or null if not found

addOverride

public void addOverride(ObjectOverride override)

Description copied from interface: IDatabase

Adds object override

Specified by:

addOverride in interface IDatabase

Parameters:

override - object override

copyLaunchers

public void copyLaunchers(ChDatabase db)

Copies analysis launchers from another database to this one.

Parameters:

db - the database to copy launchers from

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