Arangosh Details

Interaction

You can paste multiple lines into Arangosh, given the first line ends with anopening brace:

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

Show execution results

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!

Hide execution results

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 bytyping quit<CR>

Shell Output

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

arangosh> 42 * 23

Show execution results

966

Hide execution results

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

Show execution results

Hide execution results

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

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

Show execution results

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

Hide execution results

By default, the ArangoDB shell uses a pretty printer when JSON documents areprinted. 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()

Show execution results

[ArangoCollection 88584, "five" (type document, status loaded)]
[ 
  { 
    "_key" : "88589", 
    "_id" : "five/88589", 
    "_rev" : "_ZJNT-0y---", 
    "value" : 0 
  }, 
  { 
    "_key" : "88591", 
    "_id" : "five/88591", 
    "_rev" : "_ZJNT-0y--A", 
    "value" : 1 
  }, 
  { 
    "_key" : "88593", 
    "_id" : "five/88593", 
    "_rev" : "_ZJNT-02---", 
    "value" : 2 
  }, 
  { 
    "_key" : "88595", 
    "_id" : "five/88595", 
    "_rev" : "_ZJNT-02--A", 
    "value" : 3 
  }, 
  { 
    "_key" : "88597", 
    "_id" : "five/88597", 
    "_rev" : "_ZJNT-02--C", 
    "value" : 4 
  } 
]

Hide execution results

While the pretty-printer produces nice looking results, it will need a lot ofscreen space for each document. Sometimes a more dense output might be better.In this case, the pretty printer can be turned off using the commandstop_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 singleliteral backslash (c:\tmp\test.js):

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

You can use bind variables tomitigate this:

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

Database Wrappers

Arangosh provides the db object by default, and this object canbe used for switching to a different database and managing collections inside thecurrent database.

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

arangosh> db._help(); 

Show execution results

--------------------------- 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

Hide execution results

The db object is available in arangosh_as well as on _arangod i.e. if you’re using Foxx. While itsinterface is persistent between the arangosh and the arangod implementations,its underpinning is not. The arangod implementation are JavaScript wrappersaround ArangoDB’s native C++ implementation, whereas the arangosh implementationwraps HTTP accesses to ArangoDB’s RESTfull API.

So while this code may produce similar results when executed in arangosh andarangod, the CPU usage and time required will be really different since thearangosh version will be doing around 100k HTTP requests, and thearangod 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 theuser’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 executethe 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 homedirectory:

// "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 validJavaScript code. If you want any variables in the global scope to survive you need toomit the var keyword for them. Otherwise the variables will only be visible insidethe script itself, but not outside.