The cl-marklogic Reference Manual

4.1.1 cl-marklogic/cl-marklogic.asd

Source

cl-marklogic.asd.

Parent Component

cl-marklogic (system).

ASDF Systems

cl-marklogic.

---

4.1.2 cl-marklogic/package.lisp

Source

cl-marklogic.asd.

Parent Component

cl-marklogic (system).

Packages

• cl-marklogic.
• ml-rest.

---

4.1.3 cl-marklogic/cl-marklogic.lisp

Dependency

package.lisp (file).

Source

cl-marklogic.asd.

Parent Component

cl-marklogic (system).

Public Interface

• echo (function).
• host-time (function).
• ping (function).

---

4.1.4 cl-marklogic/lib/database.lisp

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

• database-attach-forest (function).
• database-create (function).
• database-find-id-by-property (function).
• database-ids (function).
• database-name-p (function).
• database-names (function).
• database-properties (function).
• database-property (function).
• get-database-info (function).

Internals

database-attach-sub-database (function).

---

4.1.5 cl-marklogic/lib/appserver.lisp

Dependency

database.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

rest-api-create (function).

---

4.1.6 cl-marklogic/lib/forest.lisp

Dependency

appserver.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

• forest-create (function).
• forest-find-id-by-property (function).
• forest-ids (function).
• forest-name-p (function).
• forest-names (function).
• forest-properties (function).
• forest-property (function).
• get-forest-info (function).
• get-forest-status (function).

---

4.1.7 cl-marklogic/lib/host.lisp

Dependency

forest.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

• get-host-info (function).
• host-find-id-by-property (function).
• host-ids (function).
• host-name-p (function).
• host-names (function).
• host-properties (function).
• host-property (function).

---

4.1.8 cl-marklogic/lib/cluster.lisp

Dependency

host.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

• cluster-find-id-by-property (function).
• cluster-ids (function).
• cluster-name-p (function).
• cluster-names (function).
• cluster-properties (function).
• cluster-property (function).
• get-cluster-info (function).

---

4.1.9 cl-marklogic/lib/id-names.lisp

Dependency

cluster.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

get-id-names (function).

---

4.1.10 cl-marklogic/lib/group.lisp

Dependency

id-names.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

• get-group-info (function).
• group-find-id-by-property (function).
• group-ids (function).
• group-name-p (function).
• group-names (function).
• group-properties (function).
• group-property (function).

---

4.1.11 cl-marklogic/lib/xquery.lisp

Dependency

group.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

evaluate-xquery (function).

Internals

• inline-includes (function).
• read-include (function).
• read-stream (function).

---

4.1.12 cl-marklogic/lib/document.lisp

Dependency

xquery.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

• delete-document (function).
• get-document (function).
• ingest-directory (function).
• ingest-source-directory (function).
• put-document (function).

Internals

octets-to-string (function).

---

4.1.13 cl-marklogic/lib/config.lisp

Dependency

document.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

• config-property (function).
• get-config (function).
• load-config (function).
• read-config (function).
• save-config (function).
• set-config (function).
• with-config (macro).
• write-config (function).

Internals

*config* (special variable).

---

4.1.14 cl-marklogic/lib/dependent-hosts.lisp

Dependency

config.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Internals

• *dependent-hosts* (special variable).
• dependent-hosts-property (function).
• get-dependent-hosts (function).
• load-dependent-hosts (function).
• read-dependent-hosts (function).
• save-dependent-hosts (function).
• set-dependent-hosts (function).
• with-dependent-hosts (macro).
• write-dependent-hosts (function).

---

4.1.15 cl-marklogic/lib/cluster-config.lisp

Dependency

dependent-hosts.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

• cache-cluster-config (function).
• cluster-config-property (function).
• get-cluster-config (function).
• get-cluster-config-from-connection (function).
• load-cluster-config (function).
• read-cluster-config (function).
• save-cluster-config (function).
• set-cluster-config (function).
• with-cluster-config (macro).
• write-cluster-config (function).

Internals

*cluster-config* (special variable).

---

4.1.16 cl-marklogic/lib/application.lisp

Dependency

cluster-config.lisp (file).

Source

cl-marklogic.asd.

Parent Component

lib (module).

Public Interface

• install-base-data (function).
• install-base-modules (function).
• install-database (function).
• install-rest-server (function).

---

4.1.17 cl-marklogic/ml-rest/connection.lisp

Source

