Document Functions¶

Quick Reference¶

Function	Description
`DOCUMENT_CONTAINS`	Returns true if the document contains the given key.
`DOCUMENT_GET`	Returns the value for a given key in the document.
`DOCUMENT_KEYS`	Returns the list of keys in the given document.
`DOCUMENT_MERGE`	Returns a new document that is the result of merging two doc...
`DOCUMENT_REMOVE`	Returns a new document with the specified key removed.
`DOCUMENT_VALUES`	Returns the list of values in the given document.

DOCUMENT_CONTAINS(doc DOCUMENT, key STRING) -> BOOLEAN

Returns true if the document contains the given key.

Parameters:

Name	Type	Description
`doc`	DOCUMENT	The input document.
`key`	STRING	The key to check in the document.

Returns: BOOLEAN - True if the document contains the key, false otherwise.

Examples:

DOCUMENT_CONTAINS({\
:1,\

DOCUMENT_GET(doc DOCUMENT, key STRING) -> ANY

Returns the value for a given key in the document.

Parameters:

Name	Type	Description
`doc`	DOCUMENT	The input document.
`key`	STRING	The key to retrieve from the document.

Returns: ANY - The value associated with the given key.

Examples:

DOCUMENT_GET({\
:1,\

DOCUMENT_KEYS(doc DOCUMENT) -> ARRAY OF STRING

Returns the list of keys in the given document.

Parameters:

Name	Type	Description
`doc`	DOCUMENT	The input document.

Returns: ARRAY OF STRING - An array of keys from the document.

Examples:

DOCUMENT_KEYS({\
:1,\

DOCUMENT_MERGE(doc1 DOCUMENT, doc2 DOCUMENT) -> DOCUMENT

Returns a new document that is the result of merging two documents.

Parameters:

Name	Type	Description
`doc1`	DOCUMENT	The first document.
`doc2`	DOCUMENT	The second document.

Returns: DOCUMENT - A new document containing all keys and values from both documents.

Examples:

DOCUMENT_MERGE({\

DOCUMENT_REMOVE(doc DOCUMENT, key STRING) -> DOCUMENT

Returns a new document with the specified key removed.

Parameters:

Name	Type	Description
`doc`	DOCUMENT	The input document.
`key`	STRING	The key to remove from the document.

Returns: DOCUMENT - A new document without the specified key.

Examples:

DOCUMENT_REMOVE({\
:1,\

DOCUMENT_VALUES(doc DOCUMENT) -> ARRAY

Returns the list of values in the given document.

Parameters:

Name	Type	Description
`doc`	DOCUMENT	The input document.

Returns: ARRAY - An array of values from the document.

Examples:

DOCUMENT_VALUES({\
:1,\