Package com.c8db.internal

Class C8DatabaseImpl

java.lang.Object

com.c8db.internal.C8Executeable<E>

com.c8db.internal.InternalC8Database<C8DBImpl,C8ExecutorSync>

com.c8db.internal.C8DatabaseImpl

All Implemented Interfaces:

C8Database, C8SerializationAccessor

public class C8DatabaseImpl
extends InternalC8Database<C8DBImpl,C8ExecutorSync>
implements C8Database

Field Summary

Fields inherited from class com.c8db.internal.InternalC8Database

PATH_API_CURSOR, PATH_API_DATABASE, PATH_API_DCLIST, PATH_API_EXPLAIN, PATH_API_PERSISTENT, PATH_API_QUERY, PATH_API_QUERY_CURRENT, PATH_API_QUERY_PROPERTIES, PATH_API_QUERY_SLOW, PATH_API_STREAM, PATH_API_STREAMS, PATH_API_TENANT, PATH_API_TRANSACTION, PATH_API_USER, PATH_API_USER_QUERIES, PATH_API_VERSION

Fields inherited from class com.c8db.internal.C8Executeable

context, executor, util

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	C8DatabaseImpl(C8DBImpl c8DB, String tenant, String name, String spotDc, String dcList)

Method Summary

Modifier and Type	Method	Description
StreamTransactionEntity	abortStreamTransaction(String id)	Aborts a Stream Transaction.
C8Admin	admin()	Returns a C8Admin instance.
C8ApiKeys	apiKeys()	Returns a C8ApiKeys instance.
StreamTransactionEntity	beginStreamTransaction(StreamTransactionOptions options)	Begins a Stream Transaction.
void	clearBacklog()	Clear backlog for all streams on a stream db.
void	clearBacklog(String subscriptionName)	Clear backlog for given subscription.
void	clearSlowQueries()	Clears the list of slow AQL queries
C8Collection	collection(String name)	Returns a ArangoCollection instance for the given collection name.
StreamTransactionEntity	commitStreamTransaction(String id)	Commits a Stream Transaction.
Boolean	create()	Creates the database
Boolean	create(String geoFabric)	Create a geofabric/db in Demo tenant
CollectionEntity	createCollection(String name)	Creates a collection for the given collection's name, then returns collection information from the server.
CollectionEntity	createCollection(String name, CollectionCreateOptions options)	Creates a collection with the given options for this collection's name, then returns collection information from the server.
GraphEntity	createGraph(String name, Collection<EdgeDefinition> edgeDefinitions)	Create a new graph in the graph module.
GraphEntity	createGraph(String name, Collection<EdgeDefinition> edgeDefinitions, GraphCreateOptions options)	Create a new graph in the graph module.
void	createPersistentStream(String name, C8StreamCreateOptions options)	Create asynchronously a persistent stream for a given fabric.
UserQueryEntity	createUserQuery(UserQueryOptions userQueryDefinition)	Creates user query as the current user
UserQueryEntity	createUserQuery(UserQueryOptions userQueryDefinition, String user)	Creates user query as a given user.
<T> C8Cursor<T>	cursor(String cursorId, Class<T> type)	Return an cursor from the given cursor-ID if still existing
String	deleteIndex(String id)	Deletes an index
Boolean	drop()	Deletes the database from the server.
C8Event	event()
<V,E> TraversalEntity<V,E>	executeTraversal(Class<V> vertexClass, Class<E> edgeClass, TraversalOptions options)	Execute a server-side traversal
<T> C8Cursor<T>	executeUserQuery(String userName, String name, Map<String,Object> bindVars, Class<T> type)	Executes a saved using query using the given name and bindVars, then returns a new C8Cursor instance for the result list.
boolean	exists()	Checks whether the database exists
C8qlExecutionExplainEntity	explainQuery(String query, Map<String,Object> bindVars, C8qlQueryExplainOptions options)	Explain an AQL query and return information about it
Collection<String>	getAccessibleGeoFabrics()	Retrieves a list of all databases the current user can access
Collection<CollectionEntity>	getCollections()	Fetches all collections from the database and returns an list of collection descriptions.
Collection<CollectionEntity>	getCollections(CollectionsReadOptions options)	Fetches all collections from the database and returns an list of collection descriptions.
Collection<QueryEntity>	getCurrentlyRunningQueries()	Returns a list of currently running AQL queries
<T> T	getDocument(String id, Class<T> type)	Reads a single document
<T> T	getDocument(String id, Class<T> type, DocumentReadOptions options)	Reads a single document
Collection<GraphEntity>	getGraphs()	Lists all graphs known to the graph module
IndexEntity	getIndex(String id)	Returns an index
DatabaseEntity	getInfo()	Retrieves information about the current database
Permissions	getPermissions(String user)	Get specific database access level
Collection<C8StreamEntity>	getPersistentStreams(C8StreamCreateOptions options)	Get list of persistent streams under the given stream db.
QueryTrackingPropertiesEntity	getQueryTrackingProperties()	Returns the configuration for the AQL query tracking
Collection<QueryEntity>	getSlowQueries()	Returns a list of slow running AQL queries
Collection<C8StreamEntity>	getStreams()	Get list of all streams under given database.
StreamTransactionEntity	getStreamTransaction(String id)	Gets information about a Stream Transaction.
Collection<TransactionEntity>	getStreamTransactions()	Gets all the currently running Stream Transactions.
C8DBVersion	getVersion()	Returns the server name and version number.
void	grantAccess(String user)	Grants access to the database for user user.
void	grantAccess(String user, Permissions permissions)	Grants or revoke access to the database for user user.
C8Graph	graph(String name)	Returns a ArangoGraph instance for the given graph name.
void	killQuery(String id)	Kills a running query.
C8qlParseEntity	parseQuery(String query)	Parse an AQL query and return information about it This method is for query validation only.
<T> C8Cursor<T>	query(String query, C8qlQueryOptions options, Class<T> type)	Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.
<T> C8Cursor<T>	query(String query, Class<T> type)	Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.
<T> C8Cursor<T>	query(String query, Map<String,Object> bindVars, C8qlQueryOptions options, Class<T> type)	Performs a database query using the given query and bindVars, then returns a new C8Cursor instance for the result list.
<T> C8Cursor<T>	query(String query, Map<String,Object> bindVars, Class<T> type)	Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.
void	resetAccess(String user)	Clear the database access level, revert back to the default access level.
Restql	restql()	Returns a Restql instance.
void	revokeAccess(String user)	Revokes access to the database dbname for user user.
protected C8DatabaseImpl	setCursorInitializer(C8CursorInitializer cursorInitializer)
QueryTrackingPropertiesEntity	setQueryTrackingProperties(QueryTrackingPropertiesEntity properties)	Changes the configuration for the AQL query tracking
C8Stream	stream(String name)	Returns a C8Stream instance for the given stream name.
<T> T	transaction(String action, Class<T> type, C8TransactionOptions options)	Performs a server-side transaction and returns its return value.
void	unsubscribe(String subscriptionName)	Unsubscribes the given subscription on all streams on a stream db.

