| Package | Description |
|---|---|
| com.marklogic.client.admin |
The package provides the classes for configuration and initialization
of the REST server.
|
| com.marklogic.client.document |
The package provides classes for creating, retrieving, updating, and deleting
documents in the database for the REST server.
|
| Modifier and Type | Method and Description |
|---|---|
void |
NamespacesManager.deletePrefix(String prefix)
Deletes a namespace binding on the server.
|
void |
NamespacesManager.updatePrefix(String prefix,
String namespaceURI)
Writes a namespace binding on the server.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DocumentManager.delete(DocumentDescriptor desc)
Deletes the document metadata and content from the database
To call delete(), an application must authenticate as rest-writer or rest-admin.
|
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)
Deletes the document metadata and content from the database
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.
|
<T extends R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle)
Reads the document metadata and content from the database 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,
long start,
long length)
Reads metadata and a range of bytes from the content of a binary database document 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,
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 R> |
DocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform)
Reads the document metadata and content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
long start,
long length)
Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.
|
<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 R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle)
Reads the document content from the database 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)
Reads a range of bytes from the content of a binary database document 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,
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 R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform)
Reads the document content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform,
long start,
long length)
Reads a range of bytes from the content of a binary database document as transformed on the server.
|
<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 R> |
DocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle)
Reads the document metadata and content from the database 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,
long start,
long length)
Reads metadata and a range of bytes from the content of a binary database document 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,
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 R> |
DocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform)
Reads the document metadata and content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
long start,
long length)
Reads metadata and a range of bytes from the content of a binary database document as transformed on the server.
|
<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 R> |
DocumentManager.read(String docId,
T contentHandle)
Reads the document content from the database 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,
long start,
long length)
Reads a range of bytes from the content of a binary database document 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,
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 R> |
DocumentManager.read(String docId,
T contentHandle,
ServerTransform transform)
Reads the document content from the database as transformed on the server.
|
<T extends BinaryReadHandle> |
BinaryDocumentManager.read(String docId,
T contentHandle,
ServerTransform transform,
long start,
long length)
Reads a range of bytes from the content of a binary database document as transformed on the server.
|
<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)
Reads the document metadata from the database in the representation provided by the handle
To call readMetadata(), 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)
Writes the document metadata and content to the database 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,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform)
Writes the document metadata and content to the database as transformed on the server.
|
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)
Writes the document content to the database from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
DocumentManager.write(DocumentDescriptor desc,
W contentHandle,
ServerTransform transform)
Writes the document content to the database as transformed on the server.
|
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)
Writes the document metadata and content to the database 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,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform)
Writes the document metadata and content to the database as transformed on the server.
|
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)
Writes the document content to the database 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,
W contentHandle,
ServerTransform transform)
Writes the document content to the database as transformed on the server.
|
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)
Reverts the document metadata in the database to the defaults
To call writeDefaultMetadata(), 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)
Writes the document metadata to the database from the representation provided by the handle
To call writeMetadata(), 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.
|
Copyright © 2013-2014 MarkLogic Corporation.