fluidB
/
fluidb
1
0
Fork 0
Code Pull Requests Activity

update docs

Browse Source
main
Ziyang Hu 2 years ago
parent c5f489d946
commit 58b4e7cf9c
9 changed files with 50 additions and 106 deletions
Show Stats Download Patch File Download Diff File

BIN
1_direct_reachable.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
2_one_hop_reachable.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 32 KiB

BIN
3_all_rechable.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 44 KiB

BIN
4_most_hops.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 96 KiB

BIN
5_algo.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 54 KiB

BIN
6_err_msg.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 91 KiB

156
IN_PROG.md
Unescape Escape View File

@ -1,3 +1,5 @@
<img src="logo_c.png" width="200" height="175">
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/cozodb/cozo/Build)](https://github.com/cozodb/cozo/actions/workflows/build.yml)
[![Crates.io](https://img.shields.io/crates/v/cozo)](https://crates.io/crates/cozo)
[![GitHub](https://img.shields.io/github/license/cozodb/cozo)](https://github.com/cozodb/cozo/blob/main/LICENSE.txt)
@ -17,131 +19,73 @@ that uses Datalog for query, is embeddable, and focuses on graph data and algori
* Easy to use from any programming language, or as a standalone program
* [Embeddable](https://cozodb.github.io/current/manual/setup.html#embedding-cozo), with ready-to-use bindings for
Python, NodeJS and Java
* Single executable, trivial to deploy and run
* Single executable standalone server, trivial to deploy and run
* [Jupyter](https://jupyter.org/) notebooks integration, plays well with the DataScience ecosystem
* Modern, clean, flexible syntax, informative error messages
## Teasers
Here `*route` is a relation with two columns `src` and `dst`,
representing a route between those airports.
Find airports reachable by one stop from Frankfurt Airport (code `FRA`):
TODO replace with images
```js
? [dst] : =
*
route
{
src: 'FRA', dst
:
stop
}
,
*
route
{
src: stop, dst
}
```
Find airports reachable from Frankfurt with any number of stops
with code starting with the letter `A`:
```js
reachable[dst]
:
=
*
route
{
src: 'FRA', dst
}
reachable[dst]
:
= reachable[src],
*
route
{
src, dst
}
? [airport] : = reachable[airport], starts_with(airport, 'A')
```
Compute the shortest path between Frankfurt and all airports in the world:
```js
shortest_paths[dst, shortest(path)]
:
=
*
route
{
src: 'FRA', dst
}
,
path = ['FRA', dst]
shortest_paths[dst, shortest(path)]
:
= shortest_paths[stop, prev_path],
*
route
{
src: stop, dst
}
,
path = append(prev_path, dst)
? [dst, path] : = shortest_paths[dst, path]
```
Compute the shortest path again, but with built-in algorithm:
```js
starting[airport]
:
= airport = 'FRA'
? [src, dst, cost, path] < ~ShortestPathDijkstra( * route[], starting[]
)
```
Nice error messages when things go wrong:
xxx
Here `*route` is a relation with two columns `fr` and `to`,
representing a route between those airports,
and `FRA` is the code for Frankfurt Airport.
## Install
How many airports are directly connected to `FRA`?
As Cozo is used as an embedded database,
there are lots of options for installing it.
We aim to provide binary distributions for the most popular systems.
If a binary distribution is not available for you, you need to compile
from source.
<img src="1_direct_reachable.png" width="664" height="95">
How many airports are reachable from `FRA` by one stop?
<img src="2_one_hop_reachable.png" width="662" height="117">
How many airports are reachable from `FRA` by any number of stops?
<img src="3_all_rechable.png" width="664" height="132">
What are the two most difficult to reach airports
by the mininum number of hops required,
starting from `FRA`?
The following table lists the supported systems and how to install.
<img src="4_most_hops.png" width="662" height="268">
| Host | OS | Install command | Details |
|-----------------------------------------------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
| Python 3.7+ | B* | `pip install "pycozo[embedded,pandas]"`,<br/>or `pip install "pycozo[embedded]"` if you do not want Pandas support | [pycozo](https://github.com/cozodb/pycozo) |
| NodeJS 10+ | B* | `npm install --save cozo-node` | [cozo-node](https://github.com/cozodb/cozo-lib-nodejs) |
| Clojure (with JDK 11+) | B* | Use the maven package `com.github.zh217:cozo-clj` (hosted in Clojars) in your package manager, [like this](https://clojars.org/com.github.zh217/cozo-clj) | [cozo-clj](https://github.com/cozodb/cozo-clj) |
| Java 11+ | B* | Use the maven package `com.github.zh217:cozo-lib-java` (hosted in Clojars) in your package manager, [like this](https://clojars.org/com.github.zh217/cozo-lib-java) | [cozo-lib-java](https://github.com/cozodb/cozo-lib-java) |
| Rust (compiler needs to support the 2021 edition) | Any | Add `cozo = 0.1.4` to your Cargo.toml under `[dependencies]` | [docs.rs](https://docs.rs/cozo) |
| C/C++ or language with C FFI (Go, Ruby, R, Swift, Haskell, ...) | A* | Use the [header file](https://github.com/cozodb/cozo/blob/main/cozo-lib-c/cozo_c.h), and download the static/dynamic library from the [release page](https://github.com/cozodb/cozo/releases/) | [cozo-lib-c](https://github.com/cozodb/cozo/tree/main/cozo-lib-c) |
| Standalone (client/server with HTTP) | A* | Download the executable (named `cozoserver-*`) for your system from the [release page](https://github.com/cozodb/cozo/releases/) | [cozoserver](https://github.com/cozodb/cozo/blob/main/standalone.md) |
What is the shortest path between `FRA` and `YPO`, by actual distance travelled?
<img src="5_algo.png" width="665" height="141">
Cozo attempts to provide nice error messages when you make mistakes:
<img src="6_err_msg.png" width="660" height="261">
## Install
As Cozo is an embedded database,
there are lots of options for installing it.
We aim to provide packaged distributions (binary when applicable) for the most common language/OS/arch combinations:
| Host language | OS | Installation TL;DR | Details |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
| Python 3.7+ | B* | `pip install "pycozo[embedded,pandas]"`,<br/>or `pip install "pycozo[embedded]"` if you don't want [Pandas dataframe](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) support | [pycozo](https://github.com/cozodb/pycozo) |
| NodeJS 10+ | B* | `npm install --save cozo-node` | [cozo-node](https://github.com/cozodb/cozo-lib-nodejs) |
| Clojure (with JDK 11+) | B* | Use `com.github.zh217:cozo-clj` (maven repo: https://clojars.org/repo) in your package manager, [like this](https://clojars.org/com.github.zh217/cozo-clj) | [cozo-clj](https://github.com/cozodb/cozo-clj) |
| Java 11+ | B* | Use `com.github.zh217:cozo-lib-java` (maven repo: https://clojars.org/repo) in your package manager, [like this](https://clojars.org/com.github.zh217/cozo-lib-java) | [cozo-lib-java](https://github.com/cozodb/cozo-lib-java) |
| Rust | Any | Add `cozo = 0.1.4` to your Cargo.toml under `[dependencies]` | [docs.rs](https://docs.rs/cozo) |
| C/C++ or language with C FFI ([Go](https://pkg.go.dev/cmd/cgo), [Ruby](https://github.com/ffi/ffi), [Haskell](https://wiki.haskell.org/Foreign_Function_Interface), ...) | A* | Use the [C header file](https://github.com/cozodb/cozo/blob/main/cozo-lib-c/cozo_c.h), and download the static/dynamic library `libcozo_c-*` from the [release page](https://github.com/cozodb/cozo/releases/) | [cozo-lib-c](https://github.com/cozodb/cozo/tree/main/cozo-lib-c) |
| Standalone (HTTP server) | A* | Download `cozoserver-*` for your system from the [release page](https://github.com/cozodb/cozo/releases/), uncompress, and run in a terminal | [cozoserver](https://github.com/cozodb/cozo/blob/main/standalone.md) |
for the OS column:
* **B** includes:
* Recent versions of Linux running on x86_64
* Recent versions of Mac running on x86_64 and Apple ARM
* Recent versions of MacOS running on ARM (M1/M2) and x86_64
* Recent versions of Windows on x86_64
* **A** includes all supported systems in **B**, and:
* **A** includes everything in **B**, and:
* Recent versions of Linux running on aarch64
If a packaged distribution is not available for you, you can still compile
from source.
For embedded use, a single database directory can only be used by one process at any moment.
The database can be used from multiple threads within the single process and everything is thread-safe.
If you need multi-process access to a single database, use the standalone client/server option.
If you need multi-process access to a single database, use the standalone server.
Ease of installation is a priority for Cozo.
If you feel that something should be done to improve the current user experience,

BIN
logo.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 107 KiB

BIN
logo_c.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

Write Preview
Loading…
Cancel
Save