Package org.hibernate.boot.model.relational

Interface SqlStringGenerationContext

  • All Known Implementing Classes:
    SqlStringGenerationContextImpl
    public interface SqlStringGenerationContext
    A context provided to methods responsible for generating SQL strings on startup.

    • Method Detail

      • getDialect

        Dialect getDialect()
        Returns:
        The database dialect of the current JDBC environment, to generate SQL fragments that are specific to each vendor.

      • getIdentifierHelper

        @Deprecated
IdentifierHelper getIdentifierHelper()
        Deprecated.
        Use toIdentifier(String) instead.
        Returns:
        The helper for dealing with identifiers in the current JDBC environment.

        Note that the Identifiers returned from this helper already account for auto-quoting.

      • toIdentifier

        Identifier toIdentifier​(String text)
        Generate an Identifier instance from its simple name as obtained from mapping information.

        Note that Identifiers returned from here may be implicitly quoted based on 'globally quoted identifiers' or based on reserved words.

        Parameters:
        text - The text form of a name as obtained from mapping information.
        Returns:
        The identifier form of the name.

      • getDefaultCatalog

        Identifier getDefaultCatalog()
        Returns:
        The default catalog, used for table/sequence names that do not explicitly mention a catalog. May be null. This default is generally applied automatically by the format methods, but in some cases it can be useful to access it directly.

      • catalogWithDefault

        Identifier catalogWithDefault​(Identifier explicitCatalogOrNull)
        Parameters:
        explicitCatalogOrNull - An explicitly configured catalog, or null.
        Returns:
        The given identifier if non-null, or the default catalog otherwise.

      • getDefaultSchema

        Identifier getDefaultSchema()
        Returns:
        The default schema, used for table/sequence names that do not explicitly mention a schema. May be null. This default is generally applied automatically by the format methods, but in some cases it can be useful to access it directly.

      • schemaWithDefault

        Identifier schemaWithDefault​(Identifier explicitSchemaOrNull)
        Parameters:
        explicitSchemaOrNull - An explicitly configured schema, or null.
        Returns:
        The given identifier if non-null, or the default schema otherwise.

      • format

        String format​(QualifiedTableName qualifiedName)
        Render a formatted a table name
        Parameters:
        qualifiedName - The table name
        Returns:
        The formatted name,

      • format

        String format​(QualifiedSequenceName qualifiedName)
        Render a formatted sequence name
        Parameters:
        qualifiedName - The sequence name
        Returns:
        The formatted name

      • format

        String format​(QualifiedName qualifiedName)
        Render a formatted non-table and non-sequence qualified name
        Parameters:
        qualifiedName - The name
        Returns:
        The formatted name

      • formatWithoutCatalog

        String formatWithoutCatalog​(QualifiedSequenceName qualifiedName)
        Render a formatted sequence name, without the catalog (even the default one).
        Parameters:
        qualifiedName - The sequence name
        Returns:
        The formatted name

      • isMigration

        boolean isMigration()
        Is the generated SQL for use in schema migration?
        Returns:
        true if and only if this is a migration