Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

documentation fixes

This commit is contained in:
Jan Steemann 2014-11-01 21:03:30 +01:00
parent 1ae150d90a
commit 432430632e
7 changed files with 39 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/Books/Users/Arangosh/Configuration.mdpp
View File

@ -8,7 +8,7 @@ You can use this to define your own extra variables and functions that you need
For example, you could put the following into the *.arangosh.rc* file in your home For example, you could put the following into the *.arangosh.rc* file in your home
directory: directory:
``` ```js
// var keyword omitted intentionally, // var keyword omitted intentionally,
// otherwise "timed" would not survive the scope of this script // otherwise "timed" would not survive the scope of this script
timed = function (cb) { timed = function (cb) {
@ -23,7 +23,7 @@ This will make a function named *timed* available in _arangosh_ in the global sc
You can now start _arangosh_ and invoke the function like this: You can now start _arangosh_ and invoke the function like this:
``` ```js
timed(function () { timed(function () {
for (var i = 0; i < 1000; ++i) { for (var i = 0; i < 1000; ++i) {
db.test.save({ value: i }); db.test.save({ value: i });

12
Documentation/Books/Users/ConfigureArango/Arangod.mdpp
View File

@ -36,6 +36,10 @@
@startDocuBlock serverAllowMethod @startDocuBlock serverAllowMethod
!SUBSECTION Server threads
@startDocuBlock serverThreads
!SUBSECTION Keyfile !SUBSECTION Keyfile
@startDocuBlock serverKeyfile @startDocuBlock serverKeyfile
@ -64,12 +68,12 @@
@startDocuBlock serverBacklog @startDocuBlock serverBacklog
!SUBSECTION Disable statics !SUBSECTION Disable statistics
`--disable-statistics value` `--disable-statistics value`
If this option is *value* is *true*, then ArangoDB's statistics gathering If this option is *value* is *true*, then ArangoDB's statistics gathering
is turned off. Statistics gathering causes constant CPU activity so using this is turned off. Statistics gathering causes regular CPU activity so using this
option to turn it off might relieve heavy-loaded instances. option to turn it off might relieve heavy-loaded instances.
Note: this option is only available when ArangoDB has not been compiled with Note: this option is only available when ArangoDB has not been compiled with
the option *--disable-figures*. the option *--disable-figures*.
@ -90,6 +94,10 @@ the option *--disable-figures*.
@startDocuBlock databaseForceSyncProperties @startDocuBlock databaseForceSyncProperties
!SUBSECTION V8 Contexts
@startDocuBlock v8Contexts
!SUBSECTION Frequency !SUBSECTION Frequency
@startDocuBlock jsGcFrequency @startDocuBlock jsGcFrequency

8
Documentation/Books/Users/ConfigureArango/Communication.mdpp
View File

@ -1,17 +1,17 @@
!CHAPTER Command-Line Options for Communication !CHAPTER Command-Line Options for Communication
!SUBSECTION Scheduler threads !SUBSECTION Scheduler threads
<!-- lib/Scheduler/ApplicationScheduler.h -->
@startDocuBlock schedulerThreads @startDocuBlock schedulerThreads
!SUBSECTION Scheduler maximal queue size !SUBSECTION Scheduler maximal queue size
<!-- arangod/RestServer/ArangoServer.h --> @startDocuBlock schedulerMaximalQueueSize
@startDocuBlock serverAuthenticationDisable
!SUBSECTION Scheduler backend !SUBSECTION Scheduler backend
<!-- lib/Scheduler/ApplicationScheduler.h -->
@startDocuBlock schedulerBackend @startDocuBlock schedulerBackend
!SUBSECTION Io backends !SUBSECTION Io backends
`--show-io-backends` `--show-io-backends`

16
Documentation/Books/Users/ConfigureArango/EmergencyConsole.mdpp
View File

@ -2,7 +2,7 @@
!SUBSECTION In Case Of Disaster !SUBSECTION In Case Of Disaster
The following command starts a emergency console. The following command starts an emergency console.
**Note**: Never start the emergency console for a database which also has a **Note**: Never start the emergency console for a database which also has a
server attached to it. In general the ArangoDB shell is what you want. server attached to it. In general the ArangoDB shell is what you want.
@ -14,18 +14,16 @@ ArangoDB shell [V8 version 3.9.4, DB version 1.x.y]
arango> 1 + 2; arango> 1 + 2;
3 3
arango> db.geo.count(); arango> var db = require("org/arangodb").db; db.geo.count();
703 703
``` ```
The emergency console disables the HTTP interface of the server and The emergency console provides a JavaScript console directly running in the
opens a JavaScript console on standard output instead. This allows you arangod server process. This allows to debug and examine collections and
to debug and examine collections and documents without interference documents as with the normal ArangoDB shell, but without client/server
from the outside. In most respects the emergency console behaves like communication.
the normal ArangoDB shell - but with exclusive access and no
client/server communication.
However, it is very likely that you never need the emergency console However, it is very likely that you will never need the emergency console
unless you are an ArangoDB developer. unless you are an ArangoDB developer.

4
Documentation/Books/Users/ConfigureArango/RandomNumbers.mdpp
View File

@ -1,4 +0,0 @@
!SUBSECTION Command-Line Options for Random Numbers
<!-- lib/ApplicationServer/ApplicationServer.h -->
@startDocuBlock randomGenerator

3
Documentation/Books/Users/SUMMARY.md
View File

@ -138,14 +138,13 @@
* [Authentication](Sharding/Authentication.md) * [Authentication](Sharding/Authentication.md)
* [Firewall setup](Sharding/FirewallSetup.md) * [Firewall setup](Sharding/FirewallSetup.md)
<!-- 20 --> <!-- 20 -->
* [Configure ArangoDB](ConfigureArango/README.md) * [Server Configuration](ConfigureArango/README.md)
* [Arangod options](ConfigureArango/Arangod.md) * [Arangod options](ConfigureArango/Arangod.md)
* [Write-ahead log options](ConfigureArango/Wal.md) * [Write-ahead log options](ConfigureArango/Wal.md)
* [Endpoints options](ConfigureArango/Endpoint.md) * [Endpoints options](ConfigureArango/Endpoint.md)
* [Cluster options](ConfigureArango/Cluster.md) * [Cluster options](ConfigureArango/Cluster.md)
* [Logging options](ConfigureArango/Logging.md) * [Logging options](ConfigureArango/Logging.md)
* [Communication options](ConfigureArango/Communication.md) * [Communication options](ConfigureArango/Communication.md)
* [Random numbers](ConfigureArango/RandomNumbers.md)
* [Authentication](ConfigureArango/Authentication.md) * [Authentication](ConfigureArango/Authentication.md)
* [Emergency Console](ConfigureArango/EmergencyConsole.md) * [Emergency Console](ConfigureArango/EmergencyConsole.md)
<!-- 21 --> <!-- 21 -->

24
README.md
View File

@ -40,22 +40,28 @@ For Mac OSX users: execute
For Windows and Linux users: use the installer script or distribution package For Windows and Linux users: use the installer script or distribution package
from our [download page](http://www.arangodb.com/download). from our [download page](http://www.arangodb.com/download).
If the package manager has not already started the ArangoDB server, use If the package manager has not already started the ArangoDB server, use the
following command to start it.
unix> /path/to/sbin/arangod unix> /path/to/sbin/arangod
2012-03-30T12:54:19Z [11794] INFO ArangoDB (version 2.x.y) is ready for business 2012-03-30T12:54:19Z [11794] INFO ArangoDB (version 2.x.y) is ready for business
2012-03-30T12:54:19Z [11794] INFO Have Fun! 2012-03-30T12:54:19Z [11794] INFO Have Fun!
`/path/to/sbin` is OS dependent. It will normally by either `/usr/sbin` or `/user/local/sbin`. Point your browser to `/path/to/sbin` is OS dependent. It will normally be either `/usr/sbin` or `/user/local/sbin`.
To access ArangoDB in your browser, open the following URL
http://localhost:8529/ http://localhost:8529/
and select `Tools / JS Shell`. You can now use the Arango shell from within your browser. Alternative, it is available as command-line tool _arangosh_. and select `Tools / JS Shell`. You can now use the Arango shell from within your browser.
Alternatively, a scriptable shell is available as a command-line tool _arangosh_.
arangosh> db._create("hello"); arangosh> db._create("hello");
arangosh> db.hello.save({ world: "earth" }); arangosh> db.hello.save({ world: "earth" });
Congratulations! You have created your first collection called `hello` and your first document. To verify your achievements, type: Congratulations! You have created your first collection named `hello` and your first document.
To verify your achievements, type:
arangosh> db.hello.toArray(); arangosh> db.hello.toArray();
@ -64,15 +70,15 @@ More Information
---------------- ----------------
Please check the Please check the
[Installation Manual](http://www.arangodb.com/manuals/current/InstallManual.html) [Installation Manual](https://www.arangodb.com/Installing/README.html)
for installation and compilation instructions. for installation and compilation instructions.
The The
[User Manual](http://www.arangodb.com/manuals/current/UserManual.html) [User Manual](https://www.arangodb.com/FirstSteps/README.html)
has an introductory chapter showing the basic operations of ArangoDB. has an introductory chapter showing the basic operations of ArangoDB.
Or you can use the Or you can use the
[online tutorial](http://www.arangodb.com/try) [online tutorial](https://www.arangodb.com/tryitout)
to play with ArangoDB without installing it locally. to play with ArangoDB without installing it locally.
@ -86,7 +92,7 @@ you report them:
You can use the Google group for improvements, feature requests, comments You can use the Google group for improvements, feature requests, comments
[http://www.arangodb.com/community](http://www.arangodb.com/community) [http://www.arangodb.com/community](https://www.arangodb.com/community)
Citing ArangoDB Citing ArangoDB
@ -96,7 +102,7 @@ Please kindly cite ArangoDB in your publications if it helps your research:
```bibtex ```bibtex
@misc{ArangoDB2014, @misc{ArangoDB2014,
Author = {ArangoDB}, Author = {ArangoDB},
Title = { {ArangoDB 2.2}: An Open Source multi-purpose database supporting flexible data models for documents, graphs, and key-values.}, Title = { {ArangoDB 2.3}: An Open source, multi-purpose database supporting flexible data models for documents, graphs, and key-values.},
Year = {2014}, Year = {2014},
Howpublished = {\url{http://arangodb.com/} Howpublished = {\url{http://arangodb.com/}
} }