SQLUtils (Oracle Graph Java API Reference for Property Graph Release 22.3 (F59609-02))

java.lang.Object
- oracle.pg.common.SQLUtils

```
public class SQLUtils
extends java.lang.Object
```
This class contains some useful helper SQL functions. Many of the methods are wrapper functions of what are provided in oracle.spatial.util.Util.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SQLUtils.DbFeature

Nested Classes
Modifier and Type	Class and Description
`static class`	`SQLUtils.DbFeature`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DB_12C`
`static int`	`DB_18C`
`static int`	`DB_19C`
`static int`	`DB_20C`
`static int`	`DB_21C`
`static int`	`DB_MINOR_VERSION_DEFAULT`
`static java.lang.String`	`OPG_PATCH_NOT_INSTALLED`
`static int`	`ORA_INVALID_ID` This constant denotes the Oracle error code for invalid ID
`static int`	`ORA_LITERAL_TOO_LONG` This constant denotes the Oracle error code for string literal too long

Constructor Summary

Constructors
Constructor and Description

SQLUtils()

Constructors
Constructor and Description
`SQLUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.Object`	`castRDBMSObject(java.lang.Object obj, java.lang.Class dtClass)`
`static java.lang.String`	`checkSQLName(java.lang.String string, int maxStringLength)` Checks for any illegal characters in a SQL name.
`static void`	`createInitialProcedure(java.sql.Connection conn, java.lang.String procedureStr)`
`static java.lang.String`	`enquoteColumnName(java.sql.Connection conn, java.lang.String columnName)` Enquotes a column name.
`static java.lang.String`	`enquoteColumnNameCaseSensitive(java.sql.Connection conn, java.lang.String name)` Enquotes a column name.
`static java.lang.String`	`enquoteLiteral(java.sql.Connection conn, java.lang.String name)` This method enquotes a literal value.
`static java.lang.String`	`enquoteLiteral(java.sql.Connection conn, java.lang.String literal, int maxLengthAllowed)` Returns the enquoted literal
`static java.lang.String`	`enquoteNameSQLName(java.sql.Connection conn, java.lang.String name)` Returns the ENQUOTE_NAME formatted String for the SQL name If the Oracle JDBC is present, use the new OracleStatement.enquoteIdentifier API in the JDK8 JDBC.
`static java.lang.String`	`enquoteTableName(java.sql.Connection conn, java.lang.String tableName)` Enquotes a table name with or without schema name which is separated by ".".
`static int`	`getDatabaseMajorVersion(java.sql.Connection conn)` Gets Database Version of the given connection
`static int`	`getMaxLengthAllowed(java.sql.Connection conn)` Checks if the specified name is a qualified SQL name.
`static java.lang.String`	`getOpgVersion(java.sql.Connection conn)` Gets OPG pl/sql packages version installed
`static java.lang.String`	`getValidatedGraphName(java.sql.Connection conn, java.lang.String graphName)` Returns the validated graph name
`static java.lang.String`	`getValidatedGraphName(java.sql.Connection conn, java.lang.String graphName, int maxLengthAllowed)` Returns the validated graph name
`static boolean`	`isEnterpriseEditionDB(java.sql.Connection conn)` Finds if Database of the given connection is Enterprise Edition
`static boolean`	`isMaxStringSizeExtended(java.sql.Connection conn)` Finds if max_str_size parameter value is extended in the given DB connection
`static boolean`	`isOpgPatchInstalled(java.lang.String opgVersion)` Checks if the OPG pl/sql patch is installed in a DB with given OPG version
`static java.lang.String`	`myCheckName(java.lang.String string)` Checks for any illegal characters in a SQL name.
`static java.lang.String`	`qualifiedSQLName(java.sql.Connection conn, java.lang.String name)` Checks if the specified name is a qualified SQL name.
`static void`	`setEventForPartitioning(java.sql.Connection connection, int level)` Sets level for partitioning enable/disable event (1 to turn off, 0 to turn on)
`static void`	`setStmtArgumentForDml(int idx, java.sql.PreparedStatement ps, java.lang.String szKey, java.lang.Object objVa1)`
`static java.lang.String`	`simpleSqlNameCheck(java.sql.Connection conn, java.lang.String name)` This method returns the result of OracleStatement.enquoteIdentifier function: If identifier is a simple SQL identifier, the original value is returned A SQLException will be thrown if identifier contains any characters invalid in a delimited identifier or the identifier length is invalid for the datasource.
`static java.lang.String`	`stripSchema(java.sql.Connection connection, java.lang.String tabName)`
`static boolean`	`validateIsNumericColumn(int sqlType)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DB_12C
```
public static final int DB_12C
```
    See Also:
    
    Constant Field Values
  - DB_18C
