Package com.inductiveautomation.ignition.gateway.db

Interface DBTranslator

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  DBTranslator.Tokens  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String applyLimit​(java.lang.String query, java.lang.Integer limit)
      Takes a SELECT query and applies the given limit to it, resulting in a select query with a limiting clause.
      java.util.List<java.lang.String> getAlterCommand​(java.lang.String tableName, ColumnList columns)  
      java.lang.String getColumnQuoteChar()
      Returns the character that this driver uses to quote names in queries
      java.util.List<java.lang.String> getCreateCommand​(java.lang.String tableName, ColumnList columns)  
      java.lang.String getCreateIndexCommand​(java.lang.String tableName, Column column)  
      java.lang.String getCurrentTimeQuery()
      Returns a query that can be used to get the current database time.
      java.lang.String getFetchKeyQuery​(java.lang.String tableName, java.lang.String columnName)
      A query to be executed instead of using JDBC's built-in facility for obtaining auto-generated keys.
      java.lang.String getTableListFilter()
      Returns a filter that will be used to narrow the list of tables returned from the database.
      boolean isSupportsRGK()  

    • Method Detail

      • getCreateCommand

        java.util.List<java.lang.String> getCreateCommand​(java.lang.String tableName,
                                                  ColumnList columns)

      • getAlterCommand

        java.util.List<java.lang.String> getAlterCommand​(java.lang.String tableName,
                                                 ColumnList columns)

      • getCreateIndexCommand

        java.lang.String getCreateIndexCommand​(java.lang.String tableName,
                                       Column column)

      • applyLimit

        java.lang.String applyLimit​(java.lang.String query,
                            java.lang.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

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

      • getColumnQuoteChar

        java.lang.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

        java.lang.String getFetchKeyQuery​(java.lang.String tableName,
                                  java.lang.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

        java.lang.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*"