mirror of https://gitee.com/bigwinds/arangodb
updated README
This commit is contained in:
Frank Celler
parent
0b8725e2bb
commit
26027346de
32
CHANGELOG
32
CHANGELOG
|
|
@ -1,6 +1,21 @@
|
||||||
v1.1.0 (XXXX-XX-XX)
|
v1.1.0 (2012-12-05)
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
|
* WARNING:
|
||||||
|
arangod now performs a database version check at startup. It will look for a file
|
||||||
|
named "VERSION" in its database directory. If the file is not present, arangod will
|
||||||
|
perform an automatic upgrade of the database directory. This should be the normal
|
||||||
|
case when upgrading from ArangoDB 1.0 to ArangoDB 1.1.
|
||||||
|
|
||||||
|
If the VERSION file is present but is from an older version of ArangoDB, arangod
|
||||||
|
will refuse to start and ask the user to run a manual upgrade first. A manual upgrade
|
||||||
|
can be performed by starting arangod with the option `--upgrade`.
|
||||||
|
|
||||||
|
This upgrade procedure shall ensure that users have full control over when they
|
||||||
|
perform any updates/upgrades of their data, and can plan backups accordingly. The
|
||||||
|
procedure also guarantees that the server is not run without any required system
|
||||||
|
collections or with in incompatible data state.
|
||||||
|
|
||||||
* fixed issue #311: fixed segfault on unload
|
* fixed issue #311: fixed segfault on unload
|
||||||
|
|
||||||
* fixed issue #309: renamed stub "import" button from web interface
|
* fixed issue #309: renamed stub "import" button from web interface
|
||||||
|
|
@ -49,21 +64,6 @@ v1.1.0 (XXXX-XX-XX)
|
||||||
|
|
||||||
* added UPGRADING help text
|
* added UPGRADING help text
|
||||||
|
|
||||||
* WARNING:
|
|
||||||
arangod now performs a database version check at startup. It will look for a file
|
|
||||||
named "VERSION" in its database directory. If the file is not present, arangod will
|
|
||||||
perform an automatic upgrade of the database directory. This should be the normal
|
|
||||||
case when upgrading from ArangoDB 1.0 to ArangoDB 1.1.
|
|
||||||
|
|
||||||
If the VERSION file is present but is from an older version of ArangoDB, arangod
|
|
||||||
will refuse to start and ask the user to run a manual upgrade first. A manual upgrade
|
|
||||||
can be performed by starting arangod with the option `--upgrade`.
|
|
||||||
|
|
||||||
This upgrade procedure shall ensure that users have full control over when they
|
|
||||||
perform any updates/upgrades of their data, and can plan backups accordingly. The
|
|
||||||
procedure also guarantees that the server is not run without any required system
|
|
||||||
collections or with in incompatible data state.
|
|
||||||
|
|
||||||
* fixed issue #284: fixed Javascript errors when adding edges/vertices without own
|
* fixed issue #284: fixed Javascript errors when adding edges/vertices without own
|
||||||
attributes
|
attributes
|
||||||
|
|
||||||
|
|
|
||||||
84
README
84
README
|
|
@ -33,65 +33,57 @@ For more in-depth information
|
||||||
* or give it a try.
|
* or give it a try.
|
||||||
|
|
||||||
|
|
||||||
Compilation
|
For the Impatient
|
||||||
|
|
||||||
Please check the Installation_Manual for installation and compilation
|
For Mac OSX execute
|
||||||
instructions.
|
|
||||||
|
|
||||||
Mac OS X Hints
|
brew install arangodb
|
||||||
|
|
||||||
On Mac OS X you can install ArangoDB using the packagemanager Homebrew:
|
For Linux use the distribution dependend package manager, see Installation
|
||||||
|
Manual for details.
|
||||||
|
For Windows users: we are working hard on a Windows version. A first version
|
||||||
|
will become available soon.
|
||||||
|
If the package manager has not already started the ArangoDB server, use
|
||||||
|
|
||||||
* brew install arangodb (use --HEAD in order to build ArangoDB from current
|
unix> /path/to/sbin/arangod
|
||||||
master)
|
|
||||||
|
|
||||||
This will install ArangoDB and all dependencies. Note that the server will be
|
|
||||||
installed as
|
|
||||||
|
|
||||||
/usr/local/sbin/arangod
|
|
||||||
|
|
||||||
The ArangoDB shell will be install as
|
|
||||||
|
|
||||||
/usr/local/bin/arangosh
|
|
||||||
|
|
||||||
|
|
||||||
First Steps
|
|
||||||
|
|
||||||
Start the server:
|
|
||||||
|
|
||||||
> /usr/sbin/arangod
|
|
||||||
2012-03-30T12:54:19Z [11794] INFO ArangoDB (version 1.x.y) is ready for
|
2012-03-30T12:54:19Z [11794] INFO ArangoDB (version 1.x.y) is ready for
|
||||||
business
|
business
|
||||||
2012-03-30T12:54:19Z [11794] INFO Have Fun!
|
2012-03-30T12:54:19Z [11794] INFO Have Fun!
|
||||||
|
|
||||||
Start the shell in another windows:
|
/path/to/sbin is OS dependent. It will normally by either /usr/sbin or /user/
|
||||||
|
local/sbin. Point your browser to
|
||||||
|
|
||||||
> /usr/bin/arangosh
|
http://localhost:8529/
|
||||||
_
|
|
||||||
__ _ _ __ __ _ _ __ __ _ ___ ___| |__
|
|
||||||
/ _` | '__/ _` | '_ \ / _` |/ _ \/ __| '_ \
|
|
||||||
| (_| | | | (_| | | | | (_| | (_) \__ \ | | |
|
|
||||||
\__,_|_| \__,_|_| |_|\__, |\___/|___/_| |_|
|
|
||||||
|___/
|
|
||||||
|
|
||||||
Welcome to arangosh 1.x.y. Copyright (c) 2012 triAGENS GmbH.
|
and select the tab Shell. You can now use the Arango shell from within your
|
||||||
Using Google V8 3.9.4.0 JavaScript engine.
|
browser. Alternative, it is available as command-line tool arangosh.
|
||||||
Using READLINE 6.1.
|
|
||||||
|
|
||||||
Connected to Arango DB 127.0.0.1:8529 Version 1.x.y
|
arangosh> db._create("hallo");
|
||||||
|
arangosh> db.hallo.save({ world: "earth" });
|
||||||
|
|
||||||
arangosh> db._create("examples")
|
Congratulations! You have created your first collection called hallo and your
|
||||||
[ArangoCollection 106097, "examples]
|
first document. To verify your achievements
|
||||||
|
|
||||||
arangosh> db.examples.save({ Hallo: "World" });
|
arangosh> db.hallo.toArray();
|
||||||
{"error":false,"_id":"106097/2333739","_rev":2333739}
|
|
||||||
|
|
||||||
arangosh> db.examples.all();
|
|
||||||
[{ _id : "82883/1524675", _rev : 1524675, Hallo : "World" }]
|
|
||||||
|
|
||||||
|
|
||||||
Caveat
|
More Information
|
||||||
|
|
||||||
|
Please check the Installation_Manual for installation and compilation
|
||||||
|
instructions.
|
||||||
|
The User_Manual has an introductory chapter showing the basic operations of
|
||||||
|
ArangoDB.
|
||||||
|
Or you can use the online_tutorial to play with ArangoDB without installing it
|
||||||
|
locally.
|
||||||
|
|
||||||
|
Stay in Contact
|
||||||
|
|
||||||
|
Please note that there will be bugs and we'd really appreciate it if you report
|
||||||
|
them:
|
||||||
|
|
||||||
|
https://github.com/triAGENS/ArangoDB/issues
|
||||||
|
|
||||||
|
You can use the Google group for improvements, feature requests, comments
|
||||||
|
|
||||||
|
http://www.arangodb.org/connect
|
||||||
|
|
||||||
Please note that this is an early version of ArangoDB. There will be bugs and
|
|
||||||
we'd really appreciate it if you report them:
|
|
||||||
https://github.com/triAGENS/ArangoDB/issues
|
|
||||||
|
|
|
||||||
88
README.md
88
README.md
|
|
@ -1,4 +1,6 @@
|
||||||
# ArangoDB
|
ArangoDB
|
||||||
|
========
|
||||||
|
|
||||||
[](http://travis-ci.org/triAGENS/ArangoDB)
|
[](http://travis-ci.org/triAGENS/ArangoDB)
|
||||||
|
|
||||||
ArangoDB is a universal open-source database with flexible data model for documents, graphs, and key-values. Build high performance application using a convenient sql-like query language or JavaScript/Ruby extensions.
|
ArangoDB is a universal open-source database with flexible data model for documents, graphs, and key-values. Build high performance application using a convenient sql-like query language or JavaScript/Ruby extensions.
|
||||||
|
|
@ -20,64 +22,66 @@ For more in-depth information
|
||||||
|
|
||||||
* read more on the [design goals of ArangoDB](http://www.arangodb.org/2012/03/07/avocadodbs-design-objectives)
|
* read more on the [design goals of ArangoDB](http://www.arangodb.org/2012/03/07/avocadodbs-design-objectives)
|
||||||
* [watch the video](http://vimeo.com/36411892) - Martin Schoenert, architect of ArangoDB, gives an introduction of what the ArangoDB project is about.
|
* [watch the video](http://vimeo.com/36411892) - Martin Schoenert, architect of ArangoDB, gives an introduction of what the ArangoDB project is about.
|
||||||
* or give it a try.
|
* or give it a [try](http://www.arangodb.org/try).
|
||||||
|
|
||||||
## Compilation
|
|
||||||
|
|
||||||
Please check the
|
For the Impatient
|
||||||
[Installation Manual](http://www.arangodb.org/manuals/1.0.0/InstallManual.html)
|
-----------------
|
||||||
for installation and compilation instructions.
|
|
||||||
|
|
||||||
### Mac OS X Hints
|
For Mac OSX execute
|
||||||
|
|
||||||
On Mac OS X you can install ArangoDB using the packagemanager [Homebrew](http://mxcl.github.com/homebrew/):
|
brew install arangodb
|
||||||
|
|
||||||
* `brew install arangodb` (use `--HEAD` in order to build ArangoDB from current master)
|
For Linux use the distribution dependend package manager, see
|
||||||
|
[Installation Manual](http://www.arangodb.org/manuals/current/Installing.html)
|
||||||
|
for details.
|
||||||
|
|
||||||
This will install ArangoDB and all dependencies. Note that the server will be installed as
|
For Windows users: we are working hard on a Windows version. A first version will become available soon.
|
||||||
|
|
||||||
/usr/local/sbin/arangod
|
If the package manager has not already started the ArangoDB server, use
|
||||||
|
|
||||||
The ArangoDB shell will be install as
|
unix> /path/to/sbin/arangod
|
||||||
|
|
||||||
/usr/local/bin/arangosh
|
|
||||||
|
|
||||||
## First Steps
|
|
||||||
|
|
||||||
Start the server:
|
|
||||||
|
|
||||||
> /usr/sbin/arangod
|
|
||||||
2012-03-30T12:54:19Z [11794] INFO ArangoDB (version 1.x.y) is ready for business
|
2012-03-30T12:54:19Z [11794] INFO ArangoDB (version 1.x.y) is ready for business
|
||||||
2012-03-30T12:54:19Z [11794] INFO Have Fun!
|
2012-03-30T12:54:19Z [11794] INFO Have Fun!
|
||||||
|
|
||||||
Start the shell in another windows:
|
`/path/to/sbin` is OS dependent. It will normally by either `/usr/sbin` or `/user/local/sbin`. Point your browser to
|
||||||
|
|
||||||
> /usr/bin/arangosh
|
http://localhost:8529/
|
||||||
_
|
|
||||||
__ _ _ __ __ _ _ __ __ _ ___ ___| |__
|
|
||||||
/ _` | '__/ _` | '_ \ / _` |/ _ \/ __| '_ \
|
|
||||||
| (_| | | | (_| | | | | (_| | (_) \__ \ | | |
|
|
||||||
\__,_|_| \__,_|_| |_|\__, |\___/|___/_| |_|
|
|
||||||
|___/
|
|
||||||
|
|
||||||
Welcome to arangosh 1.x.y. Copyright (c) 2012 triAGENS GmbH.
|
and select the tab `Shell`. You can now use the Arango shell from within your browser. Alternative, it is available as command-line tool _arangosh_.
|
||||||
Using Google V8 3.9.4.0 JavaScript engine.
|
|
||||||
Using READLINE 6.1.
|
|
||||||
|
|
||||||
Connected to Arango DB 127.0.0.1:8529 Version 1.x.y
|
arangosh> db._create("hallo");
|
||||||
|
arangosh> db.hallo.save({ world: "earth" });
|
||||||
|
|
||||||
arangosh> db._create("examples")
|
Congratulations! You have created your first collection called `hallo` and your first document. To verify your achievements
|
||||||
[ArangoCollection 106097, "examples]
|
|
||||||
|
|
||||||
arangosh> db.examples.save({ Hallo: "World" });
|
arangosh> db.hallo.toArray();
|
||||||
{"error":false,"_id":"106097/2333739","_rev":2333739}
|
|
||||||
|
|
||||||
arangosh> db.examples.all();
|
|
||||||
[{ _id : "82883/1524675", _rev : 1524675, Hallo : "World" }]
|
|
||||||
|
|
||||||
## Caveat
|
More Information
|
||||||
|
----------------
|
||||||
|
|
||||||
Please note that this is an early version of ArangoDB. There will be
|
Please check the
|
||||||
bugs and we'd really appreciate it if you report them:
|
[Installation Manual](http://www.arangodb.org/manuals/current/InstallManual.html)
|
||||||
|
for installation and compilation instructions.
|
||||||
|
|
||||||
https://github.com/triAGENS/ArangoDB/issues
|
The
|
||||||
|
[User Manual](http://www.arangodb.org/manuals/current/UserManual.html)
|
||||||
|
has an introductory chapter showing the basic operations of ArangoDB.
|
||||||
|
|
||||||
|
Or you can use the
|
||||||
|
[online tutorial](http://www.arangodb.org/try)
|
||||||
|
to play with ArangoDB without installing it locally.
|
||||||
|
|
||||||
|
|
||||||
|
Stay in Contact
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Please note that there will be bugs and we'd really appreciate it if
|
||||||
|
you report them:
|
||||||
|
|
||||||
|
https://github.com/triAGENS/ArangoDB/issues
|
||||||
|
|
||||||
|
You can use the Google group for improvements, feature requests, comments
|
||||||
|
|
||||||
|
http://www.arangodb.org/connect
|
||||||
|
|
|
||||||
|
|
@ -222,8 +222,14 @@
|
||||||
/// brew install arangodb
|
/// brew install arangodb
|
||||||
/// @endcode
|
/// @endcode
|
||||||
///
|
///
|
||||||
/// This will install the current stable version of ArangoDB within
|
/// This will install the current stable version of ArangoDB and all dependencies within
|
||||||
/// your Homebrew tree.
|
/// your Homebrew tree. Note that the server will be installed as
|
||||||
|
///
|
||||||
|
/// /usr/local/sbin/arangod
|
||||||
|
///
|
||||||
|
/// The ArangoDB shell will be install as
|
||||||
|
///
|
||||||
|
/// /usr/local/bin/arangosh
|
||||||
///
|
///
|
||||||
/// If you want to install the latest version use:
|
/// If you want to install the latest version use:
|
||||||
///
|
///
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue