org.apache.hadoop.hive.metastore.dataconnector

Interface IDataConnectorProvider

All Known Implementing Classes:

AbstractDataConnectorProvider, AbstractJDBCConnectorProvider, DerbySQLConnectorProvider, HiveJDBCConnectorProvider, MSSQLConnectorProvider, MySQLConnectorProvider, OracleConnectorProvider, PostgreSQLConnectorProvider

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public interface IDataConnectorProvider

This interface provides a way for us to plugin different datasources into hive. Each implementing class plugs in a new datasource type that the hive metastore can then call on The implementing class understand the hive model objects and provide the translation between hive and the native datasource.

Field Summary

Fields

Modifier and Type	Field and Description
static DataConnector	connector
static String	DERBY_TYPE
static String	HIVE_JDBC_TYPE
static String	MSSQL_TYPE
static String	MYSQL_TYPE
static String	ORACLE_TYPE
static String	POSTGRES_TYPE

Method Summary

Modifier and Type	Method and Description
boolean	alterTable(String tableName, Table newTable) Alter an existing table in the remote data source.
void	close() Closes a transport/connection to the datasource.
boolean	createTable(Table table) Creates a table with the given name in the remote data source.
boolean	dropTable(String tableName) Drop an existing table with the given name in the remote data source.
Table	getTable(String tableName) Fetch a single table with the given name, returns a Hive Table object from the remote database
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.
void	open() Opens a transport/connection to the datasource.
void	setScope(String databaseName) Set the scope of this object.

Field Detail

MYSQL_TYPE

static final String MYSQL_TYPE

See Also:

Constant Field Values

POSTGRES_TYPE

static final String POSTGRES_TYPE

See Also:

Constant Field Values

ORACLE_TYPE

static final String ORACLE_TYPE

See Also:

Constant Field Values

MSSQL_TYPE

static final String MSSQL_TYPE

See Also:

Constant Field Values

DERBY_TYPE

static final String DERBY_TYPE

See Also:

Constant Field Values

HIVE_JDBC_TYPE

static final String HIVE_JDBC_TYPE

See Also:

Constant Field Values

connector

static final DataConnector connector

Method Detail

open

void open()
   throws ConnectException,
          MetaException

Opens a transport/connection to the datasource. Throws exception if the connection cannot be established.

Throws:

MetaException - Throws MetaException if the connector does not have all info for a connection to be setup.

ConnectException - if the connection could not be established for some reason.

close

void close()
    throws ConnectException

Closes a transport/connection to the datasource.

Throws:

ConnectException - if the connection could not be closed.

setScope

void setScope(String databaseName)

Set the scope of this object.

getTables

List<Table> getTables(String regex)
               throws MetaException

Returns Hive Table objects from the remote database for tables that match a name pattern.

Returns:

List A collection of objects that match the name pattern, null otherwise.

Throws:

MetaException - To indicate any failures with executing this API

getTableNames

List<String> getTableNames()
                    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

getTable

Table getTable(String tableName)
        throws MetaException

Fetch a single table with the given name, returns a Hive Table object from the remote database

Returns:

Table A Table object for the matching table, null otherwise.

Throws:

MetaException - To indicate any failures with executing this API

createTable

boolean createTable(Table table)
             throws MetaException

Creates a table with the given name in the remote data source. Conversion between hive data types and native data types is handled by the provider.

Parameters:

table - A Hive table object to translate and create in remote data source.

Returns:

boolean True if the operation succeeded or false otherwise

Throws:

MetaException - To indicate any failures in executing this operation.

dropTable

boolean dropTable(String tableName)
           throws MetaException

Drop an existing table with the given name in the remote data source.

Parameters:

tableName - Table name to drop from the remote data source.

Returns:

boolean True if the operation succeeded or false otherwise

Throws:

MetaException - To indicate any failures in executing this operation.

alterTable

boolean alterTable(String tableName,
                   Table newTable)
            throws MetaException

Alter an existing table in the remote data source.

Parameters:

tableName - Table name to alter in the remote datasource.

newTable - New Table object to modify the existing table with.

Returns:

boolean True if the operation succeeded or false otherwise.

Throws:

MetaException - To indicate any failures in executing this operation.