com.complexible.stardog.api

Class KernelDatabaseConnection

java.lang.Object

com.complexible.stardog.api.impl.AbstractConnection

com.complexible.stardog.api.KernelDatabaseConnection

All Implemented Interfaces:

Connection, AutoCloseable

public final class KernelDatabaseConnection
extends com.complexible.stardog.api.impl.AbstractConnection
implements Connection

A wrapper around the Kernel via DatabaseConnection to provide an adapter for Connection so that it can be used in an "embedded" mode where you're interacting with the kernel directly without a server involved.

Since:

5.0

Version:

5.0.2

Author:

Michael Grove

Field Summary

Fields inherited from class com.complexible.stardog.api.impl.AbstractConnection

LOGGER, mCollector, mConnectionViews

Method Summary

Modifier and Type	Method and Description
protected BooleanQueryResult	_ask(BooleanQuery theQuery)
protected UUID	_begin()
protected void	_close()
protected CommitResult	_commit()
protected GraphQueryResult	_graph(GraphQuery theQuery)
protected PathQueryResult	_paths(PathQuery theQuery)
protected InputStream	_read(ReadQuery<?> theQuery, FileFormat theFormat)
protected void	_rollback()
protected SelectQueryResult	_select(SelectQuery theQuery)
protected SelectQueryResult	_selectPlan(SelectPlanQuery theQuery)
protected void	_update(UpdateQuery theQuery)
AdminConnection	admin() Returns an instance of the AdminConnection class that can be used to perform administrative functions.
protected CommitResult	applyChanges(ChangeList<com.complexible.stardog.api.impl.ConnectionChangeType,Object> theChanges, boolean andCommit)
BooleanQuery	ask(String theQuery, String theBase) Create a SPARQL ask query against the database
<T> T	call(com.google.common.base.Supplier<T> theSupplier)
void	cleanupTx(boolean theClose)
com.complexible.stardog.db.DatabaseConnection	connection(String theReasoningSchema, boolean theRW)
com.complexible.stardog.db.DatabaseConnection	connection(String theReasoningSchema, Options theOptions, boolean theRW)
Map<String,Object>	currentStatus() Return the current status of the database
protected String	explain(Query<?> theQuery, Options theOptions)
Exporter	export() Create an Exporter to export RDF from the database
com.stardog.model.DataModel	generateModel(com.stardog.model.DataModelFormat theInputFormat, Options theOptions) Generates n data model from the database.
com.complexible.stardog.Kernel	getKernel()
String	getName()
GraphQuery	graph(String theQuery, String theBase) Create a SPARQL graph query against the database
com.complexible.stardog.query.GraphAliases	graphAliases() Get graph aliases for this database.
boolean	isOpen() Return whether or not this connection is open.
boolean	isStrictParsing() In embedded mode this function returns the value of `strict.parsing` database option since there is no client/server separation.
NamespacesInfo	namespaces()
Options	options()
PathQuery	paths(String theQuery, String theBase) Create a path query against the database
void	run(Runnable theAction)
SelectQuery	select(String theQuery, String theBase) Create a SPARQL select query against the database
SelectPlanQuery	selectPlan(String theQuery, String theBase) Create a plan query against the database
long	size() Return size of the database.
com.complexible.common.rdf.impl.StreamStatementSources.StatementSourceCreator	statementSourceCreator()
static com.complexible.stardog.query.UpdateQuery	toUpdateQuery(com.complexible.stardog.db.DatabaseConnection theConnection, UpdateQuery theQuery)
Collection<TxInfo>	transactions() Returns an immutable collection of info objects for the open transactions in this database on the server-side.
UpdateQuery	update(String theQuery, String theBase) Create a SPARQL update query against the database

Methods inherited from class com.complexible.stardog.api.impl.AbstractConnection

add, as, ask, assertInTransaction, assertNotInTransaction, assertOpen, begin, cleanupPendingChanges, close, close, commit, executeAsk, executeGraph, executeReadQuery, executeSelect, executeSelectPlan, executeUpdate, explain, get, getDefaultParserConfig, getSchema, graph, isInTransaction, isReasoningEnabled, name, paths, pushOutstanding, pushOutstandingAndCommit, remove, rollback, select, selectPlan, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.complexible.stardog.api.Connection

add, as, ask, begin, close, commit, get, getOption, getSchema, graph, isReasoningEnabled, name, paths, remove, rollback, select, selectPlan, update

Method Detail

statementSourceCreator

public com.complexible.common.rdf.impl.StreamStatementSources.StatementSourceCreator statementSourceCreator()

Overrides:

