Namespace: MLRest

Namespaces

Database

Transaction

Methods

create([options])
commitTransaction(txId)
create([uri], content[, params])
database(name)
delete(uri[, params])
deleteAll([uris][, params])
doc(uri[, params])
graph([uri][, params])

listGraphs()
listOptions()
listValues([params])
openTransaction()
options(name)
request(endpoint[, params][, req])
rollbackTransaction(txId)
search([query][, params])

suggest([prefix][, query][, params])
things(iris[, params])
transaction()
transactionDetails(txId)
update(uri, content[, params])
values(name[, query][, params])

Namespaces

Database

Transaction

Methods

static

create([options]) → MLRest

Creates an MLRest client

Parameter

Name	Type	Optional	Description
options	Object	Yes

Properties

Name	Type	Optional	Description
options.endpoint	String	Yes	the REST API endpoint Defaults to `'/'`.
options.version	String	Yes	the REST API version Defaults to `'v1'`.
options.baseURI	String	Yes	the base URI for REST API instance Defaults to `document.baseURI`.
options.request	Object	Yes	default args for deps.external:fetch

Returns: MLRest

commitTransaction(txId) → "Promise<Response>"

Commit a multi-statement transaction

Parameter

Name	Type	Optional	Description
txId	String		transaction ID

See also: http://docs.marklogic.com/REST/POST/v1/transactions/[txid]
Returns: "Promise<Response>"

create([uri], content[, params]) → "Promise<Response>"

Create a document

Parameters

Name	Type	Optional	Description
uri	String	Yes	document URI (generated server-side if not present)
content			document content
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/PUT/v1/documents; http://docs.marklogic.com/REST/POST/v1/documents; http://docs.marklogic.com/REST/POST/v1/documents@extension=[ext]
Returns: "Promise<Response>"

database(name) → Database

Creates a Database instance with the same settings as this, throws an Error this is a Database

Parameter

Name	Type	Optional	Description
name	String

Returns: Database

delete(uri[, params]) → "Promise<Response>"

Delete a document

Parameters

Name	Type	Optional	Description
uri	String
params	(Object or deps.external:URLSearchParams)	Yes

See also: http://docs.marklogic.com/REST/DELETE/v1/documents
Returns: "Promise<Response>"

deleteAll([uris][, params]) → "Promise<Response>"

Delete multiple documents by URI, directory, or collection

Parameters

Name	Type	Optional	Description
uris	Array of String	Yes	document URIs
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/DELETE/v1/documents; http://docs.marklogic.com/REST/DELETE/v1/search
Returns: "Promise<Response>"

doc(uri[, params]) → "Promise<Response>"

Get a document

Parameters

Name	Type	Optional	Description
uri	String		document URI
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/GET/v1/documents
Returns: "Promise<Response>"

graph([uri][, params]) → "Promise<Response>"

Get the contents of a specified graph, or the default graph

Parameters

Name	Type	Optional	Description
uri	String	Yes	graph URI
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/GET/v1/graphs
Returns: "Promise<Response>"

listGraphs() → "Promise<Response>"

List all semantic graphs by name

See also: http://docs.marklogic.com/REST/GET/v1/graphs
Returns: "Promise<Response>"

listOptions() → "Promise<Response>"

List the server-side query options

See also: http://docs.marklogic.com/REST/GET/v1/config/query
Returns: "Promise<Response>"

listValues([params]) → "Promise<Response>"

List the server-side values definitions

Parameter

Name	Type	Optional	Description
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/GET/v1/values
Returns: "Promise<Response>"

openTransaction() → "Promise<Response>"

Open a multi-statement transaction

See also: http://docs.marklogic.com/REST/POST/v1/transactions
Returns: "Promise<Response>"

options(name) → "Promise<Response>"

Get server-side options by name

Parameter

Name	Type	Optional	Description
name	String

See also: http://docs.marklogic.com/REST/GET/v1/config/query/['default'-or-name]
Returns: "Promise<Response>"

request(endpoint[, params][, req]) → "Promise<Response>"

Make an arbitrary REST request

Parameters

Name	Type	Optional
endpoint	String
params	(Object or deps.external:URLSearchParams)	Yes
req	Object	Yes

Returns: "Promise<Response>"

rollbackTransaction(txId) → "Promise<Response>"

Rollback a multi-statement transaction

Parameter

Name	Type	Optional	Description
txId	String		transaction ID

See also: http://docs.marklogic.com/REST/POST/v1/transactions/[txid]
Returns: "Promise<Response>"

search([query][, params]) → "Promise<Response>"

Search for documents or metadata

Parameters

Name	Type	Optional	Description
query	Object	Yes	a combined query
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/POST/v1/search
Returns: "Promise<Response>"

suggest([prefix][, query][, params]) → "Promise<Response>"

Get search phrase suggestions (for autocompletion)

Parameters

Name	Type	Optional	Description
prefix	String	Yes	search phrase to match
query	Object	Yes	a combined query
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/POST/v1/suggest
Returns: "Promise<Response>"

things(iris[, params]) → "Promise<Response>"

Get triples related to the specified IRIs

Parameters

Name	Type	Optional	Description
iris	(String or Array of String)		one-or-more IRIs
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/GET/v1/graphs/things
Returns: "Promise<Response>"

transaction() → Transaction

Creates a Transaction instance with the same settings as this, throws an Error if this is a Transaction

Returns: Transaction

transactionDetails(txId) → "Promise<Response>"

Get the details of an open transaction

Parameter

Name	Type	Optional	Description
txId	String		transaction ID

See also: http://docs.marklogic.com/REST/GET/v1/transactions/[txid]
Returns: "Promise<Response>"

update(uri, content[, params]) → "Promise<Response>"

Update a document

Parameters

Name	Type	Optional	Description
uri	String		document URI
content	Object		updated document contents
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/PUT/v1/documents
Returns: "Promise<Response>"

values(name[, query][, params]) → "Promise<Response>"

Get values for the named definition

Parameters

Name	Type	Optional	Description
name	String		values definition name
query	Object	Yes	a combined query
params	(Object or deps.external:URLSearchParams)	Yes	request params

See also: http://docs.marklogic.com/REST/POST/v1/values/[name]
Throws: TypeError if name is not provided
Returns: "Promise<Response>"