com.tibco.cep.store.custom

## Class StoreDeployment

- java.lang.Object
- - com.tibco.cep.store.custom.StoreDeployment

-     public abstract class StoreDeployment
      extends java.lang.Object

  A `StoreDeployment` acts as a base store deployment implementation.
  Since:
    6.1.0

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract boolean` | `connectToDatabase()` Connect to database and return if it successfully connected or not.
    `protected abstract java.lang.String` | `getAlterTableAddColumnStatement(java.lang.String tableName, java.lang.String colName, java.lang.String dataType)` Set store specific statement which can be used to add new column in existing table.
    `protected abstract java.lang.String` | `getAlterTableDropColumnStatement(java.lang.String tableName, java.lang.String colName)` Format and return store specific statement which can be used to delete a column from existing table.
    `protected abstract java.lang.String` | `getCommentStatement()` Set store specific comment statement.
    `protected abstract java.lang.String` | `getCreateIndexStatement(java.lang.String tableName, java.lang.String indexName, java.lang.String[] colName)` Format and return store specifc statement which can be used to create an index on a table.
    `protected abstract java.lang.String` | `getDropIndexStatement(java.lang.String tableName, java.lang.String indexName)` Format and return store specifc statement which can be used to drop an index on a table.
    `protected abstract java.lang.String` | `getDropTableStatement(java.lang.String tableName)` Set store specific statement which can be used to drop table from store.
    `protected java.lang.String` | `getExecuteCommand()` Set data base specific execute command if any.
    `protected abstract java.lang.String` | `getModifyColumnStatement(java.lang.String tableName, java.lang.String colName, java.lang.String dataType)` Format and return modify column statement if store supports column datatype conversion.
    `protected java.lang.String` | `getNewline()` Set data base specific line terminator and new line command.
    `protected boolean` | `isColumnTypeConversionSupported()` Set if column type conversion is supported for store.
    `protected boolean` | `isCreateSystemTablesScript()` Set if need to create create script for system tables.
    `abstract boolean` | `testConnection()` Connect to database and Test if it can successfully connect or not.

- - ### Method Detail

    - #### getExecuteCommand

          protected java.lang.String getExecuteCommand()

      Set data base specific execute command if any.
      Returns:
        String

    - #### getNewline

          protected java.lang.String getNewline()

      Set data base specific line terminator and new line command.
      Returns:
        String

    - #### isColumnTypeConversionSupported

          protected boolean isColumnTypeConversionSupported()

      Set if column type conversion is supported for store.
      Returns:
        boolean

    - #### getCommentStatement

          protected abstract java.lang.String getCommentStatement()

      Set store specific comment statement.
      Returns:
        `String`

    - #### getDropTableStatement

          protected abstract java.lang.String getDropTableStatement(java.lang.String tableName)

      Set store specific statement which can be used to drop table from store.
      Parameters:
        `tableName` -
      Returns:
        `String`

    - #### getAlterTableAddColumnStatement

          protected abstract java.lang.String getAlterTableAddColumnStatement(java.lang.String tableName,
                                                                              java.lang.String colName,
                                                                              java.lang.String dataType)

      Set store specific statement which can be used to add new column in existing table.
      Parameters:
        `tableName` -
        `colName` -
        `dataType` -
      Returns:
        `String`

    - #### getAlterTableDropColumnStatement

          protected abstract java.lang.String getAlterTableDropColumnStatement(java.lang.String tableName,
                                                                               java.lang.String colName)

      Format and return store specific statement which can be used to delete a column from existing table.
      Parameters:
        `tableName` -
        `colName` -
      Returns:
        `String`

    - #### getDropIndexStatement

          protected abstract java.lang.String getDropIndexStatement(java.lang.String tableName,
                                                                    java.lang.String indexName)

      Format and return store specifc statement which can be used to drop an index on a table.
      Parameters:
        `tableName` -
        `indexName` -
      Returns:
        `String`

    - #### getCreateIndexStatement

          protected abstract java.lang.String getCreateIndexStatement(java.lang.String tableName,
                                                                      java.lang.String indexName,
                                                                      java.lang.String[] colName)

      Format and return store specifc statement which can be used to create an index on a table.
      Parameters:
        `tableName` -
        `indexName` -
        `colName` -
      Returns:
        `String`

    - #### getModifyColumnStatement

          protected abstract java.lang.String getModifyColumnStatement(java.lang.String tableName,
                                                                       java.lang.String colName,
                                                                       java.lang.String dataType)

      Format and return modify column statement if store supports column datatype conversion. Else simply return blank string.
      Parameters:
        `tableName` -
        `def` -
      Returns:
        `String`

    - #### connectToDatabase

          protected abstract boolean connectToDatabase()

      Connect to database and return if it successfully connected or not.
      Returns:
        boolean

    - #### isCreateSystemTablesScript

          protected boolean isCreateSystemTablesScript()

      Set if need to create create script for system tables.
      Returns:
        boolean

    - #### testConnection

          public abstract boolean testConnection()

      Connect to database and Test if it can successfully connect or not. Make sure to close the connection in this method.
      Returns:
        boolean