Package com.inductiveautomation.ignition.gateway.db

Interface DBTranslator

All Known Implementing Classes:
DefaultDBTranslator
public interface DBTranslator

  • Method Details

    • getCreateCommand

      List<String> getCreateCommand(String tableName, ColumnList columns)

    • getAlterCommand

      List<String> getAlterCommand(String tableName, ColumnList columns)

    • getCreateIndexCommand

      String getCreateIndexCommand(String tableName, Column column)

    • applyLimit

      String applyLimit(String query, Integer limit)
      Takes a SELECT query and applies the given limit to it, resulting in a select query with a limiting clause. If the incoming query already has a limit clause, the existing text will be used (that is, nothing further will be done).

    • getCurrentTimeQuery

      String getCurrentTimeQuery()
      Returns a query that can be used to get the current database time.

    • getColumnQuoteChar

      String getColumnQuoteChar()
      Returns the character that this driver uses to quote names in queries

    • isSupportsRGK

      boolean isSupportsRGK()
      Returns:
      whether or not this driver supports returning generated keys on insert queries

    • getFetchKeyQuery

      String getFetchKeyQuery(String tableName, String columnName)
      A query to be executed instead of using JDBC's built-in facility for obtaining auto-generated keys. Only used if supportsRGK is false. Takes the table name and column name in case the query needs to use them- it will depend on the database as to whether or not they are.

    • getTableListFilter

      String getTableListFilter()
      Returns a filter that will be used to narrow the list of tables returned from the database. A semi-colon separated list of simple patterns, like "apex_*;sys_info*"

    • usesNativeBooleanType

      default boolean usesNativeBooleanType()
      Whether this translator maps DataType.Boolean to a native boolean SQL type -- one that requires a real boolean bind rather than an integer 0/1. This is the best available signal for the type a boolean column was most likely created with when the column's actual type cannot be read back from the database; it is consulted only as a fallback, since the mapping is mutable and can diverge from an already-created column. Defaults to false; DefaultDBTranslator overrides it to classify its configured boolean keyword, and any translator that wraps another (e.g. a datasource's swap-able delegate) must forward this call so the wrapped mapping is not lost.