```
public static final int DB_18C
```
    See Also:
    
    Constant Field Values
  - DB_19C
```
public static final int DB_19C
```
    See Also:
    
    Constant Field Values
  - DB_20C
```
public static final int DB_20C
```
    See Also:
    
    Constant Field Values
  - DB_21C
```
public static final int DB_21C
```
    See Also:
    
    Constant Field Values
  - DB_MINOR_VERSION_DEFAULT
```
public static final int DB_MINOR_VERSION_DEFAULT
```
    See Also:
    
    Constant Field Values
  - OPG_PATCH_NOT_INSTALLED
```
public static final java.lang.String OPG_PATCH_NOT_INSTALLED
```
    See Also:
    
    Constant Field Values
  - ORA_INVALID_ID
```
public static final int ORA_INVALID_ID
```
    This constant denotes the Oracle error code for invalid ID
    
    See Also:
    
    Constant Field Values
  - ORA_LITERAL_TOO_LONG
```
public static final int ORA_LITERAL_TOO_LONG
```
    This constant denotes the Oracle error code for string literal too long
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SQLUtils
```
public SQLUtils()
```
- Method Detail
  - castRDBMSObject
```
public static final java.lang.Object castRDBMSObject(java.lang.Object obj,
                                                     java.lang.Class dtClass)
```
  - checkSQLName
```
public static java.lang.String checkSQLName(java.lang.String string,
                                            int maxStringLength)
                                     throws java.sql.SQLException
```
    Checks for any illegal characters in a SQL name. Only alpha-numeric characters and "_","$","#" are allowed.
    
    Parameters:
    
    string - input string
    
    maxStringLength - maximum length for input string
    
    Returns:
    
    string Retruns the string if passes the check
    
    Throws:
    
    java.sql.SQLException - An exception is thrown if the input string contains any illegal characters or exceeds the maximum length
  - createInitialProcedure
```
public static void createInitialProcedure(java.sql.Connection conn,
                                          java.lang.String procedureStr)
```
  - enquoteColumnName
```
public static java.lang.String enquoteColumnName(java.sql.Connection conn,
                                                 java.lang.String columnName)
                                          throws java.sql.SQLException
```
    Enquotes a column name.
    
    Parameters:
    
    conn -
    
    columnName -
    
    Returns:
    
    String
    
    Throws:
    
    java.sql.SQLException
  - enquoteColumnNameCaseSensitive
```
public static java.lang.String enquoteColumnNameCaseSensitive(java.sql.Connection conn,
                                                              java.lang.String name)
                                                       throws java.sql.SQLException
```
    Enquotes a column name.
    
    Throws:
    
    java.sql.SQLException
  - enquoteLiteral
```
public static java.lang.String enquoteLiteral(java.sql.Connection conn,
                                              java.lang.String name)
                                       throws java.sql.SQLException
```
    This method enquotes a literal value. It calls SYS.DBMS_ASSERT.enquoteLiteral function.
    
    Parameters:
    
    conn - the database connection
    
    name - the input literal
    
    Returns:
    
    string Retruns the string if passes the check
    
    Throws:
    
    java.sql.SQLException - A SQLexception is thrown if the dbms_assert.qualified_sql_name failed
  - enquoteLiteral
