org.rvpf.store.server.the.sql.dialect

Interface DialectSupport

All Known Implementing Classes:

DerbyDialect, DialectSupport.Abstract, GenericDialect, H2Dialect, HSQLDialect, MariaDBDialect, PostgreSQLDialect

public interface DialectSupport

Database dialect support.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DialectSupport.Abstract Abstract dialect support.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARCHIVE_TABLE_PROPERTY The name of the archive table.
static String	CATALOG_PROPERTY The name of the database catalog.
static String	DEFAULT_ARCHIVE_TABLE_NAME Default archive table name.
static String	DEFAULT_CATALOG_NAME Default catalog name.
static String	DEFAULT_POINT_COLUMN Default point column.
static String	DEFAULT_SCHEMA_NAME Default schema name.
static String	DEFAULT_SNAPSHOT_TABLE_NAME Default snapshot table name.
static String	DEFAULT_STAMP_COLUMN Default stamp column.
static String	DEFAULT_STATE_COLUMN Default state column.
static String	DEFAULT_VALUE_COLUMN Default value column.
static String	DEFAULT_VERSION_COLUMN Default version column.
static String	POINT_COLUMN_PROPERTY The name of the Point column.
static String	SCHEMA_PROPERTY The name of the database schema.
static String	SNAPSHOT_TABLE_PROPERTY The name of the snapshot table.
static String	STAMP_COLUMN_PROPERTY The name of the Stamp column.
static String	STATE_COLUMN_PROPERTY The name of the State column.
static String	TABLE_PROPERTY The name of the database table.
static String	VALUE_COLUMN_PROPERTY The name of the Value column.
static String	VERSION_COLUMN_PROPERTY The name of the Version column.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getCatalogName() Gets the catalog name.
List<String>	getCreateTableSQL() Gets the SQL for statements that create the table.
ClassDefImpl	getDefaultClientDriverClassDef() Gets the default client driver class definition.
default String	getDefaultConnectionOptions() Gets the default connection options.
default Optional<String>	getDefaultConnectionPassword() Gets the default connection password.
default boolean	getDefaultConnectionShared() Gets the default connection shared indicator.
default String	getDefaultConnectionURL(File storeDataDir, String storeEntityName) Gets the default connection URL.
default String	getDefaultConnectionUser() Gets the default connection user.
StringBuilder	getDeleteSQL(boolean purge) Gets the SQL for a DELETE statement.
String	getDialectName() Gets the dialect name.
StringBuilder	getInsertSQL() Gets the SQL for an INSERT statement.
String	getSchemaName() Gets the schema name.
StringBuilder	getSelectSQL(StoreCursor cursor) Gets the SQL for a SELECT statement.
String	getTableName() Gets the table name.
StringBuilder	getUpdateSQL() Gets the SQL for an UPDATE statement.
void	onFirstConnection(TheStoreConnection connection) Called on the first connection.
Class<? extends Driver>	registerDriver(ClassDef driverClassDef) Registers the JDBC driver.
int	setDeleteStatement(PreparedStatement statement, byte[] point, long startStamp, long finishStamp) Sets a DELETE statement.
int	setInsertStatement(PreparedStatement statement, byte[] point, long stamp, long version, byte[] state, byte[] value) Sets an INSERT statement according to the PointValue.
int	setSelectStatement(PreparedStatement statement, StoreCursor cursor) Sets a SELECT statement according to the Request and request type.
boolean	setUp(Optional<StoreServiceAppImpl> storeAppImpl, File storeDataDir, String storeEntityName) Sets up the basic informations for dialect support.
int	setUpdateStatement(PreparedStatement statement, byte[] point, long stamp, long version, Optional<byte[]> state, Optional<byte[]> value) Sets an UPDATE statement according to the PointValue.
void	tearDown() Tears down what has been set up.

Field Detail

ARCHIVE_TABLE_PROPERTY

static final String ARCHIVE_TABLE_PROPERTY

The name of the archive table.

See Also:

Constant Field Values

CATALOG_PROPERTY

static final String CATALOG_PROPERTY

The name of the database catalog.

See Also:

Constant Field Values

DEFAULT_ARCHIVE_TABLE_NAME

static final String DEFAULT_ARCHIVE_TABLE_NAME

Default archive table name.

See Also:

Constant Field Values

