Package io.permazen.kv.mysql

Class MySQLKVDatabase

java.lang.Object

io.permazen.kv.sql.SQLKVDatabase

io.permazen.kv.mysql.MySQLKVDatabase

All Implemented Interfaces:

KVDatabase

public class MySQLKVDatabase
extends SQLKVDatabase

MySQL variant of SQLKVDatabase.

Automatically creates the key/value table on startup if it doesn't already exist.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INNODB_LARGE_INDEX_SIZE
static final int	INNODB_NORMAL_INDEX_SIZE

Fields inherited from class io.permazen.kv.sql.SQLKVDatabase

dataSource, DEFAULT_KEY_COLUMN_NAME, DEFAULT_TABLE_NAME, DEFAULT_VALUE_COLUMN_NAME, isolationLevel, keyColumnName, log, OPTION_ISOLATION, tableName, valueColumnName

Constructor Summary

Constructors

Constructor	Description
MySQLKVDatabase()

Method Summary

Modifier and Type	Method	Description
protected void	configureConnection(Connection connection)	Configure a newly created Connection.
protected SQLKVTransaction	createSQLKVTransaction(Connection connection)	Create a new SQLKVTransaction for a new transaction given the specified Connection.
int	getLockTimeout()	Get the lock timeout with which to configure new transactions.
protected void	initializeDatabaseIfNecessary(Connection connection)	Perform any required database initialization.
String	limitSingleRow(String sql)	Appends LIMIT 1 to the statement.
String	quote(String name)	Encloses the given name in backticks.
void	setInnodbLargePrefix(boolean innodbLargePrefix)	Configure the use of InnoDB large prefixes.
void	setLockTimeout(int lockTimeout)
KVTransactionException	wrapException(SQLKVTransaction tx, SQLException e)	Wrap the given SQLException in the appropriate KVTransactionException.

Methods inherited from class io.permazen.kv.sql.SQLKVDatabase

beginTransaction, createGetAllStatement, createGetAtLeastStatement, createGetAtMostStatement, createGetRangeStatement, createGetStatement, createPutStatement, createRemoveAllStatement, createRemoveAtLeastStatement, createRemoveAtMostStatement, createRemoveRangeStatement, createRemoveStatement, createTransaction, createTransaction, createTransactionConnection, getDataSource, getIsolationLevel, getIsolationLevel, getKeyColumnName, getTableName, getValueColumnName, isRollbackForReadOnly, postBeginTransaction, preBeginTransaction, setDataSource, setIsolationLevel, setKeyColumnName, setRollbackForReadOnly, setTableName, setValueColumnName, start, stop

Methods inherited from class java.lang.Object

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

Field Details

INNODB_NORMAL_INDEX_SIZE

public static final int INNODB_NORMAL_INDEX_SIZE

See Also:

• Constant Field Values

INNODB_LARGE_INDEX_SIZE

public static final int INNODB_LARGE_INDEX_SIZE

See Also:

• Constant Field Values

Constructor Details

MySQLKVDatabase

public MySQLKVDatabase()

Method Details

setInnodbLargePrefix

public void setInnodbLargePrefix(boolean innodbLargePrefix)

Configure the use of InnoDB large prefixes.

MySQL InnoDB indexes are normally limited to 767 bytes, but you can go up to 3072 bytes if you set these parameters in /etc/my.cnf:

  [mysqld]
  innodb_large_prefix      = true
  innodb_file_per_table    = true
  innodb_file_format       = barracuda
 

Setting this property to true increases the maximum key length from 767 to 3072 bytes and adds ROW_FORMAT=DYNAMIC to the table creation statement in initializeDatabaseIfNecessary(). This property has no effect if the table already exists at startup.

Default is false.

Parameters:

innodbLargePrefix - true for InnoDB large prefixes

See Also:

• Limits on InnoDB Tables

getLockTimeout

public int getLockTimeout()

Get the lock timeout with which to configure new transactions.

Default is 3.

Returns:

lock timeout for new transactions

setLockTimeout

public void setLockTimeout(int lockTimeout)

initializeDatabaseIfNecessary

protected void initializeDatabaseIfNecessary(Connection connection)
                                      throws SQLException

Description copied from class: SQLKVDatabase

Perform any required database initialization.

The implementation in SQLKVDatabase does nothing. Subclasses will typically invoke CREATE TABLE ... IF NOT EXISTS here, etc.

Overrides:

initializeDatabaseIfNecessary in class SQLKVDatabase

Parameters:

connection - open database connection (will be closed by the caller of this method)

Throws:

SQLException - if an error occurs

configureConnection

protected void configureConnection(Connection connection)
                            throws SQLException

Description copied from class: SQLKVDatabase

Configure a newly created Connection.

The implementation in SQLKVDatabase does nothing.

Overrides:

configureConnection in class SQLKVDatabase

Parameters:

connection - newly created Connection

Throws:

SQLException - if an error occurs

createSQLKVTransaction

protected SQLKVTransaction createSQLKVTransaction(Connection connection)
                                           throws SQLException

Description copied from class: SQLKVDatabase

Create a new SQLKVTransaction for a new transaction given the specified Connection. There will already be an SQL transaction open on connection.

The implementation in SQLKVDatabase just invokes new SQLKVTransaction(this, connection).

Overrides:

createSQLKVTransaction in class SQLKVDatabase

Parameters:

connection - the Connection for a new transaction

Returns:

newly created transaction

Throws:

SQLException - if an error occurs

quote

public String quote(String name)

Encloses the given name in backticks.

Overrides:

quote in class SQLKVDatabase

Parameters:

name - table or column name

Returns:

name enquoted as necessary for this database type

limitSingleRow

public String limitSingleRow(String sql)

Appends LIMIT 1 to the statement.

Overrides:

limitSingleRow in class SQLKVDatabase

Parameters:

sql - SQL statement

Returns:

SQL statement

wrapException

public KVTransactionException wrapException(SQLKVTransaction tx,
 SQLException e)

Description copied from class: SQLKVDatabase

Wrap the given SQLException in the appropriate KVTransactionException.

Overrides:

wrapException in class SQLKVDatabase

Parameters:

tx - the SQLKVTransaction in which the exception occured

e - SQL exception

Returns:

appropriate KVTransactionException with chained exception e