Oihana PHP Arango

Operation uses ConstantsTrait

Table of Contents

Constants

COLLECT  : string = 'COLLECT'
The COLLECT operation can group data by one or multiple grouping criteria, retrieve all distinct values, count how often values occur, and calculate statistical properties efficiently.
FILTER  : string = 'FILTER'
The FILTER operation lets you restrict the results to elements that match arbitrary logical conditions
FOR  : string = 'FOR'
The versatile FOR operation can iterate over a collection or View, the elements of an array, or traverse a graph
GRAPH  : string = 'GRAPH'
The name identifying the named graph.
INSERT  : string = 'INSERT'
You can use the INSERT operation to create new documents in a collection.
LET  : string = 'LET'
You can use the LET operation to assign an arbitrary value to a variable.
LIMIT  : string = 'LIMIT'
The LIMIT operation allows you to reduce the number of results to at most the specified number and optionally skip results using an offset for pagination.
PRUNE  : string = 'PRUNE'
An expression, like in a FILTER statement, which is evaluated in every step of the traversal, as early as possible.
REMOVE  : string = 'REMOVE'
You can use the REMOVE operation to delete documents from a collection.
REPLACE  : string = 'REPLACE'
The REPLACE operation removes all attributes of a document and sets the given attributes, excluding immutable system attributes.
RETURN  : string = 'RETURN'
You can use the RETURN operation to produce the result of a query
SEARCH  : string = 'SEARCH'
The SEARCH operation lets you filter Views, accelerated by the underlying indexes
SORT  : string = 'SORT'
The SORT operation allows you to specify one or multiple sort criteria and directions to control the order of query results or the elements of arrays.
UPDATE  : string = 'UPDATE'
The UPDATE operation partially modifies a document with the given attributes, by adding new and updating existing attributes.
UPSERT  : string = 'UPSERT'
An UPSERT operation either modifies an existing document, or creates a new document if it does not exist.
WINDOW  : string = 'WINDOW'
Aggregate adjacent documents or value ranges with a sliding window to calculate running totals, rolling averages, and other statistical properties.
WITH  : string = 'WITH'
An AQL query can start with a WITH operation, listing collections that a query implicitly reads from.

Constants

COLLECT

The COLLECT operation can group data by one or multiple grouping criteria, retrieve all distinct values, count how often values occur, and calculate statistical properties efficiently.

public string COLLECT = 'COLLECT'
Tags
see
https://docs.arangodb.com/stable/aql/high-level-operations/collect
example
FOR u IN users
COLLECT city = u.city INTO groups
RETURN { "city" : city, "usersInCity" : groups }

UPSERT

An UPSERT operation either modifies an existing document, or creates a new document if it does not exist.

public string UPSERT = 'UPSERT'
Tags
see
https://docs.arangodb.com/stable/aql/high-level-operations/upsert
example
UPSERT searchExpression
INSERT insertExpression
UPDATE updateExpression
IN collection

or

UPSERT searchExpression
INSERT insertExpression
REPLACE updateExpression
IN collection

or

UPSERT { name: 'superuser' }
INSERT { name: 'superuser', logins: 1, created: DATE_NOW() , modified: DATE_NOW() }
UPDATE { logins: OLD.logins + 1 , modified: DATE_NOW() } IN users

WINDOW

Aggregate adjacent documents or value ranges with a sliding window to calculate running totals, rolling averages, and other statistical properties.

public string WINDOW = 'WINDOW'
Tags
see
https://docs.arangodb.com/stable/aql/high-level-operations/window
example

Row Based (adjacent document)

WINDOW { preceding: numPrecedingRows, following: numFollowingRows }
AGGREGATE variableName = aggregateExpression

Range Based (value or duration range)

WINDOW rangeValue WITH { preceding: offsetPreceding, following: offsetFollowing }
AGGREGATE variableName = aggregateExpression
On this page

Search results