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

DOC-385 | Add overview of Tools to Getting Started #1316

Merged
merged 11 commits into from
May 8, 2023
Merged

DOC-385 | Add overview of Tools to Getting Started #1316

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ee03ce3
added overview of tools to getting started
nerpaula Mar 29, 2023
96c934f
Merge branch 'main' into DOC-385
nerpaula Mar 29, 2023
7e1e29c
Apply suggestions from code review
nerpaula Apr 5, 2023
01a206c
Merge branch 'main' into DOC-385
nerpaula Apr 5, 2023
2049c8f
regrouping
nerpaula Apr 5, 2023
5aa161a
Apply suggestions from code review
nerpaula Apr 6, 2023
63d9a8a
Merge branch 'main' into DOC-385
nerpaula Apr 12, 2023
684e405
review
nerpaula Apr 12, 2023
686fd12
review
nerpaula Apr 13, 2023
d8a8344
Merge branch 'main' into DOC-385
nerpaula May 8, 2023
dacd456
apply to 3.12
nerpaula May 8, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 63 additions & 3 deletions 3.10/quick-start-guide.md
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a dedicated page for "How to interact with ArangoDB" and this content seems like it would fit there. For the quick start guide, I would expect something shorter, for example, leaving out arangobench, and not focusing on the different executables/tools, but rather creating groups by topic. What I mean is that it should look at the tools more from a user perspective and be worded accordingly, like "get data into and out of ArangoDB" as a topic, covering arangoimport + arangoexport, but also mentioning other options like the API and the JSON upload/download option in the web interface (which is pretty limited but still). Similarly, arangodump, arangorestore, and arangobackup can be grouped together under a topic for backing up and restoring data/the system.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ redirect_from:

This chapter introduces ArangoDB's core concepts and covers the following:

- Available tools in ArangoDB
- The high-level data organization
- Its data model (or rather multiple data models)
- Important terminology used throughout the database system and in this
Expand All @@ -21,6 +22,65 @@ update, replace, and remove documents using ArangoDB's web interface or a driver

Learn more about ArangoDB's [data model and concepts](data-model-and-concepts.html).

## Available Tools in ArangoDB

ArangoDB provides various tools to help you manage and work with your data.

- [ArangoDB Server](programs-arangod.html) is the core component of ArangoDB that
stores data and handles requets. You can communicate with the server through
the web interface, command-line interface, drivers, and REST API.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's important to mention the name of the executable (arangod) and clarify the difference between an ArangoDB server as in an instance of the database system (which can be comprised of multiple arangod processes), the server binary, and a server node. For clusters, you shouldn't communicate with any server node but only Coordinators - not something that necessarily needs to be mentioned here, but perhaps there is a wording that leaves this room for interpretation.

- [ArangoDB Shell](programs-arangosh.html) is the command-line tool that
allows you to interact with the ArangoDB server. It also offers a V8 JavaScript
shell environment that you can use to manage collections or run queries.

- [ArangoDB Web Interface](programs-web-interface.html) is the graphical user
interface tool that lets you perform all essential actions like creating
collections, viewing documents, and running queries. You can also view
graphs and the server logs and metrics, as well as administrate user accounts.

- [ArangoDB Starter](programs-starter.html) helps you set up and deploy ArangoDB
instances on bare-metal servers and supports all ArangoDB deployment modes, such
as a single server instance, active failover, and cluster (including
Datacenter-to-Datacenter replication).

- [*arangodump*](programs-arangodump.html) is the command-line tool that allows you
to create backups of your data and structures in a flexible and efficient manner
and can be used for all ArangoDB deployment modes.

With *arangodump*, you can create backups for selected collections or for all
collections of a database. Additionally, you can back up the structural information
of your collections (name, indexes, sharding, etc.) with or without the data stored in them.

- [*arangorestore*](programs-arangorestore.html) is the command-line tool that allows
you to restore backups created by *arangodump*.

Similarly to the backup process, you can restore either all collections or just
specific ones and choose whether to restore structural information with or
without data.