DEFAULT_CATALOG_NAME

static final String DEFAULT_CATALOG_NAME

Default catalog name.

DEFAULT_POINT_COLUMN

static final String DEFAULT_POINT_COLUMN

Default point column.

See Also:

Constant Field Values

DEFAULT_SCHEMA_NAME

static final String DEFAULT_SCHEMA_NAME

Default schema name.

See Also:

Constant Field Values

DEFAULT_SNAPSHOT_TABLE_NAME

static final String DEFAULT_SNAPSHOT_TABLE_NAME

Default snapshot table name.

See Also:

Constant Field Values

DEFAULT_STAMP_COLUMN

static final String DEFAULT_STAMP_COLUMN

Default stamp column.

See Also:

Constant Field Values

DEFAULT_STATE_COLUMN

static final String DEFAULT_STATE_COLUMN

Default state column.

See Also:

Constant Field Values

DEFAULT_VALUE_COLUMN

static final String DEFAULT_VALUE_COLUMN

Default value column.

See Also:

Constant Field Values

DEFAULT_VERSION_COLUMN

static final String DEFAULT_VERSION_COLUMN

Default version column.

See Also:

Constant Field Values

POINT_COLUMN_PROPERTY

static final String POINT_COLUMN_PROPERTY

The name of the Point column.

See Also:

Constant Field Values

SCHEMA_PROPERTY

static final String SCHEMA_PROPERTY

The name of the database schema.

See Also:

Constant Field Values

SNAPSHOT_TABLE_PROPERTY

static final String SNAPSHOT_TABLE_PROPERTY

The name of the snapshot table.

See Also:

Constant Field Values

STAMP_COLUMN_PROPERTY

static final String STAMP_COLUMN_PROPERTY

The name of the Stamp column.

See Also:

Constant Field Values

STATE_COLUMN_PROPERTY

static final String STATE_COLUMN_PROPERTY

The name of the State column.

See Also:

Constant Field Values

TABLE_PROPERTY

static final String TABLE_PROPERTY

The name of the database table.

See Also:

Constant Field Values

VALUE_COLUMN_PROPERTY

static final String VALUE_COLUMN_PROPERTY

The name of the Value column.

See Also:

Constant Field Values

VERSION_COLUMN_PROPERTY

static final String VERSION_COLUMN_PROPERTY

The name of the Version column.

See Also:

Constant Field Values

Method Detail

getCatalogName

@Nonnull
 @CheckReturnValue
Optional<String> getCatalogName()

Gets the catalog name.

Returns:

The catalog name.

getCreateTableSQL

@Nonnull
 @CheckReturnValue
List<String> getCreateTableSQL()

Gets the SQL for statements that create the table.

Returns:

The SQL.

getDefaultClientDriverClassDef

@Nonnull
 @CheckReturnValue
ClassDefImpl getDefaultClientDriverClassDef()

Gets the default client driver class definition.

Returns:

The default client driver class definition.

getDefaultConnectionOptions

@Nonnull
 @CheckReturnValue
default String getDefaultConnectionOptions()

Gets the default connection options.

Returns:

The default connection options.

getDefaultConnectionPassword

@Nonnull
 @CheckReturnValue
default Optional<String> getDefaultConnectionPassword()

Gets the default connection password.

Returns:

The optional default connection password.

getDefaultConnectionShared

@CheckReturnValue
default boolean getDefaultConnectionShared()

Gets the default connection shared indicator.

Returns:

The default connection shared indicator.

getDefaultConnectionURL

@Nonnull
 @CheckReturnValue
default String getDefaultConnectionURL(@Nonnull
                                                                     File storeDataDir,
                                                                     @Nonnull
                                                                     String storeEntityName)

Gets the default connection URL.

Will always fail when not overridden.

Parameters:

storeDataDir - The store data directory.

storeEntityName - The store entity name.

Returns:

The default connection URL.

getDefaultConnectionUser

@Nonnull
 @CheckReturnValue
default String getDefaultConnectionUser()

Gets the default connection user.

Will always fail when not overridden.

Returns:

The default connection user.

getDeleteSQL

@Nonnull
 @CheckReturnValue
StringBuilder getDeleteSQL(boolean purge)

Gets the SQL for a DELETE statement.

Parameters:

purge - True when the operation is a purge.

Returns:

