8000 Remove long obsolete DB-to-Endpoint mapping page (#757) · arangodb/docs@f705dad · GitHub
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit f705dad

Browse files
authored
Remove long obsolete DB-to-Endpoint mapping page (#757)
* Rework database organization section * Remove DB file layout from HTTP docs, add minimal description for RocksDB engine
1 parent cb732ba commit f705dad

16 files changed

+87
-451
lines changed

3.6/appendix-glossary.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,36 @@ A database contains its own collections (which cannot be accessed from other dat
3636

3737
There will always be at least one database in ArangoDB. This is the default database, named _system. This database cannot be dropped, and provides special operations for creating, dropping, and enumerating databases. Users can create additional databases and give them unique names to access them later. Database management operations cannot be initiated from out of user-defined databases.
3838

39-
When ArangoDB is accessed via its HTTP REST API, the database name is read from the first part of the request URI path (e.g. /_db/_system/...). If the request URI does not contain a database name, the database name is automatically derived from the endpoint. Please refer to [DatabaseEndpoint](http/database-database-endpoint.html) for more information.
39+
When ArangoDB is accessed via its HTTP REST API, the database name is read from the first part of the request URI path (e.g. `/_db/myDB/`). If the request URI does not contain a database name, it defaults to `/_db/_system`.
4040

4141
Database Name
4242
-------------
4343

44-
A single ArangoDB instance can handle multiple databases in parallel. When multiple databases are used, each database must be given a unique name. This name is used to uniquely identify a database. The default database in ArangoDB is named _system.
44+
Each database must be given a unique name. This name is used to uniquely
45+
identify a database.
4546

46-
The database name is a string consisting of only letters, digits and the _ (underscore) and - (dash) characters. User-defined database names must always start with a letter. Database names is case-sensitive.
47+
The database name is a string consisting of only letters, digits, underscore
48+
(`_`) and dash (`-`) characters. User-defined database names must always start
49+
with a letter.
50+
51+
Database names are case-sensitive.
4752

4853
Database Organization
4954
---------------------
5055

51-
A single ArangoDB instance can handle multiple databases in parallel. By default, there will be at least one database, which is named _system.
56+
A single ArangoDB instance can handle multiple databases in parallel. By default,
57+
there will be at least one database which is named `_system`.
5258

53-
Databases are physically stored in separate sub-directories underneath the database directory, which itself resides in the instance's data directory.
59+
With the MMFiles storage engine, databases are
60+
physically stored in separate sub-directories underneath the database directory,
61+
which itself resides in the instance's data directory.
5462

55-
Each database has its own sub-directory, named database-<database id>. The database directory contains sub-directories for the collections of the database, and a file named parameter.json. This file contains the database id and name.
63+
Each database has its own sub-directory, named `database-<database id>`. The
64+
database directory contains sub-directories for the collections of the database,
65+
and a file named parameter.json. This file contains the database id and name.
5666

57-
In an example ArangoDB instance which has two databases, the filesystem layout could look like this:
67+
In an example ArangoDB instance which has two databases, the filesystem layout
68+
could look like this:
5869

5970
```
6071
data/ # the instance's data directory
@@ -68,7 +79,16 @@ data/ # the instance's data directory
6879
collection-<id>/ # directory containing data about a collection
6980
```
7081

71-
Foxx applications are also organized in database-specific directories inside the application path. The filesystem layout could look like this:
82+
With the RocksDB storage engine,
83+
data is physically stored in `.sst` files in a sub-directory `engine-rocksdb`
84+
that resides in the instance's data directory. A single file can contain
85+
documents of various collections and databases.
86+
87+
ArangoSearch stores data in database-specific directories underneath the
88+
`databases` folder.
89+
90+
Foxx applications are also organized in database-specific directories inside the
91+
application path. The filesystem layout could look like this:
7292

7393
```
7494
apps/ # the instance's application directory

3.6/http/database-database-endpoint.md

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

3.6/http/database-notes-on-databases.md

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ additional databases and give them unique names to access them later. Database
3232
management operations cannot be initiated from out of user-defined databases.
3333

3434
When ArangoDB is accessed via its HTTP REST API, the database name is read from
35-
the first part of the request URI path (e.g. `/_db/_system/...`). If the request
36-
URI does not contain a database name, the database name is automatically
37-
determined by the algorithm described in Database-to-Endpoint Mapping.
35+
the first part of the request URI path (e.g. `/_db/myDB/...`). If the request
36+
URI does not contain a database name, it defaults to `/_db/_system`.
3837

3938
Database Name
4039
-------------
@@ -45,44 +44,3 @@ This name is used to uniquely identify a database. The default database in
4544
ArangoDB is named `_system`. The database name is a string consisting of only
4645
letters, digits and the _ (underscore) and - (dash) characters. User-defined
4746
database names must always start with a letter. Database names are case-sensitive.
48-
49-
Database Organization
50-
---------------------
51-
52-
A single ArangoDB instance can handle multiple databases in parallel. By default,
53-
there will be at least one database which is named `_system`. Databases are
54-
physically stored in separate sub-directories underneath the database directory,
55-
which itself resides in the instance's data directory.
56-
57-
Each database has its own sub-directory, named `database-<database id>`. The
58-
database directory contains sub-directories for the collections of the database,
59-
and a file named parameter.json. This file contains the database id and name.
60-
61-
In an example ArangoDB instance which has two databases, the filesystem layout
62-
could look like this:
63-
64-
```
65-
data/ # the instance's data directory
66-
databases/ # sub-directory containing all databases' data
67-
database-<id>/ # sub-directory for a single database
68-
parameter.json # file containing database id and name
69-
collection-<id>/ # directory containing data about a collection
70-
database-<id>/ # sub-directory for another database
71-
parameter.json # file containing database id and name
72-
collection-<id>/ # directory containing data about a collection
73-
collection-<id>/ # directory containing data about a collection
74-
```
75-
76-
Foxx applications are also organized in database-specific directories inside the
77-
application path. The filesystem layout could look like this:
78-
79-
```
80-
apps/ # the instance's application directory
81-
system/ # system applications (can be ignored)
82-
databases/ # sub-directory containing database-specific applications
83-
<database-name>/ # sub-directory for a single database
84-
<app-name> # sub-directory for a single application
85-
<app-name> # sub-directory for a single application
86-
<database-name>/ # sub-directory for another database
87-
<app-name> # sub-directory for a single application
88-
```

3.7/appendix-glossary.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,39 +36,35 @@ A database contains its own collections (which cannot be accessed from other dat
3636

3737
There will always be at least one database in ArangoDB. This is the default database, named _system. This database cannot be dropped, and provides special operations for creating, dropping, and enumerating databases. Users can create additional databases and give them unique names to access them later. Database management operations cannot be initiated from out of user-defined databases.
3838

39-
When ArangoDB is accessed via its HTTP REST API, the database name is read from the first part of the request URI path (e.g. /_db/_system/...). If the request URI does not contain a database name, the database name is automatically derived from the endpoint. Please refer to [DatabaseEndpoint](http/database-database-endpoint.html) for more information.
39+
When ArangoDB is accessed via its HTTP REST API, the database name is read from the first part of the request URI path (e.g. `/_db/myDB/`). If the request URI does not contain a database name, it defaults to `/_db/_system`.
4040

4141
Database Name
4242
-------------
4343

44-
A single ArangoDB instance can handle multiple databases in parallel. When multiple databases are used, each database must be given a unique name. This name is used to uniquely identify a database. The default database in ArangoDB is named _system.
44+
Each database must be given a unique name. This name is used to uniquely
45+
identify a database.
4546

46-
The database name is a string consisting of only letters, digits and the _ (underscore) and - (dash) characters. User-defined database names must always start with a letter. Database names is case-sensitive.
47+
The database name is a string consisting of only letters, digits, underscore
48+
(`_`) and dash (`-`) characters. User-defined database names must always start
49+
with a letter.
50+
51+
Database names are case-sensitive.
4752

4853
Database Organization
4954
---------------------
5055

51-
A single ArangoDB instance can handle multiple databases in parallel. By default, there will be at least one database, which is named _system.
52-
53-
Databases are physically stored in separate sub-directories underneath the database directory, which itself resides in the instance's data directory.
54-
55-
Each database has its own sub-directory, named database-<database id>. The database directory contains sub-directories for the collections of the database, and a file named parameter.json. This file contains the database id and name.
56+
A single ArangoDB instance can handle multiple databases in parallel. By default,
57+
there will be at least one database which is named `_system`.
5658

57-
In an example ArangoDB instance which has two databases, the filesystem layout could look like this:
59+
Data is physically stored in `.sst` files in a sub-directory `engine-rocksdb`
60+
that resides in the instance's data directory. A single file can contain
61+
documents of various collections and databases.
5862< 325A /code>

59-
```
60-
data/ # the instance's data directory
61-
databases/ # sub-directory containing all databases' data
62-
database-<id>/ # sub-directory for a single database
63-
parameter.json # file containing database id and name
64-
collection-<id>/ # directory containing data about a collection
65-
database-<id>/ # sub-directory for another database
66-
parameter.json # file containing database id and name
67-
collection-<id>/ # directory containing data about a collection
68-
collection-<id>/ # directory containing data about a collection
69-
```
63+
ArangoSearch stores data in database-specific directories underneath the
64+
`databases` folder.
7065

71-
Foxx applications are also organized in database-specific directories inside the application path. The filesystem layout could look like this:
66+
Foxx applications are also organized in database-specific directories but inside
67+
the application path. The filesystem layout could look like this:
7268

7369
```
7470
apps/ # the instance's application directory

3.7/http/database-database-endpoint.md

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

3.7/http/database-notes-on-databases.md

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ additional databases and give them unique names to access them later. Database
3232
management operations cannot be initiated from out of user-defined databases.
3333

3434
When ArangoDB is accessed via its HTTP REST API, the database name is read from
35-
the first part of the request URI path (e.g. `/_db/_system/...`). If the request
36-
URI does not contain a database name, the database name is automatically
37-
determined by the algorithm described in Database-to-Endpoint Mapping.
35+
the first part of the request URI path (e.g. `/_db/myDB/...`). If the request
36+
URI does not contain a database name, it defaults to `/_db/_system`.
3837

3938
Database Name
4039
-------------
@@ -45,44 +44,3 @@ This name is used to uniquely identify a database. The default database in
4544
ArangoDB is named `_system`. The database name is a string consisting of only
4645
letters, digits and the _ (underscore) and - (dash) characters. User-defined
4746
database names must always start with a letter. Database names are case-sensitive.
48-
49-
Database Organization
50-
---------------------
51-
52-
A single ArangoDB instance can handle multiple databases in parallel. By default,
53-
there will be at least one database which is named `_system`. Databases are
54-
physically stored in separate sub-directories underneath the database directory,
55-
which itself resides in the instance's data directory.
56-
57-
Each database has its own sub-directory, named `database-<database id>`. The
58-
database directory contains sub-directories for the collections of the database,
59-
and a file named parameter.json. This file contains the database id and name.
60-
61-
In an example ArangoDB instance which has two databases, the filesystem layout
62-
could look like this:
63-
64-
```
65-
data/ # the instance's data directory
66-
databases/ # sub-directory containing all databases' data
67-
database-<id>/ # sub-directory for a single database
68-
parameter.json # file containing database id and name
69-
collection-<id>/ # directory containing data about a collection
70-
database-<id>/ # sub-directory for another database
71-
parameter.json # file containing database id and name
72-
collection-<id>/ # directory containing data about a collection
73-
collection-<id>/ # directory containing data about a collection
74-
```
75-
76-
Foxx applications are also organized in database-specific directories inside the
77-
application path. The filesystem layout could look like this:
78-
79-
```
80-
apps/ # the instance's application directory
81-
system/ # system applications (can be ignored)
82-
databases/ # sub-directory containing database-specific applications
83-
<database-name>/ # sub-directory for a single database
84-
<app-name> # sub-directory for a single application
85-
<app-name> # sub-directory for a single application
86-
<database-name>/ # sub-directory for another database
87-
<app-name> # sub-directory for a single application
88-
```

0 commit comments

Comments
 (0)
0