Class PostgreSQLDialect

java.lang.Object
org.hibernate.dialect.Dialect
org.hibernate.dialect.PostgreSQLDialect
All Implemented Interfaces:
CheckConstraintSupport, ForeignKeySupport, IdentifierSupport, KeywordSupport, LiteralSupport, AlterTableSupport, ColumnDefinitionSupport, ConstraintControlSupport, IndexDdlSupport, TableCreationSupport, TruncateSupport, CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport, ConversionContext
Direct Known Subclasses:
PostgisPG10Dialect, PostgisPG93Dialect, PostgisPG94Dialect, PostgisPG95Dialect, PostgresPlusDialect, SpannerPostgreSQLDialect
@SPI({USE,IMPLEMENT}) public class PostgreSQLDialect extends Dialect implements CurrentTemporalSupport, TemporalFormatSupport, TemporalOperationSupport

A SQL dialect for PostgreSQL 14 and above.

Please refer to the PostgreSQL documentation.

This class is also the supported family base for provider Dialects derived from PostgreSQL. Provider subclasses must invoke a constructor classified IMPLEMENT. The generated SPI inventory identifies the constructors and members covered by this type-level implementation contract; unclassified implementation details are not provider extension points.

Since:
8.0

  • Field Details

  • Constructor Details

  • 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 Dialect
      Returns:
      the direct Java Time JDBC support for this Dialect and driver
      See Also:

    • 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 Dialect
      See Also:

    • getTemporalFormatSupport

      @SPI({IMPLEMENT,SUPPLY}) public TemporalFormatSupport getTemporalFormatSupport()
      Description copied from class: Dialect
      Supply datetime-format translation. Return one stable, non-null, thread-safe implementation.
      Overrides:
      getTemporalFormatSupport in class Dialect
      See Also:

    • 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 Dialect
      See Also:

    • 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 Dialect

    • getDriverKind

      public PostgreSQLDriverKind getDriverKind()

    • getMinimumSupportedVersion

      @SPI({IMPLEMENT,SUPPLY}) protected DatabaseVersion getMinimumSupportedVersion()
      Description copied from class: Dialect
      Get the version of the SQL dialect that is the minimum supported by this implementation.

      This method is called during superclass construction. Implementations must return construction-safe immutable data and must not depend on subclass initialization.

      Overrides:
      getMinimumSupportedVersion in class Dialect

    • 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 Dialect
      Parameters:
      properties - the isolated contribution target

    • 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 Dialect

    • 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 Dialect

    • registerColumnTypes

      @SPI({IMPLEMENT,SUPPLY}) protected void registerColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
      Description copied from class: Dialect

      Register the inherited ANSI-oriented DDL type descriptors during Dialect type contribution.

      Override this focused sub-hook to extend or replace column type registrations. Invoke super first to retain the inherited descriptor set; omitting it deliberately replaces that set. Mutate the supplied boot-scoped registry only during this callback, and do not retain the contribution context or registry afterward. Implement an independent TypeContributor instead when the contribution is not owned by a Dialect.

      Overrides:
      registerColumnTypes in class Dialect
      Parameters:
      typeContributions - the Hibernate-supplied contribution target
      serviceRegistry - the Hibernate-supplied bootstrap services
      See Also:

    • registerPostgreSQLColumnTypes

      protected void registerPostgreSQLColumnTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)

    • resolveSqlTypeDescriptor

      @SPI({USE,IMPLEMENT}) public JdbcType resolveSqlTypeDescriptor(String columnTypeName, int jdbcTypeCode, int precision, int scale, JdbcTypeRegistry jdbcTypeRegistry)
      Description copied from class: Dialect

      Resolve the non-null JDBC descriptor for result-set metadata.

      Preserve vendor replacement and array-component resolution, and delegate unmatched codes to jdbcTypeRegistry.

      Overrides:
      resolveSqlTypeDescriptor in class Dialect

    • 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 Dialect

    • 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 Dialect
      Returns:
      the non-null enum support strategy
      See Also:

    • 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

    • 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

    • currentTimestampWithTimeZone

      @SPI({USE,IMPLEMENT}) public String currentTimestampWithTimeZone()
      Description copied from interface: CurrentTemporalSupport
      Render the current timestamp-with-time-zone expression.
      Specified by:
      currentTimestampWithTimeZone in interface CurrentTemporalSupport

    • extractPattern

      @SPI({USE,IMPLEMENT}) public String extractPattern(TemporalUnit unit)
      The extract() function returns TemporalUnit.DAY_OF_WEEK numbered from 0 to 6. This isn't consistent with what most other databases do, so here we adjust the result by generating (extract(dow,arg)+1)).
      Specified by:
      extractPattern in interface TemporalOperationSupport

    • 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 Dialect
      Parameters:
      from - a CastType indicating the type of the value argument
      to - a CastType indicating the type the value argument is cast to

    • fractionalSecondPrecisionInNanos

      @SPI({USE,IMPLEMENT}) public long fractionalSecondPrecisionInNanos()
      microsecond is the smallest unit for an interval, and the highest precision for a timestamp, so we could use it as the "native" precision, but it's more convenient to use whole seconds (with the fractional part), since we want to use extract(epoch from ...) in our emulation of timestampdiff().
      Specified by:
      fractionalSecondPrecisionInNanos in interface TemporalOperationSupport

    • 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

    • 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

    • getTimeZoneSupport

      @SPI({IMPLEMENT,SUPPLY}) public TimeZoneSupport getTimeZoneSupport()
      Description copied from class: Dialect

      Select the database's support profile for SQL with time zone types.

      Override this method to report whether the database preserves the original zone, normalizes values to UTC, or has no native support. This value participates in mapping and JDBC type selection; it does not control temporal-literal syntax.

      Overrides:
      getTimeZoneSupport in class Dialect
      Returns:
      the database time-zone type support profile
      See Also:

    • 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 Dialect
      Parameters:
      functionContributions - the Hibernate-supplied function contribution target
      See Also:

    • registerUtilityFunctions

      protected void registerUtilityFunctions(FunctionContributions functionContributions)

    • registerXmlFunctions

      protected void registerXmlFunctions(CommonFunctionFactory functionFactory)

    • registerJsonFunction

      protected void registerJsonFunction(CommonFunctionFactory functionFactory)

    • registerArrayFunctions

      protected void registerArrayFunctions(CommonFunctionFactory functionFactory)

    • getDefaultOrdinalityColumnName

      @Nullable public String getDefaultOrdinalityColumnName()
      Description copied from class: Dialect

      Supplies the preferred default ordinality-column name for a set-returning function.

      Return a stable, unqualified SQL column name, or null when the database does not define a preferred name. Hibernate uses i as the fallback and applies collision suffixing where necessary. A null result does not mean that set-returning functions are unsupported.

      Overrides:
      getDefaultOrdinalityColumnName in class Dialect
      Returns:
      the preferred unqualified name, or null to use Hibernate's fallback

    • supportsMinMaxOnUuid

      protected boolean supportsMinMaxOnUuid()

      Whether PostgreSQL supports min(uuid)/max(uuid), which it doesn't by default. Since the emulation does not perform well, this method may be overridden by any user who ensures that aggregate functions for handling uuids exist in the database.

      The following definitions can be used for this purpose:

      create or replace function min(uuid, uuid)
    returns uuid
    immutable parallel safe
    language plpgsql as
