DBMetaData (Bosch IoT Remote Manager 7.1 System Package API)

```
public interface DBMetaData
```
This interface can be used to receive some important information about a DB server. It is a limited subset of java.sql.DatabaseMetaData, on one hand, and features some ConnectionManager-specific methods, on the other. Implementation of the interface can be obtained through the ConnectionManager.getMetaData() method.

Version:

2.0.0

Author:

Rempes, Ivailo Duevski

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`areLikeEscapesBugged()` Connection-Manager specific.
`boolean`	`areLongTypesStreamable()` Returns if SQL API set/getXXXStream() methods can be used without problems on the SQL types designated as `java.sql.Types.LONGVARCHAR` and `java.sql.Types.LONGVARBINARY` when interrogating the database metadata of the underlying DB server.
`boolean`	`areSpecialEscapesInterpreted()` Connection-Manager specific.
`int`	`connectionLimit()` ConnectionManager-specific : returns the ConnectionManager's connection limit.
`java.lang.String`	`getBinarySearchSyntax(java.lang.String column)` Returns specific syntax for binary (case-sensitive) search on VARCHAR/TEXT columns, depending on the underlying database server.
`java.lang.String`	`getBinarySortSyntax(java.lang.String column)` Returns specific syntax for binary (case-sensitive) sort of VARCHAR/TEXT columns, depending on the underlying database server.
`java.lang.String`	`getDBTimeFunction()` Returns the name of the built-in SQL current-time function of the underlying DB server.
`java.lang.String`	`getFictiveFromClause()` Connection-Manager specific.
`java.lang.String`	`getIgnoreCaseSearchSyntax(java.lang.String column, java.lang.String operator)` If underlying database server absolultely requires specific syntax for case-inensitive search on VARCHAR/TEXT columns, and mPRM DB configuration for this server requires CI search, this method will return server-specific CI search syntax.
`java.lang.String`	`getLikeSpecialCharacters()` Returns a String containing the special (meta) symbols that the underlying DB server interprets in a special way in LIKE search patterns.
`java.lang.String`	`getOuterJoinSyntax(java.lang.String table1, char alias1, java.lang.String table2, char alias2, java.lang.String column1, java.lang.String column2, java.lang.String furtherWhereClause, boolean isLeft)` Connection-Manager specific.
`java.lang.String`	`getSearchStringEscape()`
`boolean`	`isCLOBTypeEQSearchable()`
`boolean`	`isConfiguredCaseInsensitive()`
`boolean`	`isDB2()` Connection-Manager specific.
`boolean`	`isH2()` Connection-Manager specific.
`boolean`	`isModFunctionPercent()` Returns true if the only supported syntax for mod() expressions in the underlying's DB server is 'expr % divisor' (as opposed to the standard 'mod(expr, divisor)').
`boolean`	`isMySQL()` Connection-Manager specific.
`boolean`	`isMySQLInnoDB()` Connection-Manager specific.
`boolean`	`isOracle()` Connection-Manager specific.
`boolean`	`isOracle10()` Connection-Manager specific.
`boolean`	`isPostgreSql()` Connection-Manager specific.
`java.lang.String`	`mod(java.lang.String column, int value)` Returns the underlying DB server's mod function syntax for the expression 'mod(COLUMN, value)'.
`java.lang.String`	`nullCheckLOB(java.lang.String column)` Returns specific syntax for IS NULL clause on LOB (LONGVARCHAR/LONGVARBINARY) columns, if the underlying DB server requires such.
`java.lang.String`	`product()` The same as java.sql.DatabaseMetaData.getDatabaseProductName().
`boolean`	`supportsAlterTableWithAddColumn()`
`boolean`	`supportsAlterTableWithDropColumn()`
`boolean`	`supportsAlterTableWithModifyColumn()`
`boolean`	`supportsCorrelatedSubqueries()`
`boolean`	`supportsLikeEscapeClause()`
`boolean`	`supportsSubqueriesInComparisons()`
`boolean`	`supportsSubqueriesInExists()`
`boolean`	`supportsSubqueriesInIns()`
`boolean`	`supportsTransactions()`

- Method Detail
  - product
```
java.lang.String product()
```
    The same as java.sql.DatabaseMetaData.getDatabaseProductName().
  - getSearchStringEscape
```
java.lang.String getSearchStringEscape()
```
  - supportsLikeEscapeClause
```
boolean supportsLikeEscapeClause()
```
  - supportsTransactions
```
boolean supportsTransactions()
```
  - supportsCorrelatedSubqueries
```
boolean supportsCorrelatedSubqueries()
```
  - supportsSubqueriesInIns
```
boolean supportsSubqueriesInIns()
```
  - supportsSubqueriesInExists
