Package | Description |
---|---|
com.marklogic.client.admin |
The package provides the classes for
configuration and initialization of the REST server.
|
com.marklogic.client.alerting |
A REST interface to MarkLogic alerting
capabilities.
|
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.
|
com.marklogic.client.pojo |
The goal of this package (sometimes referred to
as "the pojo facade" is to simplify working with custom Plain Old
Java Objects (pojos) without hassling with persistence
details.
|
com.marklogic.client.semantics |
Modifier and Type | Method | Description |
---|---|---|
void |
ExtensionLibrariesManager.delete(ExtensionLibraryDescriptor libraryDescriptor) |
Removes a library asset from the server.
|
void |
ExtensionLibrariesManager.delete(java.lang.String libraryPath) |
Removes a library asset from the server.
|
void |
QueryOptionsManager.deleteOptions(java.lang.String name) |
Remove a search configuration from the REST
server.
|
void |
NamespacesManager.deletePrefix(java.lang.String prefix) |
Deprecated.
|
void |
TransformExtensionsManager.deleteTransform(java.lang.String transformName) |
Uninstalls the transform.
|
ExtensionLibraryDescriptor[] |
ExtensionLibrariesManager.list() |
Lists all of the library files that are
installed on the server.
|
ExtensionLibraryDescriptor[] |
ExtensionLibrariesManager.list(java.lang.String directory) |
Lists all of the library files in one directory
(infinite depth) on the server.
|
<T> T |
ExtensionLibrariesManager.read(ExtensionLibraryDescriptor libraryDescriptor,
java.lang.Class<T> as) |
Reads the contents of a library asset as an
object of an IO class.
|
<T extends AbstractReadHandle> |
ExtensionLibrariesManager.read(ExtensionLibraryDescriptor libraryDescriptor,
T readHandle) |
Reads the contents of a library asset into a
handle.
|
<T extends AbstractReadHandle> |
ExtensionLibrariesManager.read(java.lang.String libraryPath,
T readHandle) |
Reads the contents of a library asset into a
handle.
|
<T> T |
ExtensionLibrariesManager.readAs(java.lang.String libraryPath,
java.lang.Class<T> as) |
Reads the contents of a library asset as an
object of an IO class.
|
<T extends TextReadHandle> |
TransformExtensionsManager.readJavascriptTransform(java.lang.String transformName,
T sourceHandle) |
Reads the source for a transform implemented in
Javascript.
|
<T> T |
TransformExtensionsManager.readJavascriptTransformAs(java.lang.String transformName,
java.lang.Class<T> as) |
Reads the source for a transform implemented in
Javascript in a textual representation provided as an object of an
IO class.
|
<T extends QueryOptionsReadHandle> |
QueryOptionsManager.readOptions(java.lang.String name,
T queryOptionsHandle) |
Fetch a query options configuration from the
REST Server by name.
|
<T> T |
QueryOptionsManager.readOptionsAs(java.lang.String name,
Format format,
java.lang.Class<T> as) |
Fetch a query options configuration from the
REST Server by name.
|
<T extends TextReadHandle> |
TransformExtensionsManager.readXQueryTransform(java.lang.String transformName,
T sourceHandle) |
Reads the source for a transform implemented in
XQuery.
|
<T> T |
TransformExtensionsManager.readXQueryTransformAs(java.lang.String transformName,
java.lang.Class<T> as) |
Reads the source for a transform implemented in
XQuery in a textual representation provided as an object of an IO
class.
|
<T extends XMLReadHandle> |
TransformExtensionsManager.readXSLTransform(java.lang.String transformName,
T sourceHandle) |
Reads the source for a transform implemented in
XSLT.
|
<T> T |
TransformExtensionsManager.readXSLTransformAs(java.lang.String transformName,
java.lang.Class<T> as) |
Reads the source for a transform implemented in
XSLT in an XML representation provided as an object of an IO
class.
|
void |
NamespacesManager.updatePrefix(java.lang.String prefix,
java.lang.String namespaceURI) |
Deprecated.
|
void |
ExtensionLibrariesManager.write(ExtensionLibraryDescriptor libraryDescriptor,
AbstractWriteHandle contentHandle) |
Writes the contents of a handle to the provided
path on the REST server.
|
void |
ExtensionLibrariesManager.write(java.lang.String libraryPath,
AbstractWriteHandle contentHandle) |
Writes the contents of a handle to the provided
path on the REST server.
|
void |
ExtensionLibrariesManager.writeAs(ExtensionLibraryDescriptor libraryDescriptor,
java.lang.Object content) |
Writes the contents of a handle to the provided
path on the REST server as an object of an IO class.
|
void |
ExtensionLibrariesManager.writeAs(java.lang.String libraryPath,
java.lang.Object content) |
Writes the contents of a handle to the provided
path on the REST server as an object of an IO class.
|
void |
ServerConfigurationManager.writeConfiguration() |
Writes the values of the properties of this
object to the server.
|
void |
TransformExtensionsManager.writeJavascriptTransform(java.lang.String transformName,
TextWriteHandle sourceHandle) |
Installs a transform implemented in
Javascript.
|
void |
TransformExtensionsManager.writeJavascriptTransform(java.lang.String transformName,
TextWriteHandle sourceHandle,
ExtensionMetadata metadata) |
Installs a transform implemented in
Javascript.
|
void |
TransformExtensionsManager.writeJavascriptTransformAs(java.lang.String transformName,
ExtensionMetadata metadata,
java.lang.Object source) |
Installs a transform implemented in Javascript
in a textual representation provided as an object of an IO
class.
|
void |
TransformExtensionsManager.writeJavascriptTransformAs(java.lang.String transformName,
java.lang.Object source) |
Installs a transform implemented in XQuery in a
textual representation provided as an object of an IO class.
|
void |
QueryOptionsManager.writeOptions(java.lang.String name,
QueryOptionsWriteHandle queryOptionsHandle) |
Write a named QueryOptions configuration to the
REST server.
|
void |
QueryOptionsManager.writeOptionsAs(java.lang.String name,
Format format,
java.lang.Object queryOptions) |
Write a named QueryOptions configuration to the
REST server in a JSON or XML representation provided as an object
of an IO class.
|
void |
TransformExtensionsManager.writeXQueryTransform(java.lang.String transformName,
TextWriteHandle sourceHandle) |
Installs a transform implemented in
XQuery.
|
void |
TransformExtensionsManager.writeXQueryTransform(java.lang.String transformName,
TextWriteHandle sourceHandle,
ExtensionMetadata metadata) |
Installs a transform implemented in
XQuery.
|
void |
TransformExtensionsManager.writeXQueryTransformAs(java.lang.String transformName,
ExtensionMetadata metadata,
java.lang.Object source) |
Installs a transform implemented in XQuery in a
textual representation provided as an object of an IO class.
|
void |
TransformExtensionsManager.writeXQueryTransformAs(java.lang.String transformName,
java.lang.Object source) |
Installs a transform implemented in XQuery in a
textual representation provided as an object of an IO class.
|
void |
TransformExtensionsManager.writeXSLTransform(java.lang.String transformName,
XMLWriteHandle sourceHandle) |
Installs a transform implemented in XSL.
|
void |
TransformExtensionsManager.writeXSLTransform(java.lang.String transformName,
XMLWriteHandle sourceHandle,
ExtensionMetadata metadata) |
Installs a transform implemented in XSL.
|
void |
TransformExtensionsManager.writeXSLTransformAs(java.lang.String transformName,
ExtensionMetadata metadata,
java.lang.Object source) |
Installs a transform implemented in XSL in an
XML representation provided as an object of an IO class.
|
void |
TransformExtensionsManager.writeXSLTransformAs(java.lang.String transformName,
java.lang.Object source) |
Installs a transform implemented in XSL in an
XML representation provided as an object of an IO class.
|
Modifier and Type | Method | Description |
---|---|---|
<T extends RuleReadHandle> |
RuleManager.readRule(java.lang.String ruleName,
T readHandle) |
Reads a rule from the server into the provided
handle.
|
<T> T |
RuleManager.readRuleAs(java.lang.String ruleName,
java.lang.Class<T> as) |
Reads a rule from the server in an XML
representation provided as an object of an IO class.
|
void |
RuleManager.writeRule(RuleDefinition writeHandle) |
Writes a rule to the server from the provided
handle.
|
void |
RuleManager.writeRuleAs(java.lang.String ruleName,
java.lang.Object ruleSource) |
Writes a rule to the server in an XML
representation provided as an object of an IO class.
|
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.delete(java.lang.String docId,
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(java.lang.String docId,
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(java.lang.String docId,
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(java.lang.String docId,
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 |
Modifier and Type | Method | 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(Transaction transaction,
java.lang.String... uris) |
Deletes the documents' metadata and content from
an open database transaction To call delete(), an application must
authenticate as rest-writer or rest-admin.
|
void |
DocumentManager.delete(java.lang.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(java.lang.String... uris) |
Deletes the documents' metadata and content To
call delete(), an application must authenticate as rest-writer or
rest-admin.
|
void |
DocumentManager.delete(java.lang.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 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 BinaryReadHandle> |
BinaryDocumentManager.read(java.lang.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(java.lang.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(java.lang.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(java.lang.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 BinaryReadHandle> |
BinaryDocumentManager.read(java.lang.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(java.lang.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(java.lang.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(java.lang.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(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.
|
<T extends R> |
DocumentManager.read(java.lang.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 R> |
DocumentManager.read(java.lang.String docId,
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(java.lang.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(java.lang.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(java.lang.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 R> |
DocumentManager.read(java.lang.String docId,
T contentHandle, ServerTransform transform) |
Reads the document content from the database as
transformed on the server.
|
<T extends R> |
DocumentManager.read(java.lang.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(java.lang.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> T |
BinaryDocumentManager.readAs(java.lang.String docId,
DocumentMetadataReadHandle metadataHandle,
java.lang.Class<T> as, long start,
long length) |
Reads a range of bytes from the content of a
binary database document in the representation specified by the IO
class.
|
<T> T |
BinaryDocumentManager.readAs(java.lang.String docId,
java.lang.Class<T> as, long start,
long length) |
Reads a range of bytes from the content of a
binary database document in the representation specified by the IO
class.
|
<T> T |
DocumentManager.readAs(java.lang.String docId,
DocumentMetadataReadHandle metadataHandle,
java.lang.Class<T> as) |
Reads the document metadata and content from the
database in the representation specified by the IO class.
|
<T> T |
DocumentManager.readAs(java.lang.String docId,
DocumentMetadataReadHandle metadataHandle,
java.lang.Class<T> as, ServerTransform transform) |
Reads the document metadata and content from the
database in the representation specified by the IO class.
|
<T> T |
DocumentManager.readAs(java.lang.String docId,
java.lang.Class<T> as) |
Reads the document content from the database in
the representation specified by the IO class.
|
<T> T |
DocumentManager.readAs(java.lang.String docId,
java.lang.Class<T> as, ServerTransform transform) |
Reads the document content from the database in
the representation specified by the IO class.
|
<T extends DocumentMetadataReadHandle> |
DocumentManager.readMetadata(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String docId,
W contentHandle,
ServerTransform transform) |
Writes the document content to the database as
transformed on the server.
|
void |
DocumentManager.write(java.lang.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(java.lang.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.writeAs(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
java.lang.Object content) |
Writes the document content to the database from
an object of an IO class.
|
void |
DocumentManager.writeAs(java.lang.String docId,
DocumentMetadataWriteHandle metadataHandle,
java.lang.Object content, ServerTransform transform) |
Writes the document content to the database from
an object of an IO class.
|
void |
DocumentManager.writeAs(java.lang.String docId,
java.lang.Object content) |
Writes the document content to the database from
an object of an IO class.
|
void |
DocumentManager.writeAs(java.lang.String docId,
java.lang.Object content, ServerTransform transform) |
Writes the document content to the database from
an object of an IO class.
|
void |
DocumentManager.writeDefaultMetadata(Transaction transaction,
java.lang.String... uris) |
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.writeDefaultMetadata(java.lang.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(java.lang.String... uris) |
Reverts the metadata in the database for the
documents to the defaults To call writeDefaultMetadata(), an
application must authenticate as rest-writer or rest-admin.
|
void |
DocumentManager.writeDefaultMetadata(java.lang.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(java.lang.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(java.lang.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 | Description |
---|---|---|
void |
PojoRepository.delete(ID... ids) |
Deletes from the database the persisted pojo
instances with the corresponding ids
|
void |
PojoRepository.delete(ID[] ids,
Transaction transaction) |
As part of transaction, deletes from the
database the documents with the corresponding ids
|
void |
PojoRepository.deleteAll() |
Deletes from the database all documents of the
type managed by this PojoRepositoryof type T persisted by the pojo
facade
|
void |
PojoRepository.deleteAll(Transaction transaction) |
As part of transaction, deletes from the
database all documents of the type managed by this PojoRepositoryof
type T persisted by the pojo facade
|
T |
PojoRepository.read(ID id) |
Read one persisted pojo by id and unmarshall its
data into a new pojo instance.
|
T |
PojoRepository.read(ID id, Transaction transaction) |
Within an open transaction, read one persisted
pojo by id and unmarshall its data into a new pojo instance.
|
void |
PojoRepository.write(T entity) |
Write this instance to the database.
|
void |
PojoRepository.write(T entity,
Transaction transaction) |
Does everything in
write(T) but in your multi-statement
transaction context. |
void |
PojoRepository.write(T entity,
Transaction transaction,
java.lang.String... collections) |
Does everything in
write(T) but also adds your collections to the
persisted instance and performs the write in your multi-statement
transaction context. |
void |
PojoRepository.write(T entity,
java.lang.String... collections) |
Does everything in
write(T) but also adds your collections to the
persisted instance. |
Modifier and Type | Method | Description |
---|---|---|
void |
GraphManager.delete(java.lang.String uri) |
Permanently delete the specified graph from the
server.
|
void |
GraphManager.delete(java.lang.String uri,
Transaction transaction) |
Permanently delete the specified graph from the
server.
|
void |
GraphManager.deleteGraphs() |
Permanently delete all quads from all
graphs.
|
void |
GraphManager.deleteGraphs(Transaction transaction) |
Permanently delete all quads from all
graphs.
|
void |
GraphManager.deletePermissions(java.lang.String uri) |
Delete all permissions for the graph.
|
void |
GraphManager.deletePermissions(java.lang.String uri,
Transaction transaction) |
Delete all permissions for the graph.
|
GraphPermissions |
GraphManager.getPermissions(java.lang.String uri) |
Retrieve permissions for a graph.
|
GraphPermissions |
GraphManager.getPermissions(java.lang.String uri,
Transaction transaction) |
Retrieve permissions for a graph.
|
void |
GraphManager.merge(java.lang.String uri,
TriplesWriteHandle handle) |
Add triples from the handle to the specified
graph.
|
void |
GraphManager.merge(java.lang.String uri,
TriplesWriteHandle handle,
GraphPermissions permissions) |
Add triples from the handle and add specified
permissions to the specified graph.
|
void |
GraphManager.merge(java.lang.String uri,
TriplesWriteHandle handle,
GraphPermissions permissions,
Transaction transaction) |
Add triples from the handle and add specified
permissions to the specified graph.
|
void |
GraphManager.merge(java.lang.String uri,
TriplesWriteHandle handle,
Transaction transaction) |
Add triples from the handle to the specified
graph.
|
void |
GraphManager.mergeAs(java.lang.String uri,
java.lang.Object graphData) |
Add triples from the graphData object to the
specified graph.
|
void |
GraphManager.mergeAs(java.lang.String uri,
java.lang.Object graphData, GraphPermissions permissions) |
Add triples from the graphData object and add
specified permissions to the specified graph.
|
void |
GraphManager.mergeAs(java.lang.String uri,
java.lang.Object graphData, GraphPermissions permissions,
Transaction transaction) |
Add triples from the graphData object and add
specified permissions to the specified graph.
|
void |
GraphManager.mergeAs(java.lang.String uri,
java.lang.Object graphData, Transaction transaction) |
Add triples from the graphData object to the
specified graph.
|
void |
GraphManager.mergeGraphs(QuadsWriteHandle handle) |
Add quads from the handle to the graphs
specified in the quads data.
|
void |
GraphManager.mergeGraphs(QuadsWriteHandle handle,
Transaction transaction) |
Add quads from the handle to the graphs
specified in the quads data.
|
void |
GraphManager.mergeGraphsAs(java.lang.Object quadsData) |
Add quads from the object to the graphs
specified in the quads data.
|
void |
GraphManager.mergeGraphsAs(java.lang.Object quadsData,
Transaction transaction) |
Add quads from the object to the graphs
specified in the quads data.
|
void |
GraphManager.mergePermissions(java.lang.String uri,
GraphPermissions permissions) |
Add to permissions on the graph.
|
void |
GraphManager.mergePermissions(java.lang.String uri,
GraphPermissions permissions,
Transaction transaction) |
Add to permissions on the graph.
|
<T extends TriplesReadHandle> |
GraphManager.read(java.lang.String uri,
T handle) |
Read triples from the server.
|
<T extends TriplesReadHandle> |
GraphManager.read(java.lang.String uri,
T handle, Transaction transaction) |
Read triples from the server.
|
<T> T |
GraphManager.readAs(java.lang.String uri,
java.lang.Class<T> as) |
Read triples from the server as the specified
type.
|
<T> T |
GraphManager.readAs(java.lang.String uri,
java.lang.Class<T> as, Transaction transaction) |
Read triples from the server as the specified
type.
|
void |
GraphManager.replaceGraphs(QuadsWriteHandle handle) |
Remove all quads from all graphs then insert
quads from the handle to the graphs specified in the quads
data.
|
void |
GraphManager.replaceGraphs(QuadsWriteHandle handle,
Transaction transaction) |
Remove all quads from all graphs then insert
quads from the handle to the graphs specified in the quads
data.
|
void |
GraphManager.replaceGraphsAs(java.lang.Object quadsData) |
Remove all quads from all graphs then insert
quads from the quadsData to the graphs specified in the quads
data.
|
void |
GraphManager.replaceGraphsAs(java.lang.Object quadsData,
Transaction transaction) |
Remove all quads from all graphs then insert
quads from the quadsData to the graphs specified in the quads
data.
|
<T extends TriplesReadHandle> |
GraphManager.things(T handle,
java.lang.String... iris) |
Retrieves all triples related to specified
subject or object iris.
|
<T> T |
GraphManager.thingsAs(java.lang.Class<T> as,
java.lang.String... iris) |
Retrieves all triples related to specified
subject or object iris.
|
void |
GraphManager.write(java.lang.String uri,
TriplesWriteHandle handle) |
Overwrite triples from the handle as the
specified graph.
|
void |
GraphManager.write(java.lang.String uri,
TriplesWriteHandle handle,
GraphPermissions permissions) |
Overwrite triples from the handle and specified
permissions as the specified graph.
|
void |
GraphManager.write(java.lang.String uri,
TriplesWriteHandle handle,
GraphPermissions permissions,
Transaction transaction) |
Overwrite triples from the handle and specified
permissions as the specified graph.
|
void |
GraphManager.write(java.lang.String uri,
TriplesWriteHandle handle,
Transaction transaction) |
Overwrite triples from the handle as the
specified graph.
|
void |
GraphManager.writeAs(java.lang.String uri,
java.lang.Object graphData) |
Overwrite triples from the graphData object as
the specified graph.
|
void |
GraphManager.writeAs(java.lang.String uri,
java.lang.Object graphData, GraphPermissions permissions) |
Overwrite triples from the graphData object and
specified permissions as the specified graph.
|
void |
GraphManager.writeAs(java.lang.String uri,
java.lang.Object graphData, GraphPermissions permissions,
Transaction transaction) |
Overwrite triples from the graphData object and
specified permissions as the specified graph.
|
void |
GraphManager.writeAs(java.lang.String uri,
java.lang.Object graphData, Transaction transaction) |
Overwrite triples from the graphData object as
the specified graph.
|
void |
GraphManager.writePermissions(java.lang.String uri,
GraphPermissions permissions) |
Overwrite all permissions for the graph.
|
void |
GraphManager.writePermissions(java.lang.String uri,
GraphPermissions permissions,
Transaction transaction) |
Overwrite all permissions for the graph.
|
Copyright © 2022 MarkLogic Corporation