Namespace: patchBuilderProperties

patchBuilderProperties

Specifies operations to patch the metadata properties of a document.

Methods


add(name, value) → {patchBuilder.PatchOperation}

Specifies a new property to add to a document's metadata.
Parameters:
Name Type Description
name string the name of the new metadata property
value the value of the new metadata property
Since:
  • 1.0
Returns:
a patch operation
Type
patchBuilder.PatchOperation

remove(name) → {patchBuilder.PatchOperation}

Specifies a metadata property to remove from the document's metadata.
Parameters:
Name Type Description
name string the name of the metadata property to remove
Since:
  • 1.0
Returns:
a patch operation
Type
patchBuilder.PatchOperation

replace(name, value) → {patchBuilder.PatchOperation}

Specifies a different value for a property in a document's metadata.
Parameters:
Name Type Description
name string the name of the existing metadata property
value the modified value of the metadata property
Since:
  • 1.0
Returns:
a patch operation
Type
patchBuilder.PatchOperation
Copyright 2014-2017 MarkLogic Corporation Documentation generated by JSDoc 3.4.3 on 2017-07-14T11:04:00-07:00 using the DocStrap template.