```
boolean supportsSubqueriesInExists()
```
  - supportsSubqueriesInComparisons
```
boolean supportsSubqueriesInComparisons()
```
  - supportsAlterTableWithAddColumn
```
boolean supportsAlterTableWithAddColumn()
```
  - supportsAlterTableWithDropColumn
```
boolean supportsAlterTableWithDropColumn()
```
  - supportsAlterTableWithModifyColumn
```
boolean supportsAlterTableWithModifyColumn()
```
  - connectionLimit
```
int connectionLimit()
```
    ConnectionManager-specific : returns the ConnectionManager's connection limit.
    
    Returns:
    
    the connection limit of the corresponding ConnectionManager
  - isOracle
```
boolean isOracle()
```
    Connection-Manager specific.
    
    Returns:
    
    true if the underlying DB server is an Oracle(tm) database.
  - isOracle10
```
boolean isOracle10()
```
    Connection-Manager specific.
    
    Returns:
    
    true if the underlying DB server is an Oracle(tm) database version 10.
  - isMySQL
```
boolean isMySQL()
```
    Connection-Manager specific.
    
    Returns:
    
    true if the underlying DB server is a MySQL(tm) database.
  - isH2
```
boolean isH2()
```
    Connection-Manager specific.
    
    Returns:
    
    true if the underlying DB server is a H2 database.
  - isPostgreSql
```
boolean isPostgreSql()
```
    Connection-Manager specific.
    
    Returns:
    
    true if the underlying DB server is a PostgreSql database.
  - isMySQLInnoDB
```
boolean isMySQLInnoDB()
```
    Connection-Manager specific.
    
    Returns:
    
    true if the underlying DB server is a MySQL(tm) database, and its current default table type is InnoDB(tm).
  - isDB2
```
boolean isDB2()
```
    Connection-Manager specific.
    
    Returns:
    
    true if the underlying DB server is a IBM DB2(tm) database.
  - areLongTypesStreamable
```
boolean areLongTypesStreamable()
```
    Returns if SQL API set/getXXXStream() methods can be used without problems on the SQL types designated as java.sql.Types.LONGVARCHAR and java.sql.Types.LONGVARBINARY when interrogating the database metadata of the underlying DB server.
    The return value is intended to be used by mPRM Table Creator for determining if the above types should be considered for choice of the actual type for a LONGVARCHAR/LONGVARBINARY table column (or only Types.CLOB and Types.BLOB should be considered).
    
    Returns:
    
    true if Types.LONGVARCHAR/Types.LONGVARBINARY SQL types of underlying DB server are safely streamable, false otherwise
  - areSpecialEscapesInterpreted
