arangosh Details

Interaction

You can paste multiple lines into arangosh, given the first line ends with an opening brace:

arangosh> for (var i = 0; i < 10; i ++) {
........>         require("@arangodb").print("Hello world " + i + "!\n");
........> }

Hello world 0!

Hello world 1!

Hello world 2!

Hello world 3!

Hello world 4!

Hello world 5!

Hello world 6!

Hello world 7!

Hello world 8!

Hello world 9!

To load your own JavaScript code into the current JavaScript interpreter context, use the load command:

require("internal").load("/tmp/test.js")     // <- Linux / macOS
require("internal").load("c:\\tmp\\test.js") // <- Windows

Exiting arangosh can be done using the key combination <CTRL> + D or by typing quit<CR>

Shell Output

The ArangoDB shell will print the output of the last evaluated expression by default:

arangosh> 42 * 23

966

In order to prevent printing the result of the last evaluated expression, the expression result can be captured in a variable, e.g.

arangosh> var calculationResult = 42 * 23

(Empty output)

There is also the print function to explicitly print out values in the ArangoDB shell:

arangosh> print({ a: "123", b: [1,2,3], c: "test" });

{ 
  "a" : "123", 
  "b" : [ 
    1, 
    2, 
    3 
  ], 
  "c" : "test" 
}

By default, the ArangoDB shell uses a pretty printer when JSON documents are printed. This ensures documents are printed in a human-readable way:

arangosh> db._create("five")
arangosh> for (i = 0; i < 5; i++) db.five.save({value:i})
arangosh> db.five.toArray()

[ArangoCollection 81651, "five" (type document, status loaded)]
[ 
  { 
    "_key" : "81656", 
    "_id" : "five/81656", 
    "_rev" : "_fw2Y3He--_", 
    "value" : 0 
  }, 
  { 
    "_key" : "81658", 
    "_id" : "five/81658", 
    "_rev" : "_fw2Y3He--A", 
    "value" : 1 
  }, 
  { 
    "_key" : "81660", 
    "_id" : "five/81660", 
    "_rev" : "_fw2Y3He--B", 
    "value" : 2 
  }, 
  { 
    "_key" : "81662", 
    "_id" : "five/81662", 
    "_rev" : "_fw2Y3He--C", 
    "value" : 3 
  }, 
  { 
    "_key" : "81664", 
    "_id" : "five/81664", 
    "_rev" : "_fw2Y3He--D", 
    "value" : 4 
  } 
]

While the pretty-printer produces nice looking results, it will need a lot of screen space for each document. Sometimes a more dense output might be better. In this case, the pretty printer can be turned off using the command stop_pretty_print().

To turn on pretty printing again, use the start_pretty_print() command.

Escaping

In AQL, escaping is done traditionally with the backslash character: \. As seen above, this leads to double backslashes when specifying Windows paths. arangosh requires another level of escaping, also with the backslash character. It adds up to four backslashes that need to be written in arangosh for a single literal backslash (c:\tmp\test.js):

db._query('RETURN "c:\\\\tmp\\\\test.js"')

You can use bind variables to mitigate this:

var somepath = "c:\\tmp\\test.js"
db._query(aql`RETURN ${somepath}`)

Database Wrappers

arangosh provides the db object by default, and this object can be used for switching to a different database and managing collections inside the current database.

For a list of available methods for the db object, type

arangosh> db._help();

--------------------------- ArangoDatabase (db) help ---------------------------
Administration Functions:                                                 
  _help()                               this help                         
  _flushCache()                         flush and refill collection cache 
                                                                          
Collection Functions:                                                     
  _collections()                        list all collections              
  _collection(<name>)                   get collection by identifier/name 
  _create(<name>, <properties>)         creates a new collection          
  _createEdgeCollection(<name>)         creates a new edge collection     
  _drop(<name>)                         delete a collection               
                                                                          
Document Functions:                                                       
  _document(<id>)                       get document by handle (_id)      
  _replace(<id>, <data>, <overwrite>)   overwrite document                
  _update(<id>, <data>, <overwrite>,    partially update document         
          <keepNull>)                                                     
  _remove(<id>)                         delete document                   
  _exists(<id>)                         checks whether a document exists  
  _truncate()                           delete all documents              
                                                                          
Database Management Functions:                                            
  _createDatabase(<name>)               creates a new database            
  _dropDatabase(<name>)                 drops an existing database        
  _useDatabase(<name>)                  switches into an existing database
  _drop(<name>)                         delete a collection               
  _name()                               name of the current database      
                                                                          
Query / Transaction Functions:                                            
  _executeTransaction(<transaction>)    execute transaction               
  _query(<query>)                       execute AQL query                 
  _createStatement(<data>)              create and return AQL query       
                                                                          
View Functions:                                                           
  _views()                              list all views                    
  _view(<name>)                         get view by name                  
  _createView(<name>, <type>,           creates a new view                
              <properties>)                                               
  _dropView(<name>)                     delete a view

The db object is available in arangosh as well as on arangod i.e. if you’re using Foxx. While its interface is persistent between the arangosh and the arangod implementations, its underpinning is not. The arangod implementation are JavaScript wrappers around ArangoDB’s native C++ implementation, whereas the arangosh implementation wraps HTTP accesses to ArangoDB’s RESTful API.

So while this code may produce similar results when executed in arangosh and arangod, the CPU usage and time required will be really different since the arangosh version will be doing around 100k HTTP requests, and the arangod version will directly write to the database:

for (i = 0; i < 100000; i++) {
    db.test.save({ name: { first: "Jan" }, count: i});
}

Using arangosh via unix shebang mechanisms

In unix operating systems you can start scripts by specifying the interpreter in the first line of the script. This is commonly called shebang or hash bang. You can also do that with arangosh, i.e. create ~/test.js:

#!/usr/bin/arangosh --javascript.execute 
require("internal").print("hello world")
db._query("FOR x IN test RETURN x").toArray()

Note that the first line has to end with a blank in order to make it work. Mark it executable to the OS:

#> chmod a+x ~/test.js

and finaly try it out:

#> ~/test.js

Shell Configuration

arangosh will look for a user-defined startup script named .arangosh.rc in the user’s home directory on startup. The home directory will likely be /home/<username>/ on Unix/Linux, and is determined on Windows by peeking into the environment variables %HOMEDRIVE% and %HOMEPATH%.

If the file .arangosh.rc is present in the home directory, arangosh will execute the contents of this file inside the global scope.

You can use this to define your own extra variables and functions that you need often. For example, you could put the following into the .arangosh.rc file in your home directory:

// "var" keyword avoided intentionally...
// otherwise "timed" would not survive the scope of this script
global.timed = function (cb) {
  console.time("callback");
  cb();
  console.timeEnd("callback");
};

This will make a function named timed available in arangosh in the global scope.

You can now start arangosh and invoke the function like this:

timed(function () { 
  for (var i = 0; i < 1000; ++i) {
    db.test.save({ value: i }); 
  }
});

Please keep in mind that, if present, the .arangosh.rc file needs to contain valid JavaScript code. If you want any variables in the global scope to survive you need to omit the var keyword for them. Otherwise the variables will only be visible inside the script itself, but not outside.