oracle.pg.rdbms.pgql

Class DbmsUtils

java.lang.Object

oracle.pg.rdbms.pgql.DbmsUtils

public class DbmsUtils
extends java.lang.Object

This class implements various methods for database-related operations.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DB_18C
static int	DB_19C
static int	DB_20C
static double	OPG_20_1
static double	OPG_20_3
static double	OPG_NOT_AVAILABLE
static double	OPG_PATCH_NOT_INSTALLED
static int	ORA_INVALID_ID
static int	ORA_LITERAL_TOO_LONG

Constructor Summary

Constructors

Constructor and Description
DbmsUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	enquoteTableName(java.sql.Connection conn, java.lang.String tableName) Returns a sanitized enquoted table name.
static java.lang.String	escapeAndEnquoteLiteral(java.lang.String str) Does a SQL escape of single quotes and enquotes the literal
static java.lang.String	escapeAndEnquoteLiteral(java.lang.String str, boolean forNVarchar) Does a SQL escape of single quotes and enquotes the literal
static PgqlResultElement	getPgqlResultElement(java.sql.ResultSet rs, PgqlColumnDescriptor colDesc) Creates and returns a PgqlResultElement object from the passed in ResultSet object.
static java.lang.StringBuffer	getQueryWrapper(java.lang.String query, int parallel, int dynamicSampling) Wraps the given query to add a hint for parallel and dynamic sampling
static java.lang.StringBuffer	getQueryWrapper(java.lang.String query, int maxResults, int parallel, int dynamicSampling) Wraps the given query to limit the number of results that will be returned and also to add a hint for parallel and dynamic sampling
static void	quietlyCloseResultSetAndStmt(java.sql.ResultSet rs, java.sql.Statement stmt) Closes (in a best effort fashion) the provided result set and its corresponding statement.
static java.lang.Object	readObjFromResultSet(java.sql.ResultSet rs, int idxTypeCol) Reads a few columns: T, V, VN, VT from the result set and constructs an Object (V in a K/V pair) depending on the actual object type.
static java.lang.String	sanitizeGraphName(java.sql.Connection conn, java.lang.String graphName) Returns a sanitized version of graphName.
static java.lang.String	sanitizeGraphOwner(java.sql.Connection conn, java.lang.String ownerName) Returns a sanitized graph owner name.
static java.lang.String	upperCaseSimpleIdentifier(java.sql.Connection conn, java.lang.String identifier) Returns an upper-case version if this is a simple identifier.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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

OPG_20_1

public static final double OPG_20_1

See Also:

Constant Field Values

OPG_20_3

public static final double OPG_20_3

See Also:

Constant Field Values

OPG_NOT_AVAILABLE

public static final double OPG_NOT_AVAILABLE

See Also:

Constant Field Values

OPG_PATCH_NOT_INSTALLED

public static final double OPG_PATCH_NOT_INSTALLED

See Also:

Constant Field Values

ORA_INVALID_ID

public static final int ORA_INVALID_ID

See Also:

Constant Field Values

ORA_LITERAL_TOO_LONG

public static final int ORA_LITERAL_TOO_LONG

See Also:

Constant Field Values

Constructor Detail

DbmsUtils

public DbmsUtils()

Method Detail

enquoteTableName

public static java.lang.String enquoteTableName(java.sql.Connection conn,
                                                java.lang.String tableName)
                                         throws java.sql.SQLException

Returns a sanitized enquoted table name.

Parameters:

conn - the database connection (must be an OracleConnection)

tableName - the table name to check

Returns:

an enquoted version of tableName that is free of SQL injection

Throws:

java.sql.SQLException - when the given name is illegal

escapeAndEnquoteLiteral

public static java.lang.String escapeAndEnquoteLiteral(java.lang.String str)
                                                throws PgqlToSqlException

Does a SQL escape of single quotes and enquotes the literal

Parameters:

str - the string to escape

Returns:

enquoted str with single quotes escaped

Throws:

PgqlToSqlException

escapeAndEnquoteLiteral

public static java.lang.String escapeAndEnquoteLiteral(java.lang.String str,
                                                       boolean forNVarchar)
                                                throws PgqlToSqlException

Does a SQL escape of single quotes and enquotes the literal

Parameters:

str - the string to escape

forNVarchar - true if should wrap literal with n''

Returns:

enquoted str with single quotes escaped

Throws:

PgqlToSqlException

getPgqlResultElement