```
boolean areSpecialEscapesInterpreted()
```
    Connection-Manager specific. Used to determine whether escape sequences for special symbols (\r, \n, etc.) are interpreted in query inline strings and LIKE patterns. The escape symbol for special sequences is assumed to be the same as returned by getSearchStringEscape().
    NB:On DB servers, over which this method returns true (MySQL), escape interpretation for LIKE patterns happens even if using PreparedStatement !
    
    Returns:
    
    true if the underlying DB server interprets its search string escape symbol (as returned by getSearchStringEscape() also as an escape symbol for special characters in string data, false otherwise
  - areLikeEscapesBugged
```
boolean areLikeEscapesBugged()
```
    Connection-Manager specific. Returns true if due to internal bugs, the underlying DB server cannot perform correct LIKE search when the LIKE pattern contains backslashes or the standard JDBC LIKE escape string (usually backslash as well). This is true for Mckoi database server.
    
    Returns:
    
    true if the underlying DB server has internal bugs in regard to the interpretation of standard and backslash (\) escape symbols in LIKE patterns, false otherwise
  - getLikeSpecialCharacters
```
java.lang.String getLikeSpecialCharacters()
```
    Returns a String containing the special (meta) symbols that the underlying DB server interprets in a special way in LIKE search patterns.
    
    Returns:
    
    a String concatenation of the underlying DB server's LIKE meta-symbols
  - getOuterJoinSyntax
```
java.lang.String getOuterJoinSyntax(java.lang.String table1,
                                    char alias1,
                                    java.lang.String table2,
                                    char alias2,
                                    java.lang.String column1,
                                    java.lang.String column2,
                                    java.lang.String furtherWhereClause,
                                    boolean isLeft)
```
    Connection-Manager specific. Returns the outer join syntax specific to the underlying DB server, for the join of 2 tables on one equality search condition.
    
    Parameters:
    
    table1 - the first table
    
    alias1 - alias for table1 ; pass some single letter
    
    table2 - the second table
    
    alias2 - alias for table2 ; pass some other single letter ( != alias1)
    
    column1 - column from the first table for the equality search condition
    
    column2 - column from the second table for the equality search condition
    
    furtherWhereClause - where clause to be appended after the outer join, pass null if not desired
    
    isLeft - must be true for a left outer join, false for a right outer join
    
    Returns:
    
    the outer join clause after the FROM keyword in the SELECT statement
  - getFictiveFromClause
```
java.lang.String getFictiveFromClause()
```
    Connection-Manager specific. Returns the fictive FROM clause, required for special SELECT statements, e.g. 'SELECT 1 + 1' - if the underlying DB server requires one.
    
    Returns:
    
    the fictive FROM clause for the underlying DB server, if it requires one, or "" if it does not.
  - getDBTimeFunction
```
java.lang.String getDBTimeFunction()
```
    Returns the name of the built-in SQL current-time function of the underlying DB server.
    
    Returns:
    
    name of database server's current-time SQL function
  - isModFunctionPercent
```
boolean isModFunctionPercent()
```
    Returns true if the only supported syntax for mod() expressions in the underlying's DB server is 'expr % divisor' (as opposed to the standard 'mod(expr, divisor)').
  - mod
```
java.lang.String mod(java.lang.String column,
                     int value)
```
    Returns the underlying DB server's mod function syntax for the expression 'mod(COLUMN, value)'.
    
    Parameters:
    
    column - column name
    
    value - the divisor as constant integer value
    
    Returns:
    
    DB-dependent mod function syntax
  - nullCheckLOB
```
java.lang.String nullCheckLOB(java.lang.String column)
```
    Returns specific syntax for IS NULL clause on LOB (LONGVARCHAR/LONGVARBINARY) columns, if the underlying DB server requires such.
    
    Returns:
    
    DB-dependent IS NULL syntax for LOB columns
  - isCLOBTypeEQSearchable
```
boolean isCLOBTypeEQSearchable()
```
    Returns:
    
    true if the LONGVARCHAR (CLOB) type of the underlying DB server is searchable with =, false otherwise
  - getBinarySortSyntax
```
java.lang.String getBinarySortSyntax(java.lang.String column)
```
    Returns specific syntax for binary (case-sensitive) sort of VARCHAR/TEXT columns, depending on the underlying database server.
    
    Parameters:
    
    column - the name of the column used for the sort
    
    Returns:
    
    binary-cast syntax of the column name, usable in an ORDER BY clause
  - getBinarySearchSyntax
```
java.lang.String getBinarySearchSyntax(java.lang.String column)
```
    Returns specific syntax for binary (case-sensitive) search on VARCHAR/TEXT columns, depending on the underlying database server.
    
    Parameters:
    
    column - the name of the column used to search on
    
    Returns:
    
    comparison clause for the column usable in a prepared statement, i.e. the syntactic equivalent of "COL = ?" for a case-sensitive search
  - isConfiguredCaseInsensitive
```
boolean isConfiguredCaseInsensitive()
```
    Returns:
    
    true if mPRM DB Configuration for underlying DB server requires case-insensitive search
  - getIgnoreCaseSearchSyntax
```
java.lang.String getIgnoreCaseSearchSyntax(java.lang.String column,
                                           java.lang.String operator)
```
    If underlying database server absolultely requires specific syntax for case-inensitive search on VARCHAR/TEXT columns, and mPRM DB configuration for this server requires CI search, this method will return server-specific CI search syntax. Otherwise (i.e. DB server supports configuration of CI search using database collations, or mPRM DB configuration for server doesn't require CI search), the method will return standard syntax.
    
    Parameters:
    
    column - the name of the column used to search on
    
    operator - comparison operator - "=" or "LIKE"
    
    Returns:
    
    comparison clause for the column usable in a prepared statement, i.e. the syntactic equivalent of "COL = ?" ("COL LIKE ?") for a case-insensitive search

Interface DBMetaData

Method Summary

Method Detail

product

getSearchStringEscape

supportsLikeEscapeClause

supportsTransactions

supportsCorrelatedSubqueries

supportsSubqueriesInIns

supportsSubqueriesInExists

supportsSubqueriesInComparisons

supportsAlterTableWithAddColumn

supportsAlterTableWithDropColumn

supportsAlterTableWithModifyColumn

connectionLimit

isOracle

isOracle10

isMySQL

isH2

isPostgreSql

isMySQLInnoDB

isDB2

areLongTypesStreamable

areSpecialEscapesInterpreted

areLikeEscapesBugged

getLikeSpecialCharacters

getOuterJoinSyntax

getFictiveFromClause

getDBTimeFunction

isModFunctionPercent

mod

nullCheckLOB

isCLOBTypeEQSearchable

getBinarySortSyntax

getBinarySearchSyntax

isConfiguredCaseInsensitive

getIgnoreCaseSearchSyntax