Package org.apache.hadoop.hdfs.server.federation.store.driver.impl

Class StateStoreMySQLImpl

java.lang.Object

org.apache.hadoop.hdfs.server.federation.store.driver.StateStoreDriver

org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreBaseImpl

org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreSerializableImpl

org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreMySQLImpl

All Implemented Interfaces:

StateStoreRecordOperations

public class StateStoreMySQLImpl
extends StateStoreSerializableImpl

StateStoreDriver implementation based on MySQL. There is a separate table for each record type. Each table just as two columns, recordKey and recordValue.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONNECTION_DRIVER
static java.lang.String	CONNECTION_PASSWORD
static java.lang.String	CONNECTION_URL
static java.lang.String	CONNECTION_USERNAME
static java.lang.String	SQL_STATE_STORE_CONF_PREFIX

Fields inherited from class org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreSerializableImpl

COLON_MARK, SLASH_MARK

Constructor Summary

Constructors

Constructor	Description
StateStoreMySQLImpl()

Method Summary

Modifier and Type	Method	Description
void	close()	Close the State Store driver connection.
<T extends BaseRecord> QueryResult<T>	get(java.lang.Class<T> clazz)	Get all records of the requested record class from the data store.
boolean	initDriver()	Prepare the driver to access data storage.
<T extends BaseRecord> boolean	initRecordStorage(java.lang.String className, java.lang.Class<T> clazz)	Initialize storage for a single record class.
protected boolean	insertRecord(java.lang.String tableName, java.lang.String key, java.lang.String data)	Insert a record with a given key into the specified table.
boolean	isDriverReady()	Check if the driver is currently running and the data store connection is valid.
<T extends BaseRecord> StateStoreOperationResult	putAll(java.util.List<T> records, boolean allowUpdate, boolean errorIfExists)	Creates multiple records.
protected boolean	recordExists(java.lang.String tableName, java.lang.String key)	Checks if a record with a given key existing in the specified table.
<T extends BaseRecord> int	remove(java.lang.Class<T> clazz, Query<T> query)	Remove multiple records of a specific class that match a query.
<T extends BaseRecord> boolean	removeAll(java.lang.Class<T> clazz)	Remove all records of this class from the store.
protected boolean	removeRecord(java.lang.String tableName, java.lang.String key)	Removes the record with a given key from the specified table.
protected boolean	updateRecord(java.lang.String tableName, java.lang.String key, java.lang.String data)	Updates the record with a given key from the specified table.

Methods inherited from class org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreSerializableImpl

getOriginalPrimaryKey, getPrimaryKey, init, newRecord, serialize, serializeString

Methods inherited from class org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreBaseImpl

get, getMultiple, put, remove

Methods inherited from class org.apache.hadoop.hdfs.server.federation.store.driver.StateStoreDriver

getConf, getIdentifier, getMetrics, getTime, verifyDriverReady

Methods inherited from class java.lang.Object

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

Field Detail

SQL_STATE_STORE_CONF_PREFIX

public static final java.lang.String SQL_STATE_STORE_CONF_PREFIX

See Also:

Constant Field Values

CONNECTION_URL

public static final java.lang.String CONNECTION_URL

See Also:

Constant Field Values

CONNECTION_USERNAME

public static final java.lang.String CONNECTION_USERNAME

See Also:

Constant Field Values

CONNECTION_PASSWORD

public static final java.lang.String CONNECTION_PASSWORD

See Also:

Constant Field Values

CONNECTION_DRIVER

public static final java.lang.String CONNECTION_DRIVER

See Also:

Constant Field Values

Constructor Detail

StateStoreMySQLImpl

public StateStoreMySQLImpl()

Method Detail

initDriver

public boolean initDriver()

Description copied from class: StateStoreDriver

Prepare the driver to access data storage.

Specified by:

initDriver in class StateStoreDriver

Returns:

True if the driver was successfully initialized. If false is returned, the state store will periodically attempt to re-initialize the driver and the router will remain in safe mode until the driver is initialized.

initRecordStorage

public <T extends BaseRecord> boolean initRecordStorage(java.lang.String className,
                                                        java.lang.Class<T> clazz)

Description copied from class: StateStoreDriver

Initialize storage for a single record class.

Specified by:

initRecordStorage in class StateStoreDriver

Type Parameters:

T - Type of the state store record.

Parameters:

className - String reference of the record class to initialize, used to construct paths and file names for the record. Determined by configuration settings for the specific driver.

clazz - Record type corresponding to the provided name.

Returns:

True if successful, false otherwise.

isDriverReady

public boolean isDriverReady()

Description copied from class: StateStoreDriver

Check if the driver is currently running and the data store connection is valid.

Specified by:

isDriverReady in class StateStoreDriver

Returns:

True if the driver is initialized and the data store is ready.

close

public void close()
           throws java.lang.Exception

Description copied from class: StateStoreDriver

Close the State Store driver connection.

Specified by:

close in class StateStoreDriver

Throws:

java.lang.Exception - if something goes wrong while closing the state store driver connection.

get

public <T extends BaseRecord> QueryResult<T> get(java.lang.Class<T> clazz)
                                          throws java.io.IOException

Description copied from interface: StateStoreRecordOperations

Get all records of the requested record class from the data store. To use the default implementations in this class, getAll must return new instances of the records on each call. It is recommended to override the default implementations for better performance.

Type Parameters:

T - Record class of the records.

Parameters:

clazz - Class of record to fetch.

Returns:

List of all records that match the class.

Throws:

java.io.IOException - Throws exception if unable to query the data store.

putAll

public <T extends BaseRecord> StateStoreOperationResult putAll(java.util.List<T> records,
                                                               boolean allowUpdate,
                                                               boolean errorIfExists)
                                                        throws java.io.IOException

Description copied from interface: StateStoreRecordOperations

Creates multiple records. Optionally updates existing records that have the same primary key.

Type Parameters:

T - Record class of the records.

Parameters:

records - List of data records to update or create. All records must be of class clazz.

allowUpdate - True if update of exiting record is allowed.

errorIfExists - True if an error should be returned when inserting an existing record. Only used if allowUpdate = false.

Returns:

The result of the putAll operation.

Throws:

java.io.IOException - Throws exception if unable to query the data store.

removeAll

public <T extends BaseRecord> boolean removeAll(java.lang.Class<T> clazz)
                                         throws java.io.IOException

Description copied from interface: StateStoreRecordOperations

Remove all records of this class from the store.

Type Parameters:

T - Record class of the records.

Parameters:

clazz - Class of records to remove.

Returns:

True if successful.

Throws:

java.io.IOException - Throws exception if unable to query the data store.

remove

public <T extends BaseRecord> int remove(java.lang.Class<T> clazz,
                                         Query<T> query)
                                  throws java.io.IOException

Description copied from interface: StateStoreRecordOperations

Remove multiple records of a specific class that match a query. Requires the getAll implementation to fetch fresh records on each call.

Type Parameters:

T - Record class of the records.

Parameters:

clazz - The class to match the records with.

query - Query to filter what to remove.

Returns:

The number of records removed.

Throws:

java.io.IOException - Throws exception if unable to query the data store.

insertRecord

protected boolean insertRecord(java.lang.String tableName,
                               java.lang.String key,
                               java.lang.String data)

Insert a record with a given key into the specified table.

Parameters:

tableName - Name of table to modify

key - Primary key for the record.

data - The record value for the given record key.

Returns:

True is operation is successful, false otherwise.

updateRecord

protected boolean updateRecord(java.lang.String tableName,
                               java.lang.String key,
                               java.lang.String data)

Updates the record with a given key from the specified table.

Parameters:

tableName - Name of table to modify

key - Primary key for the record.

data - The record value for the given record key.

Returns:

True is operation is successful, false otherwise.

recordExists

protected boolean recordExists(java.lang.String tableName,
                               java.lang.String key)

Checks if a record with a given key existing in the specified table.

Parameters:

tableName - Name of table to modify

key - Primary key for the record.

Returns:

True is operation is successful, false otherwise.

removeRecord

protected boolean removeRecord(java.lang.String tableName,
                               java.lang.String key)

Removes the record with a given key from the specified table.

Parameters:

tableName - Name of table to modify

key - Primary key for the record.

Returns:

True is operation is successful, false otherwise.