8000 Merge branch 'devel' of https://github.com/arangodb/arangodb into bug… · mnemosdev/arangodb@926a869 · GitHub
[go: up one dir, main page]
Skip to content

Commit 926a869

Browse files
gnusignusi
committed
Merge branch 'devel' of https://github.com/arangodb/arangodb into bug-fix/internal-issue-#375
2 parents 90e0a93 + 99f091c commit 926a869

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+981
-905
lines changed

‎Documentation/Books/AQL/Invocation/WithArangosh.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,13 +146,14 @@ There are further options that can be passed in the *options* attribute of the *
146146
creation and optimization for complex queries, but normally there is no need to adjust
147147
this value.
148148

149-
- *stream*: when set to *false* the query will be executed right away in its entirety.
150-
In that case query results are either returned right away (if the resultset is small enough),
151-
or stored on the arangod instance and accessible via the cursor API.
152-
Specify *true* and the query will be executed in a **streaming** fashion. The query result is
149+
- *stream*: Specify *true* and the query will be executed in a **streaming** fashion. The query result is
153150
not stored on the server, but calculated on the fly. *Beware*: long-running queries will
154151
need to hold the collection locks for as long as the query cursor exists. It is advisable
155152
to *only* use this option on short-running queries *or* without exclusive locks (write locks on MMFiles).
153+
When set to *false* the query will be executed right away in its entirety.
154+
In that case query results are either returned right away (if the resultset is small enough),
155+
or stored on the arangod instance and accessible via the cursor API.
156+
156157
Please note that the query options `cache`, `count` and `fullCount` will not work on streaming
157158
queries. Additionally query statistics, warnings and profiling data will only be available
158159
after the query is finished.

‎Documentation/Books/Manual/GettingStarted/ComingFromSql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ It will also help you to translate SQL queries to AQL when migrating to ArangoDB
1818
Basic queries
1919
-------------
2020

21-
**How do browse vectors translate to document queries?**
21+
**How do select lists translate to AQL queries?**
2222

2323
In traditional SQL you may either fetch all columns of a table row by row, using
2424
`SELECT * FROM table`, or select a subset of the columns. The list of table
25-
columns to fetch is commonly called *column list* or *browse vector*:
25+
columns to fetch is commonly called *select list*:
2626

2727
```sql
2828
SELECT columnA, columnB, columnZ FROM table

‎Documentation/Books/Manual/GettingStarted/DatabasesCollectionsDocuments.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Databases, Collections and Documents
2+
====================================
3+
4+
Databases are sets of collections. Collections store records, which are referred
5+
to as documents. Collections are the equivalent of tables in RDBMS, and
6+
documents can be thought of as rows in a table. The difference is that you don't
7+
define what columns (or rather attributes) there will be in advance. Every
8+
document in any collection can have arbitrary attribute keys and
9+
values. Documents in a single collection will likely have a similar structure in
10+
practice however, but the database system itself does not impose it and will
11+
operate stable and fast no matter how your data looks like.
12+
13+
Read more in the [data-model concepts](../DataModeling/Concepts.md) chapter.
14+
15+
For now, you can stick with the default `_system` database and use the web
16+
interface to create collections and documents. Start by clicking the
17+
*COLLECTIONS* menu entry, then the *Add Collection* tile. Give it a name, e.g.
18+
*users*, leave the other settings unchanged (we want it to be a document
19+
collection) and *Save* it. A new tile labeled *users* should show up, which
20+
you can click to open.
21+
22+
There will be *No documents* yet. Click the green circle with the white plus
23+
on the right-hand side to create a first document in this collection. A dialog
24+
will ask you for a `_key`. You can leave the field blank and click *Create* to
25+
let the database system assign an automatically generated (unique) key. Note
26+
that the `_key` property is immutable, which means you can not change it once
27+
the document is created. What you can use as document key is described in the
28+
[naming conventions](../DataModeling/NamingConventions/DocumentKeys.md).
29+
30+
An automatically generated key could be `"9883"` (`_key` is always a string!),
31+
and the document `_id` would be `"users/9883"` in that case. Aside from a few
32+
system attributes, there is nothing in this document yet. Let's add a custom
33+
attribute by clicking the icon to the left of *(empty object)*, then *Append*.
34+
Two input fields will become available, *FIELD* (attribute key) and *VALUE*
35+
(attribute value). Type `name` as key and your name as value. *Append* another
36+
attribute, name it `age` and set it to your age. Click *Save* to persist the
37+
changes. If you click on *Collection: users* at the top on the right-hand side
38+
of the ArangoDB logo, the document browser will show the documents in the
39+
*users* collection and you will see the document you just created in the list.

‎Documentation/Books/Manual/GettingStarted/Installation.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Installation
2+
============
3+
4+
Head to [arangodb.com/download](https://www.arangodb.com/download/),
5+
select your operating system and download ArangoDB. You may also follow
6+
the instructions on how to install with a package manager, if available.
7+
8+
If you installed a binary package under Linux, the server is
9+
automatically started.
10+
11+
If you installed ArangoDB using homebrew under MacOS X, start the
12+
server by running `/usr/local/sbin/arangod`.
13+
14+
If you installed ArangoDB under Windows as a service, the server is
15+
automatically started. Otherwise, run the `arangod.exe` located in the
16+
installation folder's `bin` directory. You may have to run it as administrator
17+
to grant it write permissions to `C:\Program Files`.
18+
19+
For more in-depth information on how to install ArangoDB, as well as available
20+
startup parameters, installation in a cluster and so on, see
21+
[Installation](../Installation/README.md) and
22+
[Deployment](../Deployment/README.md).
23+
24+
{% hint 'info' %}
25+
ArangoDB offers two [**storage engines**](../Architecture/StorageEngines.md):
26+
MMFiles and RocksDB. Choose the one which suits your needs best in the
27+
installation process or on first startup.
28+
{% endhint %}
29+
30+
31+
Securing the installation
32+
-------------------------
33+
34+
The default installation contains one database *_system* and a user
35+
named *root*.
36+
37+
Debian based packages and the Windows installer will ask for a
38+
password during the installation process. Red-Hat based packages will
39+
set a random password. For all other installation packages you need to
40+
execute
41+
42+
```
43+
shell> arango-secure-installation
44+
```
45+
46+
This will ask for a root password and sets this password.

‎Documentation/Books/Manual/GettingStarted/Installing/Compiling.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎Documentation/Books/Manual/GettingStarted/Installing/README.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎Documentation/Books/Manual/GettingStarted/NextSteps.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Next Steps
2+
==========
3+
4+
There is a lot more to [discover in AQL](../../AQL/index.html) and much more
5+
functionality that ArangoDB offers. Continue reading the other chapters and
6+
experiment with a test database to foster your knowledge.
7+
8+
If you want to write more AQL queries right now, have a look here:
9+
10+
- [Data Queries](../../AQL/DataQueries.html): data access and modification queries
11+
- [High-level operations](../../AQL/Operations/index.html): detailed descriptions
12+
of `FOR`, `FILTER` and more operations not shown in this introduction
13+
- [Functions](../../AQL/Functions/index.html): a reference of all provided functions
14+
15+
Visit the [ArangoDB Training Center](https://www.arangodb.com/arangodb-training-center/)
16+
for courses, tutorials and more.

0 commit comments

Comments
 (0)
0