Package org.pgcodekeeper.core.schema.ch

Class ChIndex

java.lang.Object

org.pgcodekeeper.core.schema.PgStatement

org.pgcodekeeper.core.schema.AbstractIndex

org.pgcodekeeper.core.schema.ch.ChIndex

All Implemented Interfaces:

IHashable, IOptionContainer, ISearchPath, ISimpleColumnContainer, ISimpleOptionContainer, IStatement

public final class ChIndex
extends AbstractIndex

Represents a ClickHouse table index. ClickHouse indexes are used for data skipping and include expression, type, and granularity settings.

Field Summary

Fields inherited from class org.pgcodekeeper.core.schema.PgStatement

GO

Fields inherited from interface org.pgcodekeeper.core.schema.IOptionContainer

GP_OPTION_LIST

Constructor Summary

Constructors

Constructor	Description
ChIndex(String name)	Creates a new ClickHouse index with the specified name.

Method Summary

Modifier and Type	Method	Description
ObjectState	appendAlterSQL(PgStatement newCondition, SQLScript script)	Fill script with object changes and return change type
boolean	compare(PgStatement obj)	This method does not account for nested child PgStatements.
void	computeHash(Hasher hasher)	Computes the hash of the implementing object using the provided hasher.
void	getCreationSQL(SQLScript script)	Generates the SQL statements needed to create this database object.
DatabaseType	getDbType()
String	getDefinition()	Returns the full definition string for this index.
void	getDropSQL(SQLScript script, boolean optionExists)	Generates DROP SQL for this statement.
void	setExpr(String expr)
void	setGranVal(int granVal)
void	setType(String type)

Methods inherited from class org.pgcodekeeper.core.schema.AbstractIndex

addColumn, addInclude, addOption, compareColumns, getContainingSchema, getOptions, getStatementType, getTablespace, isSubElement, isUnique, setClustered, setTablespace, setUnique, setWhere, shallowCopy

Methods inherited from class org.pgcodekeeper.core.schema.PgStatement

addAllDeps, addDep, addPrivilege, appendAlterComments, appendComments, appendOwnerSQL, canDrop, canDropBeforeCreate, checkComments, clearPrivileges, compareChildren, deepCopy, equals, getAuthor, getBareName, getChildren, getComment, getDeps, getDescendants, getDropSQL, getLibName, getLocation, getName, getObjectState, getObjectState, getOwner, getParent, getPrivileges, getQualifiedName, getSQL, getTwin, getTypeName, hasChildren, hashCode, isLib, isOwned, setAuthor, setComment, setLibName, setLocation, setOwner, setParent, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pgcodekeeper.core.schema.ISearchPath

getDatabase, getSchemaName

Methods inherited from interface org.pgcodekeeper.core.schema.ISimpleOptionContainer

appendOptions, compareOptions

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

getBareName, getComment, getName, getParent, getQualifiedName

Constructor Details

ChIndex

public ChIndex(String name)

Creates a new ClickHouse index with the specified name.

Parameters:

name - the name of the index

Method Details

setExpr

public void setExpr(String expr)

setType

public void setType(String type)

setGranVal

public void setGranVal(int granVal)

getDefinition

public String getDefinition()

Returns the full definition string for this index.

Returns:

the complete index definition

getCreationSQL

public void getCreationSQL(SQLScript script)

Description copied from class: PgStatement

Generates the SQL statements needed to create this database object. This is an abstract method that must be implemented by subclasses to provide the specific CREATE SQL for each object type.

Specified by:

getCreationSQL in class PgStatement

Parameters:

script - the SQL script to append creation statements to

appendAlterSQL

public ObjectState appendAlterSQL(PgStatement newCondition,
 SQLScript script)

Description copied from class: PgStatement

Fill script with object changes and return change type

Specified by:

appendAlterSQL in class PgStatement

Parameters:

newCondition - new object state

script - script to collect changes

Returns:

object change type

getDropSQL

public void getDropSQL(SQLScript script,
 boolean optionExists)

Description copied from class: PgStatement

Generates DROP SQL for this statement.

Overrides:

getDropSQL in class PgStatement

Parameters:

script - the SQL script to append the DROP statement to

optionExists - whether to include "IF EXISTS" in the DROP statement

getDbType

public DatabaseType getDbType()

Overrides:

getDbType in class PgStatement

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

Overrides:

computeHash in class AbstractIndex

Parameters:

hasher - the hasher instance to use for hash computation

compare

public boolean compare(PgStatement obj)

Description copied from class: PgStatement

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

Overrides:

compare in class AbstractIndex