org.apache.hadoop.hbase.client

Class ConnectionFactory

java.lang.Object

org.apache.hadoop.hbase.client.ConnectionFactory

Direct Known Subclasses:

HConnectionManager

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class ConnectionFactory
extends Object

A non-instantiable class that manages creation of Connections. Managing the lifecycle of the Connections to the cluster is the responsibility of the caller. From a Connection, Table implementations are retrieved with Connection.getTable(TableName). Example:

 Connection connection = ConnectionFactory.createConnection(config);
 Table table = connection.getTable(TableName.valueOf("table1"));
 try {
   // Use the table as needed, for a single operation and a single thread
 } finally {
   table.close();
   connection.close();
 }
 

Similarly, Connection also returns Admin and RegionLocator implementations. This class replaces HConnectionManager, which is now deprecated.

Since:

0.99.0

See Also:

Connection

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConnectionFactory() No public c.tors

Method Summary

Methods

Modifier and Type	Method and Description
static Connection	createConnection() Create a new Connection instance using default HBaseConfiguration.
static Connection	createConnection(org.apache.hadoop.conf.Configuration conf) Create a new Connection instance using the passed conf instance.
static Connection	createConnection(org.apache.hadoop.conf.Configuration conf, ExecutorService pool) Create a new Connection instance using the passed conf instance.
static Connection	createConnection(org.apache.hadoop.conf.Configuration conf, ExecutorService pool, User user) Create a new Connection instance using the passed conf instance.
static Connection	createConnection(org.apache.hadoop.conf.Configuration conf, User user) Create a new Connection instance using the passed conf instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionFactory

protected ConnectionFactory()

No public c.tors

Method Detail

createConnection

public static Connection createConnection()
                                   throws IOException

Create a new Connection instance using default HBaseConfiguration. Connection encapsulates all housekeeping for a connection to the cluster. All tables and interfaces created from returned connection share zookeeper connection, meta cache, and connections to region servers and masters.
The caller is responsible for calling Connection.close() on the returned connection instance. Typical usage:

 Connection connection = ConnectionFactory.createConnection();
 Table table = connection.getTable(TableName.valueOf("mytable"));
 try {
   table.get(...);
   ...
 } finally {
   table.close();
   connection.close();
 }
 

Returns:

Connection object for conf

Throws:

IOException

createConnection

public static Connection createConnection(org.apache.hadoop.conf.Configuration conf)
                                   throws IOException

Create a new Connection instance using the passed conf instance. Connection encapsulates all housekeeping for a connection to the cluster. All tables and interfaces created from returned connection share zookeeper connection, meta cache, and connections to region servers and masters.
The caller is responsible for calling Connection.close() on the returned connection instance. Typical usage:

 Connection connection = ConnectionFactory.createConnection(conf);
 Table table = connection.getTable(TableName.valueOf("mytable"));
 try {
   table.get(...);
   ...
 } finally {
   table.close();
   connection.close();
 }
 

Parameters:

conf - configuration

Returns:

Connection object for conf

Throws:

IOException

createConnection

public static Connection createConnection(org.apache.hadoop.conf.Configuration conf,
                          ExecutorService pool)
                                   throws IOException

Create a new Connection instance using the passed conf instance. Connection encapsulates all housekeeping for a connection to the cluster. All tables and interfaces created from returned connection share zookeeper connection, meta cache, and connections to region servers and masters.
The caller is responsible for calling Connection.close() on the returned connection instance. Typical usage:

 Connection connection = ConnectionFactory.createConnection(conf);
 Table table = connection.getTable(TableName.valueOf("mytable"));
 try {
   table.get(...);
   ...
 } finally {
   table.close();
   connection.close();
 }
 

Parameters:

conf - configuration

pool - the thread pool to use for batch operations

Returns:

Connection object for conf

Throws:

IOException

createConnection

public static Connection createConnection(org.apache.hadoop.conf.Configuration conf,
                          User user)
                                   throws IOException

Create a new Connection instance using the passed conf instance. Connection encapsulates all housekeeping for a connection to the cluster. All tables and interfaces created from returned connection share zookeeper connection, meta cache, and connections to region servers and masters.
The caller is responsible for calling Connection.close() on the returned connection instance. Typical usage:

 Connection connection = ConnectionFactory.createConnection(conf);
 Table table = connection.getTable(TableName.valueOf("table1"));
 try {
   table.get(...);
   ...
 } finally {
   table.close();
   connection.close();
 }
 

Parameters:

conf - configuration

user - the user the connection is for

Returns:

Connection object for conf

Throws:

IOException

createConnection

public static Connection createConnection(org.apache.hadoop.conf.Configuration conf,
                          ExecutorService pool,
                          User user)
                                   throws IOException

Create a new Connection instance using the passed conf instance. Connection encapsulates all housekeeping for a connection to the cluster. All tables and interfaces created from returned connection share zookeeper connection, meta cache, and connections to region servers and masters.
The caller is responsible for calling Connection.close() on the returned connection instance. Typical usage:

 Connection connection = ConnectionFactory.createConnection(conf);
 Table table = connection.getTable(TableName.valueOf("table1"));
 try {
   table.get(...);
   ...
 } finally {
   table.close();
   connection.close();
 }
 

Parameters:

conf - configuration

user - the user the connection is for

pool - the thread pool to use for batch operations

Returns:

Connection object for conf

Throws:

IOException