Oihana PHP Arango

values.php

Table of Contents

Functions

values()  : string
Return the attribute values of a document.

Functions

values()

Return the attribute values of a document.

values(string $document[, bool|null $removeSystemAttrs = null ]) : string

Wraps the ArangoDB AQL function VALUES(document, removeSystemAttrs).

Example AQL usage:

VALUES({a: 1, b: 2})                  // returns [1, 2]
VALUES({a: 1, _key: "x"}, true)       // returns [1]
Parameters
$document : string

The document variable or expression.

$removeSystemAttrs : bool|null = null

Whether to omit system attributes (_id, _key, _rev, ...).

Tags
example
use function oihana\arango\db\functions\documents\values;

$expr = values('doc');
// Produces: 'VALUES(doc)'

$expr = values('doc', true);
// Produces: 'VALUES(doc,true)'
see
https://docs.arangodb.com/stable/aql/functions/document-object/#values
since
1.1.0
author

Marc Alcaraz

Return values
string

The formatted AQL expression.

On this page

Search results