Skip to content

Commit 0cf4257

Browse files
committed
Merge branch 'aql-timezone' of https://github.com/arangodb/docs-hugo into aql-timezone
2 parents 8f30308 + ba58ef6 commit 0cf4257

File tree

63 files changed

+1177
-802
lines changed

Some content is hidden

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

63 files changed

+1177
-802
lines changed

site/content/3.10/about-arangodb/features/_index.md

Lines changed: 57 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,63 @@ archetype: chapter
99
aliases:
1010
- ../introduction/features
1111
---
12-
## Editions
12+
## On-premises versus Cloud
13+
14+
### Fully managed cloud service
15+
16+
The fully managed multi-cloud
17+
[ArangoGraph Insights Platform](https://dashboard.arangodb.cloud/home?utm_source=docs&utm_medium=cluster_pages&utm_campaign=docs_traffic)
18+
is the easiest and fastest way to get started. It runs the Enterprise Edition
19+
of ArangoDB, lets you deploy clusters with just a few clicks, and is operated
20+
by a dedicated team of ArangoDB engineers day and night. You can choose from a
21+
variety of support plans to meet your needs.
22+
23+
- Supports many cloud deployment regions across the main cloud providers
24+
(AWS, Azure, GCP)
25+
- High availability featuring multi-region zone clusters, managed backups,
26+
and zero-downtime upgrades
27+
- Integrated monitoring, alerting, and log management
28+
- Highly secure with encryption at transit and at rest
29+
- Includes elastic scalability for all deployment models (OneShard and Sharded clusters)
30+
31+
To learn more, go to the [ArangoGraph documentation](../../arangograph/_index.md).
32+
33+
### Self-managed in the cloud
34+
35+
ArangoDB can be self-deployed on AWS or other cloud platforms, too. However, when
36+
using a self-managed deployment, you take full control of managing the resources
37+
needed to run it in the cloud. This involves tasks such as configuring,
38+
provisioning, and monitoring the system. For more details, see
39+
[self-deploying ArangoDB in the cloud](../../deploy/in-the-cloud.md).
40+
41+
ArangoDB supports Kubernetes through its official
42+
[Kubernetes Operator](../../deploy/kubernetes.md) that allows you to easily
43+
deploy and manage clusters within a Kubernetes environment.
44+
45+
### On-premises
46+
47+
Running ArangoDB on-premises means that ArangoDB is installed locally, on your
48+
organization's computers and servers, and involves managing all the necessary
49+
resources within the organization's environment, rather than using external
50+
services.
51+
52+
You can install ArangoDB locally by downloading and running the
53+
[official packages](https://arangodb.com/download/) or run it using
54+
[Docker images](../../operations/installation/docker.md).
55+
56+
You can deploy it on-premises as a
57+
[single server](../../deploy/single-instance/_index.md)
58+
or as a [cluster](../../deploy/cluster/_index.md)
59+
comprised of multiple nodes with synchronous replication and automatic failover
60+
for high availability and resilience. For the highest level of data safety,
61+
you can additionally set up off-site replication for your entire cluster
62+
([Datacenter-to-Datacenter Replication](../../deploy/arangosync/_index.md)).
63+
64+
ArangoDB also integrates with Kubernetes, offering a
65+
[Kubernetes Operator](../../deploy/kubernetes.md) that lets you deploy in your
66+
Kubernetes cluster.
67+
68+
## ArangoDB Editions
1369

1470
### Community Edition
1571

@@ -70,22 +126,3 @@ See all [Enterprise Edition Features](enterprise-edition.md).
70126
| No on-disk encryption | **Encryption at Rest** with hardware-accelerated on-disk encryption and key rotation |
71127
| Only regular backups | **Datacenter-to-Datacenter Replication** for disaster recovery |
72128
| Only unencrypted backups and basic data masking for backups | **Hot Backups**, **encrypted backups**, and **enhanced data masking** for backups |
73-
74-
## On-premises versus Cloud
75-
76-
You can install ArangoDB on your local machine or run it in a Docker container
77-
for development purposes. You can deploy it on-premises as a
78-
[single server](../../deploy/single-instance/_index.md), optionally
79-
as a resilient pair with asynchronous replication and automatic failover
80-
([Active Failover](../../deploy/active-failover/_index.md)),
81-
or as a [cluster](../../deploy/cluster/_index.md)
82-
comprised of multiple nodes with synchronous replication and automatic failover
83-
for high availability and resilience. For the highest level of data safety,
84-
you can additionally set up off-site replication for your entire cluster
85-
([Datacenter-to-Datacenter Replication](../../deploy/arangosync/_index.md)).
86-
87-
If you do not want to operate your own ArangoDB instances on-premises, then
88-
you may use our fully managed multi-cloud **ArangoGraph Insights Platform**.
89-
It runs the Enterprise Edition of ArangoDB, lets you deploy clusters with a
90-
few clicks, and is operated by a dedicated team of ArangoDB engineers day and
91-
night. To learn more, go to [dashboard.arangodb.cloud](https://dashboard.arangodb.cloud/home?utm_source=docs&utm_medium=cluster_pages&utm_campaign=docs_traffic).

site/content/3.10/about-arangodb/features/community-edition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/)
3939
documents, or graphs - perfect for social relations. Optional document
4040
validation using JSON Schema (draft-4, without remote schema support).
4141

42-
- [**Data Storage**](../../deploy/architecture/storage-engine.md):
42+
- [**Data Storage**](../../components/arangodb-server/storage-engine.md):
4343
RocksDB storage engine to persist data and indexes on disk, with a hot set in
4444
memory. It uses journaling (write-ahead logging) and can take advantage of
4545
modern storage hardware, like SSDs and large caches.

site/content/3.10/about-arangodb/features/highlights-by-version.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ Also see [What's New in 3.5](../../release-notes/version-3.5/whats-new-in-3-5.md
301301
as soon as possible.
302302

303303
- **RocksDB as Default Storage Engine**: With ArangoDB 3.4 the default
304-
[storage engine](../../deploy/architecture/storage-engine.md) for fresh installations will
304+
[storage engine](../../components/arangodb-server/storage-engine.md) for fresh installations will
305305
switch from MMFiles to RocksDB. Many optimizations have been made to RocksDB
306306
since the first release in 3.2. For 3.4 we optimized the binary storage
307307
format for improved insertion, implemented "optional caching", reduced the
@@ -342,7 +342,7 @@ Also see [What's New in 3.3](../../release-notes/version-3.3/whats-new-in-3-3.md
342342

343343
**All Editions**
344344

345-
- [**RocksDB Storage Engine**](../../deploy/architecture/storage-engine.md): You can now use
345+
- [**RocksDB Storage Engine**](../../components/arangodb-server/storage-engine.md): You can now use
346346
as much data in ArangoDB as you can fit on your disk. Plus, you can enjoy
347347
performance boosts on writes by having only document-level locks.
348348

site/content/3.10/about-arangodb/use-cases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ binary large objects (BLOBs) and works best with small to medium-sized
131131
JSON objects.
132132

133133
For more information about how ArangoDB persists data, see
134-
[Storage Engine](../deploy/architecture/storage-engine.md).
134+
[Storage Engine](../components/arangodb-server/storage-engine.md).
135135

136136
## ArangoDB as a Search Engine
137137

site/content/3.10/arangograph/data-loader/example.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ representing the nodes and a corresponding CSV file representing the edges.
1313

1414
This example uses a sample data set of two files, `airports.csv` and `flights.csv`
1515
to create a graph showing flights arriving to and departing from various cities.
16+
You can download the files from [GitHub](https://github.com/arangodb/example-datasets/tree/master/Data%20Loader).
1617

1718
The `airports.csv` contains rows of airport entries, which are the future nodes
1819
in your graph. The `flights.csv` contains rows of flight entries, which are the

site/content/3.10/deploy/architecture/storage-engine.md renamed to site/content/3.10/components/arangodb-server/storage-engine.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
22
title: Storage Engine
33
menuTitle: Storage Engine
4-
weight: 15
4+
weight: 20
55
description: >-
66
The storage engine is responsible for persisting data on disk, holding copies
77
in memory, providing indexes and caches to speed up queries
88
archetype: default
9+
aliases:
10+
- ../../deploy/architecture/storage-engine
911
---
1012
ArangoDB's storage engine is based on Facebook's **RocksDB** and the only
1113
storage engine available in ArangoDB 3.7 and above. It is the bottom layer of

site/content/3.10/deploy/architecture/_index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: ArangoDB Architecture
33
menuTitle: Architecture
44
weight: 100
55
description: >-
6-
Technical insights into ArangoDB's scalability, sharding, the storage engine,
7-
and replication
6+
Technical insights into ArangoDB's scalability, sharding, and replication
87
archetype: chapter
98
---

site/content/3.10/develop/drivers/java/reference-version-7/driver-setup.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@ Here are examples to integrate configuration properties from different sources:
9191
- `loadBalancingStrategy(LoadBalancingStrategy)`: load balancing strategy, possible values are: `NONE`, `ROUND_ROBIN`, `ONE_RANDOM`, (default: `NONE`)
9292
- `responseQueueTimeSamples(Integer)`: amount of samples kept for queue time metrics, (default: `10`)
9393
- `serde(ArangoSerde)`: serde to serialize and deserialize user-data
94-
- `asyncExecutor(Executor)`: downstream `java.util.concurrent.Executor` that will be used to consume the responses of the async API
9594

9695
### Config File Properties
9796

site/content/3.10/develop/foxx-microservices/guides/working-with-files.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ the filesystem from within a service:
6161
may therefore cause race conditions and **result in corrupted data**.
6262

6363
- Writing to files outside the service folder introduces external state. In
64-
a cluster this will result in Coordinators no longer being interchangeable.
64+
a cluster, this results in Coordinators no longer being interchangeable.
6565

6666
- Writing to files during setup is unreliable because the setup script may
67-
be executed several times or not at all. In a cluster the setup script
68-
will only be executed on a single Coordinator.
67+
be executed several times or not at all. In a cluster, the setup script
68+
is only executed on a single Coordinator.
6969

7070
Therefore it is almost always a better option to store files using a
7171
specialized, external file storage service
@@ -77,13 +77,13 @@ ArangoDB documents by using a separate collection.
7777
{{< danger >}}
7878
Due to the way ArangoDB stores documents internally, you should not store
7979
file contents alongside other attributes that might be updated independently.
80-
Additionally, large file sizes will impact performance for operations
80+
Additionally, large file sizes impact performance for operations
8181
involving the document and may affect overall database performance.
8282
{{< /danger >}}
8383

8484
{{< warning >}}
8585
In production, you should avoid storing any files in ArangoDB or handling file
86-
uploads in Foxx. The following example will work for moderate amounts of small
86+
uploads in Foxx. The following example works for moderate amounts of small
8787
files but is not recommended for large files or frequent uploads or
8888
modifications.
8989
{{< /warning >}}

site/content/3.10/develop/http-api/indexes/inverted.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -472,10 +472,10 @@ paths:
472472
Wait at least this many commits between removing unused files in the
473473
ArangoSearch data directory (default: 2, to disable use: 0).
474474
For the case where the consolidation policies merge segments often (i.e. a lot
475-
of commit+consolidate), a lower value will cause a lot of disk space to be
475+
of commit+consolidate), a lower value causes a lot of disk space to be
476476
wasted.
477477
For the case where the consolidation policies rarely merge segments (i.e. few
478-
inserts/deletes), a higher value will impact performance without any added
478+
inserts/deletes), a higher value impacts performance without any added
479479
benefits.
480480
481481
_Background:_
@@ -491,12 +491,11 @@ paths:
491491
Wait at least this many milliseconds between committing inverted index data store
492492
changes and making documents visible to queries (default: 1000, to disable
493493
use: 0).
494-
For the case where there are a lot of inserts/updates, a lower value, until
495-
commit, will cause the index not to account for them and memory usage would
496-
continue to grow.
497-
For the case where there are a few inserts/updates, a higher value will impact
498-
performance and waste disk space for each commit call without any added
499-
benefits.
494+
For the case where there are a lot of inserts/updates, a higher value causes the
495+
index not to account for them and memory usage continues to grow until the commit.
496+
A lower value impacts performance, including the case where there are no or only a
497+
few inserts/updates because of synchronous locking, and it wastes disk space for
498+
each commit call.
500499
501500
_Background:_
502501
For data retrieval, ArangoSearch follows the concept of
@@ -518,7 +517,7 @@ paths:
518517
For the case where there are a lot of data modification operations, a higher
519518
value could potentially have the data store consume more space and file handles.
520519
For the case where there are a few data modification operations, a lower value
521-
will impact performance due to no segment candidates available for
520+
impacts performance due to no segment candidates being available for
522521
consolidation.
523522
524523
_Background:_
@@ -536,8 +535,8 @@ paths:
536535
_Background:_
537536
With each ArangoDB transaction that inserts documents, one or more
538537
ArangoSearch-internal segments get created.
539-
Similarly, for removed documents the segments that contain such documents
540-
will have these documents marked as 'deleted'.
538+
Similarly, for removed documents, the segments that contain such documents
539+
have these documents marked as 'deleted'.
541540
Over time, this approach causes a lot of small and sparse segments to be
542541
created.
543542
A "consolidation" operation selects one or more segments and copies all of
@@ -594,7 +593,7 @@ paths:
594593
description: |
595594
Maximum memory byte size per writer (segment) before a writer (segment) flush
596595
is triggered. `0` value turns off this limit for any writer (buffer) and data
597-
will be flushed periodically based on the value defined for the flush thread
596+
is flushed periodically based on the value defined for the flush thread
598597
(ArangoDB server startup option). `0` value should be used carefully due to
599598
high potential memory consumption
600599
(default: 33554432, use 0 to disable)

0 commit comments

Comments
 (0)