Package io.permazen.core

Class TransactionConfig

java.lang.Object

io.permazen.core.TransactionConfig

public final class TransactionConfig
extends Object

Configuration for a Transaction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TransactionConfig.Builder	Builder for TransactionConfigs.
static enum	TransactionConfig.SchemaRemoval	Configures if and when to automatically detect and remove unused schemas from a database.

Method Summary

Modifier and Type	Method	Description
static TransactionConfig.Builder	builder()	Create a TransactionConfig.Builder.
TransactionConfig.Builder	copy()	Create a TransactionConfig.Builder that is pre-configured as a copy of this instance.
Map<String,?>	getKVOptions()	Configure KVDatabase transaction options.
SchemaModel	getSchemaModel()	Get the schema model to use.
TransactionConfig.SchemaRemoval	getSchemaRemoval()	Get when to automatically detect and remove unused schemas.
boolean	isAllowNewSchema()	Get whether it is allowed to register a new schema model into the database.
Transaction	newTransaction(Database db)	Convenience method that uses this instance to create a new transaction in the given database.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getSchemaModel

public SchemaModel getSchemaModel()

Get the schema model to use.

Returns:

the schema to use during transactions

See Also:

• TransactionConfig.Builder.schemaModel

isAllowNewSchema

public boolean isAllowNewSchema()

Get whether it is allowed to register a new schema model into the database.

Returns:

whether registering a new schema is allowed

See Also:

• TransactionConfig.Builder.allowNewSchema

getSchemaRemoval

public TransactionConfig.SchemaRemoval getSchemaRemoval()

Get when to automatically detect and remove unused schemas.

Returns:

if and when to remove unused schemas

See Also:

• TransactionConfig.Builder.schemaRemoval

getKVOptions

public Map<String,?> getKVOptions()

Configure KVDatabase transaction options.

Returns:

transaction options for the underlying KVDatabase, or null for none

See Also:

• TransactionConfig.Builder.kvOptions(java.util.Map<java.lang.String, ?>)
• KVDatabase.createTransaction(Map)

builder

public static TransactionConfig.Builder builder()

Create a TransactionConfig.Builder.

Returns:

new transaction config builder

copy

public TransactionConfig.Builder copy()

Create a TransactionConfig.Builder that is pre-configured as a copy of this instance.

Returns:

new pre-configured transaction config builder

newTransaction

public Transaction newTransaction(Database db)

Convenience method that uses this instance to create a new transaction in the given database.

Parameters:

db - database in which to open a new transaction

Returns:

new transaction in db

Throws:

IllegalArgumentException - if db is null

See Also:

• Database.createTransaction(TransactionConfig)

toString

public String toString()

Overrides:

toString in class Object