Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/main/asciidoc/api-reference/chapter.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ You can use any programming language that supports HTTP calls (pretty much any l
| Language | Project URL | License
| Java | Bundled with the project. Look at `Remote Database` class | Apache 2
| CHICKEN Scheme | http://wiki.call-cc.org/eggref/5/arcadedb | zlib-acknowledgement
| Elixir | https://github.com/mindreframer/arcadex | MIT
| .NET | https://github.com/tetious/ArcadeDb.Client | Apache 2
| PHP (Laravel) | https://github.com/skcheung/laravel-arcadedb | ?
| Python | https://github.com/adaros92/arcadedb-python-driver | Apache 2
Expand Down
14 changes: 7 additions & 7 deletions src/main/asciidoc/content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Skip the boring parts and check this out:
* ArcadeDB supports the following models:
** <<graph-model,Graph>> (compatible with Gremlin and OrientDB SQL)
** <<document-model,Document>> (compatible with the MongoDB driver and MongoDB queries)
** <<keyvalue-model,Key/Value>> (compatible with the Redis driver)
** <<keyvalue-model,Key/Value>> (compatible with Redis commands)
** <<searchengine-model,Search Engine>> (LSM-Tree Full-Text Index)
** <<timeseries-model,Time Series>> (under construction)
// ** <<timeseries-model,Time Series>> (under construction)
** <<vector-model,Vector>> (based on the HNSW index)

* ArcadeDB understands multiple languages, with a SQL dialect as native database query language:
Expand All @@ -20,14 +20,14 @@ Skip the boring parts and check this out:

* ArcadeDB can be used as:
** <<embedded-server,Embedded>> from any language on top of the Java Virtual Machine
** Remotely by using <<http-json-api,HTTP/JSON>>
** Remotely by using the <<http-json-api,HTTP JSON-API>>
** Remotely by using a <<postgres-driver,Postgres driver>> (ArcadeDB implements Postgres Wire protocol)
** Remotely by using a <<mongodb-query-language,MongoDB driver>> (only a subset of the operations are implemented)
** Remotely by using a <<redis-query-language,Redis driver>> (only a subset of the operations are implemented)
** Remotely by using a <<mongodb-query-language,MongoDB driver>> (a subset of the operations are implemented)
** Remotely by using a <<redis-query-language,Redis driver>> (a subset of the operations are implemented)

* Getting started with ArcadeDB:
** Tutorials: <<java-tutorial,Java Tutorial>>
** Tools: <<console-tutorial,Working with the Console>>
** Tutorials: <<java-tutorial,Java>>
** Tools: <<console-tutorial,Console>>
** Containers: <<docker,Docker>>, <<kubernetes,Kubernetes>>
** Migrating: <<orientdb-importer,from OrientDB>>

Expand Down
2 changes: 1 addition & 1 deletion src/main/asciidoc/getting-started/multimodel.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ In the table below, you can find a comparison between the graph model, the relat

The data in this model is stored inside documents. A document is a set of key/value pairs (also referred to as fields or properties), where the key allows access to its value. Values can hold primitive data types, embedded documents, or arrays of other values. Documents are not typically forced to have a schema, which can be advantageous, because they remain flexible and easy to modify. Documents are stored in collections, enabling developers to group data as they decide. ArcadeDB uses the concepts of "<<types,Types>>" and "<<buckets,Buckets>>" as its form of "collections" for grouping documents. This provides several benefits, which we will discuss in further sections of the documentation.

ArcadeDB's document model also adds the concept of a "<<relationships,Relationship>>" between documents. With ArcadeDB, you can decide whether to embed documents or link to them directly. When you fetch a document, all the links are automatically resolved by ArcadeDB. This is a major difference to other document databases, like MongoDB or CouchDB, where the developer must handle any and all relationships between the documents herself.
ArcadeDB's document model also adds the concept of a "<<relationships,Relationship>>" between documents. With ArcadeDB, you can decide whether to embed documents or link to them directly. When you fetch a document, all the links are automatically resolved by ArcadeDB. This is a major difference to other document databases, like MongoDB or CouchDB, where the developer must handle any and all relationships between the documents themself.

The table below illustrates the comparison between the relational model, the document model, and the ArcadeDB document model:

Expand Down
13 changes: 6 additions & 7 deletions src/main/asciidoc/getting-started/run.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ image:../images/edit.png[link="https://github.com/ArcadeData/arcadedb-docs/blob/

You can run ArcadeDB in the following ways:

- In the cloud (coming soon), by running an ArcadeDB instance on Amazon AWS, Microsoft Azure, or Google Cloud Engine.
- In the cloud, by running an ArcadeDB instance on Amazon AWS, Microsoft Azure, or Google Cloud Engine.
- On-premise, on your servers, any OS is good.
You can run with Docker, Podman, Kubernetes or bare metal.
- On x86(-64), arm(64), or any other hardware supporting a JRE (Java* Runtime Environment)
- <<embedded-server,Embedded>>, if you develop with a language that runs on the JVM (Java* Virtual Machine)*

To reach the best performance, use ArcadeDB in <<embedded-server,embedded>> mode to reach two million insertions per second on common hardware.
If you need to scale up with the queries, run a HA (high availability) configuration with at least three servers, and a load balancer in front.
Run ArcadeDB with Kubernetes to have an automatic setup of servers in HA with a load balancer upfront.
Run ArcadeDB with Kubernetes to have an automatic setup of servers in HA and a load balancer upfront.

[discrete]
==== Embedded
Expand Down Expand Up @@ -60,14 +60,14 @@ For more information look at <<high-availability,High Availability>>.
** Linux / MacOS: `bin/server.sh`
** Windows: `bin\server.bat`

4. Exit server via **CTRL+C**

5. Interact with server
4. Interact with server
** Studio: http://localhost:2480[`http://localhost:2480`]
** Console:
*** Linux / MacOS: `bin/console.sh`
*** Windows: `bin\console.bat`

5. Exit server via **CTRL+C**

===== Windows via Scoop

Instead of using manual install you can use Scoop installer, instructions are available on their https://scoop.sh[project website].
Expand All @@ -91,7 +91,6 @@ You should use these instead of `bin\console.bat` and `bin\server.bat` mentioned
===== Mac OS X

Popular way to get opensource software is to use https://brew.sh[homebrew project].

Currently, ArcadeDB is not available through an official Homebrew formula.
To install ArcadeDB on Mac OS X:

Expand All @@ -107,7 +106,7 @@ source ~/.zshrc

Alternatively, you can run ArcadeDB using Docker:

[source,bash,subs="+attributes"]
[source,bash,subs="attributes+"]
----
docker run --rm -p 2424:2424 -p 2480:2480 -p 5432:5432 \
--name arcadedb arcadedata/arcadedb:{revnumber}
Expand Down
2 changes: 1 addition & 1 deletion src/main/asciidoc/getting-started/what-is-arcadedb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

image:../images/edit.png[link="https://github.com/ArcadeData/arcadedb-docs/blob/main/src/main/asciidoc/getting-started/what-is-arcadedb.adoc" float="right"]

ArcadeDB is the new generation of DBMS (DataBase Management System) that runs pretty much on every hardware/software configuration.
ArcadeDB is the a generation of DBMS (DataBase Management System) that runs pretty much on every hardware/software configuration.
ArcadeDB is multi-model, which means it can work with graphs, documents as well as other models of data,
and doing so extremely fast.

Expand Down
2 changes: 1 addition & 1 deletion src/main/asciidoc/query-languages/sql/sql-create-edge.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ ArcadeDB> CREATE EDGE E1 FROM #10:3 TO #11:4 SET brand = 'fiat', name = 'wow'
ArcadeDB> CREATE EDGE E FROM #1:0 TO [#4:0, #7:0];
----

* Create no edges from a single source vertex (this is usefule when using subqueries for the destination):
* Create no edges from a single source vertex (this is useful when using subqueries for the destination):

----
ArcadeDB> CREATE EDGE E FROM #1:0 TO [];
Expand Down
Loading