cl-marklogic.asd.

Parent Component

ml-rest (module).

Public Interface

• connection-property (function).
• get-connection (function).
• load-connection (function).
• read-connection (function).
• save-connection (function).
• set-connection (function).
• with-connection (macro).
• write-connection (function).

Internals

*connection* (special variable).

---

4.1.18 cl-marklogic/ml-rest/call.lisp

Dependency

connection.lisp (file).

Source

cl-marklogic.asd.

Parent Component

ml-rest (module).

Public Interface

call (function).

Internals

• calc-text-offset (function).
• extract-text-only (function).
• find-multi-marker (function).

---

4.1.19 cl-marklogic/ml-rest/eval.lisp

Dependency

call.lisp (file).

Source

cl-marklogic.asd.

Parent Component

ml-rest (module).

Public Interface

eval-xquery (function).

Internals

variables-to-json (function).

---

4.1.20 cl-marklogic/initialize.lisp

Dependency

ml-rest (module).

Source

cl-marklogic.asd.

Parent Component

cl-marklogic (system).

Internals

save-all-ccfg (function).

---

6.1.1 Macros

Macro: with-cluster-config ((cluster-config-value) &body body) ¶

This macro binds ‘cluster-config-value‘ to *cluster-config* overriding the default cached cluster configuration for the wrapped expressions.

Package

cl-marklogic.

Source

cluster-config.lisp.

Macro: with-config ((config-value) &body body) ¶

Bind ‘config-value‘ to *config* to override the global config a-list.

Package

cl-marklogic.

Source

config.lisp.

Macro: with-connection ((connection-value) &body body) ¶

Bind ‘connection-value‘ to *connection* to override the global connection a-list.

Package

ml-rest.

Source

connection.lisp.

---

6.1.2 Ordinary functions

Function: cache-cluster-config () ¶

This function refreshes the default cached cluster configuration from the default connection.

Package

cl-marklogic.

Source

cluster-config.lisp.

Function: call (path &key method parameters accept content content-type) ¶

Package

ml-rest.

Source

call.lisp.

Function: cluster-config-property (property-name &optional cluster-config) ¶

This function accesses a property in a cluster configuration.

Package

cl-marklogic.

Source

cluster-config.lisp.

Function: cluster-find-id-by-property (property value &optional info) ¶

Package

cl-marklogic.

Source

cluster.lisp.

Function: cluster-ids (&optional cluster-info) ¶

Get a list of the cluster ids known to the local cluster.

Package

cl-marklogic.

Source

cluster.lisp.

Function: cluster-name-p (cluster-name &optional cluster-info) ¶

Get T if cluster-name exists or nil if not.

Package

cl-marklogic.

Source

cluster.lisp.

Function: cluster-names (&optional cluster-info) ¶

Get a list the cluster names in the cluster.

Package

cl-marklogic.

Source

cluster.lisp.

Function: cluster-properties (cluster-id &optional cluster-info) ¶

Get the properties for a cluster-id.

Package

cl-marklogic.

Source

cluster.lisp.

Function: cluster-property (cluster-id property &optional cluster-info) ¶

Get the value of a cluster property given the cluster-id and property. The available properties are:
:time-stamp -> The date and time this a-list was created. :cluster-id -> Id of this cluster.

Package

cl-marklogic.

Source

cluster.lisp.

Function: config-property (property-name &optional config) ¶

Package

cl-marklogic.

Source

config.lisp.

Function: connection-property (property-name &optional connection) ¶

Package

ml-rest.

Source

connection.lisp.

Function: database-attach-forest (database-name forest-name) ¶

Attach a forest to a database.

Package

cl-marklogic.

Source

database.lisp.

Function: database-create (database-name &key security-database-name schemas-database-name forest-attach-name forest-create-name database-attach-name) ¶

Creat a new database.

Package

cl-marklogic.

Source

database.lisp.

Function: database-find-id-by-property (property value &optional info) ¶

Package

cl-marklogic.

Source

database.lisp.

Function: database-ids (&optional database-info) ¶

Get a list the database ids in the cluster.

Package

cl-marklogic.

Source

database.lisp.

Function: database-name-p (database-name &optional database-info) ¶

Get T if database-name exists or nil if not.

Package

cl-marklogic.

Source

database.lisp.

Function: database-names (&optional database-info) ¶

Get a list the database names in the cluster.

Package

cl-marklogic.

Source

database.lisp.