Methods inherited from class com.c8db.internal.InternalC8Database

abortStreamTransactionRequest, beginStreamTransactionRequest, c8db, clearC8StreamBacklogRequest, clearC8StreamBacklogRequest, clearSlowQueriesRequest, commitStreamTransactionRequest, createC8PersistentStreamRequest, createCollectionRequest, createDropResponseDeserializer, createGraphRequest, createGraphResponseDeserializer, createUserQueryRequest, createUserQueryResponseDeserializer, dcList, deserializeEdges, deserializeVertices, dropRequest, executeTraversalRequest, executeTraversalResponseDeserializer, explainQueryRequest, getAccessibleDatabasesForResponseDeserializer, getAccessibleDatabasesRequest, getC8PersistentStreamsRequest, getC8StreamsRequest, getC8StreamsResponseDeserializer, getCollectionsRequest, getCollectionsResponseDeserializer, getCurrentlyRunningQueriesRequest, getDatabaseResponseDeserializer, getGraphsRequest, getGraphsResponseDeserializer, getInfoRequest, getInfoResponseDeserializer, getPermissionsRequest, getPermissionsResponseDeserialzer, getQueryTrackingPropertiesRequest, getSlowQueriesRequest, getStreamTransactionRequest, getStreamTransactionsRequest, getVersionRequest, grantAccessRequest, killQueryRequest, name, parseQueryRequest, queryCloseRequest, queryNextRequest, queryRequest, resetAccessRequest, setQueryTrackingPropertiesRequest, spotDc, streamTransactionResponseDeserializer, tenant, transactionRequest, transactionResponseDeserializer, transactionsResponseDeserializer, unsubscribeRequest, userQueryRequest