public static PgqlResultElement getPgqlResultElement(java.sql.ResultSet rs,
                                                     PgqlColumnDescriptor colDesc)
                                              throws java.sql.SQLException,
                                                     oracle.pgql.lang.PgqlException

Creates and returns a PgqlResultElement object from the passed in ResultSet object. Values are read from the current position in rs and colDesc describes the expected values and column offset in rs.

Parameters:

rs - the JDBC ResultSet to read the query result from

colDesc - a descriptor for the expected component values

Returns:

a new OraclePgqlResultElement object for the PGQL result element described by colDesc

Throws:

java.sql.SQLException - when an error occurs getting the object

oracle.pgql.lang.PgqlException - when the object has an unexpected type

getQueryWrapper

public static java.lang.StringBuffer getQueryWrapper(java.lang.String query,
                                                     int parallel,
                                                     int dynamicSampling)

Wraps the given query to add a hint for parallel and dynamic sampling

Parameters:

query - the query to wrap

parallel - the parallel value to apply if bigger than 0

dynamicSampling - the dynamic sampling value to apply if different from defaultDs

Returns:

query wrapped with appropriate hints to achieve the desired settings

getQueryWrapper

public static java.lang.StringBuffer getQueryWrapper(java.lang.String query,
                                                     int maxResults,
                                                     int parallel,
                                                     int dynamicSampling)

Wraps the given query to limit the number of results that will be returned and also to add a hint for parallel and dynamic sampling

Parameters:

query - the query to wrap

maxResults - the maximum number of results desired

parallel - the parallel value to apply if bigger than 0

dynamicSampling - the dynamic sampling value to apply if different from DEFAULT_DS

Returns:

query wrapped with appropriate hints and ROWNUM clause to achieve the desired settings

quietlyCloseResultSetAndStmt

public static void quietlyCloseResultSetAndStmt(java.sql.ResultSet rs,
                                                java.sql.Statement stmt)

Closes (in a best effort fashion) the provided result set and its corresponding statement.

Parameters:

rs - the result set to close

stmt - the statement to close

readObjFromResultSet

public static java.lang.Object readObjFromResultSet(java.sql.ResultSet rs,
                                                    int idxTypeCol)
                                             throws java.sql.SQLException,
                                                    oracle.pgql.lang.PgqlException

Reads a few columns: T, V, VN, VT from the result set and constructs an Object (V in a K/V pair) depending on the actual object type.

Parameters:

rs - a JDBC result set

idxTypeCol - column index (integer) of the data type column (T)

Returns:

the object in the result set at the given index

Throws:

java.sql.SQLException - when an error occurs getting the object

oracle.pgql.lang.PgqlException - when the object has an unexpected type

sanitizeGraphName

public static java.lang.String sanitizeGraphName(java.sql.Connection conn,
                                                 java.lang.String graphName)
                                          throws java.sql.SQLException,
                                                 PgqlToSqlException

Returns a sanitized version of graphName. Enforces that graphName is a simple SQL name and returns an upper-case version of graphName.

Parameters:

conn - the database connection (must be an OracleConnection)

graphName - the graph name to check

Returns:

a sanitized version of graphName that is free of SQL injection

Throws:

java.sql.SQLException - when the given name is illegal

PgqlToSqlException - when the given name is not a simple identifier

sanitizeGraphOwner

public static java.lang.String sanitizeGraphOwner(java.sql.Connection conn,
                                                  java.lang.String ownerName)
                                           throws java.sql.SQLException

Returns a sanitized graph owner name. If ownerName is a simple SQL name it will be returned in upper-case without double quotes. If ownerName is not a simple SQL name it will be returned as-is but surrounded with double quotes. A SQLException will be thrown if ownerName is not a valid SQL identifier.

Parameters:

conn - the database connection (must be an OracleConnection)

ownerName - the database user name to check

Returns:

a sanitized version of ownerName that is free of SQL injection

Throws:

java.sql.SQLException - when the given name is illegal

upperCaseSimpleIdentifier

public static java.lang.String upperCaseSimpleIdentifier(java.sql.Connection conn,
                                                         java.lang.String identifier)
                                                  throws java.sql.SQLException

Returns an upper-case version if this is a simple identifier. If ownerName is not a simple SQL name it will be returned as-is.

Parameters:

conn - the database connection (must be an OracleConnection)

identifier - the database identifier to check

Returns:

a upper-case version of simple SQL identifier

Throws:

java.sql.SQLException - when the given identifier is illegal