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.

Sign up for GitHub

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

Jump to bottom

update readme #1794

Merged
merged 3 commits into from
Jul 10, 2023
Merged

update readme #1794

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbc0da6
update readme
andyfengHKU Jul 10, 2023
9038512
update rust and java installation
ray6080 Jul 10, 2023
12ac686
update installation link
ray6080 Jul 10, 2023
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
99 changes: 15 additions & 84 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,95 +34,26 @@ Kùzu is an in-process property graph database management system (GDBMS) built f
Kùzu is being actively developed at University of Waterloo as a feature-rich and usable GDBMS. Kùzu is available under a permissible license. So try it out and help us make it better! We welcome your feedback and feature requests.

## Installation
### Precompiled binary
Precompiled binary of our latest release can be downloaded [here](https://github.com/kuzudb/kuzu/releases/latest).
### Python package
Our Python package can be directly install through pip.
```
pip install kuzu
```
### NodeJS package
```
npm install kuzu
```

We also support official C++ and C bindings. For more installation and usage instructions, please refer to [our website](https://kuzudb.com/).
| Language | Installation |
| -------- | ------------ |
| Python | `pip install kuzu` |
| NodeJS | `npm install kuzu` |
| Rust | |
| Java | |
| C/C++ | [precompiled binaries](https://github.com/kuzudb/kuzu/releases/latest) |
| CLI | [precompiled binaries](https://github.com/kuzudb/kuzu/releases/latest) |

## Getting Started
We take `tinysnb` as an example graph, which is under `dataset/demo-db/csv` in our source code, and can be downloaded [here](https://github.com/kuzudb/kuzu/tree/master/dataset/demo-db/csv).

### CLI

Start CLI with a database directory `./kuzu_shell ./testdb/`
```cypher
# Data definition
kuzu> CREATE NODE TABLE User(name STRING, age INT64, PRIMARY KEY (name));
kuzu> CREATE REL TABLE Follows(FROM User TO User, since INT64);
# Data loading
kuzu> COPY User FROM "dataset/demo-db/csv/user.csv";
kuzu> COPY Follows FROM "dataset/demo-db/csv/follows.csv";
# Querying
kuzu> MATCH (a:User)-[f:Follows]->(b:User) RETURN a.name, b.name, f.since;
```
To learn more about installation, see [Installation](https://kuzudb.com/docusaurus/getting-started/).

### Python
```python
import kuzu

db = kuzu.Database('./testdb')
conn = kuzu.Connection(db)
# Data definition
conn.execute("CREATE NODE TABLE User(name STRING, age INT64, PRIMARY KEY (name))")
conn.execute("CREATE REL TABLE Follows(FROM User TO User, since INT64)")
# Data loading
conn.execute('COPY User FROM "user.csv"')
conn.execute('COPY Follows FROM "follows.csv"')
# Run a query.
results = conn.execute('MATCH (u:User) RETURN COUNT(*);')
while results.has_next():
print(results.get_next())
# Run a query and get results as a pandas dataframe.
results = conn.execute('MATCH (a:User)-[f:Follows]->(b:User) RETURN a.name, f.since, b.name;').get_as_df()
print(results)
# Run a query and get results as an arrow table.
results = conn.execute('MATCH (u:User) RETURN u.name, u.age;').get_as_arrow(chunk_size=100)
print(results)
```
## Getting Started

### NodeJS
```js
// Import library
const kuzu = require("kuzu");

(async () => {
// Create an empty database and connect to it
const db = new kuzu.Database("./test");
const conn = new kuzu.Connection(db);

// Data definition
await conn.query(
"CREATE NODE TABLE User(name STRING, age INT64, PRIMARY KEY (name))"
);
await conn.query("CREATE REL TABLE Follows(FROM User TO User, since INT64)");

// Data loading
await conn.query('COPY User FROM "user.csv"');
await conn.query('COPY Follows FROM "follows.csv"');

// Run a query
const queryResult = await conn.query("MATCH (u:User) RETURN u.name, u.age;");

// Get all rows from the query result
const rows = await queryResult.getAll();

// Print the rows
for (const row of rows) {
console.log(row);
}
})();
```
Refer to our [Getting Started](https://kuzudb.com/docusaurus/getting-started/) page for your first example.

Refer to our [Data Import](https://kuzudb.com/docs/data-import) and [Cypher](https://kuzudb.com/docs/cypher) section for more information.
More information can be found at
- [Data Import](https://kuzudb.com/docusaurus/data-import/)
- [Cypher Reference](https://kuzudb.com/docusaurus/cypher/)
- [Client APIs](https://kuzudb.com/docusaurus/client-apis/)

## Build
To build from source code, Kùzu requires Cmake(>=3.11), Python 3, and a compiler that supports `C++20`.
Expand Down
Loading