public interface DatabaseClient
Modifier and Type | Method and Description |
---|---|
Object |
getClientImplementation()
Returns the client object from the library that implements communication with the
server.
|
<T extends ResourceManager> |
init(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.
|
GenericDocumentManager |
newDocumentManager()
Creates a document manager for documents with unknown or heterogeneous formats.
|
JSONDocumentManager |
newJSONDocumentManager()
Creates a document manager for documents containing a JSON structure.
|
RequestLogger |
newLogger(OutputStream out)
Creates a logger for document and query requests.
|
QueryManager |
newQueryManager()
Creates a manager for querying 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.
|
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(String name)
Starts a transaction with the specified name, which makes the transaction easier to recognize
when you get status reports.
|
Transaction |
openTransaction(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
ForbiddenUserException
FailedRequestException
Transaction openTransaction(String name) throws ForbiddenUserException, FailedRequestException
name
- the transaction nameForbiddenUserException
FailedRequestException
Transaction openTransaction(String name, int timeLimit) throws ForbiddenUserException, FailedRequestException
name
- the transaction nametimeLimit
- the number of the transaction in secondsForbiddenUserException
FailedRequestException
GenericDocumentManager newDocumentManager()
BinaryDocumentManager newBinaryDocumentManager()
JSONDocumentManager newJSONDocumentManager()
TextDocumentManager newTextDocumentManager()
XMLDocumentManager newXMLDocumentManager()
QueryManager newQueryManager()
RuleManager newRuleManager()
ServerConfigurationManager newServerConfigManager()
<T extends ResourceManager> T init(String resourceName, T resourceManager)
resourceName
- the name of the extension resourceresourceManager
- the manager for the extension resourceRequestLogger newLogger(OutputStream out)
out
- the output stream for the logging outputvoid release()
Object getClientImplementation()
Copyright © 2013-2015 MarkLogic Corporation.