Module rincon_client::aql::types [−] [src]

Types used in methods related to AQL queries.

Structs

AggregateNode	Aggregates its input and produces new output variables. This will appear once per COLLECT statement.
AstNodeId
CalculationNode	Evaluates an expression. The expression result may be used by other nodes, e.g. `FilterNode`, `EnumerateListNode`, `SortNode` etc.
CollectOptions
DistributeNode	Used on a coordinator to fan-out data to one or multiple shards, taking into account a collection's shard key.
EnumerateCollectionNode	Enumeration over documents of a collection (given in its collection attribute) without using an index.
EnumerateListNode	Enumeration over a list of (non-collection) values.
ExecutionAggregate
ExecutionCollection
ExecutionExpression
ExecutionExpressionId
ExecutionGroup
ExecutionNodeId
ExecutionPlan
ExecutionStats
ExecutionVariable
ExecutionVariableId
ExplainOptions
ExplainedQuery
ExplainedSubQuery
FilterNode	Only lets values pass that satisfy a filter condition. Will appear once per FILTER statement.
GatherNode	Used on a coordinator to aggregate results from one or many shards into a combined stream of results.
GenericExecutionNode
IndexNode	Enumeration over one or many indexes (given in its indexes attribute) of a collection. The index ranges are specified in the condition attribute of the node.
InsertNode	Inserts documents into a collection (given in its collection attribute). Will appear exactly once in a query that contains an INSERT statement.
LimitNode	Limits the number of results passed to other processing steps. Will appear once per LIMIT statement.
ModificationOptions
NewExplainQuery
NewParseQuery
NoResultsNode	Will be inserted if FILTER statements turn out to be never satisfiable. The `NoResultsNode` will pass an empty result set into the processing pipeline.
Optimizer
OptimizerRuleIntoIter
OptimizerRuleIter
OptimizerRuleSet
ParsedAstNode
ParsedQuery
RemoteNode	A `RemoteNode` will perform communication with another ArangoDB instances in the cluster. For example, the cluster coordinator will need to communicate with other servers to fetch the actual data from the shards. It will do so via `RemoteNode`s. The data servers themselves might again pull further data from the coordinator, and thus might also employ `RemoteNode`s. So, all of the above cluster relevant nodes will be accompanied by a `RemoteNode`.
RemoveNode	Removes documents from a collection (given in its collection attribute). Will appear exactly once in a query that contains a REMOVE statement.
ReplaceNode	Replaces documents in a collection (given in its collection attribute). Will appear exactly once in a query that contains a REPLACE statement.
ReturnNode	Returns data to the caller. Will appear in each read-only query at least once. Sub-queries will also contain `ReturnNode`s.
ScatterNode	Used on a coordinator to fan-out data to one or multiple shards.
SingletonNode	The purpose of a `SingletonNode` is to produce an empty document that is used as input for other processing steps. Each execution plan will contain exactly one `SingletonNode` as its top node.
SortNode	Performs a sort of its input values.
SubQueryNode	Executes a sub-query.
UpdateNode	Updates documents in a collection (given in its collection attribute). Will appear exactly once in a query that contains an UPDATE statement.
UpsertNode	Upserts documents in a collection (given in its collection attribute). Will appear exactly once in a query that contains an UPSERT statement.

Enums

CollectMethod
ExecutionNode	The execution node types will appear in the execution plan as output of the explain method.
ExecutionNodeType	The execution node types will appear in the execution plan as output of the explain method.
IncludedExcluded
OptimizerRule	Represents the rules for the AQL query optimizer.