Package io.permazen.kv.cockroach

Class CockroachKVDatabase

java.lang.Object

io.permazen.kv.sql.SQLKVDatabase

io.permazen.kv.cockroach.CockroachKVDatabase

All Implemented Interfaces:

KVDatabase

public class CockroachKVDatabase
extends SQLKVDatabase

KVDatabase implementation based on CockroachDB.

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

Field Summary

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
CockroachKVDatabase()

Method Summary

Modifier and Type	Method	Description
protected void	beginTransaction(Connection connection)	Open a new SQL transaction on the given Connection.
String	createPutStatement()	Create an SQL statement that inserts the key/value pair with key ?1 and value ?2 A row with key ?1 may already exist; if so, the value should be updated to ?2 (if syntax requires it, the value may be updated to ?3 instead; ?3, if it exists, will be set to the same value as ?2).
protected io.permazen.kv.cockroach.CockroachKVTransaction	createSQLKVTransaction(Connection connection)	Create a new SQLKVTransaction for a new transaction given the specified Connection.
protected void	initializeDatabaseIfNecessary(Connection connection)	Perform any required database initialization.
String	limitSingleRow(String sql)	Appends LIMIT 1 to the statement.
protected void	postBeginTransaction(Connection connection)	Subclass hook invoked just after opening a new SQL transaction.
String	quote(String name)	Encloses the given name in backticks.
KVTransactionException	wrapException(SQLKVTransaction tx, SQLException e)	Wrap the given SQLException in the appropriate KVTransactionException.

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

configureConnection, createGetAllStatement, createGetAtLeastStatement, createGetAtMostStatement, createGetRangeStatement, createGetStatement, createRemoveAllStatement, createRemoveAtLeastStatement, createRemoveAtMostStatement, createRemoveRangeStatement, createRemoveStatement, createTransaction, createTransaction, createTransactionConnection, getDataSource, getIsolationLevel, getIsolationLevel, getKeyColumnName, getTableName, getValueColumnName, isRollbackForReadOnly, 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

Constructor Details

CockroachKVDatabase

public CockroachKVDatabase()

Method Details

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

beginTransaction

protected void beginTransaction(Connection connection)
                         throws SQLException

Description copied from class: SQLKVDatabase

Open a new SQL transaction on the given Connection.

The implementation in SQLKVDatabase invokes Connection.setAutoCommit(false).

Overrides:

beginTransaction in class SQLKVDatabase

Parameters:

connection - the Connection for a new transaction

Throws:

SQLException - if an error occurs

See Also:

• createSQLKVTransaction()

postBeginTransaction

protected void postBeginTransaction(Connection connection)
                             throws SQLException

Description copied from class: SQLKVDatabase

Subclass hook invoked just after opening a new SQL transaction.

The implementation in SQLKVDatabase does nothing. Note: subclasses must ensure the transaction is configured for the IsolationLevel configured on this instance.

Overrides:

postBeginTransaction in class SQLKVDatabase

Parameters:

connection - the Connection for a new transaction

Throws:

SQLException - if an error occurs

See Also:

• createSQLKVTransaction()

createSQLKVTransaction

protected io.permazen.kv.cockroach.CockroachKVTransaction 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

createPutStatement

public String createPutStatement()

Description copied from class: SQLKVDatabase

Create an SQL statement that inserts the key/value pair with key ?1 and value ?2 A row with key ?1 may already exist; if so, the value should be updated to ?2 (if syntax requires it, the value may be updated to ?3 instead; ?3, if it exists, will be set to the same value as ?2).

Overrides:

createPutStatement in class SQLKVDatabase

Returns:

SQL insertion statement

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