Package io.permazen.kv.sql

Class SQLDriverKVImplementation<C extends SQLDriverKVImplementation.Config>

java.lang.Object

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

Type Parameters:

C - configuration object type

All Implemented Interfaces:

KVImplementation<C>

Direct Known Subclasses:

CockroachKVImplementation, MSSQLKVImplementation, MySQLKVImplementation

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

Support superclass for KVImplementations that create SQLKVDatabase instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SQLDriverKVImplementation.Config

Field Summary

Fields

Modifier and Type	Field	Description
protected joptsimple.OptionSpec<URI>	jdbcUriOption

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SQLDriverKVImplementation(String driverClassName)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract void	addJdbcUriOption(joptsimple.OptionParser parser)
protected void	addJdbcUriOption(joptsimple.OptionParser parser, String option, String description)
void	addOptions(joptsimple.OptionParser parser)	Add implementation-specific command line options.
C	buildConfig(joptsimple.OptionSet options)	Build a configuration from implementation-specific command line options, if any were given.
protected abstract C	buildConfig(joptsimple.OptionSet options, URI uri)
KVDatabase	createKVDatabase(C config, KVDatabase kvdb, AtomicKVStore kvstore)	Create an KVDatabase using the specified configuration.
protected abstract SQLKVDatabase	createSQLKVDatabase(C config)	Instantiate a SQLKVDatabase.
boolean	providesKVDatabase(SQLDriverKVImplementation.Config config)	Determine whether this KVImplementation includes an implementation of the KVDatabase interface.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.permazen.kv.KVImplementation

createAtomicKVStore, getConfigType, getDescription, providesAtomicKVStore, requiresAtomicKVStore, requiresKVDatabase

Field Details

jdbcUriOption

protected joptsimple.OptionSpec<URI> jdbcUriOption

Constructor Details

SQLDriverKVImplementation

protected SQLDriverKVImplementation(String driverClassName)

Constructor.

Parameters:

driverClassName - Driver implementation class name

Method Details

addOptions

public void addOptions(joptsimple.OptionParser parser)

Description copied from interface: KVImplementation

Add implementation-specific command line options.

All of the added options must be optional, because multiple key/value implementations will be available when the command line is parsed, and the presence of implementation-specific options determines which one(s) are chosen.

Specified by:

addOptions in interface KVImplementation<C extends SQLDriverKVImplementation.Config>

Parameters:

parser - command line flag parser

addJdbcUriOption

protected abstract void addJdbcUriOption(joptsimple.OptionParser parser)

addJdbcUriOption

protected void addJdbcUriOption(joptsimple.OptionParser parser,
 String option,
 String description)

buildConfig

public C buildConfig(joptsimple.OptionSet options)

Description copied from interface: KVImplementation

Build a configuration from implementation-specific command line options, if any were given.

If none of this implementation's options were provided, then this method must return null.

Specified by:

buildConfig in interface KVImplementation<C extends SQLDriverKVImplementation.Config>

Parameters:

options - parsed command line options

Returns:

corresponding configuration, or null if this implementation was not configured

buildConfig

protected abstract C buildConfig(joptsimple.OptionSet options,
 URI uri)

createKVDatabase

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

Description copied from interface: KVImplementation

Create an KVDatabase using the specified configuration.

The implementation in KVImplementation always throws UnsupportedOperationException.

Specified by:

createKVDatabase in interface KVImplementation<C extends SQLDriverKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

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

providesKVDatabase

public boolean providesKVDatabase(SQLDriverKVImplementation.Config config)

Description copied from interface: KVImplementation

Determine whether this KVImplementation includes an implementation of the KVDatabase interface.

The implementation in KVImplementation return false.

Specified by:

providesKVDatabase in interface KVImplementation<C extends SQLDriverKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if this instance can create an KVDatabase

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

Returns:

new key/value database