statementSourceCreator in class com.complexible.stardog.api.impl.AbstractConnection

connection

public com.complexible.stardog.db.DatabaseConnection connection(String theReasoningSchema,
                                                                boolean theRW)

connection

public com.complexible.stardog.db.DatabaseConnection connection(String theReasoningSchema,
                                                                Options theOptions,
                                                                boolean theRW)

getName

public String getName()

options

public Options options()

call

public <T> T call(com.google.common.base.Supplier<T> theSupplier)

run

public void run(Runnable theAction)

currentStatus

public Map<String,Object> currentStatus()
                                 throws StardogException

Return the current status of the database

Specified by:

currentStatus in interface Connection

Returns:

the status

Throws:

StardogException - if the status information could not be retrieved

isOpen

public boolean isOpen()
               throws IllegalStateException

Return whether or not this connection is open.

Specified by:

isOpen in interface Connection

Overrides:

isOpen in class com.complexible.stardog.api.impl.AbstractConnection

Returns:

true if it is open, false otherwise

Throws:

IllegalStateException - if there was an error with the connection

_begin

protected UUID _begin()
               throws StardogException

Specified by:

_begin in class com.complexible.stardog.api.impl.AbstractConnection

Throws:

StardogException

namespaces

public NamespacesInfo namespaces()
                          throws StardogException

Specified by:

namespaces in interface Connection

Throws:

StardogException - if there was an error with the connection

transactions

public Collection<TxInfo> transactions()
                                throws StardogException

Description copied from interface: Connection

Returns an immutable collection of info objects for the open transactions in this database on the server-side. The transactions open on the client-side but not yet sent to the server will not be included in the results even if the transaction is started by this connection.

The logged in user can see only the transactions he/she started. The superusers can see all open transactions.

Specified by:

transactions in interface Connection

Returns:

an immutable collection of info objects for the open transactions in this database

Throws:

StardogException - if there was an error with the connection

isStrictParsing

public boolean isStrictParsing()

In embedded mode this function returns the value of `strict.parsing` database option since there is no client/server separation.

Specified by:

isStrictParsing in class com.complexible.stardog.api.impl.AbstractConnection

_commit

protected CommitResult _commit()
                        throws StardogException

Specified by:

_commit in class com.complexible.stardog.api.impl.AbstractConnection

Throws:

StardogException

cleanupTx

public void cleanupTx(boolean theClose)

Overrides:

cleanupTx in class com.complexible.stardog.api.impl.AbstractConnection

_rollback

protected void _rollback()
                  throws StardogException

Specified by:

_rollback in class com.complexible.stardog.api.impl.AbstractConnection

Throws:

StardogException

_close

protected void _close()
               throws StardogException

Specified by:

_close in class com.complexible.stardog.api.impl.AbstractConnection

Throws:

StardogException

applyChanges

protected CommitResult applyChanges(ChangeList<com.complexible.stardog.api.impl.ConnectionChangeType,Object> theChanges,
                                    boolean andCommit)
                             throws StardogException

Specified by:

applyChanges in class com.complexible.stardog.api.impl.AbstractConnection

Throws:

StardogException

_select

protected SelectQueryResult _select(SelectQuery theQuery)

Specified by:

_select in class com.complexible.stardog.api.impl.AbstractConnection

_selectPlan

protected SelectQueryResult _selectPlan(SelectPlanQuery theQuery)

Specified by:

_selectPlan in class com.complexible.stardog.api.impl.AbstractConnection

_ask

protected BooleanQueryResult _ask(BooleanQuery theQuery)

Specified by:

_ask in class com.complexible.stardog.api.impl.AbstractConnection

_graph

protected GraphQueryResult _graph(GraphQuery theQuery)

Specified by:

_graph in class com.complexible.stardog.api.impl.AbstractConnection

_read

protected InputStream _read(ReadQuery<?> theQuery,
                            FileFormat theFormat)

Specified by:

_read in class com.complexible.stardog.api.impl.AbstractConnection

_paths

protected PathQueryResult _paths(PathQuery theQuery)

Specified by:

_paths in class com.complexible.stardog.api.impl.AbstractConnection

_update

protected void _update(UpdateQuery theQuery)

Specified by:

_update in class com.complexible.stardog.api.impl.AbstractConnection

toUpdateQuery

public static com.complexible.stardog.query.UpdateQuery toUpdateQuery(com.complexible.stardog.db.DatabaseConnection theConnection,
                                                                      UpdateQuery theQuery)

explain

protected String explain(Query<?> theQuery,
                         Options theOptions)

Specified by:

