Namespace: patchBuilderMetadataValues

patchBuilderMetadataValues

Specifies operations to patch the metadata values of a document.
Since:
  • 2.0.1

Methods


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

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

remove(name) → {patchBuilder.PatchOperation}

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

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

Specifies a metadata value to replace for a document.
Parameters:
Name Type Description
name string the name of the existing metadata value
value the modified value
Since:
  • 2.0.1
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.