Function: database-properties (database-id &optional database-info) ¶

Get the properties for a database-id.

Package

cl-marklogic.

Source

database.lisp.

Function: database-property (database-id property &optional database-info) ¶

Get the value of a database property given the database-id and property. The available properties are:
:time-stamp -> The date and time this a-list was created. :forest-ids -> Id of this database.
:database-name -> String name of the database.
:forests -> Attached forest IDs.

Package

cl-marklogic.

Source

database.lisp.

Function: delete-document (uri &key database) ¶

Delete a document BY URI.

Package

cl-marklogic.

Source

document.lisp.

Function: echo (string) ¶

Receive the string argument echoed back from the server.

Package

cl-marklogic.

Source

cl-marklogic.lisp.

Function: eval-xquery (xquery &optional variables) ¶

Evaluate an XQuery string inlining includes and applying variables.

Package

ml-rest.

Source

eval.lisp.

Function: evaluate-xquery (xquery &optional variables) ¶

Evaluate an XQuery string inlining includes and applying variables.

Package

cl-marklogic.

Source

xquery.lisp.

Function: forest-create (forest-name &key host-name data-directory large-data-directory fast-data-directory) ¶

Create a new forest.

Package

cl-marklogic.

Source

forest.lisp.

Function: forest-find-id-by-property (property value &optional info) ¶

Package

cl-marklogic.

Source

forest.lisp.

Function: forest-ids (&optional forest-info) ¶

Get a list of the forest ids in the cluster.

Package

cl-marklogic.

Source

forest.lisp.

Function: forest-name-p (forest-name &optional forest-info) ¶

Get T if forest-name exists or nil if not.

Package

cl-marklogic.

Source

forest.lisp.

Function: forest-names (&optional forest-info) ¶

Get a list the forest names in the cluster.

Package

cl-marklogic.

Source

forest.lisp.

Function: forest-properties (forest-id &optional forest-info) ¶

Get the properties for a forest-id.

Package

cl-marklogic.

Source

forest.lisp.

Function: forest-property (forest-id property &optional forest-info) ¶

Get the value of a forest property given the forest-id and property. The available properties are:
:time-stamp -> The date and time this a-list was created. :forest-ids -> Id of this forest.
:forest-name -> String name of the forest.
:host-id -> Id of the host holding the forest. :database-id -> Id of the database composed from the forest. :replicas -> List of the ids of this forest’s replicas. :data-dir -> Path of the normal data directory. :large-dir -> Path of the large data directory. :fast-dir -> Path of the fast data directory. :master-forest -> Id of the master forest.
:journals-size -> Size of the journals on disk (MB). :large-data-size -> Size of the large data on disk (MB). :data-size -> Size of the normal data on disk (MB). :memory-size -> Size of the normal data in memory (MB). :fast-data-size -> Size of the fast data on disk. :fast-memory-size -> Size of the fast data in memory. :device-space -> Available space on the normal device (MB). :large-device-space -> Available space on the large device (MB). :fast-device-space -> Available space on the fast device (MB).

Package

cl-marklogic.

Source

forest.lisp.

Function: get-cluster-config () ¶

This funtion returns the global cached cluster config.

Package

cl-marklogic.

Source

cluster-config.lisp.

Function: get-cluster-config-from-connection () ¶

This function fetches a fresh cluster configuration from the default connection.

Package

cl-marklogic.

Source

cluster-config.lisp.

Function: get-cluster-info () ¶

Get a two tier nested a-lists containing properties of all of the clusters in the cluster.

Package

cl-marklogic.

Source

cluster.lisp.

Function: get-config () ¶

Get the global config value.

Package

cl-marklogic.

Source

config.lisp.

Function: get-connection () ¶

Get the global connection value.

Package

ml-rest.

Source

connection.lisp.

Function: get-database-info () ¶

Get a two tier nested a-lists containing properties of all of the databases in the cluster.

Package

cl-marklogic.

Source

database.lisp.

Function: get-document (uri &key accept database) ¶

Get a document by URI.

Package

cl-marklogic.

Source

document.lisp.

Function: get-forest-info () ¶

Get a two tier nested a-lists containing properties of all of the forests in the cluster.

Package

cl-marklogic.

Source

forest.lisp.

Function: get-forest-status (forest-id) ¶

Get the complete XML representation of the forest’s status.

Package

cl-marklogic.

Source

forest.lisp.

Function: get-group-info () ¶

