Package | Description |
---|---|
com.marklogic.client |
The package provides the core classes, interfaces and exceptions for working with the database.
|
com.marklogic.client.document |
The package provides classes for creating, retrieving, updating, and deleting
documents in the database for the REST server.
|
com.marklogic.client.extensions |
The package provides base and support classes so you can derive
a new Resource Manager to provide a client interface for a
Resource Services extension on the REST server.
|
com.marklogic.client.query |
The package provides classes for queries including searching documents
and reading values directly from indexes in the database for the REST server.
|
Modifier and Type | Method and Description |
---|---|
Transaction |
DatabaseClient.openTransaction()
Starts a transaction.
|
Transaction |
DatabaseClient.openTransaction(String name)
Starts a transaction with the specified name, which makes the transaction easier to recognize
when you get status reports.
|
Transaction |
DatabaseClient.openTransaction(String name,
int timeLimit)
Starts a transaction with the specified name and time limit.
|
Modifier and Type | Method and Description |
---|---|
DocumentDescriptor |
DocumentManager.create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Creates a database document with metadata and content and a uri assigned by the server in an open database transaction as transformed on the server.
|
DocumentDescriptor |
DocumentManager.create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
Transaction transaction) |
DocumentDescriptor |
DocumentManager.create(DocumentUriTemplate template,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Creates a database document with a uri assigned by the server in an open database transaction as transformed on the server.
|
DocumentDescriptor |
DocumentManager.create(DocumentUriTemplate template,
W contentHandle,
Transaction transaction)
Creates a database document with a uri assigned by the server in an open database transaction.
|
void |
DocumentManager.delete(DocumentDescriptor desc,
Transaction transaction)
Deletes the document metadata and content from an open database transaction
To call delete(), an application must authenticate as rest-writer or rest-admin.
|
void |
DocumentManager.delete(String docId,
Transaction transaction)
Deletes the document metadata and content from an open database transaction
To call delete(), an application must authenticate as rest-writer or rest-admin.
|
DocumentDescriptor |
DocumentManager.exists(String docId,
Transaction transaction)
Checks whether a document exists in an open transaction and gets its length and format
To call exists(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
void |
DocumentManager.patch(DocumentDescriptor desc,
DocumentPatchHandle patch,
Transaction transaction)
Modifies the metadata or content of a document within an open database transaction on the server.
|
void |
DocumentManager.patch(String docId,
DocumentPatchHandle patch,
Transaction transaction)
Modifies the metadata or content of a document within an open database transaction on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
long start,
long length,
Transaction transaction)
Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
long start,
long length,
Transaction transaction)
Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document metadata and content from an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
Transaction transaction)
Reads the document metadata and content from an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
T contentHandle,
long start,
long length,
Transaction transaction)
Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform,
long start,
long length,
Transaction transaction)
Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document content from an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle,
Transaction transaction)
Reads the document content from an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
long start,
long length,
Transaction transaction)
Reads metadata and a range of bytes from the content of a binary document for an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
long start,
long length,
Transaction transaction)
Reads metadata and a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document metadata and content from an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
Transaction transaction)
Reads the document metadata and content from an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
T contentHandle,
long start,
long length,
Transaction transaction)
Reads a range of bytes from the content of a binary document for an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
T contentHandle,
ServerTransform transform,
long start,
long length,
Transaction transaction)
Reads a range of bytes from the content of a binary document for an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(String docId,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document content from an open database transaction as transformed on the server.
|
<T extends R> |
DocumentManager.read(String docId,
T contentHandle,
Transaction transaction)
Reads the document content from an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends DocumentMetadataReadHandle> |
DocumentManager.readMetadata(String docId,
T metadataHandle,
Transaction transaction)
Reads the document metadata from an open database transaction in the representation provided by the handle
To call readMetadata(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
void |
DocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document metadata and content to an open database transaction as transformed on the server.
|
void |
DocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
Transaction transaction)
Writes the document metadata and content to an open database transaction from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
DocumentManager.write(DocumentDescriptor desc,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document content to an open database transaction as transformed on the server.
|
void |
DocumentManager.write(DocumentDescriptor desc,
W contentHandle,
Transaction transaction)
Writes the document content to an open database transaction from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
DocumentManager.write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document metadata and content to an open database transaction as transformed on the server.
|
void |
DocumentManager.write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
Transaction transaction)
Writes the document metadata and content to an open database transaction from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
DocumentManager.write(String docId,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document content to an open database transaction as transformed on the server.
|
void |
DocumentManager.write(String docId,
W contentHandle,
Transaction transaction)
Writes the document content to an open database transaction from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
DocumentManager.writeDefaultMetadata(String docId,
Transaction transaction)
Reverts the document metadata in an open database transaction to the defaults
To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
|
void |
DocumentManager.writeMetadata(String docId,
DocumentMetadataWriteHandle metadataHandle,
Transaction transaction)
Writes the document metadata to an open database transaction from the representation provided by the handle
To call writeMetadata(), an application must authenticate as rest-writer or rest-admin.
|
Modifier and Type | Method and Description |
---|---|
<R extends AbstractReadHandle> |
ResourceServices.delete(RequestParameters params,
Transaction transaction,
R output)
Deletes content by calling a DELETE service.
|
<R extends AbstractReadHandle> |
ResourceServices.get(RequestParameters params,
Transaction transaction,
R output)
Reads resource content by calling a GET service.
|
ResourceServices.ServiceResultIterator |
ResourceServices.get(RequestParameters params,
Transaction transaction,
String... mimetypes)
Reads multiple resource content by calling a GET service.
|
<R extends AbstractReadHandle> |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
R output)
Applies content by calling a POST service.
|
ResourceServices.ServiceResultIterator |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
String... mimetypes)
Applies multiple content by calling a POST service.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
Transaction transaction,
R output)
Applies content by calling a POST service.
|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input,
Transaction transaction,
String... mimetypes)
Applies multiple content by calling a POST service.
|
<R extends AbstractReadHandle> |
ResourceServices.put(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
R output)
Writes content by calling a PUT service.
|
<R extends AbstractReadHandle,W extends AbstractWriteHandle> |
ResourceServices.put(RequestParameters params,
W[] input,
Transaction transaction,
R output)
Writes multiple content by calling a PUT service.
|
Modifier and Type | Method and Description |
---|---|
void |
QueryManager.delete(DeleteQueryDefinition querydef,
Transaction transaction)
Deletes documents based on the query criteria as part
of the specified transaction.
|
MatchDocumentSummary |
QueryManager.findOne(QueryDefinition querydef,
Transaction transaction)
The findOne method is a convenience.
|
<T extends QueryOptionsListReadHandle> |
QueryManager.optionsList(T valueHandle,
Transaction transaction)
Retrieves the list of available named query options.
|
<T extends SearchReadHandle> |
QueryManager.search(QueryDefinition querydef,
T searchHandle,
long start,
Transaction transaction)
Searches documents based on query criteria and, potentially, previously
saved query options starting with the specified page listing
document results.
|
<T extends SearchReadHandle> |
QueryManager.search(QueryDefinition querydef,
T searchHandle,
Transaction transaction)
Searches documents based on query criteria and, potentially, previously
saved query options.
|
<T extends TuplesReadHandle> |
QueryManager.tuples(ValuesDefinition valdef,
T tupleHandle,
long start,
Transaction transaction)
Retrieves combinations of values for the same document from indexes
based on query criteria and, potentially, previously saved query options.
|
<T extends TuplesReadHandle> |
QueryManager.tuples(ValuesDefinition valdef,
T tupleHandle,
Transaction transaction)
Retrieves combinations of values for the same document from indexes
based on query criteria and, potentially, previously saved query options.
|
<T extends ValuesReadHandle> |
QueryManager.values(ValuesDefinition valdef,
T valueHandle,
long start,
Transaction transaction)
Retrieves values from indexes based on query criteria and, potentially,
previously saved query options.
|
<T extends ValuesReadHandle> |
QueryManager.values(ValuesDefinition valdef,
T valueHandle,
Transaction transaction)
Retrieves values from indexes based on query criteria and, potentially,
previously saved query options.
|
<T extends ValuesListReadHandle> |
QueryManager.valuesList(ValuesListDefinition valdef,
T valueHandle,
Transaction transaction)
Retrieves the list of available named lexicon configurations from the
values list definition and, potentially, previously saved query options.
|
Copyright © 2013-2015 MarkLogic Corporation.