MarkLogic 8 Documentation

This page contains documentation for MarkLogic 8. The latest documentation is available at docs.marklogic.com

To install the application used on docs.marklogic.com on your local machine or server, you can install the github project at https://github.com/marklogic-community/RunDMC. See the README in the github repository for details, but the basic instructions to install the repository are:

On a machine in which MarkLogic is installed, perform the following from a directory where you want the github repository:

$ git clone https://github.com/marklogic-community/RunDMC.git RunDMC

$ cd RunDMC

$ ./ml local credentials

Edit the RunDMC/deploy/local.properties file and add an entry for your modules-root with a value corresponding to the src directory of your local RunDMC repository. For example:

modules-root=/space/git/RunDMC/src

Edit the RunDMC/deploy/local.properties file and add an entry for your server-version with a value corresponding to the major version of MarkLogic you are running. For example, if you are using MarkLogic 8, andd the following entry:

server-version=8

Save any changes to the RunDMC/deploy/local.properties file.

$ ./ml local bootstrap docs

$ ./ml local deploy_docs

The whole process should take about 15 minutes.

MarkLogic Documents

The following are the individual components of the MarkLogic 8 document set.

MarkLogic JavaScript Built-In Function Reference [html on the web]
API documentation for the MarkLogic built-in Server-Side JavaScript functions.
MarkLogic XQuery and XSLT Function Reference [html on the web]
API documentation for the MarkLogic built-in and module extensions to the XQuery and XSLT standard functions. It also contains API reference information for the W3C standard functions implemented in MarkLogic Server.
Getting Started With MarkLogic Server [pdf]
A quick, step-by-step overview of how to get up and running with MarkLogic Server.
Installation Guide [pdf]
Contains procedures for installing and upgrading MarkLogic Server on all platforms.
MarkLogic 8 Release Notes [pdf]
Contains a summary of new features, upgrade compatibility information, and other information about this release.
Concepts Guide [pdf]
Provides an overview of MarkLogic and conceptual information about the server architecture.
Application Developer's Guide [pdf]
Provides procedures, methodologies, and conceptual information about general application development tasks in MarkLogic Server.
Search Developer's Guide [pdf]
Provides procedures, methodologies, and conceptual information about developing search-related applications in MarkLogic Server. Includes information about the Search API and the built-in search features of MarkLogic Server.
Node.js Application Developer's Guide [pdf]
Provides procedures, methodologies, and conceptual information about developing MarkLogic Server applications using the Node.js Client API.
Java Application Developer's Guide [pdf]
Provides procedures, methodologies, and conceptual information about developing MarkLogic Server applications using the MarkLogic Java Client API.
XCC Developer's Guide [pdf]
Contains an overview of the what you can do with the XCC libraries, examples of how to use XCC, and an overview of the sample applications included with XCC.
MarkLogic Connector for Hadoop Developer's Guide [pdf]
How to create Apache Hadoop MapReduce jobs that use MarkLogic Server as an input data source or an output destination. This book includes an overview of the sample applications.
REST Application Developer's Guide [pdf]
Provides procedures, methodologies, and conceptual information about developing MarkLogic Server applications using the REST API.
Semantics Developer's Guide [pdf]
Provides information on developing semantic applications with MarkLogic.
Temporal Developer's Guide [pdf]
Provides information on developing applications using MarkLogic bi-temporal features.
Reference Application Architecture Guide [pdf]
Provides an overview of reference application architectures for multi-tiered applications built using MarkLogic as the database.
Administrator's Guide [pdf]
Provides procedures for administrative tasks such as creating servers, creating databases, backing up databases, creating users, setting up your security policy, and so on.
Scripting Administrative Tasks Guide [pdf]
Provides procedures for writing programs that use the MarkLogic APIs to perform administrative tasks such as creating servers, creating databases, backing up databases, creating users, setting up your security policy, and so on.
Database Replication Guide [pdf]
Provides step-by-step information on how to use database replication to replicate MarkLogic Server content between clusters.
Flexible Replication Guide [pdf]
Provides step-by-step information on replicating MarkLogic Server content.
Monitoring MarkLogic Guide [pdf]
Provides procedures for setting up and using monitoring applications on MarkLogic Server.
JavaScript Reference Guide [pdf]
A condensed overview of the Server-Side JavaScript in MarkLogic. This book contains reference material for MarkLogic-specific JavaScript objects available to server-side programmers.
XQuery and XSLT Reference Guide [pdf]
A condensed overview of the XQuery and XSLT languages, including a description of the three XQuery dialects supported in MarkLogic Server and descriptions of the MarkLogic extensions to XQuery and XSLT. This book does includes some syntax information, although it is primarily intended as in introduction and quick-reference to the language, not as a comprehensive reference.
mlcp User Guide [pdf]
A procedural guide that explains how to use MarkLogic Content Pump (mlcp) command line tool to load content into MarkLogic, extract content from MarkLogic, or copy content between databases.
Content Processing Framework Guide [pdf]
Provides an introduction to the Content Processing Framework and procedures for installing the default content processing framework.
Query Performance and Tuning Guide [pdf]
Provides performance-related information useful to application developers and administrators.
Scalability, Availability, and Failover Guide [pdf]
Provides information on large-scale system architecture, clustering, and details on setting up both local-disk failover and shared-disk failover.
Understanding and Using Security Guide [pdf]
Provides information on the role-based security model in MarkLogic Server.
MarkLogic Server on Amazon EC2 Guide [pdf]
A procedural guide that describes how to set up MarkLogic Server on Amazon Elastic Compute Cloud (EC2).
Query Console User Guide [pdf]
A procedural guide that describes how to use Query Console.
Loading Content Into MarkLogic Server Guide [pdf]
Provides procedures, methodologies, and conceptual information about loading content into MarkLogic Server. Includes an overview of ingestion techniques available using XQuery, JavaScript, Java, REST, .NET, and the MarkLogic Content Pump (mlcp).
SQL Data Modeling Guide [pdf]
Provides procedures for creating schemas and views to support SQL queries to MarkLogic Server.
Messages and Codes Reference Guide [pdf]
A reference guide to MarkLogic error messages that lists messages, the code for each message, and causes and responses.
Glossary, Copyright, and Support [pdf]
Includes a glossary of terms as well as copyright and support information.
MarkLogic REST API Reference [html on the web]
API documentation for the REST API.
MarkLogic Java Client API Javadoc [html]
Javadoc for the MarkLogic Java Client API.
MarkLogic Client API for Node.js Documentation [html]
API documentation for the MarkLogic Client API for Node.js.
XCC Javadoc [html]
API documentation for the MarkLogic XML Content Connector for Java (XCC/J) API.
.NET XCC API Documentation [html]
API documentation for the MarkLogic XCC .NET C# API.
MarkLogic Connector for Hadoop API Documentation [html]
API documentation for the MarkLogic Connector for Hadoop.
C++ Native Plugin API Documentation [html]
API documentation for creating native C++ plugins, such as aggregate user-defined functions (UDFs).
MarkLogic Connector for SharePoint® Administrator's Guide [pdf]
The documentation for the MarkLogic Connector for SharePoint®, which allows you to mirror documents from a Microsoft SharePoint repository in MarkLogic Server.
Application Builder Developer's Guide [pdf]
Provides step-by-step information on using the Application Builder to build a search application, and also provides information on customizing applications built with the Application Builder.
Information Studio Developer's Guide [pdf]
Provides step-by-step information on using the Information Studio to load content into MarkLogic Server.

ZIP File of All MarkLogic 8 Documentation

Click the following link to download a zip file containing the latest MarkLogic 8 documentation.

W3C XQuery Language Documents

MarkLogic Server implements the W3C XQuery 1.0 Recommendations. Additionally, there is backwards compatibility with the May 2003 version of the XQuery specification used in MarkLogic Server 3.2 and previous versions. For details on the XQuery implementation in MarkLogic 8, including the three different dialects supported, see the XQuery Reference Guide. Visit the W3C site for complete standards documentation.