| Package | Description |
|---|---|
| com.marklogic.client.datamovement |
The MarkLogic Data Movement SDK supports long-running write, read,
delete, or transform jobs.
|
| com.marklogic.client.dataservices | |
| com.marklogic.client.example.cookbook.datamovement | |
| com.marklogic.client.example.handle |
The package provides examples of extensions that read or write database documents
in a new way or with a new representation.
|
| com.marklogic.client.expression |
The package provides classes for building Optic plan pipelines and expressions
for execution on the REST server.
|
| com.marklogic.client.extra.gson |
The package provides an adapter for using the GSON Open Source library
to read and write JSON documents, JSON structured search, and other JSON
input and output.
|
| com.marklogic.client.io |
The package provides the handle classes with different representations for document content
when you read documents from the database or write documents to the database.
|
| com.marklogic.client.row |
The package provides classes for sending plan requests to and
processing row responses from the REST server.
|
| Modifier and Type | Class | Description |
|---|---|---|
class |
JSONSplitter<T extends JSONWriteHandle> |
The JSONSplitter is used to split large JSON file into separate payloads for writing to the database.
|
| Modifier and Type | Method | Description |
|---|---|---|
java.lang.String |
JSONSplitter.UriMaker.makeUri(long num,
JSONWriteHandle handle) |
Generates URI for each split
|
| Modifier and Type | Method | Description |
|---|---|---|
static ExecCaller |
ExecCaller.on(DatabaseClient client,
JSONWriteHandle apiDecl) |
Constructs an instance of the ExecCaller interface
for calling the specified endpoint.
|
static ExecEndpoint |
ExecEndpoint.on(DatabaseClient client,
JSONWriteHandle apiDecl) |
Deprecated.
|
static <I> InputCaller<I> |
InputCaller.on(DatabaseClient client,
JSONWriteHandle apiDecl,
BufferableContentHandle<I,?> inputHandle) |
Constructs an instance of the InputCaller interface.
|
static InputEndpoint |
InputEndpoint.on(DatabaseClient client,
JSONWriteHandle apiDecl) |
Deprecated.
|
static <I,O> InputOutputCaller<I,O> |
InputOutputCaller.on(DatabaseClient client,
JSONWriteHandle apiDecl,
BufferableContentHandle<I,?> inputHandle,
BufferableContentHandle<O,?> outputHandle) |
Constructs an instance of the InputOutputCaller interface.
|
static InputOutputEndpoint |
InputOutputEndpoint.on(DatabaseClient client,
JSONWriteHandle apiDecl) |
Deprecated.
|
static <O> OutputCaller<O> |
OutputCaller.on(DatabaseClient client,
JSONWriteHandle apiDecl,
BufferableContentHandle<O,?> outputHandle) |
Constructs an instance of the OutputCaller interface.
|
static OutputEndpoint |
OutputEndpoint.on(DatabaseClient client,
JSONWriteHandle apiDecl) |
Deprecated.
|
static <IC,IR,I extends BufferableContentHandle<IC,IR>> |
InputCaller.onHandles(DatabaseClient client,
JSONWriteHandle apiDecl,
I inputHandle) |
Constructs an instance of the InputCaller interface.
|
static <IC,IR,OC,OR,I extends BufferableContentHandle<IC,IR>,O extends BufferableContentHandle<OC,OR>> |
InputOutputCaller.onHandles(DatabaseClient client,
JSONWriteHandle apiDecl,
I inputHandle,
O outputHandle) |
Constructs an instance of the InputOutputCaller interface.
|
static <OC,OR,O extends BufferableContentHandle<OC,OR>> |
OutputCaller.onHandles(DatabaseClient client,
JSONWriteHandle apiDecl,
O outputHandle) |
Constructs an instance of the OutputCaller interface.
|
| Modifier and Type | Method | Description |
|---|---|---|
static BulkExportServices |
BulkExportServices.on(DatabaseClient db,
JSONWriteHandle serviceDeclaration) |
Creates a BulkExportServices object for executing operations on the database server.
|
| Modifier and Type | Class | Description |
|---|---|---|
class |
URIHandle |
A URI Handle sends read document content to a URI or
receives written database content from a URI.
|
| Modifier and Type | Method | Description |
|---|---|---|
abstract CtsQueryDefinition |
CtsQueryBuilder.newCtsQueryDefinition(CtsQueryExpr query,
JSONWriteHandle queryOptions) |
Create a CtsQueryDefinition based on a cts query and query options
|
| Modifier and Type | Class | Description |
|---|---|---|
class |
GSONHandle |
A GSONHandle represents JSON content as a GSON JsonElement for reading or
writing.
|
| Modifier and Type | Class | Description |
|---|---|---|
class |
BytesHandle |
A Bytes Handle represents document content as a byte array for reading or writing.
|
class |
FileHandle |
A File Handle represents document content as a file for reading or writing.
|
class |
InputStreamHandle |
An InputStreamHandle represents a resource as an InputStream for reading or writing.
|
class |
JacksonDatabindHandle<T> |
An adapter for using the Jackson Open Source library for JSON; represents
JSON content for reading or writing as objects of the specified POJO class.
|
class |
JacksonHandle |
An adapter for using the Jackson Open Source library for JSON; represents
JSON content as a Jackson JsonNode for reading or writing.
|
class |
JacksonParserHandle |
An adapter for using the streaming capabilities of the Jackson Open Source library.
|
class |
OutputStreamHandle |
An OutputStreamHandle generates output during writing.
|
class |
ReaderHandle |
A Reader Handle represents a character content as a reader
for reading to or writing from the database.
|
class |
StringHandle |
A String Handle represents document content as a string for reading or writing.
|
| Modifier and Type | Method | Description |
|---|---|---|
JSONWriteHandle |
RawPlanDefinition.getHandle() |
Returns the handle for the JSON representation of the AST for the plan.
|
| Modifier and Type | Method | Description |
|---|---|---|
RawPlanDefinition |
RowManager.newRawPlanDefinition(JSONWriteHandle handle) |
Defines a plan from a JSON serialization of the plan AST (Abstract Syntax Tree).
|
void |
RawPlanDefinition.setHandle(JSONWriteHandle handle) |
Specifies the handle for the JSON representation of the AST for the plan.
|
RawPlanDefinition |
RawPlanDefinition.withHandle(JSONWriteHandle handle) |
Assigns the handle and returns the raw plan as a convenience.
|
Copyright © 2013-2021 MarkLogic Corporation.