Get a two tier nested a-lists containing properties of all of the groups in the group.

Package

cl-marklogic.

Source

group.lisp.

Function: get-host-info () ¶

Get a two tier nested a-lists containing properties of all of the hosts in the cluster.

Package

cl-marklogic.

Source

host.lisp.

Function: get-id-names () ¶

Get a two tier nested a-lists containing the names associated with an ID.

Package

cl-marklogic.

Source

id-names.lisp.

Function: group-find-id-by-property (property value &optional info) ¶

Package

cl-marklogic.

Source

group.lisp.

Function: group-ids (&optional group-info) ¶

Get a list the group ids in the group.

Package

cl-marklogic.

Source

group.lisp.

Function: group-name-p (group-name &optional group-info) ¶

Get T if group-name exists or nil if not.

Package

cl-marklogic.

Source

group.lisp.

Function: group-names (&optional group-info) ¶

Get a list the group names in the group.

Package

cl-marklogic.

Source

group.lisp.

Function: group-properties (group-id &optional group-info) ¶

Get the properties for a group-id.

Package

cl-marklogic.

Source

group.lisp.

Function: group-property (group-id property &optional group-info) ¶

Get the value of a group property given the group-id and property. The available properties are:
:time-stamp -> The date and time this a-list was created. :group-id -> Id of this group.
:group-name -> String name of this group.

Package

cl-marklogic.

Source

group.lisp.

Function: host-find-id-by-property (property values &optional info) ¶

Package

cl-marklogic.

Source

host.lisp.

Function: host-ids (&optional host-info) ¶

Get a list the host ids in the cluster.

Package

cl-marklogic.

Source

host.lisp.

Function: host-name-p (host-name &optional host-info) ¶

Get T if host-name exists or nil if not.

Package

cl-marklogic.

Source

host.lisp.

Function: host-names (&optional host-info) ¶

Get a list the host names in the host.

Package

cl-marklogic.

Source

host.lisp.

Function: host-properties (host-id &optional host-info) ¶

Get the properties for a host-id.

Package

cl-marklogic.

Source

host.lisp.

Function: host-property (host-id property &optional host-info) ¶

Get the value of a host property given the host-id and property. The available properties are:
:time-stamp -> The date and time this a-list was created. :host-id -> Id of this host.
:host-name -> String name of this host.
:bind-port -> Port number to which this host is bound. :host -> Id of the host to which this host belongs. :zone -> Zone where this host is assigned.

Package

cl-marklogic.

Source

host.lisp.

Function: host-time () ¶

Get the current local dateTime of the server.

Package

cl-marklogic.

Source

cl-marklogic.lisp.

Function: ingest-directory (database-name path &key clear) ¶

Package

cl-marklogic.

Source

document.lisp.

Function: ingest-source-directory (database-name system dir-name &key clear) ¶

Package

cl-marklogic.

Source

document.lisp.

Function: install-base-data (database-name &key clear) ¶

Package

cl-marklogic.

Source

application.lisp.

Function: install-base-modules (database-name &key clear) ¶

Package

cl-marklogic.

Source

application.lisp.

Function: install-database (database-name &key forest-create-name) ¶

Package

cl-marklogic.

Source

application.lisp.

Function: install-rest-server (group-name server-name port database-name modules-database-name) ¶

Package

cl-marklogic.

Source

application.lisp.

Function: load-cluster-config (cluster-config-name) ¶

This function loads a cluster configuration from a project located in the system source tree into the default cached cluster configuration.

Package

cl-marklogic.

Source

cluster-config.lisp.

Function: load-config (config-name) ¶

Package

cl-marklogic.

Source

config.lisp.

Function: load-connection (connection-name) ¶

Package

ml-rest.

Source

connection.lisp.

Function: ping () ¶

Receive the string "pong" echoed back from the server.

Package

cl-marklogic.

Source

cl-marklogic.lisp.

Function: put-document (uri content content-type &key database) ¶

Put a document by URI.

Package

cl-marklogic.

Source

document.lisp.

Function: read-cluster-config (from) ¶

This function reads a cluster configuration from a stream.

Package

cl-marklogic.

Source

cluster-config.lisp.

Function: read-config (from) ¶

Package

cl-marklogic.

Source

config.lisp.

Function: read-connection (from) ¶

Package

ml-rest.

Source

connection.lisp.

Function: rest-api-create (group-name server-name port database-name modules-database-name) ¶