$$
begin
    return least($1, $2);
end
$$;

create aggregate min(uuid) (
    sfunc = min,
    stype = uuid,
    combinefunc = min,
    parallel = safe,
    sortop = operator (<)
    );

create or replace function max(uuid, uuid)
    returns uuid
    immutable parallel safe
    language plpgsql as
$$
begin
    return greatest($1, $2);
end
$$;

create aggregate max(uuid) (
    sfunc = max,
    stype = uuid,
    combinefunc = max,
    parallel = safe,
    sortop = operator (>)
    );

    • getNameQualifierSupport

      @SPI({IMPLEMENT,SUPPLY}) public NameQualifierSupport getNameQualifierSupport()
      Description copied from class: Dialect

      Supply catalog and schema qualification support, or return null to use DatabaseMetaData.

      This value does not define the catalog separator; override Dialect.getCatalogSeparator() independently when the metadata-free fallback is not ..

      Overrides:
      getNameQualifierSupport in class Dialect
      See Also:

    • getNamespaceSupport

      @SPI({IMPLEMENT,SUPPLY}) public NamespaceSupport getNamespaceSupport()
      Description copied from class: Dialect

      Supply catalog and schema lifecycle behavior to schema tooling.

      Return one stable, non-null strategy. Prefer a complete immutable profile from NamespaceSupports, and implement NamespaceSupport directly only for custom or multi-command namespace SQL.

      Overrides:
      getNamespaceSupport in class Dialect
      See Also:

    • 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 Dialect
      Returns:
      this Dialect's stable predicate-support profile

    • 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 Dialect
      See Also:

    • alterColumnType

      @SPI({USE,IMPLEMENT}) public String alterColumnType(AlterColumnTypeRequest request)
      Specified by:
      alterColumnType in interface AlterTableSupport

    • 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 Dialect

    • 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 Dialect

    • 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 Dialect

    • 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 Dialect
      Returns:
      the non-null sequence-support strategy
      See Also:

    • 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 Dialect
      Returns:
      the non-null row-level-security strategy
      See Also:

    • 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 Dialect
      See Also:

    • getSequenceInformationExtractor

      public SequenceInformationExtractor getSequenceInformationExtractor()
      Description copied from class: Dialect

      Supply the strategy Hibernate uses to discover existing database sequences and their metadata.

      Return SequenceInformationExtractors.none() when the database version does not expose sequence metadata. Configure ordinary single-query extraction with SequenceInformationExtractors.builder(String), and implement SequenceInformationExtractor directly only for a genuinely multi-stage algorithm.

      Overrides:
      getSequenceInformationExtractor in class Dialect
      See Also:

    • 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 Dialect
      Returns:
      a non-null handler

    • appendDefinition

      @SPI({USE,IMPLEMENT}) public void appendDefinition(SqlAppender appender, ColumnDefinitionRequest request)
      Specified by:
      appendDefinition in interface ColumnDefinitionSupport

    • getNativeValueGenerationStrategy

      public GenerationType getNativeValueGenerationStrategy()
      Description copied from class: Dialect

      Supply the semantic identifier-generation type used for native generation.

      Return a non-null typed value instead of a legacy generator name or implementation class. The inherited implementation selects GenerationType.IDENTITY when this Dialect's IdentityColumnSupport supports identity columns and GenerationType.SEQUENCE otherwise. Override it when the database's native choice differs from that rule.

      Legacy "native" mappings and NativeGenerator consume this same provider decision.

      Overrides:
      getNativeValueGenerationStrategy in class Dialect
      Returns:
      the non-null semantic native identifier-generation type
      See Also:

    • getLobSupport

      @SPI({IMPLEMENT,SUPPLY}) public LobSupport getLobSupport()
      Description copied from class: Dialect
      Supply the database and driver policy for LOB creation, binding, materialization, type classification, mutation ordering, and VALUE LOB DDL. Return one stable, thread-safe strategy for this Dialect.
      Overrides:
      getLobSupport in class Dialect
      Returns:
      the non-null LOB support strategy
      See Also:

    • getSelectClauseNullString

      @SPI({USE,IMPLEMENT}) public String getSelectClauseNullString(SqlTypedMapping sqlType, TypeConfiguration typeConfiguration)
      Description copied from class: Dialect

      Render the complete typed-null select-item expression for one arm of a union query.

      Use the complete mapping when the database requires an explicit cast so that named and aggregate types, length, precision, scale, and temporal precision are retained. Return the complete expression, not only a type name. The standard form is the untyped SQL literal null.

      Overrides:
      getSelectClauseNullString in class Dialect
      Parameters:
      sqlType - the complete mapping of the union select item
      typeConfiguration - the active type configuration
      Returns:
      the complete select-item expression

    • quoteCollation

      @SPI({USE,IMPLEMENT}) public String quoteCollation(String collation)
      Description copied from interface: IdentifierSupport
      Render a collation name used in a column definition.
      Specified by:
      quoteCollation in interface IdentifierSupport

    • getSchemaCommentSupport

      @SPI({IMPLEMENT,SUPPLY}) public SchemaCommentSupport getSchemaCommentSupport()
      Description copied from class: Dialect

      Supply schema-export support for comments attached to database objects.

      This strategy does not control query comments, hints, SQL AST decoration, or statement inspection. Return one stable, non-null strategy.

      Overrides:
      getSchemaCommentSupport in class Dialect
      See Also:

    • getCurrentTimestampSelection

      @SPI({USE,IMPLEMENT}) public CurrentTimestampSelection getCurrentTimestampSelection()
      Description copied from interface: CurrentTemporalSupport
      Select the JDBC command used for database-side current timestamp retrieval, or return null when the database offers no supported command.
      Specified by:
      getCurrentTimestampSelection in interface CurrentTemporalSupport
      See Also:

    • isCurrentTimestampStable

      @SPI({USE,IMPLEMENT}) public boolean isCurrentTimestampStable()
      Description copied from interface: CurrentTemporalSupport
      Whether the current timestamp remains stable throughout a transaction.
      Specified by:
      isCurrentTimestampStable in interface CurrentTemporalSupport

    • 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 Dialect
      Returns:
      the non-null tuple-count-syntax profile

    • appendBooleanValueString

      @SPI({USE,IMPLEMENT}) public void appendBooleanValueString(SqlAppender appender, boolean bool)
      Description copied from interface: LiteralSupport
      Append a SQL Boolean literal expression.
      Specified by:
      appendBooleanValueString in interface LiteralSupport

    • buildIdentifierHelper

      @SPI({USE,IMPLEMENT,SUPPLY}) public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuildRequest request)
      Description copied from interface: IdentifierSupport

      Build and supply the configured identifier helper from the stable JDBC metadata snapshot and selected keyword strategy.

      This inherited implementation initializes identifier casing, keywords, and namespace support from the request. Invoke it before replacing any of those values with authoritative provider settings, then build the final helper from the same builder. Settings which this implementation does not initialize may be applied before invoking it. If builder configuration cannot express a database rule, decorate the final helper with DelegatingIdentifierHelper. Do not retain the request, builder, or metadata view.

      Specified by:
      buildIdentifierHelper in interface IdentifierSupport
      See Also:

    • 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 Dialect
      Returns:
      a stable, non-null fallback selection profile

    • 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 Dialect

    • 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 Dialect
      See Also:

    • getViolatedConstraintNameExtractor

      @SPI({IMPLEMENT,SUPPLY}) public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor()
      Description copied from class: Dialect

      Supplies the extractor used to recover violated constraint names from database exceptions.

      The extractor returns null when a name cannot be recovered. Do not use an empty string or sentinel to represent absence.

      Specified by:
      getViolatedConstraintNameExtractor in interface ConversionContext
      Overrides:
      getViolatedConstraintNameExtractor in class Dialect
      Returns:
      the non-null constraint-name extractor
      See Also:

    • 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 Dialect
      Returns:
      the vendor conversion delegate, or null when none is supplied
      See Also:

    • 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 Dialect
      Returns:
      the callable-statement strategy
      See Also:

    • getRefCursorSupportFactory

      @SPI({IMPLEMENT,SUPPLY}) public RefCursorSupportFactory getRefCursorSupportFactory()
      Description copied from class: Dialect

      Supply the stable factory which creates this Dialect's JDBC REF_CURSOR registration and extraction service.

      Return one non-null factory whose identity and selection behavior remain stable for this Dialect's lifetime. This factory controls JDBC cursor access; Dialect.getCallableStatementSupport() independently controls whether and how the callable SQL protocol admits a REF_CURSOR parameter.

      Overrides:
      getRefCursorSupportFactory in class Dialect
      Returns:
      the REF_CURSOR JDBC access factory
      See Also:

    • nameQualification

      @SPI({USE,IMPLEMENT}) public IndexNameQualification nameQualification()
      Specified by:
      nameQualification in interface IndexDdlSupport

    • getIdentityColumnSupport

      public IdentityColumnSupport getIdentityColumnSupport()
      Description copied from class: Dialect

      Supply the stable identity-column DDL, insert syntax, and identity-specific retrieval behavior for this Dialect.

      Override this method to supply a provider implementation of IdentityColumnSupport. Prefer extending IdentityColumnSupportBase and return the same immutable or otherwise stable support instance on every invocation. Do not construct Hibernate mutation delegates in this supply point.

      Overrides:
      getIdentityColumnSupport in class Dialect

    • getNationalizationSupport

      @SPI({IMPLEMENT,SUPPLY}) public NationalizationSupport getNationalizationSupport()
      Description copied from class: Dialect

      Describe how this database represents nationalized character data.

      This database SQL-type capability is independent of whether the JDBC driver correctly implements nationalized access methods. Override Dialect.supportsNationalizedMethods() separately when the driver cannot use those methods.

      Overrides:
      getNationalizationSupport in class Dialect
      Returns:
      the database nationalization profile
      See Also:

    • getMaxIdentifierLength

      @SPI({USE,IMPLEMENT}) public int getMaxIdentifierLength()
      Description copied from interface: IdentifierSupport
      Return the database's maximum identifier length.
      Specified by:
      getMaxIdentifierLength in interface IdentifierSupport

    • 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 Dialect
      See Also:

    • getArraySupport

      public ArraySupport getArraySupport()
      Description copied from class: Dialect

      The independent array syntax and multi-valued parameter-binding behavior of this Dialect.

      Override this method to supply standard element-type array support, SQL array-constructor support, and the multi-valued parameter-binding strategy. Treat these as independent dimensions: do not infer syntax support from array binding, and do not infer array binding from either syntax capability. Return one immutable, non-null profile whose values remain stable for the lifetime of this Dialect.

      Overrides:
      getArraySupport in class Dialect
      Returns:
      this Dialect's stable array-support profile

    • getTemporalValueSemantics

      @SPI({IMPLEMENT,SUPPLY}) public TemporalValueSemantics getTemporalValueSemantics()
      Description copied from class: Dialect
      Supply temporal precision-adjustment and literal-offset semantics. Return one stable, non-null immutable profile.
      Overrides:
      getTemporalValueSemantics in class Dialect
      See Also:

    • appendFormat

      @SPI({USE,IMPLEMENT}) public void appendFormat(SqlAppender appender, String format)
      Description copied from interface: TemporalFormatSupport
      Append the database translation of the supplied Hibernate format pattern.
      Specified by:
      appendFormat in interface TemporalFormatSupport

    • datetimeFormat

      public Replacer datetimeFormat(String format)

    • translateExtractField

      @SPI({USE,IMPLEMENT}) public String translateExtractField(TemporalUnit unit)
      Description copied from interface: TemporalOperationSupport
      Translate an extraction field name.
      Specified by:
      translateExtractField in interface TemporalOperationSupport

    • 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 Dialect
      Returns:
      this dialect's aggregate support
      See Also:

    • appendBinaryLiteral

      @SPI({USE,IMPLEMENT}) public void appendBinaryLiteral(SqlAppender appender, byte[] bytes)
      Description copied from interface: LiteralSupport
      Append a SQL binary literal.
      Specified by:
      appendBinaryLiteral in interface LiteralSupport

    • 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 Dialect

    • 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 Dialect

    • 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 Dialect

    • 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 Dialect
      See Also:

    • getGeneratedValuesSupport

      public GeneratedValuesSupport getGeneratedValuesSupport()
      Description copied from class: Dialect

      Supply the stable profile describing immediate retrieval of arbitrary database-generated values for this Dialect.

      Override this method to declare native insert or update returning, row-id returning, or JDBC generated-key support for arbitrary generated columns. Identity-only retrieval belongs to Dialect.getIdentityColumnSupport(), and an ordinary select after mutation is a Hibernate fallback rather than a capability of this profile. Refine a family profile by copying the value returned by the superclass and changing only the differing capabilities.

      Overrides:
      getGeneratedValuesSupport in class Dialect

    • getSubquerySupport

      @SPI({IMPLEMENT,SUPPLY}) 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 Dialect
      Returns:
      this Dialect's stable subquery-support 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 Dialect
      Returns:
      this Dialect's stable window-function-support profile

    • 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 Dialect
      Returns:
      the stable fetch clause capability profile
      See Also:

    • 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 Dialect
      Returns:
      a non-null immutable capability profile
      See Also:

    • augmentRecognizedTableTypes

      @SPI(IMPLEMENT) public void augmentRecognizedTableTypes(List<String> tableTypesList)
      Description copied from class: Dialect

      Append database-specific recognized table types to tableTypesList.

      The initial list starts with TABLE, VIEW, enabled synonym types, and every physical type. Preserve existing elements, case, order, and duplicates, and do not retain the mutable list.

      Overrides:
      augmentRecognizedTableTypes in class Dialect

    • 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 Dialect
      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.

    • contributePostgreSQLTypes

      protected void contributePostgreSQLTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)
      Allow for extension points to override this only

    • 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 Dialect
      See Also:

    • getTableExporter

      public Exporter<Table> 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 Dialect

    • getUserDefinedTypeExporter

      @SPI({USE,IMPLEMENT,SUPPLY}) public Exporter<UserDefinedType> getUserDefinedTypeExporter()
      Description copied from class: Dialect

      Supply the exporter used to create and drop user-defined types.

      Return one stable exporter owned by this Dialect. Use StandardUserDefinedTypeExporter when standard object-type DDL is sufficient.

      Overrides:
      getUserDefinedTypeExporter in class Dialect

    • truncateMode

      @SPI({USE,IMPLEMENT}) public TruncateMode truncateMode()
      Specified by:
      truncateMode in interface TruncateSupport
      Overrides:
      truncateMode in class Dialect

    • renderCommands

      @SPI({USE,IMPLEMENT}) public List<String> renderCommands(TruncateRequest request)
      Specified by:
      renderCommands in interface TruncateSupport

    • 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 Dialect
      Returns:
      the stable non-null row-id strategy
      See Also:

    • getQueryHintString

      @SPI(IMPLEMENT) public String getQueryHintString(String sql, String hints)
      Description copied from class: Dialect
      Apply a hint to the given SQL query.

      The entire query is provided, allowing full control over the placement and syntax of the hint.

      By default, ignore the hint and simply return the query.

      Overrides:
      getQueryHintString in class Dialect
      Parameters:
      sql - The query to which to apply the hint.
      hints - The hints to apply
      Returns:
      The modified SQL

    • getQueryHintPlacement

      @SPI({IMPLEMENT,SUPPLY}) public QueryHintPlacement getQueryHintPlacement()
      Description copied from class: Dialect

      Supply the final placement of a leading database hint relative to a user SQL comment.

      Return one stable value. Select BEFORE_COMMENT only when the database requires its hint to be the first leading SQL comment.

      Overrides:
      getQueryHintPlacement in class Dialect
      See Also:

    • createOptionalTableUpdateOperation

      @SPI({USE,IMPLEMENT,SUPPLY}) public MutationOperation createOptionalTableUpdateOperation(OptionalTableUpdateOperationRequest request)
      Description copied from class: Dialect

      Creates the JDBC mutation operation for an optional-table update.

      Override this factory when the database needs an operation other than the standard update-then-insert behavior. The request contains the semantic update and bootstrap services; implementations must return an operation for the same OptionalTableUpdateOperationRequest.mutationTarget() and must not retain the request.

      Overrides:
      createOptionalTableUpdateOperation in class Dialect
      Returns:
      a non-null operation for the supplied optional-table update
      See Also:

    • getNativeParameterMarkerStrategy

      @SPI({USE,IMPLEMENT,SUPPLY}) public ParameterMarkerStrategy getNativeParameterMarkerStrategy()
      Description copied from class: Dialect

      Supply the native parameter-marker strategy selected for this database and JDBC driver.

      Return null to use JDBC-standard ? markers. A non-null result must remain stable after bootstrap and must not retain JDBC types passed to it.

      Overrides:
      getNativeParameterMarkerStrategy in class Dialect
      Returns:
      the native strategy, or null for JDBC-standard markers
      See Also:

    • getDmlTargetColumnQualifierSupport

      @SPI({USE,IMPLEMENT,SUPPLY}) public DmlTargetColumnQualifierSupport getDmlTargetColumnQualifierSupport()
      Description copied from class: Dialect

      The qualifier form accepted for target-column references in update and delete statements.

      Translators use this value when rendering assignments and predicates. A custom Dialect should return the least permissive form required by the database, not a form used only by an emulation.

      Overrides:
      getDmlTargetColumnQualifierSupport in class Dialect
      Returns:
      the non-null target-column qualifier support
      See Also:

    • 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 Dialect

    • getObjectNullBindingStrategy

      @SPI({IMPLEMENT,SUPPLY}) public ObjectNullBindingStrategy getObjectNullBindingStrategy()
      Description copied from class: Dialect
      Supply the JDBC strategy for binding an untyped Java null.
      Overrides:
      getObjectNullBindingStrategy in class Dialect
      Returns:
      the non-null binding strategy
      See Also:

    • 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 Dialect

    • 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 Dialect
      Returns:
      this Dialect's stable row-value-support profile

    • 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 Dialect
      See Also:

    • causesRollback

      @SPI({IMPLEMENT,SUPPLY}) public boolean causesRollback(SQLException sqlException)
      Description copied from class: Dialect

      Determine whether this database marks the current transaction for rollback after the given statement failure.

      Inspect the original database exception when the policy depends on its error code, SQL state, or subtype. This decision is independent of how Hibernate converts the exception. This determines both JDBC rollback state and whether a pessimistic lock failure becomes a JPA PessimisticLockException or LockTimeoutException.

      Overrides:
      causesRollback in class Dialect
      Parameters:
      sqlException - the original database exception
      Returns:
      true when the failed statement invalidates the transaction

    • getTemporalTableSupport

      @SPI({IMPLEMENT,SUPPLY}) public TemporalTableSupport getTemporalTableSupport()
      Description copied from class: Dialect

      Supplies the complete temporal-table DDL and historical-query strategy for this Dialect.

      Return an immutable strategy and use the supported request values without retaining them. Prefer TemporalTableSupports.standard(int, int, boolean) when only the column type, precision, and table-check capability differ.

      Overrides:
      getTemporalTableSupport in class Dialect
      Returns:
      the non-null temporal-table support strategy
      See Also: