AbstractJDBCConnectorProvider (Hive Metastore Server 4.0.0 API)

java.lang.Object
- org.apache.hadoop.hive.metastore.dataconnector.AbstractDataConnectorProvider
- - org.apache.hadoop.hive.metastore.dataconnector.jdbc.AbstractJDBCConnectorProvider

All Implemented Interfaces:

IDataConnectorProvider

Direct Known Subclasses:

DerbySQLConnectorProvider, HiveJDBCConnectorProvider, MSSQLConnectorProvider, MySQLConnectorProvider, OracleConnectorProvider, PostgreSQLConnectorProvider
```
public abstract class AbstractJDBCConnectorProvider
extends AbstractDataConnectorProvider
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JDBC_CATALOG`
`static String`	`JDBC_CONFIG_PREFIX`
`static String`	`JDBC_CONNECTOR_PREFIX`
`static String`	`JDBC_DATABASE_TYPE`
`static String`	`JDBC_DRIVER`
`static String`	`JDBC_HIVE_STORAGE_HANDLER_ID`
`static String`	`JDBC_KEY`
`static String`	`JDBC_KEYSTORE`
`static String`	`JDBC_LOW_BOUND`
`static String`	`JDBC_NUM_PARTITIONS`
`static String`	`JDBC_PARTITION_COLUMN`
`static String`	`JDBC_PASSWORD`
`static String`	`JDBC_QUERY`
`static String`	`JDBC_QUERY_FIELD_NAMES`
`static String`	`JDBC_QUERY_FIELD_TYPES`
`static String`	`JDBC_SCHEMA`
`static String`	`JDBC_SPLIT_QUERY`
`static String`	`JDBC_TABLE`
`static String`	`JDBC_UPPER_BOUND`
`static String`	`JDBC_URL`
`static String`	`JDBC_USERNAME`
`protected static Warehouse`	`warehouse`

Fields inherited from class org.apache.hadoop.hive.metastore.dataconnector.AbstractDataConnectorProvider
connector, driverClassName, handle, scoped_db

Fields inherited from interface org.apache.hadoop.hive.metastore.dataconnector.IDataConnectorProvider
DERBY_TYPE, HIVE_JDBC_TYPE, MSSQL_TYPE, MYSQL_TYPE, ORACLE_TYPE, POSTGRES_TYPE

Constructor Summary

Constructors
Constructor and Description

AbstractJDBCConnectorProvider(String dbName, DataConnector dataConn, String driverClass)

Constructors
Constructor and Description
`AbstractJDBCConnectorProvider(String dbName, DataConnector dataConn, String driverClass)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes a transport/connection to the datasource.
`protected ResultSet`	`fetchTableMetadata(String tableName)`
`protected ResultSet`	`fetchTableNames()` Returns a list of all table names from the remote database.
`protected abstract String`	`getCatalogName()`
`protected Connection`	`getConnection()`
`protected Properties`	`getConnectionProperties()`
`protected abstract String`	`getDatabaseName()`
`protected String`	`getDatasourceType()`
`protected String`	`getDataType(String mySqlType, int size)`
`protected String`	`getInputClass()`
`protected String`	`getOutputClass()`
`Table`	`getTable(String tableName)` Fetch a single table with the given name, returns a Hive Table object from the remote database
`protected String`	`getTableLocation(String tableName)`
`List<String>`	`getTableNames()` Returns a list of all table names from the remote database.
`List<Table>`	`getTables(String regex)` Returns Hive Table objects from the remote database for tables that match a name pattern.
`protected boolean`	`isClosed()`
`protected boolean`	`isOpen()`
`void`	`open()` Opens a transport/connection to the datasource.
`protected String`	`wrapSize(int size)`

Methods inherited from class org.apache.hadoop.hive.metastore.dataconnector.AbstractDataConnectorProvider
alterTable, buildTableFromColsList, createTable, dropTable, setScope

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

- Field Detail
  - warehouse
```
protected static Warehouse warehouse
```
  - JDBC_HIVE_STORAGE_HANDLER_ID
```
public static final String JDBC_HIVE_STORAGE_HANDLER_ID
```
    See Also:
    
    Constant Field Values
  - JDBC_CONFIG_PREFIX
```
public static final String JDBC_CONFIG_PREFIX
```
    See Also:
    
    Constant Field Values
  - JDBC_CATALOG
```
public static final String JDBC_CATALOG
```
    See Also:
    
    Constant Field Values
  - JDBC_SCHEMA
```
public static final String JDBC_SCHEMA
```
    See Also:
    
    Constant Field Values
  - JDBC_TABLE
```
public static final String JDBC_TABLE
```
    See Also:
    
    Constant Field Values
  - JDBC_DATABASE_TYPE
```
public static final String JDBC_DATABASE_TYPE
```
    See Also:
    
    Constant Field Values
  - JDBC_URL
```
public static final String JDBC_URL
```
    See Also:
    
    Constant Field Values
  - JDBC_DRIVER
```
public static final String JDBC_DRIVER
```
    See Also:
    
    Constant Field Values
  - JDBC_USERNAME
```
public static final String JDBC_USERNAME
```
    See Also:
    
    Constant Field Values
  - JDBC_PASSWORD
```
public static final String JDBC_PASSWORD
```
    See Also:
    
    Constant Field Values
  - JDBC_KEYSTORE
```
public static final String JDBC_KEYSTORE
```
    See Also:
    
    Constant Field Values
  - JDBC_KEY
```
public static final String JDBC_KEY
```
    See Also:
    
    Constant Field Values
  - JDBC_QUERY
```
public static final String JDBC_QUERY
```
    See Also:
    
    Constant Field Values
  - JDBC_QUERY_FIELD_NAMES
```
public static final String JDBC_QUERY_FIELD_NAMES
```
    See Also:
    
    Constant Field Values
  - JDBC_QUERY_FIELD_TYPES
```
public static final String JDBC_QUERY_FIELD_TYPES
```
    See Also:
    
    Constant Field Values
  - JDBC_SPLIT_QUERY
```
public static final String JDBC_SPLIT_QUERY
```
    See Also:
    
    Constant Field Values
  - JDBC_PARTITION_COLUMN
```
public static final String JDBC_PARTITION_COLUMN
```
    See Also:
    
    Constant Field Values
  - JDBC_NUM_PARTITIONS
```
public static final String JDBC_NUM_PARTITIONS
```
    See Also:
    
    Constant Field Values
  - JDBC_LOW_BOUND
```
public static final String JDBC_LOW_BOUND
```
    See Also:
    
    Constant Field Values
  - JDBC_UPPER_BOUND
```
public static final String JDBC_UPPER_BOUND
```
    See Also:
    
    Constant Field Values
  - JDBC_CONNECTOR_PREFIX
```
public static final String JDBC_CONNECTOR_PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractJDBCConnectorProvider
```
public AbstractJDBCConnectorProvider(String dbName,
                                     DataConnector dataConn,
                                     String driverClass)
```
- Method Detail
  - open
```
public void open()
          throws ConnectException
```
    Description copied from class: AbstractDataConnectorProvider
    
    Opens a transport/connection to the datasource. Throws exception if the connection cannot be established.
    
    Specified by:
    
    open in interface IDataConnectorProvider
    
    Overrides:
    
    open in class AbstractDataConnectorProvider
    
    Throws:
    
    ConnectException - if the connection could not be established for some reason.
  - getConnection
```
protected Connection getConnection()
```
  - isOpen
```
protected boolean isOpen()
```
  - isClosed
```
protected boolean isClosed()
```
  - close
```
public void close()
```
    Description copied from class: AbstractDataConnectorProvider
    
    Closes a transport/connection to the datasource.
    
    Specified by:
    
    close in interface IDataConnectorProvider
    
    Overrides:
    
    close in class AbstractDataConnectorProvider
  - getTables
```
public List<Table> getTables(String regex)
                      throws MetaException
```
    Returns Hive Table objects from the remote database for tables that match a name pattern.
    
    Specified by:
    
    getTables in interface IDataConnectorProvider
    
    Overrides:
    
    getTables in class AbstractDataConnectorProvider
    
    Parameters:
    
    regex -
    
    Returns:
    
    List A collection of objects that match the name pattern, null otherwise.
    
    Throws:
    
    MetaException - To indicate any failures with executing this API
  - getTableNames
```
public List<String> getTableNames()
                           throws MetaException
```
    Returns a list of all table names from the remote database.
    
    Specified by:
    
    getTableNames in interface IDataConnectorProvider
    
    Overrides:
    
    getTableNames in class AbstractDataConnectorProvider
    
    Returns:
    
    List A collection of all the table names, null if there are no tables.
    
    Throws:
    
    MetaException - To indicate any failures with executing this API
  - fetchTableMetadata
```
protected ResultSet fetchTableMetadata(String tableName)
                                throws MetaException
```
    Throws:
    
    MetaException
  - fetchTableNames
```
protected ResultSet fetchTableNames()
                             throws MetaException
```
    Returns a list of all table names from the remote database.
    
    Returns:
    
    List A collection of all the table names, null if there are no tables.
    
    Throws:
    
    MetaException - To indicate any failures with executing this API
  - getCatalogName
```
protected abstract String getCatalogName()
```
  - getDatabaseName
```
protected abstract String getDatabaseName()
```
  - getTable
```
public Table getTable(String tableName)
               throws MetaException
```
    Fetch a single table with the given name, returns a Hive Table object from the remote database
    
    Specified by:
    
    getTable in interface IDataConnectorProvider
    
    Overrides:
    
    getTable in class AbstractDataConnectorProvider
    
    Parameters:
    
    tableName -
    
    Returns:
    
    Table A Table object for the matching table, null otherwise.
    
    Throws:
    
    MetaException - To indicate any failures with executing this API
  - wrapSize
```
protected String wrapSize(int size)
```
  - getDataType
```
protected String getDataType(String mySqlType,
                             int size)
```
  - getInputClass
```
protected String getInputClass()
```
    Specified by:
    
    getInputClass in class AbstractDataConnectorProvider
  - getOutputClass
```
protected String getOutputClass()
```
    Specified by:
    
    getOutputClass in class AbstractDataConnectorProvider
  - getTableLocation
```
protected String getTableLocation(String tableName)
```
    Specified by:
    
    getTableLocation in class AbstractDataConnectorProvider
  - getConnectionProperties
```
protected Properties getConnectionProperties()
```
  - getDatasourceType
```
protected String getDatasourceType()
```
    Specified by:
    
    getDatasourceType in class AbstractDataConnectorProvider

Class AbstractJDBCConnectorProvider

Field Summary

Fields inherited from class org.apache.hadoop.hive.metastore.dataconnector.AbstractDataConnectorProvider

Fields inherited from interface org.apache.hadoop.hive.metastore.dataconnector.IDataConnectorProvider

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hive.metastore.dataconnector.AbstractDataConnectorProvider

Methods inherited from class java.lang.Object

Field Detail

warehouse

JDBC_HIVE_STORAGE_HANDLER_ID

JDBC_CONFIG_PREFIX

JDBC_CATALOG

JDBC_SCHEMA

JDBC_TABLE

JDBC_DATABASE_TYPE

JDBC_URL

JDBC_DRIVER

JDBC_USERNAME

JDBC_PASSWORD

JDBC_KEYSTORE

JDBC_KEY

JDBC_QUERY

JDBC_QUERY_FIELD_NAMES

JDBC_QUERY_FIELD_TYPES

JDBC_SPLIT_QUERY

JDBC_PARTITION_COLUMN

JDBC_NUM_PARTITIONS

JDBC_LOW_BOUND

JDBC_UPPER_BOUND

JDBC_CONNECTOR_PREFIX

Constructor Detail

AbstractJDBCConnectorProvider

Method Detail

open

getConnection

isOpen

isClosed

close

getTables

getTableNames

fetchTableMetadata

fetchTableNames

getCatalogName

getDatabaseName

getTable

wrapSize

getDataType

getInputClass

getOutputClass

getTableLocation

getConnectionProperties

getDatasourceType