public interface DatabaseClient
| Modifier and Type | Interface | Description |
|---|---|---|
static interface |
DatabaseClient.ConnectionResult |
|
static class |
DatabaseClient.ConnectionType |
Identifies whether the client connects directly to MarkLogic (the default) or
by means of a gateway such as a load balancer.
|
| Modifier and Type | Method | Description |
|---|---|---|
DatabaseClient.ConnectionResult |
checkConnection() |
Checks if the connection is valid.
|
java.lang.Object |
getClientImplementation() |
Returns the client object from the library that implements communication with the
server.
|
DatabaseClient.ConnectionType |
getConnectionType() |
How the client connects to MarkLogic.
|
java.lang.String |
getDatabase() |
|
java.lang.String |
getHost() |
|
int |
getPort() |
|
DatabaseClientFactory.SecurityContext |
getSecurityContext() |
|
<T extends ResourceManager> |
init(java.lang.String resourceName,
T resourceManager) |
Initializes a manager for a extension resource.
|
BinaryDocumentManager |
newBinaryDocumentManager() |
Creates a document manager for documents with a binary format such as images.
|
DataMovementManager |
newDataMovementManager() |
Creates a manager for long-running asynchronous write or query jobs.
|
GenericDocumentManager |
newDocumentManager() |
Creates a document manager for documents with unknown or heterogeneous formats.
|
GraphManager |
newGraphManager() |
Creates a manager for CRUD operations on semantic graphs.
|
JSONDocumentManager |
newJSONDocumentManager() |
Creates a document manager for documents containing a JSON structure.
|
RequestLogger |
newLogger(java.io.OutputStream out) |
Creates a logger for document and query requests.
|
<T,ID extends java.io.Serializable> |
newPojoRepository(java.lang.Class<T> clazz,
java.lang.Class<ID> idClass) |
Creates a PojoRepository specific to the specified class and its id type.
|
QueryManager |
newQueryManager() |
Creates a manager to query for database documents.
|
RowManager |
newRowManager() |
Creates a manager to retrieve rows from the database.
|
RuleManager |
newRuleManager() |
Creates a manager for building rules and rules-matching applications.
|
ServerConfigurationManager |
newServerConfigManager() |
Creates a manager for configuring the REST server for the database.
|
ServerEvaluationCall |
newServerEval() |
Creates a ServerEvaluationCall for eval and invoke of server-side xquery or
javascript code.
|
SPARQLQueryManager |
newSPARQLQueryManager() |
Creates a manager for executing SPARQL queries and retrieving results.
|
TextDocumentManager |
newTextDocumentManager() |
Creates a document manager for documents containing unstructured text.
|
XMLDocumentManager |
newXMLDocumentManager() |
Creates a document manager for documents containing XML.
|
Transaction |
openTransaction() |
Starts a transaction.
|
Transaction |
openTransaction(java.lang.String name) |
Starts a transaction with the specified name, which makes the transaction easier to recognize
when you get status reports.
|
Transaction |
openTransaction(java.lang.String name,
int timeLimit) |
Starts a transaction with the specified name and time limit.
|
void |
release() |
Closes the database client and releases associated resources.
|
Transaction openTransaction() throws ForbiddenUserException, FailedRequestException
ForbiddenUserExceptionFailedRequestExceptionTransaction openTransaction(java.lang.String name) throws ForbiddenUserException, FailedRequestException
name - the transaction nameForbiddenUserExceptionFailedRequestExceptionTransaction openTransaction(java.lang.String name, int timeLimit) throws ForbiddenUserException, FailedRequestException
name - the transaction nametimeLimit - the number of the transaction in secondsForbiddenUserExceptionFailedRequestExceptionGenericDocumentManager newDocumentManager()
BinaryDocumentManager newBinaryDocumentManager()
JSONDocumentManager newJSONDocumentManager()
TextDocumentManager newTextDocumentManager()
XMLDocumentManager newXMLDocumentManager()
DataMovementManager newDataMovementManager()
QueryManager newQueryManager()
RowManager newRowManager()
RuleManager newRuleManager()
ServerConfigurationManager newServerConfigManager()
GraphManager newGraphManager()
SPARQLQueryManager newSPARQLQueryManager()
<T,ID extends java.io.Serializable> PojoRepository<T,ID> newPojoRepository(java.lang.Class<T> clazz, java.lang.Class<ID> idClass)
T - the pojo type this PojoRepository will manageID - the scalar type of the id for pojos of type <T>clazz - the class type for this PojoRepository to handleidClass - the class type of the id field for this clazz, must obviously
be Serializable or we'll struggle to marshall it<T extends ResourceManager> T init(java.lang.String resourceName, T resourceManager)
T - the type of ResourceManager to init for the extension resourceresourceName - the name of the extension resourceresourceManager - the manager for the extension resourceRequestLogger newLogger(java.io.OutputStream out)
out - the output stream for the logging outputvoid release()
java.lang.Object getClientImplementation()
ServerEvaluationCall newServerEval()
DatabaseClient.ConnectionType getConnectionType()
DatabaseClient.ConnectionResult checkConnection()
DatabaseClient.ConnectionResult with a connected property of true or false.
In the false case it contains the errorMessage property identifying the failure.java.lang.String getHost()
int getPort()
java.lang.String getDatabase()
DatabaseClientFactory.SecurityContext getSecurityContext()
Copyright © 2013-2019 MarkLogic Corporation.