Methods inherited from class com.c8db.internal.C8Executeable

createPath, executor, request, util, util

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.c8db.C8Database

c8db, name, tenant

Methods inherited from interface com.c8db.C8SerializationAccessor

util, util

Constructor Detail

C8DatabaseImpl

protected C8DatabaseImpl(C8DBImpl c8DB,
                         String tenant,
                         String name,
                         String spotDc,
                         String dcList)

Method Detail

getVersion

public C8DBVersion getVersion()
                       throws C8DBException

Description copied from interface: C8Database

Returns the server name and version number.

Specified by:

getVersion in interface C8Database

Returns:

the server version, number

Throws:

C8DBException

exists

public boolean exists()
               throws C8DBException

Description copied from interface: C8Database

Checks whether the database exists

Specified by:

exists in interface C8Database

Returns:

true if the database exists, otherwise false

Throws:

C8DBException

getAccessibleGeoFabrics

public Collection<String> getAccessibleGeoFabrics()
                                           throws C8DBException

Description copied from interface: C8Database

Retrieves a list of all databases the current user can access

Specified by:

getAccessibleGeoFabrics in interface C8Database

Returns:

a list of all databases the current user can access

Throws:

C8DBException

collection

public C8Collection collection(String name)

Description copied from interface: C8Database

Returns a ArangoCollection instance for the given collection name.

Specified by:

collection in interface C8Database

Parameters:

name - Name of the collection

Returns:

collection handler

createCollection

public CollectionEntity createCollection(String name)
                                  throws C8DBException

Description copied from interface: C8Database

Creates a collection for the given collection's name, then returns collection information from the server.

Specified by:

createCollection in interface C8Database

Parameters:

name - The name of the collection

Returns:

information about the collection

Throws:

C8DBException

createCollection

public CollectionEntity createCollection(String name,
                                         CollectionCreateOptions options)
                                  throws C8DBException

Description copied from interface: C8Database

Creates a collection with the given options for this collection's name, then returns collection information from the server.

Specified by:

createCollection in interface C8Database

Parameters:

name - The name of the collection

options - Additional options, can be null

Returns:

information about the collection

Throws:

C8DBException

getCollections

public Collection<CollectionEntity> getCollections()
                                            throws C8DBException

Description copied from interface: C8Database

Fetches all collections from the database and returns an list of collection descriptions.

Specified by:

getCollections in interface C8Database

Returns:

list of information about all collections

Throws:

C8DBException

getCollections

public Collection<CollectionEntity> getCollections(CollectionsReadOptions options)
                                            throws C8DBException

Description copied from interface: C8Database

Fetches all collections from the database and returns an list of collection descriptions.

Specified by:

getCollections in interface C8Database

Parameters:

options - Additional options, can be null

Returns:

list of information about all collections

Throws:

C8DBException

See Also:

API Documentation

getIndex

public IndexEntity getIndex(String id)
                     throws C8DBException

Description copied from interface: C8Database

Returns an index

Specified by:

getIndex in interface C8Database

Parameters:

id - The index-handle

Returns:

information about the index

Throws:

C8DBException

See Also:

API Documentation

deleteIndex

public String deleteIndex(String id)
                   throws C8DBException

Description copied from interface: C8Database

Deletes an index

Specified by:

deleteIndex in interface C8Database

Parameters:

id - The index-handle

Returns:

the id of the index

Throws:

C8DBException

See Also:

API Documentation

create

public Boolean create()
               throws C8DBException

