Documentation
MarkLogic Server includes the following documentation:
Documentation |
Description |
|---|---|
Provides code examples in Optic, the SQL-like API that is MarkLogic’s primary query language. It includes detailed explanations for querying text, values, graphs, geospatial regions, and metadata culminating in joining two different data models with a single query. |
|
Provides API documentation for the Server-Side MarkLogic built-in extensions to the JavaScript standard functions. |
|
Provides API documentation for the MarkLogic built-in and module extensions to the XQuery standard functions, as well as API documentation for the W3C functions implemented in MarkLogic Server. |
|
Provides a quick, step-by-step overview of how to get up and running with MarkLogic Server. |
|
Provides procedures for installing MarkLogic Server. |
|
Provides a summary of new features and upgrade compatibility. |
|
Provides an overview of MarkLogic and conceptual information about the server architecture. |
|
Provides procedures, methodologies, and conceptual information about general MarkLogic Server application development tasks. |
|
Provides procedures, methodologies, and conceptual information about search-based application development tasks. |
|
Provides procedures, methodologies, and conceptual information about developing MarkLogic Server applications using the Node.js Client API. |
|
Provides procedures, methodologies, and conceptual information about developing MarkLogic Server applications using the Java API. |
|
Provides 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. |
|
Provides information on MarkLogic Server administration and application development using the MarkLogic REST API. |
|
Provides procedures, methodologies, and conceptual information about semantic application development tasks and MarkLogic SPARQL and triple support. |
|
Provides information on developing applications using MarkLogic bi-temporal features. |
|
Provides procedures, methodologies, and conceptual information about developing MarkLogic Applications using entity relationship modeling and the Entity Services API. |
|
Provides an overview of reference application architectures for multi-tiered applications built using MarkLogic as the database. |
|
Provides procedures for administrative tasks such as creating servers, creating databases, backing up databases, creating users, setting up your security policy, and so on. |
|
Provides information on writing code to script various administrative tasks such as creating and modifying databases, App Servers, and so on. |
|
Provides information on database replication, useful for disaster recovery scenarios. |
|
Provides information on Flexible Replication, useful for information sharing from one database to another. |
|
Provides information on monitoring MarkLogic Server, including using the built-in monitoring tools and integrating with external tools such as HP Operations Manager. |
|
Provides a language reference for the MarkLogic Server-Side JavaScript language. This guide includes MarkLogic-specific Object reference, but is not a comprehensive language reference. |
|
Provides a condensed overview of the XQuery language, including information on the three XQuery dialects in MarkLogic Server. This guide does include some syntax information, although it is primarily intended as an introduction and quick reference to the language, not as a comprehensive reference. |
|
Provides a procedural guide that explains how to use MarkLogic Content Pump (mlcp), a command line tool to load content into MarkLogic, extract content from MarkLogic, or copy content between databases. |
|
Provides an introduction to the Content Processing Framework and procedures for installing the default content processing framework. |
|
Provides performance-related information that is useful to application developers and administrators. |
|
Provides information on large-scale system architecture, clustering, availability, and details on setting up shared-disk and local-disk failover. |
|
Provides information on the role-based security model in MarkLogic Server. |
|
Provides information about running MarkLogic Server in an EC2 environment. |
|
Provides step-by-step information on using Query Console, a tool to create and run arbitrary XQuery, JavaScript, SQL, and SPARQL code. |
|
Provides procedures, methodologies, and conceptual information about loading content into MarkLogic Server. Includes an overview of the ingestion techniques available using XQuery, Java, REST, and the MarkLogic Content Pump (mlcp). |
|
Provides information on how to use MarkLogic’s SQL interface, including the creation of relational schemas and views. |
|
Provides a reference to MarkLogic Server and MarkLogic Application Services error and log messages. |
|
Provides a glossary of terms as well as copyright and support information. |
|
Provides API documentation for the REST API. |
|
Provides API documentation for the MarkLogic Java Client API. |
|
Provides API documentation for the MarkLogic Node.js Client API. |
|
Provides API documentation for the MarkLogic XML Contentbase Connector for Java API (XCC/J). |
|
Provides API documentation for the C++ User Defined Function (UDF) API. |
XQuery language documentation is provided through the W3C working group drafts specified in Compatibility with XQuery Specifications. Sample code is provided through the demo server, which is automatically installed as part of the MarkLogic Server installation process. Additionally, there are many samples available on the MarkLogic developer website).
XQuery language extensions specific to MarkLogic Server are documented online in the MarkLogic XQuery and XSLT Function Reference. Example code snippets are provided as part of that documentation. The Admin Interface provides a large-scale example of complex XQuery programming, using many of the MarkLogic XQuery language extensions.
The Admin Interface includes built-in help screens that explain the purpose of its various controls and parameters.
Known bugs are documented online as we find them or as they are reported to us. See the MarkLogic support website (supported customers only) for more details.