```
public static java.lang.String enquoteLiteral(java.sql.Connection conn,
                                              java.lang.String literal,
                                              int maxLengthAllowed)
                                       throws java.sql.SQLException
```
    Returns the enquoted literal
    
    Parameters:
    
    conn - the database connection
    
    literal - the input name
    
    Throws:
    
    java.sql.SQLException
  - enquoteNameSQLName
```
public static java.lang.String enquoteNameSQLName(java.sql.Connection conn,
                                                  java.lang.String name)
                                           throws java.sql.SQLException
```
    Returns the ENQUOTE_NAME formatted String for the SQL name If the Oracle JDBC is present, use the new OracleStatement.enquoteIdentifier API in the JDK8 JDBC. Otherwise use the DBMS_ASSERT.ENQUOTE_NAME formatted String for the SQL name using "false" for the second parameter (i.e., no capitalization of SQL name). This method is added due to avoid SQL Injection issues.
    
    Parameters:
    
    conn - the database connection
    
    name - the input name
    
    Throws:
    
    java.sql.SQLException
  - enquoteTableName
```
public static java.lang.String enquoteTableName(java.sql.Connection conn,
                                                java.lang.String tableName)
                                         throws java.sql.SQLException
```
    Enquotes a table name with or without schema name which is separated by ".". This method also can be used to enquote all column names, including object column names like col.attr1.attr2.attr3 == "COL"."ATTR1"."ATTR2"."ATTR3"
    
    Parameters:
    
    conn -
    
    tableName -
    
    Returns:
    
    String
    
    Throws:
    
    java.sql.SQLException
  - getDatabaseMajorVersion
```
public static int getDatabaseMajorVersion(java.sql.Connection conn)
```
    Gets Database Version of the given connection
  - getMaxLengthAllowed
```
public static int getMaxLengthAllowed(java.sql.Connection conn)
```
    Checks if the specified name is a qualified SQL name. It calls SYS.DBMS_ASSERT.qualified_sql_name function.
    
    Parameters:
    
    conn - the database connection
    
    Returns:
    
    the max lenght of the table, this one depends on the database. 12.2+
  - getOpgVersion
```
public static java.lang.String getOpgVersion(java.sql.Connection conn)
```
    Gets OPG pl/sql packages version installed
    
    Parameters:
    
    conn - The JDBC DB connection
    
    Returns:
    
    The OPG version installed if patch is installed, OPG_PATCH_NOT_INSTALLED otherwise
  - getValidatedGraphName
```
public static java.lang.String getValidatedGraphName(java.sql.Connection conn,
                                                     java.lang.String graphName)
                                              throws java.sql.SQLException
```
    Returns the validated graph name
    
    Parameters:
    
    conn - the database connection
    
    graphName - the input graph name
    
    Throws:
    
    java.sql.SQLException
  - getValidatedGraphName
```
public static java.lang.String getValidatedGraphName(java.sql.Connection conn,
                                                     java.lang.String graphName,
                                                     int maxLengthAllowed)
                                              throws java.sql.SQLException
```
    Returns the validated graph name
    
    Parameters:
    
    conn - the database connection
    
    graphName - the input graph name
    
    Throws:
    
    java.sql.SQLException
  - isEnterpriseEditionDB
```
public static boolean isEnterpriseEditionDB(java.sql.Connection conn)
```
    Finds if Database of the given connection is Enterprise Edition
  - isMaxStringSizeExtended
```
public static boolean isMaxStringSizeExtended(java.sql.Connection conn)
```
    Finds if max_str_size parameter value is extended in the given DB connection
    
    Parameters:
    
    conn - The connection to DB to check
    
    Returns:
    
    true if max_str_size is extended, false otherwise
  - isOpgPatchInstalled
