The cl-marklogic Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-marklogic Reference Manual

This is the cl-marklogic Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:14:22 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-marklogic

cl-marklogic is a Common Lisp system for optimizing MarkLogic clusters. There is a stable version of cl-marklogic in the QuickLisp repository.

Tested with MarkLogic 8. Tested with SBCL and ABCL.

Quick Start

This quick tutorial shows you how to run some simple examples using cl-marklogic. It is written to use SBCL, and QuickLisp on OSX. If you are using a different operating system you will need to adjust some details but the overall steps will be the same.

1. Install Homebrew.

2. Install SBCL:

brew update
brew install SBCL
brew install rlwrap

3. Install QuickLisp.

4. Start the SBCL REPL:

rlwrap sbcl

5. Load cl-marklogic.

(ql:quickload "cl-marklogic")

The first time you load cl-marklogic, QuickLisp will download it and any dependencies from the repository.

6. Load ml-test and run the unit tests:

(ql:quickload "ml-test")
(ml-test:test-all)

The connect test will fail since we have not configured a MarkLogic connection.

7. Load ml-optimizer and start it:

(ql:quickload "ml-optimizer")
(ml-optimizer:start)

8. Connect to ml-optimizer with a browser.

By default ml-optimizer starts with a cached cluster configuration for demonstration.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-marklogic

Author

Donald Anderson <dranderson@OpsResearch.com>

License

LGPL3

Description

Common Lisp library for accessing MarkLogic Server.

Dependencies
Source

cl-marklogic.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 cl-marklogic/lib

Dependency

cl-marklogic.lisp (file)

Parent

cl-marklogic (system)

Location

lib/

Components

Previous: , Up: Modules   [Contents][Index]

3.2 cl-marklogic/ml-rest

Dependency

lib (module)

Parent

cl-marklogic (system)

Location

ml-rest/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-marklogic.asd

Location

cl-marklogic.asd

Systems

