Class SpannerPostgreSQLDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.PostgreSQLDialect

org.hibernate.dialect.SpannerPostgreSQLDialect

All Implemented Interfaces:

CheckConstraintSupport, ForeignKeySupport, IdentifierSupport, KeywordSupport, LiteralSupport, AlterTableSupport, ColumnDefinitionSupport, ConstraintControlSupport, IndexDdlSupport, TableCreationSupport, TruncateSupport, CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport, ConversionContext

public class SpannerPostgreSQLDialect
extends PostgreSQLDialect
implements CurrentTemporalSupport, TemporalOperationSupport

Field Summary

Fields

Modifier and Type	Field	Description
protected static final DatabaseVersion	MINIMUM_POSTGRES_VERSION

Fields inherited from class PostgreSQLDialect

driverKind, MINIMUM_VERSION

Fields inherited from class Dialect

LEGACY_LOB_MERGE_STRATEGY, NEW_LOCATOR_LOB_MERGE_STRATEGY, STANDARD_MULTI_KEY_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY

Fields inherited from interface ConstraintControlSupport

NONE

Fields inherited from interface TruncateSupport

STANDARD

Constructor Summary

Constructors

Constructor	Description
SpannerPostgreSQLDialect()
SpannerPostgreSQLDialect(DatabaseVersion version)
SpannerPostgreSQLDialect(DialectResolutionInfo info)

Method Summary