```
public static boolean isOpgPatchInstalled(java.lang.String opgVersion)
```
    Checks if the OPG pl/sql patch is installed in a DB with given OPG version
    
    Parameters:
    
    opgVersion - The OPG version
    
    Returns:
    
    true if the patch is installed, false otherwise
  - myCheckName
```
public static java.lang.String myCheckName(java.lang.String string)
                                    throws java.sql.SQLException
```
    Checks for any illegal characters in a SQL name. Only alpha-numeric characters and ".", "_","$","#" are allowed.
    
    Parameters:
    
    string - input string
    
    Returns:
    
    string Retruns the string if passes the check
    
    Throws:
    
    java.sql.SQLException - An exception is thrown if the input string contains any illegal characters or exceeds the maximum length
  - qualifiedSQLName
```
public static java.lang.String qualifiedSQLName(java.sql.Connection conn,
                                                java.lang.String name)
                                         throws java.sql.SQLException
```
    Checks if the specified name is a qualified SQL name. It calls SYS.DBMS_ASSERT.qualified_sql_name function.
    
    Parameters:
    
    conn - the database connection
    
    name - the input name
    
    Returns:
    
    string Retruns the string if passes the check
    
    Throws:
    
    java.sql.SQLException - A SQLexception is thrown if the dbms_assert.qualified_sql_name failed
  - setEventForPartitioning
```
public static void setEventForPartitioning(java.sql.Connection connection,
                                           int level)
                                    throws java.sql.SQLException
```
    Sets level for partitioning enable/disable event (1 to turn off, 0 to turn on)
    
    Throws:
    
    java.sql.SQLException
  - setStmtArgumentForDml
```
public static void setStmtArgumentForDml(int idx,
                                         java.sql.PreparedStatement ps,
                                         java.lang.String szKey,
                                         java.lang.Object objVa1)
                                  throws java.sql.SQLException,
                                         java.io.IOException
```
    Throws:
    
    java.sql.SQLException
    
    java.io.IOException
  - simpleSqlNameCheck
```
public static java.lang.String simpleSqlNameCheck(java.sql.Connection conn,
                                                  java.lang.String name)
                                           throws java.sql.SQLException
```
    This method returns the result of OracleStatement.enquoteIdentifier function: If identifier is a simple SQL identifier, the original value is returned A SQLException will be thrown if identifier contains any characters invalid in a delimited identifier or the identifier length is invalid for the datasource.
    
    Parameters:
    
    conn - the database connection
    
    name - the input literal
    
    Returns:
    
    string Retruns the output of OracleStatement.enquoteIdentifier if passes the check
    
    Throws:
    
    java.sql.SQLException - A SQLexception is thrown if the assertion failed
  - stripSchema
```
public static java.lang.String stripSchema(java.sql.Connection connection,
                                           java.lang.String tabName)
                                    throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - validateIsNumericColumn
```
public static boolean validateIsNumericColumn(int sqlType)
```

Class SQLUtils

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DB_12C

DB_18C

DB_19C

DB_20C

DB_21C

DB_MINOR_VERSION_DEFAULT

OPG_PATCH_NOT_INSTALLED

ORA_INVALID_ID

ORA_LITERAL_TOO_LONG

Constructor Detail

SQLUtils

Method Detail

castRDBMSObject

checkSQLName

createInitialProcedure

enquoteColumnName

enquoteColumnNameCaseSensitive

enquoteLiteral

enquoteLiteral

enquoteNameSQLName

enquoteTableName

getDatabaseMajorVersion

getMaxLengthAllowed

getOpgVersion

getValidatedGraphName

getValidatedGraphName

isEnterpriseEditionDB

isMaxStringSizeExtended

isOpgPatchInstalled

myCheckName

qualifiedSQLName

setEventForPartitioning

setStmtArgumentForDml

simpleSqlNameCheck

stripSchema

validateIsNumericColumn