Interface | Description |
---|---|
AdhocQuery |
A specialization of
Request which
contains an ad-hoc query (XQuery code as a literal String) to be
submitted and evaluated by the MarkLogic Server. |
Content |
A Content object encapsulates content (a
document) that can be transferred to and inserted into a
contentbase.
|
ContentbaseMetaData |
Meta-data about a contentbase as represented by
a
Session
instance. |
ContentSource |
A ContentSource object describes a content
source (MarkLogic Server instance) and serves as a factory that
creates
Session
objects. |
ModuleInvoke |
An specialization of
Request that
contains the URI of an XQuery module (resident in the server) to be
evaluated by the MarkLogic Server. |
ModuleSpawn |
An extension of
Request that
contains the URI of an XQuery module (resident server-side) to be
spawned asynchronously by the MarkLogic Server. |
Request |
Base Request interface that contains methods
common to all requests.
|
ResultItem |
An
XdmItem
that is a member of a ResultSequence . |
ResultSequence |
A sequence of
ResultItem values
as returned from a query or module execution. |
Session |
A Session object represents a conversation with
a contentbase (database) on a MarkLogic Server instance (
ContentSource )
and holds state information related to that conversation. |
UserCredentials |
This interface encapsulates a user
identity.
|
Class | Description |
---|---|
ContentCapability |
A typesafe enumeration class defining permission
capability values.
|
ContentCreateOptions |
A set of creation options to be applied to a
document when it is inserted into a contentbase.
|
ContentFactory |
A helper class for creating instances of
Content . |
ContentPermission |
An individual
Content
(document) permission, a capability/role pair. |
ContentSourceFactory |
Static helper class with factory methods to
create instances of
ContentSource
using explicit connection parameters. |
DocumentFormat |
Typesafe enumeration of allowable formats for
document insertion.
|
DocumentRepairLevel |
A typesafe enumeration class defining load-time
document repair levels.
|
RequestOptions |
This class represents options to apply to
execution of a query.
|
ResultChannelName |
A type-safe enumeration of
ResultSequence
channel names. |
SecurityOptions |
This class contains the SSL security options to
be used by secure XCC connections.
|
ValueFactory |
This class contains various static factory
methods that return instances of
XdmValue
and XdmVariable . |
Version |
Auto-generated class that defines the XCC
release number.
|
Enum | Description |
---|---|
Session.TransactionMode | Deprecated |
Session.Update |
Nature of a transaction: query, update or
auto-detect based on the statement.
|
This package contains the core public interfaces for XCC. See the overview page for a brief introduction to XCC. Also see the types sub-package for UML diagrams of the classes that represent the XML Data Model hierarchy.
Copyright © 2024 MarkLogic
Corporation
Complete online documentation for MarkLogic Server,
XQuery and related components may
be found at
developer.marklogic.com