CRUD

Yep that's Create, Read, Update, and Delete. We use the term Insert instead of Create but that doesn't keep us from saying CRUD for fun. MarkLogic provides a simple API for CRUD.

To insert a document, send a PUT request to the /documents endpoint with the document URI as a parameter. The format parameter specifies the documents format. For example, to store a JSON document with URI /afternoon-drink.json:

curl -X PUT \
  --anyauth --user username:password \
  -d '{"name": "Iced Mocha", "size": "Grandé", "tasty": true }' \
  'http://myhost:port/v1/documents?uri=/afternoon-drink.json'

where you get myhost:port and your username and password from your database administrator.

If you haven't seen the curl tool before, it's a popular command line http client, that is ideal for playing with REST apis. If you don't have a copy, look here.

curl supports specifying your credentials on the command line with a --user username:password flag. Alternatively, you can store these in your .curlrc file. This and additional details on curl can be found in its manual page.

To get the document back:

curl -X GET \
  --anyauth --user username:password \
  'http://myhost:port/v1/documents?uri=/afternoon-drink.json'

If you'd rather have MarkLogic automatically generate a unique URI for you, you can send the original document via a POST, along with an extension parameter to indicate the format.

curl -X POST \
  --anyauth --user username:password \
  -d '{"name": "Iced Tea", "size": "Jumbo", "refreshing": true }' \
  'http://myhost:port/v1/documents?extension=json'

(The MarkLogic response includes a Location header that contains the URI of the new document.)

To update the existing document, send another PUT request:

curl -X PUT \
  --anyauth --user username:password \
  -d '{"name": "Iced Tea", "size": "Jumbo", "refreshing": true }' \
  'http://myhost/v1/documents?uri=/afternoon-drink.json'

And to delete the document, send a DELETE request:

curl -X DELETE \
  --anyauth --user username:password \
  'http://myhost/v1/documents?uri=/afternoon-drink.json'

The REST API provides additional functionality related to CRUD, including

Updating pieces of documents
Transforming documents during retrieval (for example, to HTML on the way out)
Transforming documents during during insertion (for example, to XML on the way in)
Managing document metadata (collections, permissions, properties, quality)
And much more!

These techniques are covered in the REST API Developers Guide and the Document Management endpoint reference.

Basic Concepts

Search and Query APIs

Contents

CRUD