Skip to content

Bots From Extension: arangodb

Arango Graph DB

This extension provides 13 bots.





Bot @arangodb:aql-query

Bot Position In Pipeline: Source Sink

Execute an aql query

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database Name
query* Text Enter native aql query to be executed







Bot @arangodb:create-collection

Bot Position In Pipeline: Source

Create a collection

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
name* Text Specify the collection name
edge Text no Is the collection of type edge?
sync Text no Should the document operations be synchronized
replication_factor Text 1 Number of copies of each document to be maintained







Bot @arangodb:create-graph

Bot Position In Pipeline: Source

Create a graph in arangodb

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
name* Text Name of the Graph
edges_collection* Text Edges Collection name
from_vertex_collections* Text Comma separated nodes collection names for from vertices in the graph
to_vertex_collections* Text Comma separated nodes collection names for to vertices in the graph







Bot @arangodb:delete-by-query

Bot Position In Pipeline: Sink

Delete documents using query

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
collection* Text Collection name
delete_query Text cfxql delete query







Bot @arangodb:delete-collection

Bot Position In Pipeline: Source

Delete a collection

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
name* Text Collection name to be deleted







Bot @arangodb:delete-db

Bot Position In Pipeline: Source

Delete a Database

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name







Bot @arangodb:delete-docs

Bot Position In Pipeline: Sink

Delete documents in a collection

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
collection* Text Collection name to be used







Bot @arangodb:delete-graph

Bot Position In Pipeline: Source

Delete a Graph and collections too if specified

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
name* Text Graph name to be deleted
drop_collections Text no Drop the collections used to form the graph







Bot @arangodb:insert-edges

Bot Position In Pipeline: Sink

Write data to edges collection

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
nodes_collection* Text Nodes collection name the edges refer to
edges_collection* Text Edges collection to insert data
left_id* Text The column that specifies the left of edge
right_id* Text The column that specifies the right of edge
halt_on_error Text True Insertion halts on error/illegal documents
batch_size Text 100 Batch size to be used for insertion







Bot @arangodb:insert-nodes

Bot Position In Pipeline: Sink

Write data to nodes collection

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
collection* Text The collection to insert nodes
key_column* Text Unique column data used as document key
halt_on_error Text True Insertion halts on error/illegal documents
batch_size Text 100 Batch size to be used during insertion







Bot @arangodb:list-collections

Bot Position In Pipeline: Source

list all the collections in a DB

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
include_system Text no To include system created collections of a DB







Bot @arangodb:list-db

Bot Position In Pipeline: Source

list all the databases

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot







Bot @arangodb:query-collection

Bot Position In Pipeline: Sink

Execute a cfxql query on collection

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
dbname* Text Database name
collection* Text Collection name
query* Text cfxql query