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.

Method Summary

Modifier and Type	Method	Description
static TransactionConfig.Builder	builder()	Create a TransactionConfig.Builder.
Map<String,?>	getKVOptions()	Configure KVDatabase transaction options.
SchemaModel	getSchemaModel()	Get the schema model to use.
boolean	isAllowNewSchema()	Get whether it is allowed to register a new schema model into the database.
boolean	isGarbageCollectSchemas()	Configure whether automatic schema garbage collection should be enabled.
Transaction	newTransaction(Database db)	Convenience method that uses this instance to create a new transaction in the given database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

isGarbageCollectSchemas

public boolean isGarbageCollectSchemas()

Configure whether automatic schema garbage collection should be enabled.

Returns:

whether automatically garbage collect obsolete schemas

See Also:

• TransactionConfig.Builder.garbageCollectSchemas

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

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)