io.permazen.kv.mssql

Class MSSQLKVDatabase

java.lang.Object

io.permazen.kv.sql.SQLKVDatabase

io.permazen.kv.mssql.MSSQLKVDatabase

All Implemented Interfaces:

KVDatabase

public class MSSQLKVDatabase
extends SQLKVDatabase

Microsoft SQL Server variant of SQLKVDatabase.

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

Note: Because SQL Server ignores trailing zero bytes when comparing VARBINARY values, we are forced to use "byte stuffing" to encode keys, whereby 0x00 and 0x01 are replaced by 0x0101 and 0x0102, respectively.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_LARGE_KEYS
static boolean	DEFAULT_LARGE_VALUES
static int	DEFAULT_LOCK_TIMEOUT
static String	DEFAULT_SCHEMA

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 and Description
MSSQLKVDatabase()

Method Summary

Modifier and Type	Method and Description
protected void	configureConnection(Connection connection)
String	createPutStatement()
protected SQLKVTransaction	createSQLKVTransaction(Connection connection)
int	getLockTimeout() Get the lock timeout with which to configure new transactions.
String	getSchema() Get schema name.
protected void	initializeDatabaseIfNecessary(Connection connection)
boolean	isLargeKeys() Get whether support for large keys (greater than 8,000 bytes) are enabled.
boolean	isLargeValues() Get whether support for large values (greater than 8,000 bytes) are enabled.
String	limitSingleRow(String sql)
protected String	quoteString(String value) Encloses the given name in single quotes and doubles up any single quotes therein.
void	setLargeKeys(boolean largeKeys)
void	setLargeValues(boolean largeValues)
void	setLockTimeout(int lockTimeout)
void	setSchema(String schema)
KVTransactionException	wrapException(SQLKVTransaction tx, SQLException e)

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

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

DEFAULT_SCHEMA

public static final String DEFAULT_SCHEMA

See Also:

Constant Field Values

DEFAULT_LARGE_KEYS

public static final boolean DEFAULT_LARGE_KEYS

See Also:

Constant Field Values

DEFAULT_LARGE_VALUES

public static final boolean DEFAULT_LARGE_VALUES

See Also:

Constant Field Values

DEFAULT_LOCK_TIMEOUT

public static final int DEFAULT_LOCK_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

MSSQLKVDatabase

public MSSQLKVDatabase()

Method Detail

getSchema

public String getSchema()

Get schema name.

Default is "dbo".

Returns:

schema name

setSchema

public void setSchema(String schema)

isLargeKeys

public boolean isLargeKeys()

Get whether support for large keys (greater than 8,000 bytes) are enabled.

This only affects initial table creation; it will have no effect on an already-initialized database.

Note that if large values are enabled, and any object field containing values greater than 8,000 bytes is indexed, then large keys must also be enabled.

Default is false.

Returns:

true if large key support is enabled

setLargeKeys

public void setLargeKeys(boolean largeKeys)

isLargeValues

public boolean isLargeValues()

Get whether support for large values (greater than 8,000 bytes) are enabled.

This only affects initial table creation; it will have no effect on an already-initialized database.

Note that if large values are enabled, and any object field containing values greater than 8,000 bytes is indexed, then large keys must also be enabled.

Default is true.

Returns:

true if large value support is enabled

setLargeValues

public void setLargeValues(boolean largeValues)

getLockTimeout

public int getLockTimeout()

Get the lock timeout with which to configure new transactions.

Default is 3000.

Returns:

lock timeout for new transactions

setLockTimeout

public void setLockTimeout(int lockTimeout)

initializeDatabaseIfNecessary

protected void initializeDatabaseIfNecessary(Connection connection)
                                      throws SQLException

Overrides:

initializeDatabaseIfNecessary in class SQLKVDatabase

Throws:

SQLException

configureConnection

protected void configureConnection(Connection connection)
                            throws SQLException

Overrides:

configureConnection in class SQLKVDatabase

Throws:

SQLException

createSQLKVTransaction

protected SQLKVTransaction createSQLKVTransaction(Connection connection)
                                           throws SQLException

Overrides:

createSQLKVTransaction in class SQLKVDatabase

Throws:

SQLException

createPutStatement

public String createPutStatement()

Overrides:

createPutStatement in class SQLKVDatabase

quoteString

protected String quoteString(String value)

Encloses the given name in single quotes and doubles up any single quotes therein.

Parameters:

value - string to quote

Returns:

quoted string

limitSingleRow

public String limitSingleRow(String sql)

Overrides:

limitSingleRow in class SQLKVDatabase

wrapException

public KVTransactionException wrapException(SQLKVTransaction tx,
                                            SQLException e)

Overrides:

wrapException in class SQLKVDatabase