Modifier and Type	Method	Description
boolean	addPartitionKeyToPrimaryKey()	Whether every table partition key must also occur in its primary key.
void	appendDateTimeLiteral(SqlAppender appender, TemporalAccessor temporalAccessor, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal for a java.time value.
void	appendDateTimeLiteral(SqlAppender appender, Calendar calendar, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal for a Calendar value.
void	appendDateTimeLiteral(SqlAppender appender, Date date, TemporalType precision, TimeZone jdbcTimeZone)	Append a datetime literal for a legacy Date value.
SQLExceptionConversionDelegate	buildSQLExceptionConversionDelegate()	Supplies vendor-specific SQL-exception conversion for this Dialect.
String	castPattern(CastType from, CastType to)	Obtain a pattern for the SQL equivalent to a cast() function call.
protected String	castType(int sqlTypeCode)	Return the complete cast-target type pattern for sqlTypeCode.
protected String	columnType(int sqlTypeCode)	Return the complete database column declaration pattern for a JDBC Types or Hibernate SqlTypes code used during type registration.
protected void	contributeDefaultProperties(Properties properties)	Contribute provider configuration defaults after Dialect construction.
protected void	contributePostgreSQLTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Allow for extension points to override this only
void	contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Contribute database-specific Java, JDBC, DDL, and basic type descriptors.
String	currentLocalTime()	Render the current local-time expression.
String	currentLocalTimestamp()	Render the current local-timestamp expression.
String	currentTime()	Render the current SQL time expression used for java.sql.Time.
String	currentTimestamp()	Render the current SQL timestamp expression used for java.sql.Timestamp.
Replacer	datetimeFormat(String format)
ScrollMode	defaultScrollMode()	A default ScrollMode to be used by Query.scroll().
AggregateSupport	getAggregateSupport()	Supply the aggregate-column mapping, DDL, read, assignment, and write behavior for this dialect.
String	getArrayTypeName(String javaElementTypeName, String elementTypeName, Integer maxLength)	Render an array type name from the independent Java element name, rendered SQL element name, and optional maximum length.
CallableStatementSupport	getCallableStatementSupport()	Supply the callable-statement protocol for this database and JDBC driver.
CteSupport	getCteSupport()	The common-table-expression capabilities of this Dialect.
CurrentTemporalSupport	getCurrentTemporalSupport()	Supply current temporal expressions and database-side timestamp retrieval.
DirectJavaTimeJdbcSupport	getDirectJavaTimeJdbcSupport()	Supply direct JDBC access capabilities for Java Time classes.
EnumSupport	getEnumSupport()	Supply the database's finite-domain declaration, lifecycle, and check strategy.
FetchClauseSupport	getFetchClauseSupport()	Supply the fetch clause forms accepted by this database.
FunctionalDependencyAnalysisSupport	getFunctionalDependencyAnalysisSupport()	The database's support for recognizing primary-key functional dependency in group by and order by clauses.
TemporaryTableStrategy	getGlobalTemporaryTableStrategy()	Supplies this Dialect's global temporary-table strategy.
IfExistsSupport	getIfExistsSupport()	Supply existence-check placement for schema DDL targets.
InformationExtractor	getInformationExtractor(ExtractionContext extractionContext)	Supply the context-bound strategy Hibernate uses to discover database tables, keys, indexes, and related schema metadata.
LimitHandler	getLimitHandler()	Supplies execution-time pagination for already-rendered SQL requested by Query.setMaxResults(int) or Query.setFirstResult(int).
TemporaryTableStrategy	getLocalTemporaryTableStrategy()	Supplies this Dialect's local temporary-table strategy.
LockingClauseStrategy	getLockingClauseStrategy(QuerySpec querySpec, LockOptions lockOptions)	Supplies the per-translation strategy for a statement-level [PessimisticLockStyle#CLAUSE locking clause].
LockingSupport	getLockingSupport()	Supplies the cohesive pessimistic-locking profile for this Dialect.
MultiTableMutationSupport	getMultiTableMutationSupport()	Select the Hibernate-owned fallback families used for SQM update/delete and insert operations targeting entities mapped to multiple tables.
MutationSyntaxSupport	getMutationSyntaxSupport()	The native SQL mutation-syntax capabilities of this Dialect.
ParameterLimits	getParameterLimits()	Supplies the database limits for IN-expression elements and total JDBC statement parameters.
TemporaryTableStrategy	getPersistentTemporaryTableStrategy()	Supplies the fallback persistent-table strategy used when no native local or global temporary-table strategy is selected.
PredicateSupport	getPredicateSupport()	The database's native predicate syntax and predicate-placement profile.
RowIdSupport	getRowIdSupport()	Supply the database's row-locator expression, JDBC type, and optional physical-column declaration policy.
RowLevelSecurity	getRowLevelSecurity()	Supplies the complete database-native row-level-security strategy for this Dialect.
RowValueSupport	getRowValueSupport()	The native row-value syntax of this Dialect.
SchemaDropSupport	getSchemaDropSupport()	Supply schema-drop composition and ordered pre-drop commands.
SequenceSupport	getSequenceSupport()	Supplies the complete sequence value-expression and lifecycle-DDL strategy for this Dialect.
SingleRowTableSupport	getSingleRowTableSupport()	Supply the SQL renderings used for a reusable single-row table and for an otherwise table-less select.
SqlAstTranslatorFactory	getSqlAstTranslatorFactory()	Supply the factory for this Dialect's single-use SQL AST translators.
SubquerySupport	getSubquerySupport()	Supplies the database's supported subquery placements.
StandardTableExporter	getTableExporter()	Supply the exporter used to create and drop relational tables.
TemporalOperationSupport	getTemporalOperationSupport()	Supply extraction and timestamp-arithmetic syntax.
TupleCountSupport	getTupleCountSupport()	Supplies the database syntax for ordinary and distinct tuple counts.
TypeSizingProfile	getTypeSizingProfile()	Supplies this Dialect's resolved type-sizing limits and defaults.
UniqueDelegate	getUniqueDelegate()	Supply the stable strategy used for unique-key representation and DDL.
ValuesListSupport	getValuesListSupport()	The contexts in which this Dialect supports native multi-row values syntax.
WindowFunctionSupport	getWindowFunctionSupport()	Supplies the native window-function syntax supported by this database.
void	initializeFunctionRegistry(FunctionContributions functionContributions)	Contribute the database-specific function descriptors after independent function contributors have run.
protected void	registerArrayFunctions(CommonFunctionFactory functionFactory)
protected void	registerJsonFunction(CommonFunctionFactory functionFactory)
protected void	registerPostgreSQLColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
protected void	registerUtilityFunctions(FunctionContributions functionContributions)
protected void	registerXmlFunctions(CommonFunctionFactory functionFactory)
String	renderAddConstraint(ForeignKeyConstraintRequest request)
List<String>	renderCommands(TruncateRequest request)
protected Integer	resolveSqlTypeCode(String columnTypeName, TypeConfiguration typeConfiguration)	Resolve a database-reported type name before base-name extraction.
boolean	supportsFilterClause()	Whether this database supports native aggregate filter (where ...) syntax.
boolean	supportsUserDefinedTypes()	Whether mapped aggregate structures may be represented as database user-defined types.
String	timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType)	Return a timestamp-add pattern containing ?1, ?2, and ?3.
String	timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalType, TemporalType toTemporalType)	Return a timestamp-difference pattern containing ?1, ?2, and ?3.
TruncateMode	truncateMode()
boolean	useIntegerForPrimaryKey()

Methods inherited from class PostgreSQLDialect

alterColumnType, appendBinaryLiteral, appendBooleanValueString, appendDefinition, appendFormat, augmentRecognizedTableTypes, buildIdentifierHelper, causesRollback, createOptionalTableUpdateOperation, currentTimestampWithTimeZone, extractPattern, fractionalSecondPrecisionInNanos, getArraySupport, getCurrentTimestampSelection, getDefaultOrdinalityColumnName, getDmlTargetColumnQualifierSupport, getDriverKind, getGeneratedValuesSupport, getIdentityColumnSupport, getLobSupport, getMaxIdentifierLength, getMinimumSupportedVersion, getNameQualifierSupport, getNamespaceSupport, getNationalizationSupport, getNativeParameterMarkerStrategy, getNativeValueGenerationStrategy, getObjectNullBindingStrategy, getQueryHintPlacement, getQueryHintString, getRefCursorSupportFactory, getSchemaCommentSupport, getSelectClauseNullString, getSequenceInformationExtractor, getTemporalFormatSupport, getTemporalTableSupport, getTemporalValueSemantics, getTimeZoneSupport, getUserDefinedTypeExporter, getViolatedConstraintNameExtractor, isCurrentTimestampStable, nameQualification, quoteCollation, registerColumnTypes, resolveSqlTypeDescriptor, supportsMinMaxOnUuid, translateExtractField

Methods inherited from class Dialect

appendArrayLiteral, augmentPhysicalTableTypes, buildLockingClauseStrategy, buildStringToBooleanCast, buildStringToBooleanCastDecode, constraintControlMode, contributeKeywords, determineDatabaseVersion, equivalentTypes, getAlterTableSupport, getBatchLoadSizingStrategy, getCatalogSeparator, getCheckConstraintSupport, getColumnAliasExtractor, getColumnDefinitionSupport, getConstraintControlSupport, getDefaultProperties, getEntityLockingStrategyFactory, getExpressionCoercionSupport, getForeignKeyExporter, getForeignKeySupport, getIdentifierSupport, getIndexDdlSupport, getIndexExporter, getJdbcMetadataOverrides, getKeywords, getKeywordSupport, getLiteralSupport, getLobMergeStrategy, getLowercaseFunction, getMultiKeyLoadSizingStrategy, getNullOrderingSupport, getPreferredSqlTypeCodeForArray, getPreferredSqlTypeCodeForBoolean, getQueryHintString, getSchemaNameResolver, getSequenceExporter, getSetOperationSupport, getSetOperatorSqlString, getSizeStrategy, getStringValueSemantics, getSyntheticTableGroupSupport, getTableCleaner, getTableCreationSupport, getTableMigrator, getTemporaryTableExporter, getTruncateSupport, getVersion, isJdbcLogWarningsEnabledByDefault, narrowCastType, resolveSqlTypeCode, resolveSqlTypeLength, supportsCrossJoin, supportsNationalizedMethods, supportsOrdinalSelectItemReference, throttleDdl, toString, trimPattern

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface AlterTableSupport

addColumnPrefix, addColumnSuffix, alterTableCommand

Methods inherited from interface CheckConstraintSupport

render, supports

Methods inherited from interface ConstraintControlSupport

disableCommands, disableConstraintCommands, enableCommands, enableConstraintCommands

Methods inherited from interface CurrentTemporalSupport

currentDate, currentTimestampWithTimeZone, getCurrentTimestampSelection, isCurrentTimestampStable, usesStandardCurrentTimestampFunction

Methods inherited from interface ForeignKeySupport

renderDropConstraint, requiresSelfReferentialForeignKeyNullification, supportsAlterTableConstraints, supportsOnDeleteAction

Methods inherited from interface IdentifierSupport

closeQuote, getMaxAliasLength, openQuote, quote, toQuotedIdentifier

Methods inherited from interface IndexDdlSupport

createCommand, createTail

Methods inherited from interface KeywordSupport

acceptsJdbcKeyword

Methods inherited from interface LiteralSupport

appendIntervalLiteral, appendIntervalLiteral, appendLiteral, appendUUIDLiteral, toBooleanValueString

Methods inherited from interface TableCreationSupport

createTableCommand, requiresViewColumnList, tableCreationOptions

Methods inherited from interface TemporalOperationSupport

extractPattern, fractionalSecondPrecisionInNanos, translateDurationField, translateExtractField

Field Details

MINIMUM_POSTGRES_VERSION

protected static final DatabaseVersion MINIMUM_POSTGRES_VERSION

Constructor Details

SpannerPostgreSQLDialect

public SpannerPostgreSQLDialect()

SpannerPostgreSQLDialect

public SpannerPostgreSQLDialect(DialectResolutionInfo info)

SpannerPostgreSQLDialect

public SpannerPostgreSQLDialect(DatabaseVersion version)

Method Details

getDirectJavaTimeJdbcSupport

public DirectJavaTimeJdbcSupport getDirectJavaTimeJdbcSupport()

Description copied from class: Dialect

Supply direct JDBC access capabilities for Java Time classes. Return one stable, non-null, thread-safe implementation.

Overrides:

getDirectJavaTimeJdbcSupport in class PostgreSQLDialect

Returns:

the direct Java Time JDBC support for this Dialect and driver

See Also:

• DirectJavaTimeJdbcSupport

getTemporalOperationSupport

@SPI({IMPLEMENT,SUPPLY})
public TemporalOperationSupport getTemporalOperationSupport()

Description copied from class: Dialect

Supply extraction and timestamp-arithmetic syntax. Return one stable, non-null, thread-safe implementation. Providers may implement TemporalOperationSupport directly and return this.

Overrides:

getTemporalOperationSupport in class PostgreSQLDialect

See Also:

• TemporalOperationSupport

getCurrentTemporalSupport

@SPI({IMPLEMENT,SUPPLY})
public CurrentTemporalSupport getCurrentTemporalSupport()

Description copied from class: Dialect

Supply current temporal expressions and database-side timestamp retrieval. Return one stable, non-null, thread-safe implementation. Providers may implement CurrentTemporalSupport directly and return this.

Overrides:

getCurrentTemporalSupport in class PostgreSQLDialect

See Also:

• CurrentTemporalSupport

getTypeSizingProfile

public TypeSizingProfile getTypeSizingProfile()

Description copied from class: Dialect

Supplies this Dialect's resolved type-sizing limits and defaults.

Return TypeSizingProfile.STANDARD when no dimension differs. Construct one stable immutable profile after version and server configuration are known. A family Dialect may copy its superclass profile, but must set every effective dimension which formerly changed through scalar-method delegation because profile builder setters do not cascade.

Overrides:

getTypeSizingProfile in class PostgreSQLDialect

initializeFunctionRegistry

@SPI({IMPLEMENT,SUPPLY})
public void initializeFunctionRegistry(FunctionContributions functionContributions)

Description copied from class: Dialect

Contribute the database-specific function descriptors after independent function contributors have run.

Override this callback to extend or replace the inherited function set. Invoke super first to retain Hibernate's standard and emulated registrations; omitting it deliberately replaces that set. Mutate the supplied boot-scoped function registry only during this callback, and do not retain the contribution context or registry afterward. Implement an independent FunctionContributor instead when the contribution is not owned by a Dialect.

Overrides:

initializeFunctionRegistry in class PostgreSQLDialect

Parameters:

functionContributions - the Hibernate-supplied function contribution target

See Also:

• FunctionContributions
• FunctionContributor
• SqmFunctionRegistry
• SqmFunctionDescriptor
• CommonFunctionFactory

registerJsonFunction

protected void registerJsonFunction(CommonFunctionFactory functionFactory)

Overrides:

registerJsonFunction in class PostgreSQLDialect

registerArrayFunctions

protected void registerArrayFunctions(CommonFunctionFactory functionFactory)

Overrides:

registerArrayFunctions in class PostgreSQLDialect

registerXmlFunctions

protected void registerXmlFunctions(CommonFunctionFactory functionFactory)

Overrides:

registerXmlFunctions in class PostgreSQLDialect

registerUtilityFunctions

protected void registerUtilityFunctions(FunctionContributions functionContributions)

Overrides:

registerUtilityFunctions in class PostgreSQLDialect

contributeDefaultProperties

@SPI({IMPLEMENT,SUPPLY})
protected void contributeDefaultProperties(Properties properties)

Description copied from class: Dialect

Contribute provider configuration defaults after Dialect construction.

Invoke super first to extend the inherited defaults. Omitting super deliberately replaces them. Mutate the supplied isolated property bag only during this callback; do not retain it or call Dialect.getDefaultProperties() from a Dialect constructor.

Overrides:

contributeDefaultProperties in class PostgreSQLDialect

Parameters:

properties - the isolated contribution target

getArrayTypeName

@SPI({USE,IMPLEMENT})
public String getArrayTypeName(String javaElementTypeName,
 String elementTypeName,
 Integer maxLength)

Description copied from class: Dialect

Render an array type name from the independent Java element name, rendered SQL element name, and optional maximum length.

Return null when array types are unsupported. The standard forms are element array and element array[length].

Overrides:

getArrayTypeName in class Dialect

getTableExporter

public StandardTableExporter getTableExporter()

Description copied from class: Dialect

Supply the exporter used to create and drop relational tables.

Return one stable exporter owned by this Dialect. Prefer StandardTableExporter when only its focused table-DDL template hooks are needed.

Overrides:

getTableExporter in class PostgreSQLDialect

getUniqueDelegate

@SPI({IMPLEMENT,SUPPLY})
public UniqueDelegate getUniqueDelegate()

Description copied from class: Dialect

Supply the stable strategy used for unique-key representation and DDL.

Return a stock profile from UniqueDelegates, or a stable provider-owned implementation or decorator. Do not import a Hibernate .internal leaf.

Overrides:

getUniqueDelegate in class PostgreSQLDialect

See Also:

• UniqueDelegate

getSequenceSupport

@SPI({IMPLEMENT,SUPPLY})
public SequenceSupport getSequenceSupport()

Description copied from class: Dialect

Supplies the complete sequence value-expression and lifecycle-DDL strategy for this Dialect.

Return the same stable, thread-safe strategy for the Dialect's lifetime. Use SequenceSupports.none() when sequences are unsupported, select one of the other stock strategies only when its complete grammar matches the database, or supply a provider implementation of SequenceSupport.

Overrides:

getSequenceSupport in class PostgreSQLDialect

Returns:

the non-null sequence-support strategy

See Also:

• SequenceSupport

getRowLevelSecurity

@SPI({IMPLEMENT,SUPPLY})
public RowLevelSecurity getRowLevelSecurity()

Description copied from class: Dialect

Supplies the complete database-native row-level-security strategy for this Dialect.

Return the same stable, thread-safe strategy for the Dialect's lifetime. Use RowLevelSecurityStrategies.none() when native row-level security is unsupported, and return declarative DDL instead of mutating boot metadata.

Overrides:

getRowLevelSecurity in class PostgreSQLDialect

Returns:

the non-null row-level-security strategy

See Also:

• RowLevelSecurity

getLimitHandler

public LimitHandler getLimitHandler()

Description copied from class: Dialect

Supplies execution-time pagination for already-rendered SQL requested by Query.setMaxResults(int) or Query.setFirstResult(int).

This is distinct from SQL AST PaginationRenderingSupport, which handles offset and fetch clauses represented in the semantic tree. A custom Dialect should normally return a stock LimitHandler or extend a supported handler family. The returned handler may be reused concurrently and must not retain per-query state.

Overrides:

getLimitHandler in class PostgreSQLDialect

Returns:

a non-null handler

getEnumSupport

@SPI({IMPLEMENT,SUPPLY})
public EnumSupport getEnumSupport()

Description copied from class: Dialect

Supply the database's finite-domain declaration, lifecycle, and check strategy. Return one stable, thread-safe strategy for this Dialect.

Overrides:

getEnumSupport in class PostgreSQLDialect

Returns:

the non-null enum support strategy

See Also:

• EnumSupport

getAggregateSupport

@SPI({IMPLEMENT,SUPPLY})
public AggregateSupport getAggregateSupport()

Description copied from class: Dialect

Supply the aggregate-column mapping, DDL, read, assignment, and write behavior for this dialect. Override this method to return a provider implementation of AggregateSupport, or retain the standard behavior returned by the default.

Overrides:

getAggregateSupport in class PostgreSQLDialect

Returns:

this dialect's aggregate support

See Also:

• AggregateSupport

getLockingSupport

public LockingSupport getLockingSupport()

Description copied from class: Dialect

Supplies the cohesive pessimistic-locking profile for this Dialect.

The profile coordinates capability metadata, statement-clause rendering, table hints, already-rendered SQL rewriting, connection timeout handling, and follow-on locking. A custom Dialect should supply one internally consistent profile instead of overriding those behaviors independently. The returned support must be non-null and stable for the Dialect lifetime; its components may be reused concurrently and must not retain per-query requests.

Overrides:

getLockingSupport in class PostgreSQLDialect

See Also:

• LockingSupport

resolveSqlTypeCode

@SPI({USE,IMPLEMENT})
protected Integer resolveSqlTypeCode(String columnTypeName,
 TypeConfiguration typeConfiguration)

Description copied from class: Dialect

Resolve a database-reported type name before base-name extraction.

columnTypeName is complete and may include parameters or an array suffix. Return null when it cannot be resolved.

Overrides:

resolveSqlTypeCode in class PostgreSQLDialect

getFetchClauseSupport

@SPI({USE,IMPLEMENT,SUPPLY})
public FetchClauseSupport getFetchClauseSupport()

Description copied from class: Dialect

Supply the fetch clause forms accepted by this database.

Return one non-null immutable profile whose identity and answers remain stable for this Dialect's lifetime. The four forms are independent; do not infer percent or ties support from ordinary row-count support.

Overrides:

getFetchClauseSupport in class PostgreSQLDialect

Returns:

the stable fetch clause capability profile

See Also:

• FetchClauseSupport

getLockingClauseStrategy

public LockingClauseStrategy getLockingClauseStrategy(QuerySpec querySpec,
 LockOptions lockOptions)

Description copied from class: Dialect

Supplies the per-translation strategy for a statement-level [PessimisticLockStyle#CLAUSE locking clause].

Overrides:

getLockingClauseStrategy in class Dialect

See Also:

• LockingClauseStrategy

contributeTypes

@SPI({IMPLEMENT,SUPPLY})
public void contributeTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Description copied from class: Dialect

Contribute database-specific Java, JDBC, DDL, and basic type descriptors.

Override this method when the database or JDBC driver requires descriptors beyond the inherited registrations. Invoke super first unless the Dialect intentionally replaces the complete inherited contribution protocol. Obtain reusable dialect-specific JDBC descriptors from the family facades in org.hibernate.dialect.type.spi, and preserve whether a descriptor replaces an existing registration or is added only when absent.

Overrides:

contributeTypes in class PostgreSQLDialect

Parameters:

typeContributions - the Hibernate-supplied contribution registry

serviceRegistry -

the Hibernate-supplied services, including class loading used by driver-backed descriptor factories

Mutate the supplied boot-scoped registries only during this callback and do not retain the contribution context or a mutable registry afterward. Implement an independent TypeContributor instead when the contribution is not owned by a Dialect.

getFunctionalDependencyAnalysisSupport

@SPI({IMPLEMENT,SUPPLY})
public FunctionalDependencyAnalysisSupport getFunctionalDependencyAnalysisSupport()

Description copied from class: Dialect

The database's support for recognizing primary-key functional dependency in group by and order by clauses.

This profile controls when Hibernate may omit functionally dependent columns. Report only behavior guaranteed by the database across the Dialect's supported versions.

Overrides:

getFunctionalDependencyAnalysisSupport in class PostgreSQLDialect

Returns:

a non-null immutable capability profile

See Also:

• FunctionalDependencyAnalysisSupport

contributePostgreSQLTypes

protected void contributePostgreSQLTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Description copied from class: PostgreSQLDialect

Allow for extension points to override this only

Overrides:

contributePostgreSQLTypes in class PostgreSQLDialect

getSqlAstTranslatorFactory

@SPI({IMPLEMENT,SUPPLY})
public SqlAstTranslatorFactory getSqlAstTranslatorFactory()

Description copied from class: Dialect

Supply the factory for this Dialect's single-use SQL AST translators.

Return null to use StandardSqlAstTranslatorFactory. A custom Dialect should normally return a reusable factory derived from that class and create translators derived from AbstractSqlAstTranslator or an appropriate supported family base. The factory must not retain translation requests, and every translator it returns is used for one translation.

Overrides:

getSqlAstTranslatorFactory in class PostgreSQLDialect

See Also:

• SqlAstTranslatorFactory
• JdbcEnvironment.getSqlAstTranslatorFactory()

registerPostgreSQLColumnTypes

protected void registerPostgreSQLColumnTypes(TypeContributions typeContributions,
 ServiceRegistry serviceRegistry)

Overrides:

registerPostgreSQLColumnTypes in class PostgreSQLDialect

appendDateTimeLiteral

@SPI({USE,IMPLEMENT})
public void appendDateTimeLiteral(SqlAppender appender,
 TemporalAccessor temporalAccessor,
 TemporalType precision,
 TimeZone jdbcTimeZone)

Description copied from class: Dialect

Append a datetime literal for a java.time value.

Preserve the value's offset only when the Dialect's temporal-value semantics permit it. Append immediately and retain no invocation state.

Specified by:

appendDateTimeLiteral in interface LiteralSupport

Overrides:

appendDateTimeLiteral in class PostgreSQLDialect

appendDateTimeLiteral

@SPI({USE,IMPLEMENT})
public void appendDateTimeLiteral(SqlAppender appender,
 Date date,
 TemporalType precision,
 TimeZone jdbcTimeZone)

Description copied from class: Dialect

Append a datetime literal for a legacy Date value.

Apply the supplied JDBC time zone where required, append immediately, and retain no invocation state.

Specified by:

appendDateTimeLiteral in interface LiteralSupport

Overrides:

appendDateTimeLiteral in class PostgreSQLDialect

appendDateTimeLiteral

@SPI({USE,IMPLEMENT})
public void appendDateTimeLiteral(SqlAppender appender,
 Calendar calendar,
 TemporalType precision,
 TimeZone jdbcTimeZone)

Description copied from class: Dialect

Append a datetime literal for a Calendar value.

Preserve Calendar-specific time-zone and millisecond semantics, append immediately, and retain no invocation state.

Specified by:

appendDateTimeLiteral in interface LiteralSupport

Overrides:

appendDateTimeLiteral in class PostgreSQLDialect

castType

@SPI({USE,IMPLEMENT})
protected String castType(int sqlTypeCode)

Description copied from class: Dialect

Return the complete cast-target type pattern for sqlTypeCode.

Override this hook when cast syntax differs from column declaration syntax; otherwise delegate to Dialect.columnType(int).

Overrides:

castType in class PostgreSQLDialect

timestampaddPattern

@SPI({USE,IMPLEMENT})
public String timestampaddPattern(TemporalUnit unit,
 TemporalType temporalType,
 IntervalType intervalType)

Description copied from interface: TemporalOperationSupport

Return a timestamp-add pattern containing ?1, ?2, and ?3.

Specified by:

timestampaddPattern in interface TemporalOperationSupport

Overrides:

timestampaddPattern in class PostgreSQLDialect

timestampdiffPattern

@SPI({USE,IMPLEMENT})
public String timestampdiffPattern(TemporalUnit unit,
 TemporalType fromTemporalType,
 TemporalType toTemporalType)

Description copied from interface: TemporalOperationSupport

Return a timestamp-difference pattern containing ?1, ?2, and ?3.

Specified by:

timestampdiffPattern in interface TemporalOperationSupport

Overrides:

timestampdiffPattern in class PostgreSQLDialect

castPattern

@SPI({USE,IMPLEMENT})
public String castPattern(CastType from,
 CastType to)

Description copied from class: Dialect

Obtain a pattern for the SQL equivalent to a cast() function call. The resulting pattern must contain ?1 and ?2 placeholders for the arguments.

Overrides:

castPattern in class PostgreSQLDialect

Parameters:

from - a CastType indicating the type of the value argument

to - a CastType indicating the type the value argument is cast to

columnType

@SPI({USE,IMPLEMENT})
protected String columnType(int sqlTypeCode)

Description copied from class: Dialect

Return the complete database column declaration pattern for a JDBC Types or Hibernate SqlTypes code used during type registration.

Use only $l, $p, and $s for length, precision, and scale. Define distinct mappings for the LONG32 codes; the JDBC LONG synonyms are normalized before this hook. Delegate unknown inherited codes to the superclass so its standard exception remains authoritative.

Overrides:

columnType in class PostgreSQLDialect

defaultScrollMode

@SPI({USE,IMPLEMENT,SUPPLY})
public ScrollMode defaultScrollMode()

Description copied from class: Dialect

A default ScrollMode to be used by Query.scroll().

Overrides:

defaultScrollMode in class Dialect

Returns:

the default ScrollMode to use.

getTupleCountSupport

public TupleCountSupport getTupleCountSupport()

Description copied from class: Dialect

Supplies the database syntax for ordinary and distinct tuple counts.

Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Select TupleCountSupport.Syntax.UNSUPPORTED to use Hibernate's existing emulation, TupleCountSupport.Syntax.ARGUMENT_LIST for syntax such as count(a, b), or TupleCountSupport.Syntax.PARENTHESIZED_TUPLE for syntax such as count((a, b)). Configure the ordinary and distinct forms independently; a database may require different forms for them. When refining a family Dialect, copy Dialect.getTupleCountSupport() from the superclass and replace only the differing syntax choice.

Overrides:

getTupleCountSupport in class PostgreSQLDialect

Returns:

the non-null tuple-count-syntax profile

getWindowFunctionSupport

public WindowFunctionSupport getWindowFunctionSupport()

Description copied from class: Dialect

Supplies the native window-function syntax supported by this database.

Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Baseline window calls, window partitioning, each frame unit, and frame exclusion are independent grammar facts. Every refinement requires baseline window support, and frame exclusion additionally requires a supported frame unit. Function-specific restrictions and individual frame-bound restrictions remain the responsibility of focused rendering.

When refining a family Dialect, start from WindowFunctionSupport.builder(super.getWindowFunctionSupport()) and change only the differing features.

Overrides:

getWindowFunctionSupport in class PostgreSQLDialect

Returns:

this Dialect's stable window-function-support profile

supportsUserDefinedTypes

@SPI({IMPLEMENT,SUPPLY})
public boolean supportsUserDefinedTypes()

Description copied from class: Dialect

Whether mapped aggregate structures may be represented as database user-defined types.

This capability is independent of Dialect.getUserDefinedTypeExporter(), which supplies schema commands for any UDT definitions that are present.

Overrides:

supportsUserDefinedTypes in class PostgreSQLDialect

See Also:

• Struct

supportsFilterClause

public boolean supportsFilterClause()

Description copied from class: Dialect

Whether this database supports native aggregate filter (where ...) syntax.

Return a stable answer for this Dialect's lifetime. A false result directs aggregate rendering to use the existing case-expression emulation; it does not mean that filtered aggregates are unsupported.

Overrides:

supportsFilterClause in class PostgreSQLDialect

getRowValueSupport

public RowValueSupport getRowValueSupport()

Description copied from class: Dialect

The native row-value syntax of this Dialect.

Override this method to supply explicit row(a, b) construction, row equality, ordering, and distinctness comparisons, row-valued IN lists, row-valued IN subqueries, and quantified row comparisons. Treat each feature as an exact native-syntax declaration: do not infer IN-subquery support from IN-list support or explicit row construction from comparison support. Copy the superclass profile when refining an inherited Dialect family. Return one immutable, non-null profile whose values remain stable for the lifetime of this Dialect.

Overrides:

getRowValueSupport in class PostgreSQLDialect

Returns:

this Dialect's stable row-value-support profile

getValuesListSupport

public ValuesListSupport getValuesListSupport()

Description copied from class: Dialect

The contexts in which this Dialect supports native multi-row values syntax.

The returned immutable profile must be non-null and stable for the lifetime of this Dialect. Report only native syntax support; translator emulation is selected separately.

Overrides:

getValuesListSupport in class PostgreSQLDialect

getPredicateSupport

public PredicateSupport getPredicateSupport()

Description copied from class: Dialect

The database's native predicate syntax and predicate-placement profile.

Override this method to supply independent support for a native case-insensitive-like operator, scalar distinct from, truthness predicates, and predicates used as value expressions. An absent case-insensitive-like operator selects Hibernate's lowercase-expression emulation. Return one immutable, non-null profile whose values remain stable for the lifetime of this Dialect; do not override individual consumers to reproduce these decisions.

Overrides:

getPredicateSupport in class PostgreSQLDialect

Returns:

this Dialect's stable predicate-support profile

currentTimestamp

@SPI({USE,IMPLEMENT})
public String currentTimestamp()

Description copied from interface: CurrentTemporalSupport

Render the current SQL timestamp expression used for java.sql.Timestamp.

Specified by:

currentTimestamp in interface CurrentTemporalSupport

Overrides:

currentTimestamp in class PostgreSQLDialect

currentTime

@SPI({USE,IMPLEMENT})
public String currentTime()

Description copied from interface: CurrentTemporalSupport

Render the current SQL time expression used for java.sql.Time.

Specified by:

currentTime in interface CurrentTemporalSupport

Overrides:

currentTime in class PostgreSQLDialect

currentLocalTimestamp

@SPI({USE,IMPLEMENT})
public String currentLocalTimestamp()

Description copied from interface: CurrentTemporalSupport

Render the current local-timestamp expression.

Specified by:

currentLocalTimestamp in interface CurrentTemporalSupport

currentLocalTime

@SPI({USE,IMPLEMENT})
public String currentLocalTime()

Description copied from interface: CurrentTemporalSupport

Render the current local-time expression.

Specified by:

currentLocalTime in interface CurrentTemporalSupport

getSubquerySupport

public SubquerySupport getSubquerySupport()

Description copied from class: Dialect

Supplies the database's supported subquery placements.

Return one non-null, immutable profile whose values remain stable for this Dialect's lifetime. Declare every placement independently. In particular, scalar subqueries in the select list and exists predicates in the select list are separate capabilities. Lateral spelling and fallback rendering remain translator responsibilities. When refining a family Dialect, start from SubquerySupport.builder(super.getSubquerySupport()) and change only the differing placements.

Overrides:

getSubquerySupport in class PostgreSQLDialect

Returns:

this Dialect's stable subquery-support profile

getMutationSyntaxSupport

public MutationSyntaxSupport getMutationSyntaxSupport()

Description copied from class: Dialect

The native SQL mutation-syntax capabilities of this Dialect.

The returned immutable profile must be non-null and stable for the lifetime of this Dialect. Report syntax which the translator may use directly; do not report a capability merely because it can be emulated. QueryMutationRenderingSupport consumes this profile when selecting a native or emulated plan.

Overrides:

getMutationSyntaxSupport in class PostgreSQLDialect

getParameterLimits

public ParameterLimits getParameterLimits()

Description copied from class: Dialect

Supplies the database limits for IN-expression elements and total JDBC statement parameters.

Return a non-null, immutable profile whose values remain stable for this Dialect's lifetime. Use ParameterLimits.UNLIMITED when neither limit applies and ParameterLimits.of(int) when both limits are identical. Keep the dimensions independent when the database imposes different expression and statement limits; Hibernate uses them for different planning decisions.

Overrides:

getParameterLimits in class Dialect

Returns:

the non-null parameter-limit profile

renderAddConstraint

@SPI({USE,IMPLEMENT})
public String renderAddConstraint(ForeignKeyConstraintRequest request)

Specified by:

renderAddConstraint in interface ForeignKeySupport

truncateMode

@SPI({USE,IMPLEMENT})
public TruncateMode truncateMode()

Specified by:

truncateMode in interface TruncateSupport

Overrides:

truncateMode in class PostgreSQLDialect

renderCommands

@SPI({USE,IMPLEMENT})
public List<String> renderCommands(TruncateRequest request)

Specified by:

renderCommands in interface TruncateSupport

Overrides:

renderCommands in class PostgreSQLDialect

getSchemaDropSupport

@SPI({IMPLEMENT,SUPPLY})
public SchemaDropSupport getSchemaDropSupport()

Description copied from class: Dialect

Supply schema-drop composition and ordered pre-drop commands.

Return one immutable profile for this Dialect's lifetime.

Overrides:

getSchemaDropSupport in class PostgreSQLDialect

See Also:

• SchemaDropSupport

getIfExistsSupport

@SPI({IMPLEMENT,SUPPLY})
public IfExistsSupport getIfExistsSupport()

Description copied from class: Dialect

Supply existence-check placement for schema DDL targets.

Return one immutable profile for this Dialect's lifetime.

Overrides:

getIfExistsSupport in class PostgreSQLDialect

See Also:

• IfExistsSupport

addPartitionKeyToPrimaryKey

@SPI({USE,IMPLEMENT})
public boolean addPartitionKeyToPrimaryKey()

Description copied from class: Dialect

Whether every table partition key must also occur in its primary key.

Return true only when the database requires the rule for both ordinary and temporal-history tables. This has nothing to do with window-function partitioning.

Overrides:

addPartitionKeyToPrimaryKey in class PostgreSQLDialect

getSingleRowTableSupport

public SingleRowTableSupport getSingleRowTableSupport()

Description copied from class: Dialect

Supply the SQL renderings used for a reusable single-row table and for an otherwise table-less select.

Override this method with one stable, non-null profile when either rendering differs from SingleRowTableSupport.STANDARD. The table expression and the complete select-only from fragment are independent; an empty fragment means that no from clause is required. Dialect subclasses refining a family profile should copy Dialect.getSingleRowTableSupport() from the superclass and change only the values which differ.

Overrides:

getSingleRowTableSupport in class Dialect

Returns:

the stable, non-null single-row-table-support profile

datetimeFormat

public Replacer datetimeFormat(String format)

Overrides:

datetimeFormat in class PostgreSQLDialect

getCteSupport

public CteSupport getCteSupport()

Description copied from class: Dialect

The common-table-expression capabilities of this Dialect.

The returned immutable profile must be non-null and stable for the lifetime of this Dialect. Hibernate may cache and reuse it. Overrides may construct a new profile or copy CteSupport.STANDARD; invoking super is not required. This method is called only after Dialect construction, has no corresponding shutdown lifecycle, and failures propagate to the operation which obtains the profile.

Overrides:

getCteSupport in class PostgreSQLDialect

getInformationExtractor

@SPI({IMPLEMENT,SUPPLY})
public InformationExtractor getInformationExtractor(ExtractionContext extractionContext)

Description copied from class: Dialect

Supply the context-bound strategy Hibernate uses to discover database tables, keys, indexes, and related schema metadata.

Return a new extractor for extractionContext. Prefer a stock profile from InformationExtractors, and implement InformationExtractor directly only when none of those complete profiles matches the database.

Overrides:

getInformationExtractor in class PostgreSQLDialect

See Also:

• InformationExtractor
• InformationExtractors

getMultiTableMutationSupport

public MultiTableMutationSupport getMultiTableMutationSupport()

Description copied from class: Dialect

Select the Hibernate-owned fallback families used for SQM update/delete and insert operations targeting entities mapped to multiple tables.

A custom Dialect should return one of the named profiles when both operation families use the same strategy kind, or construct an asymmetric profile when they differ. Local, global, and persistent-table selections require the corresponding non-null temporary-table strategy, while CTE requires non-query CTE support.

Configured global and entity-specific custom strategies take precedence over this fallback. Supply a custom execution implementation with QuerySettings.QUERY_MULTI_TABLE_MUTATION_STRATEGY or QuerySettings.QUERY_MULTI_TABLE_INSERT_STRATEGY instead of depending on Hibernate's internal fallback implementations.

Overrides:

getMultiTableMutationSupport in class PostgreSQLDialect

Returns:

a stable, non-null fallback selection profile

getRowIdSupport

@SPI({IMPLEMENT,SUPPLY})
public RowIdSupport getRowIdSupport()

Description copied from class: Dialect

Supply the database's row-locator expression, JDBC type, and optional physical-column declaration policy.

Overrides:

getRowIdSupport in class PostgreSQLDialect

Returns:

the stable non-null row-id strategy

See Also:

• RowIdSupport

getLocalTemporaryTableStrategy

public TemporaryTableStrategy getLocalTemporaryTableStrategy()

Description copied from class: Dialect

Supplies this Dialect's local temporary-table strategy.

Return null when the database has no supported local temporary-table form. A non-null strategy must be stable for the Dialect lifetime and consistent with Dialect.getTemporaryTableExporter().

Overrides:

getLocalTemporaryTableStrategy in class PostgreSQLDialect

getGlobalTemporaryTableStrategy

@Nullable
public TemporaryTableStrategy getGlobalTemporaryTableStrategy()

Description copied from class: Dialect

Supplies this Dialect's global temporary-table strategy.

Return null when the database has no supported global temporary-table form. A non-null strategy must be stable for the Dialect lifetime and consistent with Dialect.getTemporaryTableExporter().

Overrides:

getGlobalTemporaryTableStrategy in class Dialect

getPersistentTemporaryTableStrategy

public TemporaryTableStrategy getPersistentTemporaryTableStrategy()

Description copied from class: Dialect

Supplies the fallback persistent-table strategy used when no native local or global temporary-table strategy is selected.

The returned strategy must be non-null and must describe behavior consistent with Dialect.getTemporaryTableExporter().

Overrides:

getPersistentTemporaryTableStrategy in class Dialect

buildSQLExceptionConversionDelegate

@SPI({IMPLEMENT,SUPPLY})
public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate()

Description copied from class: Dialect

Supplies vendor-specific SQL-exception conversion for this Dialect.

The returned delegate runs in addition to Hibernate's standard JDBC exception-hierarchy and SQL-state delegates. Its null result means that it declined the exception so conversion may continue. Return null from this method when the Dialect has no vendor-specific delegate.

Prefer stable vendor error codes or SQL states and preserve the original SQLException.

Overrides:

buildSQLExceptionConversionDelegate in class PostgreSQLDialect

Returns:

the vendor conversion delegate, or null when none is supplied

See Also:

• SQLExceptionConversionDelegate

getCallableStatementSupport

@SPI({IMPLEMENT,SUPPLY})
public CallableStatementSupport getCallableStatementSupport()

Description copied from class: Dialect

Supply the callable-statement protocol for this database and JDBC driver.

Return one non-null strategy whose behavior remains stable for this Dialect's lifetime. Use CallableStatementSupports for the standard and stock database protocols.

Overrides:

getCallableStatementSupport in class PostgreSQLDialect

Returns:

the callable-statement strategy

See Also:

• CallableStatementSupport

useIntegerForPrimaryKey

public boolean useIntegerForPrimaryKey()