Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add guide for embedded/application db #988 #1011

Merged
merged 8 commits into from
Jan 26, 2024
Merged
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
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@
## <img width="25" src="./agdb_web/static/logo.svg" alt="agdb logo">&nbsp;&nbsp;Agnesoft Graph Database

<p align="center">
<a href="./docs/but_why.md">Why not SQL?</a> | <a href="#decision-tree">DECISION TREE</a> | <a href="./docs/queries.md">Queries</a>
<a href="/agdb_web/content/en/docs/1.guides/2.quickstart.md">Quickstart Db</a> | <a href="/agdb_web/content/en/docs/1.guides/3.quickstart_client.md">Quickstart Client</a> | <a href="./docs/queries.md">QUERIES</a> | <a href="#decision-tree">DECISION TREE</a>
</p>
<p align="center">
<a href="./docs/but_why.md">Why not SQL?</a>
</p>

The Agnesoft Graph Database (aka _agdb_) is persistent, optionally memory mapped graph database with native object 'no-text' queries. It can be used as a main persistent storage, data analytics platform as well as fast in-memory cache. Its typed schema-less data store allows for flexible and seamless data updates with no downtime or costly migrations. All queries are constructed via a builder pattern or directly as objects with no special language or text parsing.
Expand All @@ -63,7 +66,7 @@ The Agnesoft Graph Database (aka _agdb_) is persistent, optionally memory mapped

- Data plotted on a graph
- Typed [key-value properties](docs/concepts.md#data-types) attached to graph elements (nodes & edges)
- Persistent file based storage
- Persistent platform agnostic file based storage (transferable between platforms)
- ACID compliant
- [Object queries](docs/queries.md) with builder pattern (no text, no query language)
- Memory mapped for fast querying
Expand Down Expand Up @@ -179,7 +182,7 @@ flowchart TD;
Client --> Studio
Client --> Queries
Hosting --> Server[<a href='https://github.com/agnesoft/agdb/blob/main/docs/server.md'>Server</a>]
Hosting --> Cloud[<a href='https://github.com/agnesoft/agdb/blob/main/docs/server.md'>Cloud</a>]
Hosting --> Cloud[<a href='https://github.com/agnesoft/agdb/blob/main/docs/cloud.md'>Cloud</a>]
```

## <img width="25" src="./agdb_web/static/logo.svg" alt="agdb logo">&nbsp;&nbsp;Roadmap
Expand Down
4 changes: 3 additions & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# agdb_api
# API

TBD
3 changes: 3 additions & 0 deletions docs/cloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Cloud

Under construction.
Empty file removed docs/db.md
Empty file.
3 changes: 3 additions & 0 deletions docs/studio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Studio

Under construction.
7 changes: 7 additions & 0 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Troubleshooting

- [1. Getting cross-origin (CORS) errors when connecting to the `agdb_server`](#1-getting-cross-origin-cors-errors-when-connecting-to-the-agdb_server)

## 1. Getting cross-origin (CORS) errors when connecting to the `agdb_server`

CORS error can happen even locally when running the server and connecting to it using raw IP address (e.g. `127.0.0.1`). Try running the server and binding it to `localhost` (default) or another DNS name instead.
Loading