Package | Description |
---|---|
com.marklogic.client.bitemporal | |
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 | Interface | Description |
---|---|---|
interface |
TemporalDescriptor |
Modifier and Type | Method | Description |
---|---|---|
TemporalDescriptor |
TemporalDocumentManager.delete(DocumentDescriptor desc,
Transaction transaction,
java.lang.String temporalCollection) |
Just like
delete but delete
document in a temporalCollection, which will enforce all the rules of
bitemporal data management. |
TemporalDescriptor |
TemporalDocumentManager.delete(DocumentDescriptor desc,
Transaction transaction,
java.lang.String temporalCollection,
java.util.Calendar systemTime) |
Just like
delete but delete
document at a specified system time |
TemporalDescriptor |
TemporalDocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection) |
Just like
write but write document
in a temporalCollection, which will enforce all the rules of
bitemporal data management. |
TemporalDescriptor |
TemporalDocumentManager.write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection,
java.util.Calendar systemTime) |
Just like
write but write document
at a specific system time |
TemporalDescriptor |
TemporalDocumentManager.write(DocumentDescriptor desc,
java.lang.String temporalDocumentURI,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection) |
Just like
write but creates a new
version of the document in the logical temporal collection URI passed as argument
and names the new version of the document as the URI in the Document descriptor |
TemporalDescriptor |
TemporalDocumentManager.write(DocumentDescriptor desc,
java.lang.String temporalDocumentURI,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection,
java.util.Calendar systemTime) |
Just like
write but writes document
at a specific system time |
Modifier and Type | Method | Description |
---|---|---|
DocumentDescriptor |
DocumentManager.create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle) |
Creates a database document with metadata and content and a uri assigned by the server.
|
DocumentDescriptor |
DocumentManager.create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform) |
Creates a database document with metadata and content and a uri assigned by the server as transformed on the server.
|
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) |
Creates a database document with a uri assigned by the server.
|
DocumentDescriptor |
DocumentManager.create(DocumentUriTemplate template,
W contentHandle,
ServerTransform transform) |
Creates a database document with a uri assigned by the server as transformed on the server.
|
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.
|
DocumentDescriptor |
DocumentManager.createAs(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
java.lang.Object content) |
Creates a database document with a uri assigned by the server from an object of an IO class.
|
DocumentDescriptor |
DocumentManager.createAs(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
java.lang.Object content,
ServerTransform transform) |
Creates a database document with a uri assigned by the server from an object of an IO class.
|
DocumentDescriptor |
DocumentManager.createAs(DocumentUriTemplate template,
java.lang.Object content) |
Creates a database document with a uri assigned by the server from an object of an IO class.
|
DocumentDescriptor |
DocumentManager.createAs(DocumentUriTemplate template,
java.lang.Object content,
ServerTransform transform) |
Creates a database document with a uri assigned by the server from an object of an IO class.
|
DocumentDescriptor |
DocumentManager.exists(java.lang.String docId) |
Checks whether a document exists and gets its byte length, format, mimetype, and version
if it does.
|
DocumentDescriptor |
DocumentManager.exists(java.lang.String docId,
Transaction transaction) |
Checks whether a document exists in an open transaction and gets its byte length, format,
mimetype, and version if it does.
|
DocumentDescriptor |
DocumentRecord.getDescriptor() |
Returns a descriptor for the document content including the document version
if enabled on the server.
|
DocumentDescriptor |
DocumentManager.newDescriptor(java.lang.String uri) |
Creates a document descriptor for identifying the uri of a document,
its format and mimetype, and its version.
|
DocumentDescriptor |
DocumentDescriptor.withFormat(Format format) |
Specifies the format for a database document and
returns the descriptor object
|
Modifier and Type | Method | Description |
---|---|---|
DocumentWriteSet |
DocumentWriteSet.add(DocumentDescriptor desc,
AbstractWriteHandle contentHandle) |
Adds to this write set a document with the given uri template, and
contents provided by the handle
|
DocumentWriteSet |
DocumentWriteSet.add(DocumentDescriptor desc,
AbstractWriteHandle contentHandle,
java.lang.String temporalDocumentURI) |
Adds to this write set a document with the given uri template, temporalDocumentURI and
contents provided by the handle
|
DocumentWriteSet |
DocumentWriteSet.add(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
AbstractWriteHandle contentHandle) |
Adds to this write set a document with the given uri template, metadata,
and contents provided by the handle
|
DocumentWriteSet |
DocumentWriteSet.add(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
AbstractWriteHandle contentHandle,
java.lang.String temporalDocumentURI) |
Adds to this write set a document with the given uri template, metadata, temporalDocumentURI
and contents provided by the handle
|
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.patch(DocumentDescriptor desc,
DocumentPatchHandle patch) |
Modifies the metadata or content of a document.
|
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.
|
<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 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 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 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,
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 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 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 R> |
DocumentManager.read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform) |
Reads the document content from the database 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.
|
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.
|
Copyright © 2013-2019 MarkLogic Corporation.