explain in class com.complexible.stardog.api.impl.AbstractConnection

select

public SelectQuery select(String theQuery,
                          String theBase)
                   throws StardogException

Create a SPARQL select query against the database

Specified by:

select in interface Connection

Parameters:

theQuery - the query string

theBase - the base URI to use when parsing the query

Throws:

StardogException - if there was an error while creating the query

selectPlan

public SelectPlanQuery selectPlan(String theQuery,
                                  String theBase)
                           throws StardogException

Create a plan query against the database

Specified by:

selectPlan in interface Connection

Parameters:

theQuery - the plan string

theBase - the base URI to use when parsing the query

Throws:

StardogException - if there was an error while creating the query

graph

public GraphQuery graph(String theQuery,
                        String theBase)
                 throws StardogException

Create a SPARQL graph query against the database

Specified by:

graph in interface Connection

Parameters:

theQuery - the query string

theBase - the base URI to use when parsing the query

Throws:

StardogException - if there was an error while creating the query

paths

public PathQuery paths(String theQuery,
                       String theBase)
                throws StardogException

Create a path query against the database

Specified by:

paths in interface Connection

Parameters:

theQuery - the query string

theBase - the base URI to use when parsing the query

Throws:

StardogException - if there was an error while creating the query

ask

public BooleanQuery ask(String theQuery,
                        String theBase)
                 throws StardogException

Create a SPARQL ask query against the database

Specified by:

ask in interface Connection

Parameters:

theQuery - the query string

theBase - the base URI to use when parsing the query

Throws:

StardogException - if there was an error while creating the query

update

public UpdateQuery update(String theQuery,
                          String theBase)
                   throws StardogException

Create a SPARQL update query against the database

Specified by:

update in interface Connection

Parameters:

theQuery - the query string

theBase - the base URI to use when parsing the query

Throws:

StardogException - if there was an error while creating the query

admin

public AdminConnection admin()
                      throws StardogException

Returns an instance of the AdminConnection class that can be used to perform administrative functions. The server URL and the credentials used for the current connection will be used to login to the server. The AdminConnection will be active unless the user AdminConnection.close() logs out} explicitly or closes this connection. The same AdminConnection will be returned by this function as long as it stays active.

Specified by:

admin in interface Connection

Throws:

StardogException - if there was an error creating the AdminConnection instance

size

public long size()
          throws StardogException

Return size of the database. Behavior of this call depends on whether the connection was created with ConnectionConfiguration.EXACT_SIZE parameter or not. By default it is not and then the result will be an approximation of the current number of statements in the database. Quality of that approximation is generally not guaranteed and it depends on past transactional history such as adding statements which already existed at that point or removing statements which did not. If ConnectionConfiguration.EXACT_SIZE is enabled for the connection, the result of this method will be equal to the result of a query which would count all statements in all named graphs of the database (in particular, it will also account for uncommitted changes made through this connection). Warning: this could be expensive for large databases which is the main reason why this is not the default behavior.

Specified by:

size in interface Connection

Returns:

the size

Throws:

StardogException - if there is an error returning the size of the db.

export

public Exporter export()
                throws StardogException

Create an Exporter to export RDF from the database

Specified by:

export in interface Connection

Returns:

an Exporter

Throws:

StardogException - if the Exporter could not be created.

generateModel

public com.stardog.model.DataModel generateModel(com.stardog.model.DataModelFormat theInputFormat,
                                                 Options theOptions)
                                          throws StardogException

Description copied from interface: Connection

Generates n data model from the database. The model can be generated from a variety of different input sources and the resulting model can be significantly different based on the input source used.

• OWL: The RDFS and OWL definitions in the database are used to generate the model. Requires reasoning to be enabled. A reasoning schema name can be specified in the reasoning connection. Every class in the schema becomes a Class and every property with a domain becomes a Property.
• SHACL: The SHACL constraints in the database are used to generate the model. Every shape with a targetClass becomes a Class and the property shapes defined on those shapes are turned into a Property.

Specified by:

generateModel in interface Connection

Returns:

the data model

Throws:

StardogException - if the model could not be created.

getKernel

public com.complexible.stardog.Kernel getKernel()

graphAliases

public com.complexible.stardog.query.GraphAliases graphAliases()

Description copied from interface: Connection

Get graph aliases for this database. Queries executed through this connection are only guaranteed to see graph alias changes if those are made through the GraphAliases object returned from this method. Uncommitted changes made through the same connection but directly in the data (e.g. using the Adder object) may not be visible.

Specified by:

graphAliases in interface Connection

Returns:

graph aliases