cl-marklogic

API Reference

cl-marklogic

Common Lisp library for accessing MarkLogic Server.

CL-MARKLOGIC

  • Function PING
    Receive the string "pong" echoed back from the server.
  • Function ECHO (string)
    Receive the string argument echoed back from the server.
  • Function HOST-TIME
    Get the current local dateTime of the server.
  • Function DATABASE-NAMES (&optional (database-info (get-database-info)))
    Get a list the database names in the cluster.
  • Function DATABASE-NAME-P (database-name &optional (database-info (get-database-info)))
    Get T if database-name exists or nil if not.
  • Function DATABASE-IDS (&optional (database-info (get-database-info)))
    Get a list the database ids in the cluster.
  • Function DATABASE-FIND-ID-BY-PROPERTY (property value &optional (info (get-database-info)))
  • Function DATABASE-PROPERTIES (database-id &optional (database-info (get-database-info)))
    Get the properties for a database-id.
  • Function DATABASE-PROPERTY (database-id property &optional (database-info (get-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.
  • Function GET-DATABASE-INFO
    Get a two tier nested a-lists containing properties of all of the databases in the cluster.
  • Function DATABASE-CREATE (database-name &key (security-database-name "security") (schemas-database-name "schemas") (forest-attach-name nil) (forest-create-name nil) (database-attach-name nil))
    Creat a new database.
  • Function DATABASE-ATTACH-FOREST (database-name forest-name)
    Attach a forest to a database.
  • Function REST-API-CREATE (group-name server-name port database-name modules-database-name)
    Create a REST API server.
  • Function FOREST-NAMES (&optional (forest-info (get-forest-info)))
    Get a list the forest names in the cluster.
  • Function FOREST-NAME-P (forest-name &optional (forest-info (get-forest-info)))
    Get T if forest-name exists or nil if not.
  • Function FOREST-IDS (&optional (forest-info (get-forest-info)))
    Get a list of the forest ids in the cluster.
  • Function FOREST-FIND-ID-BY-PROPERTY (property value &optional (info (get-forest-info)))
  • Function FOREST-PROPERTIES (forest-id &optional (forest-info (get-forest-info)))
    Get the properties for a forest-id.
  • Function FOREST-PROPERTY (forest-id property &optional (forest-info (get-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).
  • Function GET-FOREST-INFO
    Get a two tier nested a-lists containing properties of all of the forests in the cluster.
  • Function GET-FOREST-STATUS (forest-id)
    Get the complete XML representation of the forest's status.
  • Function FOREST-CREATE (forest-name &key (host-name nil) (data-directory nil) (large-data-directory nil) (fast-data-directory nil))
    Create a new forest.
  • Function HOST-NAMES (&optional (host-info (get-host-info)))
    Get a list the host names in the host.
  • Function HOST-NAME-P (host-name &optional (host-info (get-host-info)))
    Get T if host-name exists or nil if not.
  • Function HOST-IDS (&optional (host-info (get-host-info)))
    Get a list the host ids in the cluster.
  • Function HOST-FIND-ID-BY-PROPERTY (property values &optional (info (get-host-info)))
  • Function HOST-PROPERTIES (host-id &optional (host-info (get-host-info)))
    Get the properties for a host-id.
  • Function HOST-PROPERTY (host-id property &optional (host-info (get-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.
  • Function GET-HOST-INFO
    Get a two tier nested a-lists containing properties of all of the hosts in the cluster.
  • Function CLUSTER-NAMES (&optional (cluster-info (get-cluster-info)))
    Get a list the cluster names in the cluster.
  • Function CLUSTER-NAME-P (cluster-name &optional (cluster-info (get-cluster-info)))
    Get T if cluster-name exists or nil if not.
  • Function CLUSTER-IDS (&optional (cluster-info (get-cluster-info)))
    Get a list of the cluster ids known to the local cluster.
  • Function CLUSTER-FIND-ID-BY-PROPERTY (property value &optional (info (get-cluster-info)))
  • Function CLUSTER-PROPERTIES (cluster-id &optional (cluster-info (get-cluster-info)))
    Get the properties for a cluster-id.
  • Function CLUSTER-PROPERTY (cluster-id property &optional (cluster-info (get-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.
  • Function GET-CLUSTER-INFO
    Get a two tier nested a-lists containing properties of all of the clusters in the cluster.
  • Function GET-ID-NAMES
    Get a two tier nested a-lists containing the names associated with an ID.
  • Function GROUP-NAMES (&optional (group-info (get-group-info)))
    Get a list the group names in the group.
  • Function GROUP-NAME-P (group-name &optional (group-info (get-group-info)))
    Get T if group-name exists or nil if not.
  • Function GROUP-IDS (&optional (group-info (get-group-info)))
    Get a list the group ids in the group.
  • Function GROUP-FIND-ID-BY-PROPERTY (property value &optional (info (get-group-info)))
  • Function GROUP-PROPERTIES (group-id &optional (group-info (get-group-info)))
    Get the properties for a group-id.
  • Function GROUP-PROPERTY (group-id property &optional (group-info (get-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.
  • Function GET-GROUP-INFO
    Get a two tier nested a-lists containing properties of all of the groups in the group.
  • Function EVALUATE-XQUERY (xquery &optional (variables nil))
    Evaluate an XQuery string inlining includes and applying variables.
  • Function PUT-DOCUMENT (uri content content-type &key (database nil))
    Put a document by URI.
  • Function GET-DOCUMENT (uri &key (accept nil) (database nil))
    Get a document by URI.
  • Function DELETE-DOCUMENT (uri &key (database nil))
    Delete a document BY URI.
  • Function INGEST-SOURCE-DIRECTORY (database-name system dir-name &key (clear nil))
  • Function INGEST-DIRECTORY (database-name path &key (clear nil))
  • Function GET-CONFIG
    Get the global config value.
  • Function SET-CONFIG (new-value)
    Set the global config value.
  • Macro WITH-CONFIG ((config-value) &body body)
    Bind `config-value` to *config* to override the global config a-list.
  • Function WRITE-CONFIG (to &optional (config (get-config)))
  • Function READ-CONFIG (from)
  • Function CONFIG-PROPERTY (property-name &optional (config *config*))
  • Function LOAD-CONFIG (config-name)
  • Function SAVE-CONFIG (&optional (config *config*))
  • Function GET-CLUSTER-CONFIG
    This funtion returns the global cached cluster config.
  • Function SET-CLUSTER-CONFIG (new-value)
    This function sets the value of the global cached cluster cache.
  • 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.
  • Function WRITE-CLUSTER-CONFIG (to &optional (config (get-cluster-config)))
    This function writes a cluster configuration to a stream.
  • Function READ-CLUSTER-CONFIG (from)
    This function reads a cluster configuration from a stream.
  • Function CACHE-CLUSTER-CONFIG
    This function refreshes the default cached cluster configuration from the default connection.
  • Function GET-CLUSTER-CONFIG-FROM-CONNECTION
    This function fetches a fresh cluster configuration from the default connection.
  • Function CLUSTER-CONFIG-PROPERTY (property-name &optional (cluster-config *cluster-config*))
    This function accesses a property in a cluster configuration.
  • 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.
  • Function SAVE-CLUSTER-CONFIG (&optional (cluster-config *cluster-config*))
    This function saves a cluster configuration to a project located in the system source tree from the default cached cluster configuration.
  • Function INSTALL-DATABASE (database-name &key (forest-create-name nil))
  • Function INSTALL-REST-SERVER (group-name server-name port database-name modules-database-name)
  • Function INSTALL-BASE-MODULES (database-name &key (clear nil))
  • Function INSTALL-BASE-DATA (database-name &key (clear nil))

ML-REST

  • Function GET-CONNECTION
    Get the global connection value.
  • Function SET-CONNECTION (new-value)
    Set the global connection value.
  • Macro WITH-CONNECTION ((connection-value) &body body)
    Bind `connection-value` to *connection* to override the global connection a-list.
  • Function WRITE-CONNECTION (to &optional (connection (get-connection)))
  • Function READ-CONNECTION (from)
  • Function CONNECTION-PROPERTY (property-name &optional (connection *connection*))
  • Function LOAD-CONNECTION (connection-name)
  • Function SAVE-CONNECTION (&optional (connection *connection*))
  • Function CALL (path &key (method :get) (parameters nil) (accept nil) (content nil) (content-type "application/json"))
  • Function EVAL-XQUERY (xquery &optional (variables nil))
    Evaluate an XQuery string inlining includes and applying variables.

ml-dsl

Describe ml-dsl here

ML-DSL

No exported symbols.

ml-optimizer

Common Lisp application to optimize MarkLogic clusters.

ML-OPTIMIZER

  • Function START
  • Function GET-DEPENDENT-HOSTS
    Get the global dependent-hosts value.
  • Function SET-DEPENDENT-HOSTS (new-value)
    Set the global dependent-hosts value.
  • Macro WITH-DEPENDENT-HOSTS ((dependent-hosts-value) &body body)
    Bind `dependent-hosts-value` to *dependent-hosts* to override the global dependent-hosts a-list.
  • Function WRITE-DEPENDENT-HOSTS (to &optional (dependent-hosts (get-dependent-hosts)))
  • Function READ-DEPENDENT-HOSTS (from)
  • Function DEPENDENT-HOSTS-PROPERTY (property-name &optional (dependent-hosts *dependent-hosts*))
  • Function LOAD-DEPENDENT-HOSTS (dependent-hosts-name)
  • Function SAVE-DEPENDENT-HOSTS (&optional (dependent-hosts *dependent-hosts*))
  • Function SETTING-CONNECTION-DETAIL

ml-test

Tests for the system cl-marklogic

ML-TEST

  • Function TEST-MARKLOGIC
  • Function TEST-OPTIMIZER
  • Function TEST-ALL
    Run unit tests for cl-marklogic and subsystems.
  • Function TEST-WITH-SERVERS