cl-marklogic (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 cl-marklogic/package.lisp

Parent

cl-marklogic (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 cl-marklogic/cl-marklogic.lisp

Dependency

package.lisp (file)

Parent

cl-marklogic (system)

Location

cl-marklogic.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 cl-marklogic/lib/database.lisp

Parent

lib (module)

Location

lib/database.lisp

Exported Definitions
Internal Definitions

database-attach-sub-database (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 cl-marklogic/lib/appserver.lisp

Dependency

database.lisp (file)

Parent

lib (module)

Location

lib/appserver.lisp

Exported Definitions

rest-api-create (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 cl-marklogic/lib/forest.lisp

Dependency

appserver.lisp (file)

Parent

lib (module)

Location

lib/forest.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 cl-marklogic/lib/host.lisp

Dependency

forest.lisp (file)

Parent

lib (module)

Location

lib/host.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 cl-marklogic/lib/cluster.lisp

Dependency

host.lisp (file)

Parent

lib (module)

Location

lib/cluster.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

cluster.lisp (file)

Parent

lib (module)

Location

lib/id-names.lisp

Exported Definitions

get-id-names (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 cl-marklogic/lib/group.lisp

Dependency

id-names.lisp (file)

Parent

lib (module)

Location

lib/group.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 cl-marklogic/lib/xquery.lisp

Dependency

group.lisp (file)

Parent

lib (module)

Location

lib/xquery.lisp

Exported Definitions

evaluate-xquery (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 cl-marklogic/lib/document.lisp

Dependency

xquery.lisp (file)

Parent

lib (module)

Location

lib/document.lisp

Exported Definitions
Internal Definitions

octets-to-string (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.13 cl-marklogic/lib/config.lisp

Dependency

document.lisp (file)

Parent

lib (module)

Location

lib/config.lisp

Exported Definitions
Internal Definitions

*config* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

config.lisp (file)

Parent

lib (module)

Location

lib/dependent-hosts.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

dependent-hosts.lisp (file)

Parent

lib (module)

Location

lib/cluster-config.lisp

Exported Definitions
Internal Definitions

*cluster-config* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.16 cl-marklogic/lib/application.lisp

Dependency

cluster-config.lisp (file)

Parent

lib (module)

Location

lib/application.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

ml-rest (module)

Location

ml-rest/connection.lisp

Exported Definitions
Internal Definitions

*connection* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

connection.lisp (file)

Parent

ml-rest (module)

Location

ml-rest/call.lisp

Exported Definitions

call (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

call.lisp (file)

Parent

ml-rest (module)

Location

ml-rest/eval.lisp

Exported Definitions

eval-xquery (function)

Internal Definitions

variables-to-json (function)


Previous: , Up: Lisp files   [Contents][Index]

4.1.20 cl-marklogic/initialize.lisp

Dependency

ml-rest (module)

Parent

cl-marklogic (system)

Location

initialize.lisp

Internal Definitions

save-all-ccfg (function)


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 ml-rest

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

5.2 cl-marklogic

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

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 (file)

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 (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: cache-cluster-config ()

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

Package

cl-marklogic

Source

cluster-config.lisp (file)

Function: call PATH &key METHOD PARAMETERS ACCEPT CONTENT CONTENT-TYPE
Package

ml-rest

Source

call.lisp (file)

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 (file)

Function: cluster-find-id-by-property PROPERTY VALUE &optional INFO
Package

cl-marklogic

Source

cluster.lisp (file)

Function: cluster-ids &optional CLUSTER-INFO

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

Package

cl-marklogic

Source

cluster.lisp (file)

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 (file)

Function: cluster-names &optional CLUSTER-INFO

Get a list the cluster names in the cluster.

Package

cl-marklogic

Source

cluster.lisp (file)

Function: cluster-properties CLUSTER-ID &optional CLUSTER-INFO

Get the properties for a cluster-id.

Package

cl-marklogic

Source

cluster.lisp (file)

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 (file)

Function: config-property PROPERTY-NAME &optional CONFIG
Package

cl-marklogic

Source

config.lisp (file)

Function: connection-property PROPERTY-NAME &optional CONNECTION
Package

ml-rest

Source

connection.lisp (file)

Function: database-attach-forest DATABASE-NAME FOREST-NAME

Attach a forest to a database.

Package

cl-marklogic

Source

database.lisp (file)

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 (file)

Function: database-find-id-by-property PROPERTY VALUE &optional INFO
Package

cl-marklogic

Source

database.lisp (file)

Function: database-ids &optional DATABASE-INFO

Get a list the database ids in the cluster.

Package

cl-marklogic

Source

database.lisp (file)

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 (file)

Function: database-names &optional DATABASE-INFO

Get a list the database names in the cluster.

Package

cl-marklogic

Source

database.lisp (file)

Function: database-properties DATABASE-ID &optional DATABASE-INFO

Get the properties for a database-id.

Package

cl-marklogic

Source

database.lisp (file)

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 (file)

Function: delete-document URI &key DATABASE

Delete a document BY URI.

Package

cl-marklogic

Source

document.lisp (file)

Function: echo STRING

Receive the string argument echoed back from the server.

Package

cl-marklogic

Source

cl-marklogic.lisp (file)

Function: eval-xquery XQUERY &optional VARIABLES

Evaluate an XQuery string inlining includes and applying variables.

Package

ml-rest

Source

eval.lisp (file)

Function: evaluate-xquery XQUERY &optional VARIABLES

Evaluate an XQuery string inlining includes and applying variables.

Package

cl-marklogic

Source

xquery.lisp (file)

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 (file)

Function: forest-find-id-by-property PROPERTY VALUE &optional INFO
Package

cl-marklogic

Source

forest.lisp (file)

Function: forest-ids &optional FOREST-INFO

Get a list of the forest ids in the cluster.

Package

cl-marklogic

Source

forest.lisp (file)

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 (file)

Function: forest-names &optional FOREST-INFO

Get a list the forest names in the cluster.

Package

cl-marklogic

Source

forest.lisp (file)

Function: forest-properties FOREST-ID &optional FOREST-INFO

Get the properties for a forest-id.

Package

cl-marklogic

Source

forest.lisp (file)

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 (file)

Function: get-cluster-config ()

This funtion returns the global cached cluster config.

Package

cl-marklogic

Source

cluster-config.lisp (file)

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

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

Package

cl-marklogic

Source

cluster-config.lisp (file)

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 (file)

Function: get-config ()

Get the global config value.

Package

cl-marklogic

Source

config.lisp (file)

Function: get-connection ()

Get the global connection value.

Package

ml-rest

Source

connection.lisp (file)

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 (file)

Function: get-document URI &key ACCEPT DATABASE

Get a document by URI.

Package

cl-marklogic

Source

document.lisp (file)

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 (file)

Function: get-forest-status FOREST-ID

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

Package

cl-marklogic

Source

forest.lisp (file)

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 (file)

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 (file)

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 (file)

Function: group-find-id-by-property PROPERTY VALUE &optional INFO
Package

cl-marklogic

Source

group.lisp (file)

Function: group-ids &optional GROUP-INFO

Get a list the group ids in the group.

Package

cl-marklogic

Source

group.lisp (file)

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 (file)

Function: group-names &optional GROUP-INFO

Get a list the group names in the group.

Package

cl-marklogic

Source

group.lisp (file)

Function: group-properties GROUP-ID &optional GROUP-INFO

Get the properties for a group-id.

Package

cl-marklogic

Source

group.lisp (file)

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 (file)

Function: host-find-id-by-property PROPERTY VALUES &optional INFO
Package

cl-marklogic

Source

host.lisp (file)

Function: host-ids &optional HOST-INFO

Get a list the host ids in the cluster.

Package

cl-marklogic

Source

host.lisp (file)

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 (file)

Function: host-names &optional HOST-INFO

Get a list the host names in the host.

Package

cl-marklogic

Source

host.lisp (file)

Function: host-properties HOST-ID &optional HOST-INFO

Get the properties for a host-id.

Package

cl-marklogic

Source

host.lisp (file)

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 (file)

Function: host-time ()

Get the current local dateTime of the server.

Package

cl-marklogic

Source

cl-marklogic.lisp (file)

Function: ingest-directory DATABASE-NAME PATH &key CLEAR
Package

cl-marklogic

Source

document.lisp (file)

Function: ingest-source-directory DATABASE-NAME SYSTEM DIR-NAME &key CLEAR
Package

cl-marklogic

Source

document.lisp (file)

Function: install-base-data DATABASE-NAME &key CLEAR
Package

cl-marklogic

Source

application.lisp (file)

Function: install-base-modules DATABASE-NAME &key CLEAR
Package

cl-marklogic

Source

application.lisp (file)

Function: install-database DATABASE-NAME &key FOREST-CREATE-NAME
Package

cl-marklogic

Source

application.lisp (file)

Function: install-rest-server GROUP-NAME SERVER-NAME PORT DATABASE-NAME MODULES-DATABASE-NAME
Package

cl-marklogic

Source

application.lisp (file)

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 (file)

Function: load-config CONFIG-NAME
Package

cl-marklogic

Source

config.lisp (file)

Function: load-connection CONNECTION-NAME
Package

ml-rest

Source

connection.lisp (file)

Function: ping ()

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

Package

cl-marklogic

Source

cl-marklogic.lisp (file)

Function: put-document URI CONTENT CONTENT-TYPE &key DATABASE

Put a document by URI.

Package

cl-marklogic

Source

document.lisp (file)

Function: read-cluster-config FROM

This function reads a cluster configuration from a stream.

Package

cl-marklogic

Source

cluster-config.lisp (file)

Function: read-config FROM
Package

cl-marklogic

Source

config.lisp (file)

Function: read-connection FROM
Package

ml-rest

Source

connection.lisp (file)

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 (file)

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 (file)

Function: save-config &optional CONFIG
Package

cl-marklogic

Source

config.lisp (file)

Function: save-connection &optional CONNECTION
Package

ml-rest

Source

connection.lisp (file)

Function: set-cluster-config NEW-VALUE

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

Package

cl-marklogic

Source

cluster-config.lisp (file)

Function: set-config NEW-VALUE

Set the global config value.

Package

cl-marklogic

Source

config.lisp (file)

Function: set-connection NEW-VALUE

Set the global connection value.

Package

ml-rest

Source

connection.lisp (file)

Function: write-cluster-config TO &optional CONFIG

This function writes a cluster configuration to a stream.

Package

cl-marklogic

Source

cluster-config.lisp (file)

Function: write-config TO &optional CONFIG
Package

cl-marklogic

Source

config.lisp (file)

Function: write-connection TO &optional CONNECTION
Package

ml-rest

Source

connection.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

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 (file)

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 (file)

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 (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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 (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Functions

Function: calc-text-offset CONTENT
Package

ml-rest

Source

call.lisp (file)

Function: database-attach-sub-database DATABASE-NAME SUB-DATABASE-NAME

Attach a sub-database to a database.

Package

cl-marklogic

Source

database.lisp (file)

Function: dependent-hosts-property PROPERTY-NAME &optional DEPENDENT-HOSTS
Package

cl-marklogic

Source

dependent-hosts.lisp (file)

Function: extract-text-only CONTENT
Package

ml-rest

Source

call.lisp (file)

Function: find-multi-marker CONTENT
Package

ml-rest

Source

call.lisp (file)

Function: get-dependent-hosts ()

Get the global dependent-hosts value.

Package

cl-marklogic

Source

dependent-hosts.lisp (file)

Function: inline-includes XQUERY
Package

cl-marklogic

Source

xquery.lisp (file)

Function: load-dependent-hosts DEPENDENT-HOSTS-NAME
Package

cl-marklogic

Source

dependent-hosts.lisp (file)

Function: octets-to-string OCTETS
Package

cl-marklogic

Source

document.lisp (file)

Function: read-dependent-hosts FROM
Package

cl-marklogic

Source

dependent-hosts.lisp (file)

Function: read-include INCLUDE
Package

cl-marklogic

Source

xquery.lisp (file)

Function: read-stream STREAM
Package

cl-marklogic

Source

xquery.lisp (file)

Function: save-all-ccfg ()
Package

cl-marklogic

Source

initialize.lisp (file)

Function: save-dependent-hosts &optional DEPENDENT-HOSTS
Package

cl-marklogic

Source

dependent-hosts.lisp (file)

Function: set-dependent-hosts NEW-VALUE

Set the global dependent-hosts value.

Package

cl-marklogic

Source

dependent-hosts.lisp (file)

Function: variables-to-json VARIABLES
Package

ml-rest

Source

eval.lisp (file)

Function: write-dependent-hosts TO &optional DEPENDENT-HOSTS
Package

cl-marklogic

Source

dependent-hosts.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-marklogic.asd: The cl-marklogic<dot>asd file
cl-marklogic/cl-marklogic.lisp: The cl-marklogic/cl-marklogic<dot>lisp file
cl-marklogic/initialize.lisp: The cl-marklogic/initialize<dot>lisp file
cl-marklogic/lib: The cl-marklogic/lib module
cl-marklogic/lib/application.lisp: The cl-marklogic/lib/application<dot>lisp file
cl-marklogic/lib/appserver.lisp: The cl-marklogic/lib/appserver<dot>lisp file
cl-marklogic/lib/cluster-config.lisp: The cl-marklogic/lib/cluster-config<dot>lisp file
cl-marklogic/lib/cluster.lisp: The cl-marklogic/lib/cluster<dot>lisp file
cl-marklogic/lib/config.lisp: The cl-marklogic/lib/config<dot>lisp file
cl-marklogic/lib/database.lisp: The cl-marklogic/lib/database<dot>lisp file
cl-marklogic/lib/dependent-hosts.lisp: The cl-marklogic/lib/dependent-hosts<dot>lisp file
cl-marklogic/lib/document.lisp: The cl-marklogic/lib/document<dot>lisp file
cl-marklogic/lib/forest.lisp: The cl-marklogic/lib/forest<dot>lisp file
cl-marklogic/lib/group.lisp: The cl-marklogic/lib/group<dot>lisp file
cl-marklogic/lib/host.lisp: The cl-marklogic/lib/host<dot>lisp file
cl-marklogic/lib/id-names.lisp: The cl-marklogic/lib/id-names<dot>lisp file
cl-marklogic/lib/xquery.lisp: The cl-marklogic/lib/xquery<dot>lisp file
cl-marklogic/ml-rest: The cl-marklogic/ml-rest module
cl-marklogic/ml-rest/call.lisp: The cl-marklogic/ml-rest/call<dot>lisp file
cl-marklogic/ml-rest/connection.lisp: The cl-marklogic/ml-rest/connection<dot>lisp file
cl-marklogic/ml-rest/eval.lisp: The cl-marklogic/ml-rest/eval<dot>lisp file
cl-marklogic/package.lisp: The cl-marklogic/package<dot>lisp file

F
File, Lisp, cl-marklogic.asd: The cl-marklogic<dot>asd file
File, Lisp, cl-marklogic/cl-marklogic.lisp: The cl-marklogic/cl-marklogic<dot>lisp file
File, Lisp, cl-marklogic/initialize.lisp: The cl-marklogic/initialize<dot>lisp file
File, Lisp, cl-marklogic/lib/application.lisp: The cl-marklogic/lib/application<dot>lisp file
File, Lisp, cl-marklogic/lib/appserver.lisp: The cl-marklogic/lib/appserver<dot>lisp file
File, Lisp, cl-marklogic/lib/cluster-config.lisp: The cl-marklogic/lib/cluster-config<dot>lisp file
File, Lisp, cl-marklogic/lib/cluster.lisp: The cl-marklogic/lib/cluster<dot>lisp file
File, Lisp, cl-marklogic/lib/config.lisp: The cl-marklogic/lib/config<dot>lisp file
File, Lisp, cl-marklogic/lib/database.lisp: The cl-marklogic/lib/database<dot>lisp file
File, Lisp, cl-marklogic/lib/dependent-hosts.lisp: The cl-marklogic/lib/dependent-hosts<dot>lisp file
File, Lisp, cl-marklogic/lib/document.lisp: The cl-marklogic/lib/document<dot>lisp file
File, Lisp, cl-marklogic/lib/forest.lisp: The cl-marklogic/lib/forest<dot>lisp file
File, Lisp, cl-marklogic/lib/group.lisp: The cl-marklogic/lib/group<dot>lisp file
File, Lisp, cl-marklogic/lib/host.lisp: The cl-marklogic/lib/host<dot>lisp file
File, Lisp, cl-marklogic/lib/id-names.lisp: The cl-marklogic/lib/id-names<dot>lisp file
File, Lisp, cl-marklogic/lib/xquery.lisp: The cl-marklogic/lib/xquery<dot>lisp file
File, Lisp, cl-marklogic/ml-rest/call.lisp: The cl-marklogic/ml-rest/call<dot>lisp file
File, Lisp, cl-marklogic/ml-rest/connection.lisp: The cl-marklogic/ml-rest/connection<dot>lisp file
File, Lisp, cl-marklogic/ml-rest/eval.lisp: The cl-marklogic/ml-rest/eval<dot>lisp file
File, Lisp, cl-marklogic/package.lisp: The cl-marklogic/package<dot>lisp file

L
Lisp File, cl-marklogic.asd: The cl-marklogic<dot>asd file
Lisp File, cl-marklogic/cl-marklogic.lisp: The cl-marklogic/cl-marklogic<dot>lisp file
Lisp File, cl-marklogic/initialize.lisp: The cl-marklogic/initialize<dot>lisp file
Lisp File, cl-marklogic/lib/application.lisp: The cl-marklogic/lib/application<dot>lisp file
Lisp File, cl-marklogic/lib/appserver.lisp: The cl-marklogic/lib/appserver<dot>lisp file
Lisp File, cl-marklogic/lib/cluster-config.lisp: The cl-marklogic/lib/cluster-config<dot>lisp file
Lisp File, cl-marklogic/lib/cluster.lisp: The cl-marklogic/lib/cluster<dot>lisp file
Lisp File, cl-marklogic/lib/config.lisp: The cl-marklogic/lib/config<dot>lisp file
Lisp File, cl-marklogic/lib/database.lisp: The cl-marklogic/lib/database<dot>lisp file
Lisp File, cl-marklogic/lib/dependent-hosts.lisp: The cl-marklogic/lib/dependent-hosts<dot>lisp file
Lisp File, cl-marklogic/lib/document.lisp: The cl-marklogic/lib/document<dot>lisp file
Lisp File, cl-marklogic/lib/forest.lisp: The cl-marklogic/lib/forest<dot>lisp file
Lisp File, cl-marklogic/lib/group.lisp: The cl-marklogic/lib/group<dot>lisp file
Lisp File, cl-marklogic/lib/host.lisp: The cl-marklogic/lib/host<dot>lisp file
Lisp File, cl-marklogic/lib/id-names.lisp: The cl-marklogic/lib/id-names<dot>lisp file
Lisp File, cl-marklogic/lib/xquery.lisp: The cl-marklogic/lib/xquery<dot>lisp file
Lisp File, cl-marklogic/ml-rest/call.lisp: The cl-marklogic/ml-rest/call<dot>lisp file
Lisp File, cl-marklogic/ml-rest/connection.lisp: The cl-marklogic/ml-rest/connection<dot>lisp file
Lisp File, cl-marklogic/ml-rest/eval.lisp: The cl-marklogic/ml-rest/eval<dot>lisp file
Lisp File, cl-marklogic/package.lisp: The cl-marklogic/package<dot>lisp file

M
Module, cl-marklogic/lib: The cl-marklogic/lib module
Module, cl-marklogic/ml-rest: The cl-marklogic/ml-rest module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   D   E   F   G   H   I   L   M   O   P   R   S   V   W  
Index Entry  Section

C
cache-cluster-config: Exported functions
calc-text-offset: Internal functions
call: Exported functions
cluster-config-property: Exported functions
cluster-find-id-by-property: Exported functions
cluster-ids: Exported functions
cluster-name-p: Exported functions
cluster-names: Exported functions
cluster-properties: Exported functions
cluster-property: Exported functions
config-property: Exported functions
connection-property: Exported functions

D
database-attach-forest: Exported functions
database-attach-sub-database: Internal functions
database-create: Exported functions
database-find-id-by-property: Exported functions
database-ids: Exported functions
database-name-p: Exported functions
database-names: Exported functions
database-properties: Exported functions
database-property: Exported functions
delete-document: Exported functions
dependent-hosts-property: Internal functions

E
echo: Exported functions
eval-xquery: Exported functions
evaluate-xquery: Exported functions
extract-text-only: Internal functions

F
find-multi-marker: Internal functions
forest-create: Exported functions
forest-find-id-by-property: Exported functions
forest-ids: Exported functions
forest-name-p: Exported functions
forest-names: Exported functions
forest-properties: Exported functions
forest-property: Exported functions
Function, cache-cluster-config: Exported functions
Function, calc-text-offset: Internal functions
Function, call: Exported functions
Function, cluster-config-property: Exported functions
Function, cluster-find-id-by-property: Exported functions
Function, cluster-ids: Exported functions
Function, cluster-name-p: Exported functions
Function, cluster-names: Exported functions
Function, cluster-properties: Exported functions
Function, cluster-property: Exported functions
Function, config-property: Exported functions
Function, connection-property: Exported functions
Function, database-attach-forest: Exported functions
Function, database-attach-sub-database: Internal functions
Function, database-create: Exported functions
Function, database-find-id-by-property: Exported functions
Function, database-ids: Exported functions
Function, database-name-p: Exported functions
Function, database-names: Exported functions
Function, database-properties: Exported functions
Function, database-property: Exported functions
Function, delete-document: Exported functions
Function, dependent-hosts-property: Internal functions
Function, echo: Exported functions
Function, eval-xquery: Exported functions
Function, evaluate-xquery: Exported functions
Function, extract-text-only: Internal functions
Function, find-multi-marker: Internal functions
Function, forest-create: Exported functions
Function, forest-find-id-by-property: Exported functions
Function, forest-ids: Exported functions
Function, forest-name-p: Exported functions
Function, forest-names: Exported functions
Function, forest-properties: Exported functions
Function, forest-property: Exported functions
Function, get-cluster-config: Exported functions
Function, get-cluster-config-from-connection: Exported functions
Function, get-cluster-info: Exported functions
Function, get-config: Exported functions
Function, get-connection: Exported functions
Function, get-database-info: Exported functions
Function, get-dependent-hosts: Internal functions
Function, get-document: Exported functions
Function, get-forest-info: Exported functions
Function, get-forest-status: Exported functions
Function, get-group-info: Exported functions
Function, get-host-info: Exported functions
Function, get-id-names: Exported functions
Function, group-find-id-by-property: Exported functions
Function, group-ids: Exported functions
Function, group-name-p: Exported functions
Function, group-names: Exported functions
Function, group-properties: Exported functions
Function, group-property: Exported functions
Function, host-find-id-by-property: Exported functions
Function, host-ids: Exported functions
Function, host-name-p: Exported functions
Function, host-names: Exported functions
Function, host-properties: Exported functions
Function, host-property: Exported functions
Function, host-time: Exported functions
Function, ingest-directory: Exported functions
Function, ingest-source-directory: Exported functions
Function, inline-includes: Internal functions
Function, install-base-data: Exported functions
Function, install-base-modules: Exported functions
Function, install-database: Exported functions
Function, install-rest-server: Exported functions
Function, load-cluster-config: Exported functions
Function, load-config: Exported functions
Function, load-connection: Exported functions
Function, load-dependent-hosts: Internal functions
Function, octets-to-string: Internal functions
Function, ping: Exported functions
Function, put-document: Exported functions
Function, read-cluster-config: Exported functions
Function, read-config: Exported functions
Function, read-connection: Exported functions
Function, read-dependent-hosts: Internal functions
Function, read-include: Internal functions
Function, read-stream: Internal functions
Function, rest-api-create: Exported functions
Function, save-all-ccfg: Internal functions
Function, save-cluster-config: Exported functions
Function, save-config: Exported functions
Function, save-connection: Exported functions
Function, save-dependent-hosts: Internal functions
Function, set-cluster-config: Exported functions
Function, set-config: Exported functions
Function, set-connection: Exported functions
Function, set-dependent-hosts: Internal functions
Function, variables-to-json: Internal functions
Function, write-cluster-config: Exported functions
Function, write-config: Exported functions
Function, write-connection: Exported functions
Function, write-dependent-hosts: Internal functions

G
get-cluster-config: Exported functions
get-cluster-config-from-connection: Exported functions
get-cluster-info: Exported functions
get-config: Exported functions
get-connection: Exported functions
get-database-info: Exported functions
get-dependent-hosts: Internal functions
get-document: Exported functions
get-forest-info: Exported functions
get-forest-status: Exported functions
get-group-info: Exported functions
get-host-info: Exported functions
get-id-names: Exported functions
group-find-id-by-property: Exported functions
group-ids: Exported functions
group-name-p: Exported functions
group-names: Exported functions
group-properties: Exported functions
group-property: Exported functions

H
host-find-id-by-property: Exported functions
host-ids: Exported functions
host-name-p: Exported functions
host-names: Exported functions
host-properties: Exported functions
host-property: Exported functions
host-time: Exported functions

I
ingest-directory: Exported functions
ingest-source-directory: Exported functions
inline-includes: Internal functions
install-base-data: Exported functions
install-base-modules: Exported functions
install-database: Exported functions
install-rest-server: Exported functions

L
load-cluster-config: Exported functions
load-config: Exported functions
load-connection: Exported functions
load-dependent-hosts: Internal functions

M
Macro, with-cluster-config: Exported macros
Macro, with-config: Exported macros
Macro, with-connection: Exported macros
Macro, with-dependent-hosts: Internal macros

O
octets-to-string: Internal functions

P
ping: Exported functions
put-document: Exported functions

R
read-cluster-config: Exported functions
read-config: Exported functions
read-connection: Exported functions
read-dependent-hosts: Internal functions
read-include: Internal functions
read-stream: Internal functions
rest-api-create: Exported functions

S
save-all-ccfg: Internal functions
save-cluster-config: Exported functions
save-config: Exported functions
save-connection: Exported functions
save-dependent-hosts: Internal functions
set-cluster-config: Exported functions
set-config: Exported functions
set-connection: Exported functions
set-dependent-hosts: Internal functions

V
variables-to-json: Internal functions

W
with-cluster-config: Exported macros
with-config: Exported macros
with-connection: Exported macros
with-dependent-hosts: Internal macros
write-cluster-config: Exported functions
write-config: Exported functions
write-connection: Exported functions
write-dependent-hosts: Internal functions

Jump to:   C   D   E   F   G   H   I   L   M   O   P   R   S   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*cluster-config*: Internal special variables
*config*: Internal special variables
*connection*: Internal special variables
*dependent-hosts*: Internal special variables

S
Special Variable, *cluster-config*: Internal special variables
Special Variable, *config*: Internal special variables
Special Variable, *connection*: Internal special variables
Special Variable, *dependent-hosts*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   M   P   S  
Index Entry  Section

C
cl-marklogic: The cl-marklogic system
cl-marklogic: The cl-marklogic package

M
ml-rest: The ml-rest package

P
Package, cl-marklogic: The cl-marklogic package
Package, ml-rest: The ml-rest package

S
System, cl-marklogic: The cl-marklogic system

Jump to:   C   M   P   S