Description copied from interface: C8Database

Creates the database

Specified by:

create in interface C8Database

Returns:

true if the database was created successfully.

Throws:

C8DBException

See Also:

API Documentation

create

public Boolean create(String geoFabric)
               throws C8DBException

Description copied from interface: C8Database

Create a geofabric/db in Demo tenant

Specified by:

create in interface C8Database

Parameters:

geoFabric - The name of the geofabric

Returns:

Throws:

C8DBException

drop

public Boolean drop()
             throws C8DBException

Description copied from interface: C8Database

Deletes the database from the server.

Specified by:

drop in interface C8Database

Returns:

true if the database was dropped successfully

Throws:

C8DBException

See Also:

API Documentation

grantAccess

public void grantAccess(String user,
                        Permissions permissions)
                 throws C8DBException

Description copied from interface: C8Database

Grants or revoke access to the database for user user. You need permission to the _system database in order to execute this call.

Specified by:

grantAccess in interface C8Database

Parameters:

user - The name of the user

permissions - The permissions the user grant

Throws:

C8DBException

See Also:

API Documentation

grantAccess

public void grantAccess(String user)
                 throws C8DBException

Description copied from interface: C8Database

Grants access to the database for user user. You need permission to the _system database in order to execute this call.

Specified by:

grantAccess in interface C8Database

Parameters:

user - The name of the user

Throws:

C8DBException

See Also:

API Documentation

revokeAccess

public void revokeAccess(String user)
                  throws C8DBException

Description copied from interface: C8Database

Revokes access to the database dbname for user user. You need permission to the _system database in order to execute this call.

Specified by:

revokeAccess in interface C8Database

Parameters:

user - The name of the user

Throws:

C8DBException

resetAccess

public void resetAccess(String user)
                 throws C8DBException

Description copied from interface: C8Database

Clear the database access level, revert back to the default access level.

Specified by:

resetAccess in interface C8Database

Parameters:

user - The name of the user

Throws:

C8DBException

See Also:

API Documentation

getPermissions

public Permissions getPermissions(String user)
                           throws C8DBException

Description copied from interface: C8Database

Get specific database access level

Specified by:

getPermissions in interface C8Database

Parameters:

user - The name of the user

Returns:

permissions of the user

Throws:

C8DBException

See Also:

API Documentation

query

public <T> C8Cursor<T> query(String query,
                             Map<String,Object> bindVars,
                             C8qlQueryOptions options,
                             Class<T> type)
                      throws C8DBException

Description copied from interface: C8Database

Performs a database query using the given query and bindVars, then returns a new C8Cursor instance for the result list.

Specified by:

query in interface C8Database

Parameters:

query - A C8QL query string

bindVars - key/value pairs defining the variables to bind the query to

options - Additional options that will be passed to the query API, can be null

type - The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map)

Returns:

cursor of the results

Throws:

C8DBException

See Also:

API Documentation

query

public <T> C8Cursor<T> query(String query,
                             Map<String,Object> bindVars,
                             Class<T> type)
                      throws C8DBException

Description copied from interface: C8Database

Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.

Specified by:

query in interface C8Database

Parameters:

query - An AQL query string

bindVars - key/value pairs defining the variables to bind the query to

type - The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map)

Returns:

cursor of the results

Throws:

C8DBException

See Also:

API Documentation

query

public <T> C8Cursor<T> query(String query,
                             C8qlQueryOptions options,
                             Class<T> type)
                      throws C8DBException

Description copied from interface: C8Database

Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.

Specified by:

query in interface C8Database

Parameters:

query - An AQL query string

options - Additional options that will be passed to the query API, can be null

type - The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map)

Returns:

cursor of the results

Throws:

C8DBException

See Also:

API Documentation

query

public <T> C8Cursor<T> query(String query,
                             Class<T> type)
                      throws C8DBException

Description copied from interface: C8Database

Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.

Specified by:

query in interface C8Database

Parameters:

query - An AQL query string

type - The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map)

Returns:

cursor of the results

Throws:

C8DBException

See Also:

API Documentation

cursor

