1
0
Fork 0
arangodb/Documentation/Books/Users/Arangosh/Configuration.mdpp

38 lines
1.2 KiB
Plaintext

!CHAPTER ArangoDB Shell Configuration
_arangosh_ will look for a user-defined startup script named *.arangosh.rc* in the
user's home directory on startup. If the file is present _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:
```js
// var keyword omitted intentionally,
// otherwise "timed" would not survive the scope of this script
timed = function (cb) {
var internal = require("internal");
var start = internal.time();
cb();
internal.print("execution took: ", internal.time() - start);
};
```
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:
```js
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.