Create a REST API server.

Package

cl-marklogic.

Source

appserver.lisp.

Function: save-cluster-config (&optional cluster-config) ¶

This function saves a cluster configuration to a project located in the system source tree from the default cached cluster configuration.

Package

cl-marklogic.

Source

cluster-config.lisp.

Function: save-config (&optional config) ¶

Package

cl-marklogic.

Source

config.lisp.

Function: save-connection (&optional connection) ¶

Package

ml-rest.

Source

connection.lisp.

Function: set-cluster-config (new-value) ¶

This function sets the value of the global cached cluster cache.

Package

cl-marklogic.

Source

cluster-config.lisp.

Function: set-config (new-value) ¶

Set the global config value.

Package

cl-marklogic.

Source

config.lisp.

Function: set-connection (new-value) ¶

Set the global connection value.

Package

ml-rest.

Source

connection.lisp.

Function: write-cluster-config (to &optional config) ¶

This function writes a cluster configuration to a stream.

Package

cl-marklogic.

Source

cluster-config.lisp.

Function: write-config (to &optional config) ¶

Package

cl-marklogic.

Source

config.lisp.

Function: write-connection (to &optional connection) ¶

Package

ml-rest.

Source

connection.lisp.

---

6.2.1 Special variables

Special Variable: *cluster-config* ¶

This is the default global cached cluster config.
Use the macro with-cluster-config to wrap expressions that you want to use a different default configuration.

Package

cl-marklogic.

Source

cluster-config.lisp.

Special Variable: *config* ¶

A-list used by default for configuration.
The macro with-config can be used to override the configuration.

Package

cl-marklogic.

Source

config.lisp.

Special Variable: *connection* ¶

A-list used by default to connect.
The macro with-connection can be used to override the connection.

Package

ml-rest.

Source

connection.lisp.

Special Variable: *dependent-hosts* ¶

A-list used by default for dependent host sets.
The macro with-dependent-hosts can be used to override the dependent-hosts.

Package

cl-marklogic.

Source

dependent-hosts.lisp.

---

6.2.2 Macros

Macro: with-dependent-hosts ((dependent-hosts-value) &body body) ¶

Bind ‘dependent-hosts-value‘ to *dependent-hosts* to override the global dependent-hosts a-list.

Package

cl-marklogic.

Source

dependent-hosts.lisp.

---

6.2.3 Ordinary functions

Function: calc-text-offset (content) ¶

Package

ml-rest.

Source

call.lisp.

Function: database-attach-sub-database (database-name sub-database-name) ¶

Attach a sub-database to a database.

Package

cl-marklogic.

Source

database.lisp.

Function: dependent-hosts-property (property-name &optional dependent-hosts) ¶

Package

cl-marklogic.

Source

dependent-hosts.lisp.

Function: extract-text-only (content) ¶

Package

ml-rest.

Source

call.lisp.

Function: find-multi-marker (content) ¶

Package

ml-rest.

Source

call.lisp.

Function: get-dependent-hosts () ¶

Get the global dependent-hosts value.

Package

cl-marklogic.

Source

dependent-hosts.lisp.

Function: inline-includes (xquery) ¶

Package

cl-marklogic.

Source

xquery.lisp.

Function: load-dependent-hosts (dependent-hosts-name) ¶

Package

cl-marklogic.

Source

dependent-hosts.lisp.

Function: octets-to-string (octets) ¶

Package

cl-marklogic.

Source

document.lisp.

Function: read-dependent-hosts (from) ¶

Package

cl-marklogic.

Source

dependent-hosts.lisp.

Function: read-include (include) ¶

Package

cl-marklogic.

Source

xquery.lisp.

Function: read-stream (stream) ¶

Package

cl-marklogic.

Source

xquery.lisp.

Function: save-all-ccfg () ¶

Package

cl-marklogic.

Source

initialize.lisp.

Function: save-dependent-hosts (&optional dependent-hosts) ¶

Package

cl-marklogic.

Source

dependent-hosts.lisp.

Function: set-dependent-hosts (new-value) ¶

Set the global dependent-hosts value.

Package

cl-marklogic.

Source

dependent-hosts.lisp.

Function: variables-to-json (variables) ¶

Package

ml-rest.

Source

eval.lisp.

Function: write-dependent-hosts (to &optional dependent-hosts) ¶

Package

cl-marklogic.

Source

dependent-hosts.lisp.

---