Package | Description |
---|---|
com.marklogic.client |
The package provides the core classes,
interfaces and exceptions for working with the database.
|
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.eval | |
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.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.query |
The package provides classes for queries
including searching documents and reading values directly from
indexes in the database for the REST server.
|
com.marklogic.client.row |
The package provides classes for sending plan
requests to and processing row responses from the REST
server.
|
com.marklogic.client.semantics |
Modifier and Type | Method and Description |
---|---|
Transaction |
DatabaseClient.openTransaction()
Starts a transaction.
|
Transaction |
DatabaseClient.openTransaction(java.lang.String name)
Starts a transaction with the specified name,
which makes the transaction easier to recognize when you get status
reports.
|
Transaction |
DatabaseClient.openTransaction(java.lang.String name,
int timeLimit)
Starts a transaction with the specified name and
time limit.
|
Modifier and Type | Method and Description |
---|---|
TemporalDescriptor |
TemporalDocumentManager.create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection)
Just like
create but create document in a
temporalCollection, which will enforce all the rules of bitemporal data
management. |
TemporalDescriptor |
TemporalDocumentManager.create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection,
java.util.Calendar systemTime)
Just like
create but create document at a specific system
time |
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 |
void |
TemporalDocumentManager.patch(java.lang.String uri,
java.lang.String temporalCollection, DocumentPatchHandle patch,
Transaction transaction)
Modifies the content of a temporal JSON or XML
document in the temporal collection.
|
void |
TemporalDocumentManager.patch(java.lang.String uri,
java.lang.String temporalDocumentURI,
java.lang.String temporalCollection,
java.lang.String sourceDocumentURI, DocumentPatchHandle patch,
Transaction transaction)
Patches a temporal document by taking the
content from the sourceDocumentURI present in the
temporalDocumentURI collection with the patch handle and creates a
new version identified by the uri in the temporalCollection.
|
void |
TemporalDocumentManager.protect(java.lang.String temporalDocumentURI,
java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level,
java.util.Calendar expiryTime,
java.lang.String archivePath, Transaction transaction)
Protects the temporal document from document
update, wipe or delete till the expiryTime provided and saves the
serialized copy of the current version in the path given
|
void |
TemporalDocumentManager.protect(java.lang.String temporalDocumentURI,
java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level,
java.util.Calendar expiryTime, Transaction transaction)
Protects the temporal document from document
update, wipe or delete till the expiryTime provided
|
void |
TemporalDocumentManager.protect(java.lang.String temporalDocumentURI,
java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level,
javax.xml.datatype.Duration duration,
java.lang.String archivePath, Transaction transaction)
Protects the temporal document from document
update, wipe or delete till the expiryTime provided and saves the
serialized copy of the current version in the path given
|
void |
TemporalDocumentManager.protect(java.lang.String temporalDocumentURI,
java.lang.String temporalCollection, TemporalDocumentManager.ProtectionLevel level,
javax.xml.datatype.Duration duration, Transaction transaction)
Protects the temporal document from document
update, wipe or delete for the specified duration.
|
void |
TemporalDocumentManager.wipe(java.lang.String temporalDocumentURI,
Transaction transaction,
java.lang.String temporalCollection)
Removes all the versions of the temporal
document specified by the temporal document logical URI in the
temporalCollection
|
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 |
void |
TemporalDocumentManager.write(DocumentWriteSet writeSet,
ServerTransform transform,
Transaction transaction,
java.lang.String temporalCollection)
Just like
write but create 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)
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 |
TemporalDescriptor |
TemporalDocumentManager.write(java.lang.String uri,
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 docId passed. |
TemporalDescriptor |
TemporalDocumentManager.write(java.lang.String uri,
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 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(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.
|
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.
|
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.
|
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(java.lang.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.
|
DocumentPage |
DocumentManager.read(ServerTransform transform,
Transaction transaction,
java.lang.String... uris)
Reads from the database a list of documents
matching the provided uris.
|
<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, 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(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 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, 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(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.
|
DocumentPage |
DocumentManager.read(Transaction transaction,
java.lang.String... uris)
Reads from the database a list of documents
matching the provided uris.
|
<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.
|
DocumentPage |
DocumentManager.readMetadata(Transaction transaction,
java.lang.String... uris)
Reads from the database the metadata for a list
of documents matching the provided uris.
|
DocumentPage |
DocumentManager.search(SearchQueryDefinition querydef,
long start, SearchReadHandle searchHandle,
Transaction transaction)
Just like
QueryManager.search(SearchQueryDefinition, SearchReadHandle,
long, Transaction) but return complete documents via
iterable DocumentPage. |
DocumentPage |
DocumentManager.search(SearchQueryDefinition querydef,
long start, SearchReadHandle searchHandle,
Transaction transaction,
java.lang.String forestName)
Just like
QueryManager.search(SearchQueryDefinition, SearchReadHandle,
long, Transaction, String) but return complete documents
via iterable DocumentPage. |
DocumentPage |
DocumentManager.search(SearchQueryDefinition querydef,
long start, Transaction transaction)
Just like
QueryManager.search but return complete documents
via iterable DocumentPage. |
DocumentPage |
DocumentManager.search(SearchQueryDefinition querydef,
long start, Transaction transaction,
java.lang.String forestName)
Just like
QueryManager.search but return complete documents
via iterable DocumentPage. |
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(DocumentWriteSet writeSet,
ServerTransform transform,
Transaction transaction)
Write a set of documents and metadata to the
server via REST API bulk capabilities.
|
void |
DocumentManager.write(DocumentWriteSet writeSet,
Transaction transaction)
Write a set of documents and metadata to the
server via REST API bulk capabilities.
|
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,
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.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.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.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 and Description |
---|---|
ServerEvaluationCall |
ServerEvaluationCall.transaction(Transaction transaction)
Initialize this call with a transaction under
which server-side execution should occur.
|
Modifier and Type | Method and Description |
---|---|
<R extends AbstractReadHandle> |
ResourceServices.delete(RequestParameters params,
Transaction transaction,
R output)
Deletes content by calling a DELETE
service.
|
ResourceServices.ServiceResultIterator |
ResourceServices.get(RequestParameters params,
Transaction transaction)
Reads multiple resource content by calling a GET
service.
|
<R extends AbstractReadHandle> |
ResourceServices.get(RequestParameters params,
Transaction transaction,
R output)
Reads resource content by calling a GET
service.
|
ResourceServices.ServiceResultIterator |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction)
Applies multiple content by calling a POST
service.
|
<R extends AbstractReadHandle> |
ResourceServices.post(RequestParameters params,
AbstractWriteHandle input,
Transaction transaction,
R output)
Applies content by calling a POST service.
|
<W extends AbstractWriteHandle> |
ResourceServices.post(RequestParameters params,
W[] input, Transaction transaction)
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.
|
<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 |
---|---|
long |
PojoRepository.count(PojoQueryDefinition query,
Transaction transaction)
In the context of transaction, the number of
documents of the type managed by this PojoRepository persisted in
the database which match the query
|
long |
PojoRepository.count(java.lang.String[] collections,
Transaction transaction)
In the context of transaction, the number of
documents of the type managed by this PojoRepository persisted in
the database with at least one of the criteria collections
|
long |
PojoRepository.count(Transaction transaction)
In the context of transaction, the number of
documents of the type managed by this PojoRepository persisted in
the database
|
void |
PojoRepository.delete(ID[] ids,
Transaction transaction)
As part of transaction, deletes from the
database the documents with the corresponding ids
|
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
|
boolean |
PojoRepository.exists(ID id, Transaction transaction)
True if in the context of transaction, a
document exists in the database with the specified id
|
PojoPage<T> |
PojoRepository.read(ID[] ids,
Transaction transaction)
Within an open transaction, read multiple
persisted pojos and unmarshall their data into new pojo
instances.
|
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.
|
PojoPage<T> |
PojoRepository.readAll(long start,
Transaction transaction)
Within an open transaction, read one page of
persisted pojos of the type managed by this PojoRepository and
unmarshall their data into new pojo instances.
|
PojoPage<T> |
PojoRepository.search(long start,
Transaction transaction,
java.lang.String... collections)
Within an open transaction, find all persisted
pojos of the type managed by this PojoRepository also in one of the
specified collections and unmarshall their data into new pojo
instances.
|
PojoPage<T> |
PojoRepository.search(PojoQueryDefinition query,
long start, SearchReadHandle searchHandle,
Transaction transaction)
Within an open transaction, search persisted
pojos of the type managed by this PojoRepository for matches to
this query and unmarshall their data into new pojo instances.
|
PojoPage<T> |
PojoRepository.search(PojoQueryDefinition query,
long start, Transaction transaction)
Within an open transaction, search persisted
pojos of the type managed by this PojoRepository for matches to
this query and unmarshall their data into new pojo instances.
|
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. |
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(SearchQueryDefinition 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(SearchQueryDefinition querydef,
T searchHandle, long start, Transaction transaction,
java.lang.String forestName)
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(SearchQueryDefinition querydef,
T searchHandle, Transaction transaction)
Searches documents based on query criteria and,
potentially, previously saved query options.
|
<T extends SearchReadHandle> |
QueryManager.search(SearchQueryDefinition querydef,
T searchHandle, Transaction transaction,
java.lang.String forestName)
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.
|
Modifier and Type | Method and Description |
---|---|
void |
RowManager.execute(PlanBuilder.Plan plan,
Transaction transaction)
Execute the given plan without returning any
result.
|
<T extends StructureReadHandle> |
RowManager.resultDoc(PlanBuilder.Plan plan,
T handle, Transaction transaction)
Constructs and retrieves a set of database rows
based on a plan using a handle to get the set of rows as a single
JSON or XML structure and reflecting documents written or deleted
by an uncommitted transaction.
|
<T> T |
RowManager.resultDocAs(PlanBuilder.Plan plan,
java.lang.Class<T> as, Transaction transaction)
Constructs and retrieves a set of database rows
based on a plan in the representation specified by the IO class and
reflecting documents written or deleted by an uncommitted
transaction.
|
RowSet<RowRecord> |
RowManager.resultRows(PlanBuilder.Plan plan,
Transaction transaction)
Constructs and retrieves a set of database rows
based on a plan using a map interface and reflecting documents
written or deleted by an uncommitted transaction.
|
<T extends StructureReadHandle> |
RowManager.resultRows(PlanBuilder.Plan plan,
T rowHandle, Transaction transaction)
Constructs and retrieves a set of database rows
based on a plan using a JSON or XML handle for each row and
reflecting documents written or deleted by an uncommitted
transaction.
|
<T> RowSet<T> |
RowManager.resultRowsAs(PlanBuilder.Plan plan,
java.lang.Class<T> as, Transaction transaction)
Constructs and retrieves a set of database rows
based on a plan using a JSON or XML handle for each row and
reflecting documents written or deleted by an uncommitted
transaction.
|
Modifier and Type | Method and Description |
---|---|
void |
GraphManager.delete(java.lang.String uri,
Transaction transaction)
Permanently delete the specified graph from the
server.
|
void |
GraphManager.deleteGraphs(Transaction transaction)
Permanently delete all quads from all
graphs.
|
void |
GraphManager.deletePermissions(java.lang.String uri,
Transaction transaction)
Delete all permissions for the graph.
|
java.lang.Boolean |
SPARQLQueryManager.executeAsk(SPARQLQueryDefinition qdef,
Transaction tx)
Execute a SPARQL "ASK" statement.
|
<T extends TriplesReadHandle> |
SPARQLQueryManager.executeConstruct(SPARQLQueryDefinition qdef,
T handle, Transaction tx)
Execute a SPARQL "CONSTRUCT" statement.
|
<T extends TriplesReadHandle> |
SPARQLQueryManager.executeDescribe(SPARQLQueryDefinition qdef,
T handle, Transaction tx)
Execute a SPARQL "DESCRIBE" query (which
implements the Concise Bounded Description specification).
|
<T extends SPARQLResultsReadHandle> |
SPARQLQueryManager.executeSelect(SPARQLQueryDefinition qdef,
T handle, long start, Transaction tx)
Execute a SPARQL "SELECT" query.
|
<T extends SPARQLResultsReadHandle> |
SPARQLQueryManager.executeSelect(SPARQLQueryDefinition qdef,
T handle, Transaction tx)
Execute a SPARQL "SELECT" query.
|
void |
SPARQLQueryManager.executeUpdate(SPARQLQueryDefinition qdef,
Transaction tx)
Execute a SPARQL update statement.
|
GraphPermissions |
GraphManager.getPermissions(java.lang.String uri,
Transaction transaction)
Retrieve permissions for a 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, 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,
Transaction transaction)
Add quads from the handle 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,
Transaction transaction)
Add to permissions on the graph.
|
<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, Transaction transaction)
Read triples from the server as the specified
type.
|
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,
Transaction transaction)
Remove all quads from all graphs then insert
quads from the quadsData to the graphs specified in the quads
data.
|
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, 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,
Transaction transaction)
Overwrite all permissions for the graph.
|
Copyright © 2024 MarkLogic Corporation. All Rights Reserved.