Module eclipselink
Package org.eclipse.persistence.tools.schemaframework

Interface DDLPlatform

    • Method Detail

      • getJavaTypes

        default Map<String,​Class<?>> getJavaTypes()
        Deprecated.
        Return the database type to class type mappings for the schema framework.

      • getDatabaseType

        default FieldDefinition.DatabaseType getDatabaseType​(String typeName)
        Deprecated.
        Returns the field type definition for the given Java type name.
        Parameters:
        typeName - the Java class representing the type
        Returns:
        the field type definition

      • getDatabaseType

        default FieldDefinition.DatabaseType getDatabaseType​(Class<?> type)
        Deprecated.
        Returns the field type definition for the given Java type.
        Parameters:
        type - the Java class representing the type
        Returns:
        the field type definition

      • buildCreateIndex

        default String buildCreateIndex​(String fullTableName,
                                String indexName,
                                String qualifier,
                                boolean isUnique,
                                String... columnNames)
        Deprecated.
        INTERNAL: Override this method with the platform's CREATE INDEX statement.
        Parameters:
        fullTableName - qualified name of the table the index is to be created on
        indexName - name of the index
        qualifier - qualifier to construct qualified name of index if needed
        isUnique - Indicates whether unique index is created
        columnNames - one or more columns the index is created for

      • buildDropIndex

        default String buildDropIndex​(String fullTableName,
                              String indexName,
                              String qualifier)
        Deprecated.
        INTERNAL: Override this method with the platform's DROP INDEX statement.
        Parameters:
        fullTableName - qualified name of the table the index is to be removed from
        indexName - name of the index
        qualifier - qualifier to construct qualified name of index if needed

      • buildSequenceObjectAlterIncrementWriter

        default Writer buildSequenceObjectAlterIncrementWriter​(Writer writer,
                                                       String fullSeqName,
                                                       int increment)
                                                throws IOException
        Deprecated.
        INTERNAL: Returns sql used to alter sequence object's increment in the database.
        Throws:
        IOException

      • buildSequenceObjectCreationWriter

        default Writer buildSequenceObjectCreationWriter​(Writer writer,
                                                 String fullSeqName,
                                                 int increment,
                                                 int start)
                                          throws IOException
        Deprecated.
        INTERNAL: Returns sql used to create sequence object in the database.
        Throws:
        IOException

      • buildSequenceObjectDeletionWriter

        default Writer buildSequenceObjectDeletionWriter​(Writer writer,
                                                 String fullSeqName)
                                          throws IOException
        Deprecated.
        INTERNAL: Returns sql used to delete sequence object from the database.
        Throws:
        IOException

      • getBatchBeginString

        default String getBatchBeginString()
        Deprecated.
        Used for batch writing and sp defs.

      • getBatchDelimiterString

        default String getBatchDelimiterString()
        Deprecated.
        Used for batch writing and sp defs.

      • getBatchEndString

        default String getBatchEndString()
        Deprecated.
        Used for batch writing and sp defs.

      • getCreateViewString

        default String getCreateViewString()
        Deprecated.
        Returns the platform-specific string for creating a view (e.g., "CREATE VIEW" or "CREATE OR REPLACE VIEW").
        Returns:
        the create view string

      • getDropCascadeString

        default String getDropCascadeString()
        Deprecated.
        Allows DROP TABLE to cascade dropping of any dependent constraints if the database supports this option.

      • getIndexNamePrefix

        default String getIndexNamePrefix​(boolean isUniqueSetOnField)
        Deprecated.
        Used to allow platforms to define their own index prefixes

      • getMaxFieldNameSize

        default int getMaxFieldNameSize()
        Deprecated.
        INTERNAL: returns the maximum number of characters that can be used in a field name on this platform.

      • getMaxIndexNameSize

        default int getMaxIndexNameSize()
        Deprecated.
        INTERNAL: returns the maximum number of characters that can be used in an index name on this platform.

      • getMaxUniqueKeyNameSize

        default int getMaxUniqueKeyNameSize()
        Deprecated.
        Returns the maximum allowed size for unique key names on this platform.
        Returns:
        the maximum unique key name size

      • getMaxForeignKeyNameSize

        default int getMaxForeignKeyNameSize()
        Deprecated.
        INTERNAL: returns the maximum number of characters that can be used in a foreign key name on this platform.

      • getProcedureAsString

        default String getProcedureAsString()
        Deprecated.
        Used for stored procedure defs.

      • getProcedureBeginString

        default String getProcedureBeginString()
        Deprecated.
        Used for stored procedure defs.

      • getProcedureEndString

        default String getProcedureEndString()
        Deprecated.
        Used for stored procedure defs.

      • getProcedureOptionList

        default String getProcedureOptionList()
        Deprecated.
        Some platforms have an option list Only to be used for stored procedure creation.
        See Also:
        StoredProcedureDefinition

      • getStoredProcedureTerminationToken

        default String getStoredProcedureTerminationToken()
        Deprecated.

      • isAlterSequenceObjectSupported

        default boolean isAlterSequenceObjectSupported()
        Deprecated.
        INTERNAL: Override this method if the platform supports sequence objects and it's possible to alter sequence object's increment in the database.

      • printFieldIdentityClause

        default void printFieldIdentityClause​(Writer writer)
                               throws IOException
        Deprecated.
        Prints the platform-specific identity clause for a field (e.g., AUTO_INCREMENT).
        Parameters:
        writer - the writer to append to
        Throws:
        IOException - if an I/O error occurs while writing

      • printFieldNotNullClause

        default void printFieldNotNullClause​(Writer writer)
                              throws IOException
        Deprecated.
        Prints the platform-specific NOT NULL clause for a field.
        Parameters:
        writer - the writer to append to
        Throws:
        IOException - if an I/O error occurs while writing

      • printFieldNullClause

        default void printFieldNullClause​(Writer writer)
                           throws IOException
        Deprecated.
        Prints the platform-specific NULL clause for a field.
        Parameters:
        writer - the writer to append to
        Throws:
        IOException - if an I/O error occurs while writing

      • printFieldTypeSize

        default void printFieldTypeSize​(Writer writer,
                                FieldDefinition field,
                                FieldDefinition.DatabaseType databaseType,
                                boolean shouldPrintFieldIdentityClause)
                         throws IOException
        Deprecated.
        Prints the field type size clause to the writer, including type name and optional size.
        Parameters:
        writer - the writer to append to
        field - the field definition
        databaseType - the field type definition
        shouldPrintFieldIdentityClause - indicates if the identity clause should be printed
        Throws:
        IOException - if an I/O error occurs while writing

      • printFieldUnique

        default void printFieldUnique​(Writer writer,
                              boolean shouldPrintFieldUniqueClause)
                       throws IOException
        Deprecated.
        Prints the platform-specific UNIQUE clause for a field.
        Parameters:
        writer - the writer to append to
        shouldPrintFieldUniqueClause - indicates if the identity clause should be printed
        Throws:
        IOException - if an I/O error occurs while writing

      • requiresNamedPrimaryKeyConstraints

        default boolean requiresNamedPrimaryKeyConstraints()
        Deprecated.
        Indicates whether the platform requires named primary key constraints.
        Returns:
        true if named primary key constraints are required; false otherwise

      • requiresProcedureBrackets

        default boolean requiresProcedureBrackets()
        Deprecated.
        Used for stored procedure creation: Some platforms need brackets around arguments declaration even if no arguments exist. Those platform will override this and return true. All other platforms will omit the brackets in this case.

      • requiresTableInIndexDropDDL

        default boolean requiresTableInIndexDropDDL()
        Deprecated.
        INTERNAL: Return if this database requires the table name when dropping an index.

      • requiresUniqueConstraintCreationOnTableCreate

        default boolean requiresUniqueConstraintCreationOnTableCreate()
        Deprecated.
        Used for table creation. If a database platform does not support ALTER TABLE syntax to add/drop unique constraints (like Symfoware), overriding this method will allow the constraint to be specified in the CREATE TABLE statement.

        This only affects unique constraints specified using the UniqueConstraint annotation or equivalent method. Columns for which the 'unique' attribute is set to true will be declared 'UNIQUE' in the CREATE TABLE statement regardless of the return value of this method.

        Returns:
        whether unique constraints should be declared as part of the CREATE TABLE statement instead of in separate ALTER TABLE ADD/DROP statements.

      • shouldCreateIndicesForPrimaryKeys

        default boolean shouldCreateIndicesForPrimaryKeys()
        Deprecated.
        Used for table creation. Most databases create an index automatically when a primary key is created. Symfoware does not.
        Returns:
        whether an index should be created explicitly for primary keys

      • shouldCreateIndicesOnForeignKeys

        default boolean shouldCreateIndicesOnForeignKeys()
        Deprecated.
        Used for table creation. Most databases do not create an index automatically for foreign key columns. Normally it is recommended to index foreign key columns. This allows for foreign key indexes to be configured, by default foreign keys are not indexed.
        Returns:
        whether an index should be created explicitly for foreign key constraints

      • shouldCreateIndicesOnUniqueKeys

        default boolean shouldCreateIndicesOnUniqueKeys()
        Deprecated.
        Used for table creation. Most databases create an index automatically for columns with a unique constraint. Symfoware does not.
        Returns:
        whether an index should be created explicitly for unique constraints

      • shouldPrintConstraintNameAfter

        default boolean shouldPrintConstraintNameAfter()
        Deprecated.
        Some Platforms want the constraint name after the constraint definition.

      • shouldPrintStoredProcedureVariablesAfterBeginString

        default boolean shouldPrintStoredProcedureVariablesAfterBeginString()
        Deprecated.
        Used for stored procedure creation: Some platforms declare variables AFTER the procedure body's BEGIN string. These need to override and return true. All others will print the variable declaration BEFORE the body's BEGIN string.

      • supportsDeleteOnCascade

        default boolean supportsDeleteOnCascade()
        Deprecated.

      • supportsForeignKeyConstraints

        default boolean supportsForeignKeyConstraints()
        Deprecated.

      • supportsUniqueKeyConstraints

        default boolean supportsUniqueKeyConstraints()
        Deprecated.

      • supportsIndexes

        default boolean supportsIndexes()
        Deprecated.
        INTERNAL: Return if this database support index creation.

      • supportsPrimaryKeyConstraint

        default boolean supportsPrimaryKeyConstraint()
        Deprecated.
        Indicates whether the platform supports primary key constraints.
        Returns:
        true if primary key constraints are supported; false otherwise

      • supportsStoredFunctions

        default boolean supportsStoredFunctions()
        Deprecated.

      • supportsUniqueColumns

        default boolean supportsUniqueColumns()
        Deprecated.
        Indicates whether the platform supports unique columns (e.g., UNIQUE keyword on column).
        Returns:
        true if unique columns are supported; false otherwise

      • writeTableCreationSuffix

        default void writeTableCreationSuffix​(Writer writer,
                                      String creationSuffix)
                               throws IOException
        Deprecated.
        Writes the platform-specific table creation suffix to the provided writer. This may include storage clauses, tablespace definitions, or other platform-specific DDL.
        Parameters:
        writer - the writer to append the suffix to
        creationSuffix - any additional user-provided suffix
        Throws:
        IOException - if an I/O error occurs while writing

      • getTableCreationSuffix

        default String getTableCreationSuffix()
        Deprecated.
        PUBLIC: Get the String used on all table creation statements generated from the DefaultTableGenerator with a session using this project (DDL generation). This value will be appended to CreationSuffix strings stored on the DatabaseTable or TableDefinition.

      • getEndDelimiter

        default String getEndDelimiter()
        Deprecated.
        Delimiter to use for fields and tables using spaces or other special values.

        Some databases use different delimiters for the beginning and end of the value. This delimiter indicates the end of the value.

      • getStartDelimiter

        default String getStartDelimiter()
        Deprecated.
        Delimiter to use for fields and tables using spaces or other special values.

        Some databases use different delimiters for the beginning and end of the value. This delimiter indicates the start of the value.

      • getCreateDatabaseSchemaString

        default String getCreateDatabaseSchemaString​(String schema)
        Deprecated.
        Return the create schema SQL syntax. Subclasses should override as needed.

      • getDropDatabaseSchemaString

        default String getDropDatabaseSchemaString​(String schema)
        Deprecated.
        Return the drop schema SQL syntax. Subclasses should override as needed.

      • shouldPrintOutputTokenBeforeType

        default boolean shouldPrintOutputTokenBeforeType()
        Deprecated.
        This is required in the construction of the stored procedures with output parameters

      • shouldPrintOutputTokenAtStart

        default boolean shouldPrintOutputTokenAtStart()
        Deprecated.
        This is required in the construction of the stored procedures with output parameters

      • getCreationOutputProcedureToken

        default String getCreationOutputProcedureToken()
        Deprecated.
        This method is used to print the required output parameter token for the specific platform. Used when stored procedures are created.

      • getOutputProcedureToken

        default String getOutputProcedureToken()
        Deprecated.
        This method is used to print the output parameter token when stored procedures are called

      • getProcedureArgumentString

        default String getProcedureArgumentString()
        Deprecated.
        Used for sp defs.

      • allowsSizeInProcedureArguments

        default boolean allowsSizeInProcedureArguments()
        Deprecated.
        Used for stored procedure definitions.

      • getInOutputProcedureToken

        default String getInOutputProcedureToken()
        Deprecated.
        This method is used to print the output parameter token when stored procedures are called

      • getCreationInOutputProcedureToken

        default String getCreationInOutputProcedureToken()
        Deprecated.
        This method is used to print the required output parameter token for the specific platform. Used when stored procedures are created.

      • shouldPrintInputTokenAtStart

        default boolean shouldPrintInputTokenAtStart()
        Deprecated.
        Used for stored procedure creation: Some platforms want to print prefix for INPUT arguments BEFORE NAME. If wanted, override and return true.

      • getInputProcedureToken

        default String getInputProcedureToken()
        Deprecated.
        Used for stored procedure creation: Prefix for INPUT parameters. Not required on most platforms.