public <T> C8Cursor<T> cursor(String cursorId,
                              Class<T> type)
                       throws C8DBException

Description copied from interface: C8Database

Return an cursor from the given cursor-ID if still existing

Specified by:

cursor in interface C8Database

Parameters:

cursorId - The ID of the cursor

type - The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map)

Returns:

cursor of the results

Throws:

C8DBException

See Also:

API Documentation

parseQuery

public C8qlParseEntity parseQuery(String query)
                           throws C8DBException

Description copied from interface: C8Database

Parse an AQL query and return information about it This method is for query validation only. To actually query the database, see C8Database.query(String, Map, C8qlQueryOptions, Class)

Specified by:

parseQuery in interface C8Database

Parameters:

query - the query which you want parse

Returns:

imformation about the query

Throws:

C8DBException

See Also:

API Documentation

getCurrentlyRunningQueries

public Collection<QueryEntity> getCurrentlyRunningQueries()
                                                   throws C8DBException

Description copied from interface: C8Database

Returns a list of currently running AQL queries

Specified by:

getCurrentlyRunningQueries in interface C8Database

Returns:

a list of currently running AQL queries

Throws:

C8DBException

explainQuery

public C8qlExecutionExplainEntity explainQuery(String query,
                                               Map<String,Object> bindVars,
                                               C8qlQueryExplainOptions options)
                                        throws C8DBException

Description copied from interface: C8Database

Explain an AQL query and return information about it

Specified by:

explainQuery in interface C8Database

Parameters:

query - the query which you want explained

bindVars - key/value pairs representing the bind parameters

options - Additional options, can be null

Returns:

information about the query

Throws:

C8DBException

See Also:

API Documentation

clearSlowQueries

public void clearSlowQueries()
                      throws C8DBException

Description copied from interface: C8Database

Clears the list of slow AQL queries

Specified by:

clearSlowQueries in interface C8Database

Throws:

C8DBException

getSlowQueries

public Collection<QueryEntity> getSlowQueries()
                                       throws C8DBException

Description copied from interface: C8Database

Returns a list of slow running AQL queries

Specified by:

getSlowQueries in interface C8Database

Returns:

a list of slow running AQL queries

Throws:

C8DBException

getQueryTrackingProperties

public QueryTrackingPropertiesEntity getQueryTrackingProperties()
                                                         throws C8DBException

Description copied from interface: C8Database

Returns the configuration for the AQL query tracking

Specified by:

getQueryTrackingProperties in interface C8Database

Returns:

configuration for the AQL query tracking

Throws:

C8DBException

setQueryTrackingProperties

public QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingPropertiesEntity properties)
                                                         throws C8DBException

Description copied from interface: C8Database

Changes the configuration for the AQL query tracking

Specified by:

setQueryTrackingProperties in interface C8Database

Parameters:

properties - properties to be set

Returns:

current set of properties

Throws:

C8DBException

killQuery

public void killQuery(String id)
               throws C8DBException

Description copied from interface: C8Database

Kills a running query. The query will be terminated at the next cancelation point.

Specified by:

killQuery in interface C8Database

Parameters:

id - The id of the query

Throws:

C8DBException

See Also:

API Documentation

graph

public C8Graph graph(String name)

Description copied from interface: C8Database

Returns a ArangoGraph instance for the given graph name.

Specified by:

graph in interface C8Database

Parameters:

name - Name of the graph

Returns:

graph handler

createGraph

public GraphEntity createGraph(String name,
                               Collection<EdgeDefinition> edgeDefinitions)
                        throws C8DBException

Description copied from interface: C8Database

Create a new graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges.

Specified by:

createGraph in interface C8Database

Parameters:

name - Name of the graph

edgeDefinitions - An array of definitions for the edge

Returns:

information about the graph

Throws:

C8DBException

See Also:

API Documentation

createGraph

public GraphEntity createGraph(String name,
                               Collection<EdgeDefinition> edgeDefinitions,
                               GraphCreateOptions options)
                        throws C8DBException

Description copied from interface: C8Database

Create a new graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges.

Specified by:

createGraph in interface C8Database

