Package org.pgcodekeeper.core.database.api.schema

Interface ISearchPath

All Superinterfaces:

IStatement

All Known Subinterfaces:

IColumn, ICompositeType, IConstraint, IConstraintFk, IConstraintPk, IForeignTable, IFunction, IIndex, IOperator, IPartitionTable, IRelation, IRule, ISequence, ISubElement, ITable, ITrigger, IType, IView, MsSourceStatement

All Known Implementing Classes:

ChColumn, ChConstraint, ChDictionary, ChIndex, ChTable, ChTableLog, ChView, GpExternalTable, GpPartitionTable, MetaCompositeType, MetaConstraint, MetaFunction, MetaOperator, MetaRelation, MsAbstractClrFunction, MsAbstractCommonFunction, MsAbstractFunction, MsAbstractStatementContainer, MsClrFunction, MsClrProcedure, MsColumn, MsConstraint, MsConstraintCheck, MsConstraintFk, MsConstraintPk, MsFunction, MsIndex, MsProcedure, MsSequence, MsStatistics, MsTable, MsTrigger, MsType, MsView, PgAbstractForeignTable, PgAbstractFunction, PgAbstractRegularTable, PgAbstractStatementContainer, PgAbstractTable, PgAbstractType, PgAbstractView, PgAggregate, PgBaseType, PgCollation, PgColumn, PgCompositeType, PgConstraint, PgConstraintCheck, PgConstraintExclude, PgConstraintFk, PgConstraintNotNull, PgConstraintPk, PgDomain, PgEnumType, PgFtsConfiguration, PgFtsDictionary, PgFtsParser, PgFtsTemplate, PgFunction, PgIndex, PgMaterializedView, PgOperator, PgPartitionForeignTable, PgPartitionTable, PgPolicy, PgProcedure, PgRangeType, PgRule, PgSequence, PgShellType, PgSimpleForeignTable, PgSimpleTable, PgStatistics, PgTrigger, PgTypedTable, PgView

public interface ISearchPath
extends IStatement

Interface for database objects that are contained within a schema and can be found via search path. Provides methods for accessing the containing schema and database.

Method Summary

Modifier and Type	Method	Description
default ISchema	getContainingSchema()	Gets the schema that contains this object.
default IDatabase	getDatabase()	Gets the database that contains this object.
default String	getSchemaName()	Gets the name of the schema that contains this object.
default ObjectReference	toObjectReference()

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

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

Method Details

getContainingSchema

default ISchema getContainingSchema()

Gets the schema that contains this object.

Returns:

the containing schema

getSchemaName

default String getSchemaName()

Gets the name of the schema that contains this object.

Returns:

the schema name

getDatabase

default IDatabase getDatabase()

Gets the database that contains this object.

Specified by:

getDatabase in interface IStatement

Returns:

the containing database

toObjectReference

default ObjectReference toObjectReference()

Specified by:

toObjectReference in interface IStatement