Namespace: custom

custom

Provides functions that maintain custom query binding or facet extensions on the REST server. The client must have been created for a user with the rest-admin role.

Methods


list() → {ResultProvider}

Lists the custom query libraries installed on the server.
Since:
  • 1.0
Returns:
an object whose result() function takes a success callback that receives the list of replacement libraries
Type
ResultProvider

read(moduleName) → {ResultProvider}

Reads a custom query library installed on the server.
Parameters:
Name Type Description
moduleName string the filename without a path for the custom query library
Since:
  • 1.0
Returns:
an object whose result() function takes a success callback that receives the source code for the library
Type
ResultProvider

remove(moduleName)

Deletes a custom query library from the server.
Parameters:
Name Type Description
moduleName string the filename without a path for the custom query library
Since:
  • 1.0

write(moduleName, permissions, source)

Installs a custom query library on the server.
Parameters:
Name Type Argument Description
moduleName string the filename without a path for the custom query library; the filename must end in an extension registered in the server's mime type mapping table for the mime type of the source code format; at present, the extension should be ".xqy"
permissions Array.<object> <optional>
the permissions controlling which users can read, update, or execute the custom query library
source string the source code for the custom query library; at present, the source code must be XQuery
Since:
  • 1.0
Copyright 2014-2017 MarkLogic Corporation Documentation generated by JSDoc 3.4.3 on 2017-10-30T13:10:55-07:00 using the DocStrap template.