com.clarkparsia.stardog
Class DatabaseOptions

java.lang.Object
  com.clarkparsia.stardog.DatabaseOptions

All Implemented Interfaces:

MetaPropertyProvider

public final class DatabaseOptions
extends Object
implements MetaPropertyProvider

Non-structural database options. These options, unlike IndexOptions, are not relevant to reading or creating the database. This set of options is for controlling behavior of the database as it lives within a Stardog DBMS.

Since:

0.7

Version:

1.2

Author:

Michael Grove, Evren Sirin

Field Summary

static ConfigProperty<Boolean>	CONSISTENCY_AUTOMATIC Option to specify if consistency checking should be performed automatically during reasoning.
static InfoProperty<com.clarkparsia.stardog.util.DateTime>	CREATION_TIME Creation time of the database.
static long	DEFAULT_OFFLINE_TIMEOUT Default offline timeout (in ms)
static ConfigProperty<Collection<URI>>	ICV_ACTIVE_GRAPHS Option to specify the active graph(s) that will be used for ICV guard mode validation.
static ConfigProperty<Boolean>	ICV_CONSISTENCY_AUTOMATIC Option to specify that ICV guard mode validation will check the consistency of the database as well.
static ConfigProperty<Boolean>	ICV_ENABLED Option to specify whether or not ICV guard mode is enabled for an index.
static ConfigProperty<ReasoningType>	ICV_REASONING_TYPE Option to specify the reasoning type that will be used for ICV guard mode validation.
static InfoProperty<com.clarkparsia.stardog.util.DateTime>	MODIFICATION_TIME Last modification time for the database.
static ConfigProperty<String>	NAME Name of the database.
static ConfigProperty<Collection<Namespace>>	NAMESPACES
static ConfigProperty<Boolean>	ONLINE Option for whether or not the database is online.
static ConfigProperty<Boolean>	PUNNING_ENABLED
static ConfigProperty<com.clarkparsia.stardog.util.Duration>	QUERY_TIMEOUT
static ConfigProperty<Collection<URI>>	SCHEMA_GRAPHS Option to specify the location where the schema should be extracted from.
static ConfigProperty<Boolean>	SEARCHABLE Option for whether or not full-text search via Waldo is enabled for the database
static ConfigProperty<Boolean>	TRANSACTIONS_DURABLE Option for whether or not the database is using durable transactions

Method Summary

static boolean

isSearchable(Metadata theOptions) Return whether or not the searchable option is set.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final ConfigProperty<String> NAME

Name of the database.

CREATION_TIME

public static final InfoProperty<com.clarkparsia.stardog.util.DateTime> CREATION_TIME

Creation time of the database.

MODIFICATION_TIME

public static final InfoProperty<com.clarkparsia.stardog.util.DateTime> MODIFICATION_TIME

Last modification time for the database.

TRANSACTIONS_DURABLE

public static final ConfigProperty<Boolean> TRANSACTIONS_DURABLE

Option for whether or not the database is using durable transactions

ONLINE

public static final ConfigProperty<Boolean> ONLINE

Option for whether or not the database is online. The value for this option at database creation time determines the initial state of the database. This option cannot be modified directly after the database has been created. The special admin functions offline and online should be used to change the value of this option.

ICV_ENABLED

public static final ConfigProperty<Boolean> ICV_ENABLED

Option to specify whether or not ICV guard mode is enabled for an index. When guard mode for ICV is enabled, each commit is inspected to ensure that the contents of the database are valid for the set of constraints that have been associated with it. Should someone attempt to commit data which violates one or more of the constraints defined for the database, the commit will fail and the data will not be added/removed.

ICV_REASONING_TYPE

public static final ConfigProperty<ReasoningType> ICV_REASONING_TYPE

Option to specify the reasoning type that will be used for ICV guard mode validation. By default no reasoning is used.

See Also:

ICV_ENABLED

ICV_ACTIVE_GRAPHS

public static final ConfigProperty<Collection<URI>> ICV_ACTIVE_GRAPHS

Option to specify the active graph(s) that will be used for ICV guard mode validation. By default only the default graph is validated in the guard mode. Set this options to ContextSets.ALL to validate all the named graphs in the database.

See Also:

ICV_ENABLED

ICV_CONSISTENCY_AUTOMATIC

public static final ConfigProperty<Boolean> ICV_CONSISTENCY_AUTOMATIC

Option to specify that ICV guard mode validation will check the consistency of the database as well. By default, ICV validation only checks the violations of constraints explicitly added to the database. However, OWL axioms that exist in the database may cause inconsistencies similar to constraint violations. Setting this option ensures that both reasoning consistencies and constraint violations will be checked during guard mode validation. This option has no effect if reasoning is not enabled for IC validation via the ICV_REASONING_TYPE option. This option only affects the ICV guard mode behavior. If guard mode is not enabled and validations are checked manually through an ICVConnection then consistency should be checked manually using the ReasoningConnection.

See Also:

ICV_ENABLED

SCHEMA_GRAPHS

public static final ConfigProperty<Collection<URI>> SCHEMA_GRAPHS

Option to specify the location where the schema should be extracted from. Expected to be a list of the graph URIs which are the context names schema axioms should be extracted from. The default value is the default (no context) graph, which is represented by ContextSets.DEFAULT_ONLY. There is also an alias for extracting schema information from the entire database in ContextSets.ALL -- however this is not recommended for large databases as it greatly increases the scope of where Stardog needs to look in order to find the schema.

PUNNING_ENABLED

public static final ConfigProperty<Boolean> PUNNING_ENABLED

CONSISTENCY_AUTOMATIC

public static final ConfigProperty<Boolean> CONSISTENCY_AUTOMATIC

Option to specify if consistency checking should be performed automatically during reasoning. If this option is turned on, Stardog will perform consistency checking any time a query through ReasoningConnection is executed and calling ReasoningConnection.isConsistent() later will return this value. If the underlying database did not change since the last consistency check, the consistency check will not be performed. By default, this option is turned off meaning consistency check will only be performed when ReasoningConnection.isConsistent() function is explicitly called.

SEARCHABLE

public static final ConfigProperty<Boolean> SEARCHABLE

Option for whether or not full-text search via Waldo is enabled for the database

NAMESPACES

public static final ConfigProperty<Collection<Namespace>> NAMESPACES

QUERY_TIMEOUT

public static final ConfigProperty<com.clarkparsia.stardog.util.Duration> QUERY_TIMEOUT

DEFAULT_OFFLINE_TIMEOUT

public static final long DEFAULT_OFFLINE_TIMEOUT

Default offline timeout (in ms)

Method Detail

isSearchable

public static boolean isSearchable(Metadata theOptions)

Return whether or not the searchable option is set.

Parameters:

theOptions - the options

Returns:

true if the searchable option is set, false otherwise