The SQL.

getDialectName

@Nonnull
 @CheckReturnValue
String getDialectName()

Gets the dialect name.

Returns:

The dialect name.

getInsertSQL

@Nonnull
 @CheckReturnValue
StringBuilder getInsertSQL()

Gets the SQL for an INSERT statement.

Returns:

The SQL.

getSchemaName

@Nonnull
 @CheckReturnValue
String getSchemaName()

Gets the schema name.

Returns:

The schema name.

getSelectSQL

@Nonnull
 @CheckReturnValue
StringBuilder getSelectSQL(StoreCursor cursor)

Gets the SQL for a SELECT statement.

Parameters:

cursor - The store cursor.

Returns:

The SQL.

getTableName

@Nonnull
 @CheckReturnValue
String getTableName()

Gets the table name.

Returns:

The table name.

getUpdateSQL

@Nonnull
 @CheckReturnValue
StringBuilder getUpdateSQL()

Gets the SQL for an UPDATE statement.

Returns:

The SQL.

onFirstConnection

void onFirstConnection(@Nonnull
                       TheStoreConnection connection)

Called on the first connection.

Parameters:

connection - The newly established connection.

registerDriver

@Nullable
 @CheckReturnValue
Class<? extends Driver> registerDriver(@Nonnull
                                                                      ClassDef driverClassDef)

Registers the JDBC driver.

Parameters:

driverClassDef - The driver class definition.

Returns:

The driver class (null on failure).

setDeleteStatement

int setDeleteStatement(@Nonnull
                       PreparedStatement statement,
                       @Nonnull
                       byte[] point,
                       long startStamp,
                       long finishStamp)
                throws SQLException

Sets a DELETE statement.

Parameters:

statement - The Statement prepared from getDeleteSQL(boolean).

point - The bytes of the Point's UUID.

startStamp - The raw value of the start time stamp.

finishStamp - The raw value of the finish time stamp.

Returns:

The number of columns set.

Throws:

SQLException - From java.sql.

setInsertStatement

@CheckReturnValue
int setInsertStatement(@Nonnull
                                          PreparedStatement statement,
                                          @Nonnull
                                          byte[] point,
                                          long stamp,
                                          long version,
                                          @Nonnull
                                          byte[] state,
                                          @Nonnull
                                          byte[] value)
                                   throws SQLException

Sets an INSERT statement according to the PointValue.

Parameters:

statement - The Statement prepared from getInsertSQL().

point - The bytes of the Point's UUID.

stamp - The raw value of the Point's time stamp.

version - The raw value of the version stamp.

state - The value's state.

value - The Point's serialized value.

Returns:

The number of columns set.

Throws:

SQLException - From java.sql.

setSelectStatement

@CheckReturnValue
int setSelectStatement(@Nonnull
                                          PreparedStatement statement,
                                          @Nonnull
                                          StoreCursor cursor)
                                   throws SQLException

Sets a SELECT statement according to the Request and request type.

Parameters:

statement - The statement prepared from getInsertSQL().

cursor - The store cursor for which the statement has been prepared.

Returns:

The number of columns set.

Throws:

SQLException - From java.sql.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 Optional<StoreServiceAppImpl> storeAppImpl,
                                 @Nonnull
                                 File storeDataDir,
                                 @Nonnull
                                 String storeEntityName)

Sets up the basic informations for dialect support.

Parameters:

storeAppImpl - The optional store application implementation.

storeDataDir - The store data directory.

storeEntityName - The store entity name.

Returns:

True on success.

setUpdateStatement

@CheckReturnValue
int setUpdateStatement(@Nonnull
                                          PreparedStatement statement,
                                          @Nonnull
                                          byte[] point,
                                          long stamp,
                                          long version,
                                          @Nonnull
                                          Optional<byte[]> state,
                                          @Nonnull
                                          Optional<byte[]> value)
                                   throws SQLException

Sets an UPDATE statement according to the PointValue.

Parameters:

statement - The Statement prepared from getUpdateSQL().

point - The bytes of the Point's UUID.

stamp - The raw value of the Point's time stamp.

version - The raw value of the version stamp.

state - The value's serialized state.

value - The Point's serialized value.

Returns:

The number of columns set.

Throws:

SQLException - From java.sql.

tearDown

void tearDown()

Tears down what has been set up.