Parameters:

name - Name of the graph

edgeDefinitions - An array of definitions for the edge

options - Additional options, can be null

Returns:

information about the graph

Throws:

C8DBException

See Also:

API Documentation

getGraphs

public Collection<GraphEntity> getGraphs()
                                  throws C8DBException

Description copied from interface: C8Database

Lists all graphs known to the graph module

Specified by:

getGraphs in interface C8Database

Returns:

graphs stored in this database

Throws:

C8DBException

transaction

public <T> T transaction(String action,
                         Class<T> type,
                         C8TransactionOptions options)
                  throws C8DBException

Description copied from interface: C8Database

Performs a server-side transaction and returns its return value.

Specified by:

transaction in interface C8Database

Parameters:

action - A String evaluating to a JavaScript function to be executed on the server.

type - The type of the result (POJO class, VPackSlice or String for JSON)

options - Additional options, can be null

Returns:

the result of the transaction if it succeeded

Throws:

C8DBException

beginStreamTransaction

public StreamTransactionEntity beginStreamTransaction(StreamTransactionOptions options)
                                               throws C8DBException

Description copied from interface: C8Database

Begins a Stream Transaction.

Specified by:

beginStreamTransaction in interface C8Database

Parameters:

options - Additional options, can be null

Returns:

information about the transaction

Throws:

C8DBException

abortStreamTransaction

public StreamTransactionEntity abortStreamTransaction(String id)
                                               throws C8DBException

Description copied from interface: C8Database

Aborts a Stream Transaction.

Specified by:

abortStreamTransaction in interface C8Database

Returns:

information about the transaction

Throws:

C8DBException

getStreamTransaction

public StreamTransactionEntity getStreamTransaction(String id)
                                             throws C8DBException

Description copied from interface: C8Database

Gets information about a Stream Transaction.

Specified by:

getStreamTransaction in interface C8Database

Returns:

information about the transaction

Throws:

C8DBException

getStreamTransactions

public Collection<TransactionEntity> getStreamTransactions()
                                                    throws C8DBException

Description copied from interface: C8Database

Gets all the currently running Stream Transactions.

Specified by:

getStreamTransactions in interface C8Database

Returns:

all the currently running Stream Transactions

Throws:

C8DBException

commitStreamTransaction

public StreamTransactionEntity commitStreamTransaction(String id)
                                                throws C8DBException

Description copied from interface: C8Database

Commits a Stream Transaction.

Specified by:

commitStreamTransaction in interface C8Database

Returns:

information about the transaction

Throws:

C8DBException

getInfo

public DatabaseEntity getInfo()
                       throws C8DBException

Description copied from interface: C8Database

Retrieves information about the current database

Specified by:

getInfo in interface C8Database

Returns:

information about the current database

Throws:

C8DBException

executeTraversal

public <V,E> TraversalEntity<V,E> executeTraversal(Class<V> vertexClass,
                                                               Class<E> edgeClass,
                                                               TraversalOptions options)
                                                        throws C8DBException

Description copied from interface: C8Database

Execute a server-side traversal

Specified by:

executeTraversal in interface C8Database

Parameters:

vertexClass - The type of the vertex documents (POJO class, VPackSlice or String for JSON)

edgeClass - The type of the edge documents (POJO class, VPackSlice or String for JSON)

options - Additional options

Returns:

Result of the executed traversal

Throws:

C8DBException

See Also:

API Documentation

getDocument

public <T> T getDocument(String id,
                         Class<T> type)
                  throws C8DBException

Description copied from interface: C8Database

Reads a single document

Specified by:

getDocument in interface C8Database

Parameters:

id - The id of the document

type - The type of the document (POJO class, VPackSlice or String for JSON)

Returns:

the document identified by the id

Throws:

C8DBException

See Also:

API Documentation

getDocument

public <T> T getDocument(String id,
                         Class<T> type,
                         DocumentReadOptions options)
                  throws C8DBException

Description copied from interface: C8Database

Reads a single document

Specified by:

getDocument in interface C8Database

Parameters:

id - The id of the document

type - The type of the document (POJO class, VPackSlice or String for JSON)

