| Package | Description |
|---|---|
| com.marklogic.client |
The package provides the core classes,
interfaces and exceptions for working with the database.
|
| com.marklogic.client.alerting |
A REST interface to MarkLogic alerting
capabilities.
|
| com.marklogic.client.datamovement |
The MarkLogic Data Movement SDK supports
long-running write, read, delete, or transform jobs.
|
| 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.expression |
The package provides classes for building Optic
plan pipelines and expressions for execution on the REST
server.
|
| com.marklogic.client.impl | |
| 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.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.semantics |
| Class | Description |
|---|---|
| QueryManager |
A Query Manager supports searching documents and
retrieving values and tuples from lexicons.
|
| Class | Description |
|---|---|
| QueryDefinition |
A QueryDefinition represents the common parts of
most kinds of searches(except Cts query) that can be
performed.
|
| Class | Description |
|---|---|
| CtsQueryDefinition |
A CtsQueryDefinition represents all kinds of cts
queries that can be performed.
|
| RawCombinedQueryDefinition |
A RawCombinedQueryDefinition provides access to
a combined query in a JSON or XML representation.
|
| RawCtsQueryDefinition |
A RawCtsQueryDefinition allows you to create a
query with a serialized cts query in a JSON or XML
representation.
|
| RawStructuredQueryDefinition |
A RawStructuredQueryDefinition provides access
to a structured query in a JSON or XML representation.
|
| StringQueryDefinition |
A StringQueryDefinition represents the criteria
associated with a simple string query.
|
| StructuredQueryDefinition |
A StructuredQueryDefinition represents a
structured query.
|
| Class | Description |
|---|---|
| QueryManager.QueryView |
The view produced by a query.
|
| SearchQueryDefinition |
A SearchQueryDefinition represents the common
parts of all kinds of searches that can be performed.
|
| Class | Description |
|---|---|
| CtsQueryDefinition |
A CtsQueryDefinition represents all kinds of cts
queries that can be performed.
|
| Class | Description |
|---|---|
| QueryDefinition |
A QueryDefinition represents the common parts of
most kinds of searches(except Cts query) that can be
performed.
|
| SearchQueryDefinition |
A SearchQueryDefinition represents the common
parts of all kinds of searches that can be performed.
|
| Class | Description |
|---|---|
| AggregateResult |
A CountedDistinctValue is a value that includes
a frequency.
|
| CountedDistinctValue |
A CountedDistinctValue is a value that includes
a frequency.
|
| FacetResult |
A FacetResult represents a single facet as
returned by a search.
|
| MatchDocumentSummary |
A MatchDocumentSummary is the information
returned for each document found by a search.
|
| QueryOptionsListResults |
This interface supports access to the list of
named query options provided by the server.
|
| SearchMetrics |
A SearchMetrics object represents the query
metrics returned by a search.
|
| SearchQueryDefinition |
A SearchQueryDefinition represents the common
parts of all kinds of searches that can be performed.
|
| SearchResults |
The SearchResults represent the set of results
returned by a search.
|
| Tuple |
A Tuple is a single tuple value taken from a
tuple/value query.
|
| TuplesResults |
TupleResults represent the values returned by a
tuple values query.
|
| ValuesDefinition |
A ValuesDefinition represents a values query
used to retreive values from the server.
|
| ValuesListResults |
A ValuesListResults represents the results of a
values query.
|
| ValuesMetrics |
A SearchMetrics object represents the query
metrics returned by a search.
|
| ValuesResults |
ValuesResults represents one set of values from
a values query.
|
| Class | Description |
|---|---|
| QueryDefinition |
A QueryDefinition represents the common parts of
most kinds of searches(except Cts query) that can be
performed.
|
| RawStructuredQueryDefinition |
A RawStructuredQueryDefinition provides access
to a structured query in a JSON or XML representation.
|
| SearchQueryDefinition |
A SearchQueryDefinition represents the common
parts of all kinds of searches that can be performed.
|
| StructuredQueryBuilder.GeospatialIndex |
A GeospatialIndex can be used for geospatial
queries.
|
| StructuredQueryBuilder.Ordering |
Control over ordering for use in near
queries.
|
| StructuredQueryBuilder.Point | |
| StructuredQueryBuilder.Region |
A region matched by a geospatial query.
|
| StructuredQueryDefinition |
A StructuredQueryDefinition represents a
structured query.
|
| Class | Description |
|---|---|
| AggregateResult |
A CountedDistinctValue is a value that includes
a frequency.
|
| CountedDistinctValue |
A CountedDistinctValue is a value that includes
a frequency.
|
| DeleteQueryDefinition |
A DeleteQueryDefinition is a query definition
suitable for use in performing a delete query.
|
| ExtractedItem |
Access the extracted XML or JSON node using any
StructureReadHandle or class registered by a ContentHandle.
|
| ExtractedResult |
Surfaces the data sent from the server-side
XQuery search:search API.
|
| FacetResult |
A FacetResult represents a single facet as
returned by a search.
|
| FacetValue |
A FacetValue represents a single value returned
in a set of facet results.
|
| MatchDocumentSummary |
A MatchDocumentSummary is the information
returned for each document found by a search.
|
| MatchLocation |
A MatchLocation represents a location in a
document matched by a search.
|
| MatchSnippet |
A MatchSnippet is a Java object representation
of a part of a snippet.
|
| QueryDefinition |
A QueryDefinition represents the common parts of
most kinds of searches(except Cts query) that can be
performed.
|
| QueryManager.QueryView |
The view produced by a query.
|
| RawCombinedQueryDefinition |
A RawCombinedQueryDefinition provides access to
a combined query in a JSON or XML representation.
|
| RawCtsQueryDefinition |
A RawCtsQueryDefinition allows you to create a
query with a serialized cts query in a JSON or XML
representation.
|
| RawQueryByExampleDefinition |
A RawQueryByExampleDefinition provides access to
a simple query by example in an JSON or XML representation.
|
| RawQueryDefinition |
A RawQueryDefinition provides access to a query
in a JSON or XML representation.
|
| RawStructuredQueryDefinition |
A RawStructuredQueryDefinition provides access
to a structured query in a JSON or XML representation.
|
| SearchMetrics |
A SearchMetrics object represents the query
metrics returned by a search.
|
| SearchQueryDefinition |
A SearchQueryDefinition represents the common
parts of all kinds of searches that can be performed.
|
| StringQueryDefinition |
A StringQueryDefinition represents the criteria
associated with a simple string query.
|
| StructuredQueryBuilder |
StructuredQueryBuilder builds a query for
documents in the database.
|
| StructuredQueryBuilder.AbstractStructuredQuery | |
| StructuredQueryBuilder.Attribute |
An Attribute represents an attribute in database
documents.
|
| StructuredQueryBuilder.Axis |
An axis for use in
temporalPeriodRange or
temporalPeriodCompare queries. |
| StructuredQueryBuilder.Box | |
| StructuredQueryBuilder.Circle | |
| StructuredQueryBuilder.ContainerIndex |
A ContainerIndex can be used for container
queries.
|
| StructuredQueryBuilder.CoordinateSystem |
CoordinateSystem provides a list of all known
coordinate systems and it also provides a capability to add new
CoordinateSystems in the future
|
| StructuredQueryBuilder.Element |
An Element represents an element in database
documents.
|
| StructuredQueryBuilder.ElementAttribute |
An ElementAttribute represents an attribute on
an element in database documents.
|
| StructuredQueryBuilder.Field |
A Field represents a field defined in the
database configuration.
|
| StructuredQueryBuilder.FragmentScope |
Whether a query should search the document or
its associated properties.
|
| StructuredQueryBuilder.GeospatialConstraintQuery | |
| StructuredQueryBuilder.GeospatialIndex |
A GeospatialIndex can be used for geospatial
queries.
|
| StructuredQueryBuilder.GeospatialOperator |
Geospatial operators to be used in geospatial
region index queries
|
| StructuredQueryBuilder.GeospatialRegionIndex |
A GeospatialRangeIndex can be used for
geospatial region index queries.
|
| StructuredQueryBuilder.IndexImpl | |
| StructuredQueryBuilder.JSONProperty |
A JSONProperty represents a key in JSON database
documents.
|
| StructuredQueryBuilder.Operator |
A comparison operator for use in range
queries.
|
| StructuredQueryBuilder.Ordering |
Control over ordering for use in near
queries.
|
| StructuredQueryBuilder.PathIndex |
A PathIndex represents an index defined with an
XPath in the database configuration.
|
| StructuredQueryBuilder.Period |
A temporal period for use in
temporalPeriodRange queries. |
| StructuredQueryBuilder.Point | |
| StructuredQueryBuilder.Polygon | |
| StructuredQueryBuilder.RangeIndex |
A RangeIndex can be used for range
queries.
|
| StructuredQueryBuilder.Region |
A region matched by a geospatial query.
|
| StructuredQueryBuilder.RegionImpl | |
| StructuredQueryBuilder.TemporalOperator |
The Allen and ISO SQL 2011 temporal operators
available for use in
temporalPeriodRange or
temporalPeriodCompare queries. |
| StructuredQueryBuilder.TextIndex |
A TextIndex can be used for word and value
queries.
|
| StructuredQueryDefinition |
A StructuredQueryDefinition represents a
structured query.
|
| SuggestDefinition |
Represents the criteria for a suggestion call,
in which the beginning of a term is supplied for possible suggested
endings.
|
| Tuple |
A Tuple is a single tuple value taken from a
tuple/value query.
|
| TypedDistinctValue |
A TypedDistinctValue is a value that includes a
type.
|
| ValueQueryDefinition |
ValueQueryDefinitions can be used in value
queries.
|
| ValuesDefinition |
A ValuesDefinition represents a values query
used to retreive values from the server.
|
| ValuesDefinition.Direction |
The possible directions.
|
| ValuesDefinition.Frequency |
The kinds of frequencies.
|
| ValuesListDefinition |
A ValuesListDefinition is the base type for a
values or tuples list.
|
| ValuesMetrics |
A SearchMetrics object represents the query
metrics returned by a search.
|
| Class | Description |
|---|---|
| QueryDefinition |
A QueryDefinition represents the common parts of
most kinds of searches(except Cts query) that can be
performed.
|
| SearchQueryDefinition |
A SearchQueryDefinition represents the common
parts of all kinds of searches that can be performed.
|
Copyright © 2022 MarkLogic Corporation