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

Class PgFunction

java.lang.Object

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

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

org.pgcodekeeper.core.database.pg.schema.PgAbstractFunction

org.pgcodekeeper.core.database.pg.schema.PgFunction

All Implemented Interfaces:

IFunction, ISearchPath, IStatement, IHashable

public class PgFunction
extends PgAbstractFunction

PostgreSQL function implementation. Represents a regular PostgreSQL function (as opposed to procedures or aggregates) with a return type and function body.

Nested Class Summary

Nested classes/interfaces inherited from class org.pgcodekeeper.core.database.pg.schema.PgAbstractFunction

PgAbstractFunction.PgArgument

Field Summary

Fields inherited from class org.pgcodekeeper.core.database.pg.schema.PgAbstractFunction

FROM_CURRENT

Constructor Summary

Constructors

Constructor	Description
PgFunction(String name)	Creates a new PostgreSQL function.

Method Summary

Modifier and Type	Method	Description
boolean	compare(IStatement 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.
String	getReturns()	Gets the return type of this function.
DbObjType	getStatementType()	Gets the type of this database object.
boolean	needDrop(IFunction newFunction)	Determines whether this function needs to be dropped before creating the new version.
void	setReturns(String returns)	Sets the return type of this function.

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

addArgument, addConfiguration, addReturnsColumn, addTransform, appendAlterSQL, appendFullName, appendFunctionSignature, canDropBeforeCreate, getArguments, getCreationSQL, getLanguage, getName, getParallel, getQualifiedName, getReturnsColumns, getSignature, isInStatementBody, setBody, setExecuteOn, setInStatementBody, setLanguageCost, setLeakproof, setParallel, setRows, setSecurityDefiner, setStrict, setSupportFunc, setVolatileType, setWindow

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, checkComments, clearPrivileges, compareChildren, deepCopy, equals, fillChildrenList, fillDescendantsList, getAuthor, getBareName, getChildren, getComment, getDependencies, getDescendants, getDropSQL, getDropSQL, getLibName, getLocation, getObjectState, getObjectState, getOwner, getParent, getPrivileges, 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.ISearchPath

getContainingSchema, getDatabase, getSchemaName, toObjectReference

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

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

Constructor Details

PgFunction

public PgFunction(String name)

Creates a new PostgreSQL function.

Parameters:

name - function name

Method Details

getStatementType

public DbObjType getStatementType()

Description copied from interface: IStatement

Gets the type of this database object.

Returns:

the database object type

getReturns

public String getReturns()

Description copied from interface: IFunction

Gets the return type of this function.

Returns:

the return type, or null if not applicable

needDrop

public boolean needDrop(IFunction newFunction)

Description copied from interface: IFunction

Determines whether this function needs to be dropped before creating the new version.

Specified by:

needDrop in interface IFunction

Overrides:

needDrop in class PgAbstractFunction

Parameters:

newFunction - the new function version to compare against

Returns:

true if the function needs to be dropped and recreated

setReturns

public void setReturns(String returns)

Description copied from interface: IFunction

Sets the return type of this function.

Parameters:

returns - the return type to set

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 PgAbstractFunction

Parameters:

hasher - the hasher instance to use for hash computation

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 PgAbstractFunction