options - Additional options, can be null

Returns:

the document identified by the id

Throws:

C8DBException

setCursorInitializer

protected C8DatabaseImpl setCursorInitializer(C8CursorInitializer cursorInitializer)

stream

public C8Stream stream(String name)

Description copied from interface: C8Database

Returns a C8Stream instance for the given stream name.

Specified by:

stream in interface C8Database

Parameters:

name - Name of the stream

Returns:

stream handler

createPersistentStream

public void createPersistentStream(String name,
                                   C8StreamCreateOptions options)
                            throws C8DBException

Description copied from interface: C8Database

Create asynchronously a persistent stream for a given fabric.

Specified by:

createPersistentStream in interface C8Database

Parameters:

name - of the stream

options - C8StreamCreateOptions

Throws:

C8DBException

getPersistentStreams

public Collection<C8StreamEntity> getPersistentStreams(C8StreamCreateOptions options)
                                                throws C8DBException

Description copied from interface: C8Database

Get list of persistent streams under the given stream db. Returns either a list of global or of local streams.

Specified by:

getPersistentStreams in interface C8Database

Returns:

Throws:

C8DBException

getStreams

public Collection<C8StreamEntity> getStreams()
                                      throws C8DBException

Description copied from interface: C8Database

Get list of all streams under given database.

Specified by:

getStreams in interface C8Database

Returns:

Throws:

C8DBException

clearBacklog

public void clearBacklog()

Description copied from interface: C8Database

Clear backlog for all streams on a stream db.

Specified by:

clearBacklog in interface C8Database

clearBacklog

public void clearBacklog(String subscriptionName)

Description copied from interface: C8Database

Clear backlog for given subscription.

Specified by:

clearBacklog in interface C8Database

Parameters:

subscriptionName - Name of the subscription

unsubscribe

public void unsubscribe(String subscriptionName)

Description copied from interface: C8Database

Unsubscribes the given subscription on all streams on a stream db.

Specified by:

unsubscribe in interface C8Database

Parameters:

subscriptionName - Identifying name of the subscripton.

restql

public Restql restql()

Description copied from interface: C8Database

Returns a Restql instance.

Specified by:

restql in interface C8Database

Returns:

Restql handler

createUserQuery

public UserQueryEntity createUserQuery(UserQueryOptions userQueryDefinition)
                                throws C8DBException

Description copied from interface: C8Database

Creates user query as the current user

Specified by:

createUserQuery in interface C8Database

Parameters:

userQueryDefinition - user query definition

Returns:

user query entity.

Throws:

C8DBException

createUserQuery

public UserQueryEntity createUserQuery(UserQueryOptions userQueryDefinition,
                                       String user)
                                throws C8DBException

Description copied from interface: C8Database

Creates user query as a given user.

Note: this can only be invoked by a admin user.

Specified by:

createUserQuery in interface C8Database

Parameters:

userQueryDefinition - user query definition.

user - user name.

Returns:

user query entity.

Throws:

C8DBException

executeUserQuery

public <T> C8Cursor<T> executeUserQuery(String userName,
                                        String name,
                                        Map<String,Object> bindVars,
                                        Class<T> type)
                                 throws C8DBException

Description copied from interface: C8Database

Executes a saved using query using the given name and bindVars, then returns a new C8Cursor instance for the result list. If userName is null then tries to execute it for current user.

Specified by:

executeUserQuery in interface C8Database

Parameters:

userName - user the query belongs to. If null executes it for current user

name - A user query name

bindVars - key/value pairs defining the variables to bind the query to

type - The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map)

Returns:

cursor of the results

Throws:

C8DBException

event

public C8Event event()

Specified by:

event in interface C8Database

admin

public C8Admin admin()

Description copied from interface: C8Database

Returns a C8Admin instance.

Specified by:

admin in interface C8Database

Returns:

C8Admin handler

apiKeys

public C8ApiKeys apiKeys()

Description copied from interface: C8Database

Returns a C8ApiKeys instance.

Specified by:

apiKeys in interface C8Database

Returns:

C8ApiKeys handler