io.permazen.kv.sql

Class SQLDriverKVImplementation<C extends SQLDriverKVImplementation.Config>

java.lang.Object

io.permazen.kv.KVImplementation<C>

io.permazen.kv.sql.SQLDriverKVImplementation<C>

Type Parameters:

C - configuration object type

Direct Known Subclasses:

CockroachKVImplementation, MSSQLKVImplementation, MySQLKVImplementation

public abstract class SQLDriverKVImplementation<C extends SQLDriverKVImplementation.Config>
extends KVImplementation<C>

Support superclass for KVImplementations that create SQLKVDatabase instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQLDriverKVImplementation.Config

Field Summary

Fields inherited from class io.permazen.kv.KVImplementation

log, XML_DESCRIPTOR_RESOURCE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SQLDriverKVImplementation(Class<C> configType, String driverClassName) Constructor.

Method Summary

Modifier and Type	Method and Description
KVDatabase	createKVDatabase(C config, KVDatabase kvdb, AtomicKVStore kvstore) Create an KVDatabase using the specified configuration.
protected abstract SQLKVDatabase	createSQLKVDatabase(C config) Instantiate a SQLKVDatabase.

Methods inherited from class io.permazen.kv.KVImplementation

createAtomicKVStore, getCommandLineOptions, getConfigType, getDescription, getImplementations, getUsageText, parseCommandLineFlag, parseCommandLineOption, parseCommandLineOptions, requiresAtomicKVStore, requiresKVDatabase

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLDriverKVImplementation

protected SQLDriverKVImplementation(Class<C> configType,
                                    String driverClassName)

Constructor.

Parameters:

configType - configuration object type

driverClassName - Driver implementation class name

Method Detail

createKVDatabase

public KVDatabase createKVDatabase(C config,
                                   KVDatabase kvdb,
                                   AtomicKVStore kvstore)

Description copied from class: KVImplementation

Create an KVDatabase using the specified configuration.

Specified by:

createKVDatabase in class KVImplementation<C extends SQLDriverKVImplementation.Config>

Parameters:

config - implementation configuration returned by parseCommandLineOptions()

kvdb - required KVDatabase; will be null unless KVImplementation.requiresKVDatabase(C) returned true

kvstore - required AtomicKVStore; will be null unless KVImplementation.requiresAtomicKVStore(C) returned true

Returns:

new KVDatabase instance

createSQLKVDatabase

protected abstract SQLKVDatabase createSQLKVDatabase(C config)

Instantiate a SQLKVDatabase.

This method does not need to configure the DataSource (via SQLKVDatabase.setDataSource()); the calling method will do that.

Parameters:

config - implementation configuration returned by parseCommandLineOptions()

Returns:

new key/value database