io.cdap.plugin

Class DBUtils

java.lang.Object

io.cdap.plugin.DBUtils

public final class DBUtils
extends Object

Utility methods for Database plugins shared by Database plugins.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_ARGUMENTS
static String	FETCH_SIZE
static String	OVERRIDE_SCHEMA
static String	PATTERN_TO_REPLACE
static String	REPLACE_WITH

Method Summary

Modifier and Type	Method and Description
static void	cleanup(Class<? extends Driver> driverClass) Performs any Database related cleanup
static void	deregisterAllDrivers(Class<? extends Driver> driverClass) De-register all SQL drivers that are associated with the class
static DriverCleanup	ensureJDBCDriverIsAvailable(Class<? extends Driver> jdbcDriverClass, String connectionString, String jdbcPluginType, String jdbcPluginName) Ensures that the JDBC Driver specified in configuration is available and can be loaded.
static List<io.cdap.cdap.api.data.schema.Schema.Field>	getOriginalSchema(ResultSet resultSet) Given the result set, get the metadata of the result set and return list of Schema.Field, where name of the field is same as column name and type of the field is obtained using DBUtils#getSchema(int, int, int)
static List<io.cdap.cdap.api.data.schema.Schema.Field>	getSchemaFields(ResultSet resultSet, String patternToReplace, String replaceWith) Given the result set, get the metadata of the result set and return list of Schema.Field, where name of the field is same as column name and type of the field is obtained using DBUtils#getSchema(String, int, int, int, String)
static List<io.cdap.cdap.api.data.schema.Schema.Field>	getSchemaFields(io.cdap.cdap.api.data.schema.Schema resultsetSchema, String schemaStr) Given the result set, get the metadata of the result set and return list of Schema.Field, where name of the field is same as column name and type of the field is obtained using DBUtils#getSchema(String, int, int, int, String)
static Object	transformValue(int sqlType, int precision, int scale, ResultSet resultSet, String fieldName)

Methods inherited from class java.lang.Object

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

Field Detail

OVERRIDE_SCHEMA

public static final String OVERRIDE_SCHEMA

See Also:

Constant Field Values

PATTERN_TO_REPLACE

public static final String PATTERN_TO_REPLACE

See Also:

Constant Field Values

REPLACE_WITH

public static final String REPLACE_WITH

See Also:

Constant Field Values

CONNECTION_ARGUMENTS

public static final String CONNECTION_ARGUMENTS

See Also:

Constant Field Values

FETCH_SIZE

public static final String FETCH_SIZE

See Also:

Constant Field Values

Method Detail

cleanup

public static void cleanup(Class<? extends Driver> driverClass)

Performs any Database related cleanup

Parameters:

driverClass - the JDBC driver class

ensureJDBCDriverIsAvailable

public static DriverCleanup ensureJDBCDriverIsAvailable(Class<? extends Driver> jdbcDriverClass,
                                                        String connectionString,
                                                        String jdbcPluginType,
                                                        String jdbcPluginName)
                                                 throws IllegalAccessException,
                                                        InstantiationException,
                                                        SQLException

Ensures that the JDBC Driver specified in configuration is available and can be loaded. Also registers it with DriverManager if it is not already registered.

Throws:

IllegalAccessException

InstantiationException

SQLException

getSchemaFields

public static List<io.cdap.cdap.api.data.schema.Schema.Field> getSchemaFields(io.cdap.cdap.api.data.schema.Schema resultsetSchema,
                                                                              @Nullable
                                                                              String schemaStr)

Given the result set, get the metadata of the result set and return list of Schema.Field, where name of the field is same as column name and type of the field is obtained using DBUtils#getSchema(String, int, int, int, String)

Parameters:

resultsetSchema - the schema from the db

schemaStr - schema string to override resultant schema

Returns:

list of schema fields

getOriginalSchema

public static List<io.cdap.cdap.api.data.schema.Schema.Field> getOriginalSchema(ResultSet resultSet)
                                                                         throws SQLException

Given the result set, get the metadata of the result set and return list of Schema.Field, where name of the field is same as column name and type of the field is obtained using DBUtils#getSchema(int, int, int)

Parameters:

resultSet - result set of executed query

Returns:

list of schema fields

Throws:

SQLException

getSchemaFields

public static List<io.cdap.cdap.api.data.schema.Schema.Field> getSchemaFields(ResultSet resultSet,
                                                                              @Nullable
                                                                              String patternToReplace,
                                                                              @Nullable
                                                                              String replaceWith)
                                                                       throws SQLException

Given the result set, get the metadata of the result set and return list of Schema.Field, where name of the field is same as column name and type of the field is obtained using DBUtils#getSchema(String, int, int, int, String)

Parameters:

resultSet - result set of executed query

patternToReplace - the pattern to replace in the field name

replaceWith - the replacement value, if it is null, the pattern will be removed

Returns:

list of schema fields

Throws:

SQLException

transformValue

@Nullable
public static Object transformValue(int sqlType,
                                              int precision,
                                              int scale,
                                              ResultSet resultSet,
                                              String fieldName)
                                       throws SQLException

Throws:

SQLException

deregisterAllDrivers

public static void deregisterAllDrivers(Class<? extends Driver> driverClass)
                                 throws NoSuchFieldException,
                                        IllegalAccessException,
                                        ClassNotFoundException

De-register all SQL drivers that are associated with the class

Throws:

NoSuchFieldException

IllegalAccessException

ClassNotFoundException