- [*arangobackup*](programs-arangobackup.html) is a command-line tool that enables
you to create instantaneous and consistent [hot backups](backup-restore.html#hot-backups)
of the data and structural information stored in ArangoDB, without interrupting
the database operations. It can be used for all ArangoDB deployment modes.

Only available in the Enterprise Edition.

- With [*arangoimport*](programs-arangoimport.html) you can import data from JSON,
JSONL, CSV, and TSV formats into a database collection. Thanks to its multi-threaded
architecture and bulk import capabilities, you can import your data at high
speeds.

- With [*arangoexport*](programs-arangoexport.html) you can export data from your
database collection to various formats such as JSON, JSONL, CSV, and XML.

- [*arangobench*](programs-arangobench.html), ArangoDB's benchmark and test tool,
can be used to issue test requests to the database system for performance and
server function testing.

For a complete list of available tools including examples, please refer to the
[Programs & Tools](programs.html) chapter.

## Modeling Data for ArangoDB

Plan for your data needs and map your conceptual model to the right features,
Expand Down Expand Up @@ -48,7 +108,7 @@ and makes the query language very powerful while remaining easy to read and writ
To get started with AQL, sign up for [ArangoDB University](https://university.arangodb.com/){:target="_blank"}
and get access to interactive courses powered by ArangoGraph.

## In the Cloud or On-premises
## Managed Cloud Service or On-premises

When you are ready for your own ArangoDB server, you can sign up for ArangoDB's
cloud service called ArangoGraph, which takes care of the setup and maintenance, so
Expand All @@ -58,8 +118,8 @@ that you can focus on building amazing things on top of ArangoDB. See
You can also install ArangoDB locally or on your own server hardware.
See [Install ArangoDB on-premises](quick-start-on-premises.html) for more details.

If you want to migrate from bare metal servers to the cloud with minimal downtime,
check out the [Cloud Migration Tool](arangograph/cloud-migration-tool.html).
If you want to migrate from an on-premises system to the fully managed ArangoGraph
cloud platform, check out the [Cloud Migration Tool](arangograph/cloud-migration-tool.html).

## Interactive Tutorials

Expand Down
60 changes: 60 additions & 0 deletions 3.11/quick-start-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ redirect_from:

This chapter introduces ArangoDB's core concepts and covers the following:

- Available tools in ArangoDB
- The high-level data organization
- Its data model (or rather multiple data models)
- Important terminology used throughout the database system and in this
Expand All @@ -21,6 +22,65 @@ update, replace, and remove documents using ArangoDB's web interface or a driver

Learn more about ArangoDB's [data model and concepts](data-model-and-concepts.html).

## Available Tools in ArangoDB

ArangoDB provides various tools to help you manage and work with your data.

- [ArangoDB Server](programs-arangod.html) is the core component of ArangoDB that
stores data and handles requets. You can communicate with the server through
the web interface, command-line interface, drivers, and REST API.

- [ArangoDB Shell](programs-arangosh.html) is the command-line tool that
allows you to interact with the ArangoDB server. It also offers a V8 JavaScript
shell environment that you can use to manage collections or run queries.

- [ArangoDB Web Interface](programs-web-interface.html) is the graphical user
interface tool that lets you perform all essential actions like creating
collections, viewing documents, and running queries. You can also view
graphs and the server logs and metrics, as well as administrate user accounts.

- [ArangoDB Starter](programs-starter.html) helps you set up and deploy ArangoDB
instances on bare-metal servers and supports all ArangoDB deployment modes, such
as a single server instance, active failover, and cluster (including
Datacenter-to-Datacenter replication).

- [*arangodump*](programs-arangodump.html) is the command-line tool that allows you
to create backups of your data and structures in a flexible and efficient manner
and can be used for all ArangoDB deployment modes.

With *arangodump*, you can create backups for selected collections or for all
collections of a database. Additionally, you can back up the structural information
of your collections (name, indexes, sharding, etc.) with or without the data stored in them.

- [*arangorestore*](programs-arangorestore.html) is the command-line tool that allows
you to restore backups created by *arangodump*.

Similarly to the backup process, you can restore either all collections or just
specific ones and choose whether to restore structural information with or
without data.

- [*arangobackup*](programs-arangobackup.html) is a command-line tool that enables
you to create instantaneous and consistent [hot backups](backup-restore.html#hot-backups)
of the data and structural information stored in ArangoDB, without interrupting
the database operations. It can be used for all ArangoDB deployment modes.

Only available in the Enterprise Edition.

- With [*arangoimport*](programs-arangoimport.html) you can import data from JSON,
JSONL, CSV, and TSV formats into a database collection. Thanks to its multi-threaded
architecture and bulk import capabilities, you can import your data at high
speeds.

- With [*arangoexport*](programs-arangoexport.html) you can export data from your
database collection to various formats such as JSON, JSONL, CSV, and XML.

- [*arangobench*](programs-arangobench.html), ArangoDB's benchmark and test tool,
can be used to issue test requests to the database system for performance and
server function testing.

For a complete list of available tools including examples, please refer to the
[Programs & Tools](programs.html) chapter.

## Modeling Data for ArangoDB

Plan for your data needs and map your conceptual model to the right features,
Expand Down