Skip to content
This repository was archived by the owner on Oct 10, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
c7a2a88
extension(neo4j): show how to import all nodes and rels (#497)
sdht0 May 27, 2025
710012c
python: move all get_next()/has_next() to iteration (#504)
sdht0 May 31, 2025
b767b0f
Merge branch 'main' into dev
prrao87 Jun 9, 2025
9c16bb5
Merge branch 'main' into dev
prrao87 Jun 9, 2025
fbe8502
merge branch 'main' into dev
prrao87 Jun 10, 2025
c5dd0b4
Merge remote-tracking branch 'origin/main' into dev
sdht0 Jun 10, 2025
8749033
Merge branch 'main' into dev
prrao87 Jun 11, 2025
69d59d7
Merge branch 'main' into dev
prrao87 Jun 12, 2025
a95039c
Merge branch 'main' into dev
prrao87 Jun 12, 2025
0e900f5
Merge branch 'main' into dev
prrao87 Jun 13, 2025
2b5be60
Merge branch 'main' into dev
prrao87 Jun 13, 2025
7df29bf
Merge branch 'main' into dev
prrao87 Jun 18, 2025
e0e622a
Merge branch 'main' into dev
prrao87 Jun 23, 2025
1a69ec5
Add docs for LLM Extension (#520)
tgahunia05 Jun 25, 2025
d49e833
fix-use-before-init-error-in-vector-example (#528)
tgahunia05 Jun 25, 2025
122e436
Merge branch 'main' into dev
prrao87 Jun 26, 2025
bd36a7b
Update LLM Docs for Ollama Config (#533)
tgahunia05 Jun 30, 2025
d1ea68c
Refactor the extension docs (#543)
sdht0 Jul 4, 2025
d6f620d
Refactor the rest of the docs (#545)
sdht0 Jul 4, 2025
e5c9582
Document cache_embeddings option for CREATE_VECTOR_INDEX (#547)
royi-luo Jul 4, 2025
8baeb83
Add docs for passing dataframes as parameters (#546)
royi-luo Jul 4, 2025
9d67c32
Document `STRUCT_PACK` function (#548)
05st Jul 4, 2025
2376f7b
Add docs for create table as (#549)
05st Jul 5, 2025
5fec0e3
Add docs for Azure extension (#505)
05st Jul 6, 2025
c9fb2ae
Remove vector index being immutable (#550)
ray6080 Jul 6, 2025
3de1049
Switch tutorial results to use Python iterators (#531)
prrao87 Jul 6, 2025
c6bb721
Fix httpfts link (#551)
andyfengHKU Jul 6, 2025
aec9135
Add alter table add from to (#552)
andyfengHKU Jul 7, 2025
2ac6932
Add new functions (#559)
andyfengHKU Jul 7, 2025
01aaab9
Add doc for `projected_graph_info` (#557)
acquamarin Jul 7, 2025
553f8fa
Add doc for `top` option in fts (#555)
acquamarin Jul 7, 2025
5d989cf
Multiple issue fixes (#560)
andyfengHKU Jul 7, 2025
f63dd1b
Add doc for export schema only (#561)
acquamarin Jul 7, 2025
2a864fb
Add advanced filtered search (#556)
andyfengHKU Jul 7, 2025
5dfc288
Add doc for extension uninstall and force install (#554)
acquamarin Jul 7, 2025
763111b
Reorg httpfs (#562)
prrao87 Jul 7, 2025
641efd9
Update extension overview list (#565)
tgahunia05 Jul 7, 2025
7794ec1
Document Update Extension (#566)
tgahunia05 Jul 7, 2025
119aac3
Fix llm doc (#567)
acquamarin Jul 8, 2025
afe567b
Update Uninstall Docs (#568)
tgahunia05 Jul 8, 2025
b9f3264
Update LLM Docs (#569)
tgahunia05 Jul 9, 2025
1a8f859
Add files managed by Kuzu page (#553)
ray6080 Jul 9, 2025
62afe42
Merge branch 'main' into dev
prrao87 Jul 9, 2025
b4ba7ec
Merge branch 'main' into dev
prrao87 Jul 9, 2025
e77daaa
Merge branch 'main' into dev
prrao87 Jul 9, 2025
eb7bfed
Merge branch 'main' into dev
prrao87 Jul 9, 2025
86d610b
Handle subpages highlight in sidebar
sdht0 Jul 9, 2025
69d4a6c
Swift docs (#575)
mewim Jul 9, 2025
250f8ae
Document show_*_extensions (#576)
tgahunia05 Jul 9, 2025
84c2a1b
Another round of docs refactoring (#577)
sdht0 Jul 10, 2025
c37214b
Fix timestamp description and examples (#579)
prrao87 Jul 10, 2025
1e98e7b
update llm docs (#578)
tgahunia05 Jul 10, 2025
7ebc5fa
Update Azure docs w/ globbing (#580)
05st Jul 10, 2025
c171af6
Single file update (#581)
prrao87 Jul 11, 2025
df4bf6f
Add swift demo project to docs
mewim Jul 11, 2025
f933b92
Update LLM (#582)
tgahunia05 Jul 11, 2025
141c067
Rust tutorial fixes (#584)
05st Jul 11, 2025
7565000
Minor changes to 0.11 docs (#583)
royi-luo Jul 11, 2025
e66f9a9
update
ray6080 Jul 11, 2025
e46b1b1
Normalize presentation (#585)
sdht0 Jul 12, 2025
61c24fa
Fix file names
sdht0 Jul 12, 2025
4897575
Fix install docs
sdht0 Jul 12, 2025
f3e4817
update shadow file
ray6080 Jul 12, 2025
3ca5efb
Merge branch 'main' into dev
prrao87 Jul 13, 2025
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
51 changes: 28 additions & 23 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ export default defineConfig({
items: [
{ label: 'Overview', link: '/tutorials' },
{ label: 'Cypher', link: '/tutorials/cypher' },
{ label: 'Python', link: '/tutorials#python' },
{ label: 'Python', link: '/tutorials/python' },
{ label: 'Rust', link: '/tutorials/rust' },
]
},
Expand Down Expand Up @@ -215,6 +215,7 @@ export default defineConfig({
{ label: 'Java', link: '/client-apis/java' },
{ label: 'Rust', link: '/client-apis/rust' },
{ label: 'Go', link: '/client-apis/go' },
{ label: 'Swift', link: '/client-apis/swift' },
{ label: 'C++', link: '/client-apis/cpp' },
{ label: 'C', link: '/client-apis/c' },
{ label: '.NET', link: '/client-apis/net', badge: { text: 'Community', variant: 'caution'}},
Expand All @@ -233,6 +234,7 @@ export default defineConfig({
{ label: 'Performance debugging', link: '/developer-guide/performance-debugging' },
{ label: 'Testing framework', link: '/developer-guide/testing-framework' },
{ label: 'Join order hints', link: '/developer-guide/join-order-hint' },
{ label: 'On-disk files', link: '/developer-guide/files' },
{
label: 'Database internals',
items: [
Expand All @@ -249,51 +251,53 @@ export default defineConfig({
collapsed: true,
items: [
{ label: 'Overview', link: '/extensions'},
{
label: 'Cloud storage systems',
collapsed: true,
items: [
{ label: 'Amazon S3', link: '/extensions/s3'},
{ label: 'Google Cloud Storage', link: '/extensions/gcs' },
{ label: 'Microsoft Azure', link: '/extensions/azure', badge: { text: 'New' }},
]
},
{ label: 'External Kuzu databases', link: '/extensions/attach/kuzu' },
{ label: 'Full-text search', link: '/extensions/full-text-search' },
{
label: 'Graph algorithms',
collapsed: true,
badge: { text: 'New' },
items: [
{ label: 'Overview', link: '/extensions/algo'},
{ label: 'K-Core decomposition', link: '/extensions/algo/kcore'},
{ label: 'K-Core Decomposition', link: '/extensions/algo/kcore'},
{ label: 'Louvain', link: '/extensions/algo/louvain'},
{ label: 'PageRank', link: '/extensions/algo/pagerank'},
{ label: 'Shortest paths', link: '/extensions/algo/path'},
{ label: 'Strongly Connected Components', link: '/extensions/algo/scc'},
{ label: 'Weakly Connected Components', link: '/extensions/algo/wcc'},
{ label: 'Shortest path', link: '/extensions/algo/path'},
]
},
{ label: 'HTTPS file system', link: '/extensions/httpfs#https-file-system' },
{ label: 'External Kuzu databases', link: '/extensions/attach/kuzu' },
{
label: 'Cloud storage systems',
{ label: 'HTTPS file system', link: '/extensions/httpfs' },
{ label: 'JSON', link: '/extensions/json' },
{
label: 'Lakehouse formats',
collapsed: true,
items: [
{ label: 'Amazon S3', link: '/extensions/httpfs#aws-s3-file-system'},
{ label: 'Google Cloud Storage', link: '/extensions/httpfs#gcs-file-system', badge: { text: 'New' }},
{ label: 'Iceberg', link: '/extensions/attach/iceberg' },
{ label: 'Delta Lake', link: '/extensions/attach/delta' },
{ label: 'Unity Catalog', link: '/extensions/attach/unity' },
]
},
{
{ label: 'LLM', link: '/extensions/llm', badge: { text: 'New' }},
{ label: 'Neo4j', link: '/extensions/neo4j'},
{
label: 'Relational databases',
collapsed: true,
items: [
{ label: 'Overview', link: '/extensions/attach/rdbms' },
{ label: 'PostgreSQL', link: '/extensions/attach/postgres' },
{ label: 'DuckDB', link: '/extensions/attach/duckdb' },
{ label: 'SQLite', link: '/extensions/attach/sqlite' },
]
},
{
label: 'Lakehouse formats',
collapsed: true,
items: [
{ label: 'Iceberg', link: '/extensions/attach/iceberg' },
{ label: 'Delta Lake', link: '/extensions/attach/delta' },
{ label: 'Unity Catalog', link: '/extensions/attach/unity' },
]
},
{ label: 'Full-text search', link: '/extensions/full-text-search' },
{ label: 'JSON', link: '/extensions/json' },
{ label: 'Neo4j', link: '/extensions/neo4j', badge: { text: 'New' }},
{ label: 'Vector search', link: '/extensions/vector'},
],
},
Expand All @@ -308,6 +312,7 @@ export default defineConfig({
]
: [],
lastUpdated: true,
routeMiddleware: './src/route-data.ts',
}),
],
});
25 changes: 4 additions & 21 deletions public/img/concurrency/kuzu-concurrency-1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 4 additions & 21 deletions public/img/concurrency/kuzu-concurrency-2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 4 additions & 10 deletions public/img/concurrency/kuzu-concurrency-3.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 11 additions & 11 deletions src/content/docs/client-apis/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ data is persisted to disk after the CLI shell is closed. Note that if the databa
directory does not exist, it will be created for you.

```bash
$ kuzu ./test_db
$ kuzu example.kuzu
```
```
Opened the database at path: ./test_db in read-write mode.
Opened the database example.kuzu in read-write mode.
Enter ":help" for usage hints.
kuzu>
```
Expand All @@ -33,7 +33,7 @@ Alternatively, you can create an in-memory database by omitting the path entirel
from your terminal:

```bash
$ kuzu
kuzu
```
```
Opened the database under in-memory mode.
Expand All @@ -43,7 +43,7 @@ kuzu>
## Shell commands

Once you start the shell, you can issue Cypher queries as shown in the [get started](/get-started)
section. List all available shell commands by running `./kuzu -h`.
section. List all available shell commands by running `kuzu -h`.

```bash
$ kuzu -h
Expand Down Expand Up @@ -174,17 +174,17 @@ Consider that you have the following DDL file:

```cypher
// schema.cypher
CREATE NODE TABLE Person (name STRING, age INT64, PRIMARY KEY(name));
CREATE NODE TABLE Person (name STRING PRIMARY KEY, age INT64);
COPY Person FROM 'person.csv';
```

Pipe the file content to the CLI as follows:

```bash
./kuzu testdb < schema.cypher
kuzu example.kuzu < schema.cypher
```
```
Opened the database at path: ./test_db in read-write mode.
Opened the database example.kuzu in read-write mode.
Enter ":help" for usage hints.
┌────────────────────────────────┐
│ result │
Expand All @@ -210,8 +210,8 @@ Time: 0.09ms (compiling), 11.75ms (executing)

For queries that might take a significant amount of time to execute, a progress bar can be enabled that displays
the number of pipelines that have been executed (each query is broken down into one or more pipelines),
as well as the percentage of the data processed in a pipeline. This gives an estimate for how much of a pipeline
has executed.
as well as the percentage of the data processed in a pipeline. This gives an estimate of how much of a pipeline
has been executed.

![](/img/cli/progress-bar.gif)

Expand Down Expand Up @@ -250,15 +250,15 @@ To change the output mode, use the `:mode` command followed by the desired mode:
```cypher
kuzu> :mode json
mode set as json
kuzu> CREATE NODE TABLE Person (name STRING, age INT64, PRIMARY KEY(name));
kuzu> CREATE NODE TABLE Person (name STRING PRIMARY KEY, age INT64);
[{"result":"Table Person has been created."}]
```

The `:max_rows` and `:max_width` commands can be used to control the number of rows and the width
of the `box`, `column`, `table`, and `markdown` output modes.

## Multi-line Cypher statements
The CLI supports queries written in multiple lines. If a semicolon is omitted, hitting enter will allow users to continue the query in a newline instead of executing it.
The CLI supports queries written in multiple lines. If a semicolon is omitted, hitting enter will allow you to continue the query in a newline instead of executing it.
```
kuzu> MATCH (a:person)
‣ RETURN a.id;
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/client-apis/cpp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ conn->query("MATCH (p:person) return addMicro(p.registerTime, to_int32(p.ID))")

### Vectorized functions

Due its columnar storage and architecture decisions, Kuzu can execute functions on input data in an
Due to its columnar storage and architecture decisions, Kuzu can execute functions on input data in an
efficient and vectorized manner. In addition to creating scalar UDFs, Kuzu also provides support for
user-defined vectorized UDFs. The `createVectorizedFunction` interface also offers two APIs to enhance clarity in datatype mapping.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/client-apis/elixir.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { LinkCard } from '@astrojs/starlight/components';

Elixir is a programming language based on the BEAM virtual environment.
Its functional style, strong community, Erlang compatibility and concurrency-friendly
features, like preemptive scheduling and spawning a large number of process without incurring much overhead,
features, like preemptive scheduling and spawning a large number of processes without incurring much overhead,
make it a popular choice among developers for building full-stack applications.

<LinkCard
Expand Down
14 changes: 11 additions & 3 deletions src/content/docs/client-apis/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Client APIs"

import { LinkCard, CardGrid} from '@astrojs/starlight/components';

Kuzu is embeddable in a variety of languages via client library APIs. Queries in Kuzu through via
Kuzu is embeddable in a variety of languages via client library APIs. Queries in Kuzu through
its CLI or client APIs are transactional, satisfying serializability, atomicity and durability requirements.

## Command line shell
Expand Down Expand Up @@ -38,6 +38,14 @@ The following client libraries are officially supported.
title="Rust"
href="/client-apis/rust"
/>
<LinkCard
title="Go"
href="/client-apis/go"
/>
<LinkCard
title="Swift"
href="/client-apis/swift"
/>
<LinkCard
title="C"
href="/client-apis/c"
Expand All @@ -51,8 +59,8 @@ The following client libraries are officially supported.

## Community-contributed clients

Community members and users are welcome to contribute client libraries for languages that are as-yet
unsupported. The following client libraries have been contributed by the community.
Community members and users are welcome to contribute client libraries for languages that are not yet
supported. The following client libraries have been contributed by the community.

<CardGrid>
<LinkCard
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/client-apis/net.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ KuzuDB-Net is a .NET DLL Wrapper for the Kuzu lib file contributed by

<LinkCard
title=".NET DLL Wrapper for Kuzu lib file"
description="The .NET package is mantained independently by an external contributor."
description="The .NET package is maintained independently by an external contributor."
href="https://github.com/FactEngineCommunity/KuzuDB-DotNetInterface"
/>

Expand Down
14 changes: 7 additions & 7 deletions src/content/docs/client-apis/nodejs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ See the following link for the full documentation of the Node.js API.
## Sync and Async APIs

Kuzu provides both a sync and an async Node.js API. The async API is the default
and more commonly used when building Kuzu applications in Node.js.
and is more commonly used when building Kuzu applications in Node.js.

<Tabs>

Expand All @@ -28,12 +28,12 @@ const kuzu = require("kuzu");

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

// Create the tables
await conn.query("CREATE NODE TABLE User(name STRING, age INT64, PRIMARY KEY (name))");
await conn.query("CREATE NODE TABLE City(name STRING, population INT64, PRIMARY KEY (name))");
await conn.query("CREATE NODE TABLE User(name STRING PRIMARY KEY, age INT64)");
await conn.query("CREATE NODE TABLE City(name STRING PRIMARY KEY, population INT64)");
await conn.query("CREATE REL TABLE Follows(FROM User TO User, since INT64)");
await conn.query("CREATE REL TABLE LivesIn(FROM User TO City)");

Expand Down Expand Up @@ -67,12 +67,12 @@ where async operations are not desired.
const kuzu = require("kuzu");

// Create an empty on-disk database and connect to it
const db = new kuzu.Database("./demo_db");
const db = new kuzu.Database("example.kuzu");
const conn = new kuzu.Connection(db);

// Create the tables
conn.querySync("CREATE NODE TABLE User(name STRING, age INT64, PRIMARY KEY (name))");
conn.querySync("CREATE NODE TABLE City(name STRING, population INT64, PRIMARY KEY (name))");
conn.querySync("CREATE NODE TABLE User(name STRING PRIMARY KEY, age INT64)");
conn.querySync("CREATE NODE TABLE City(name STRING PRIMARY KEY, population INT64)");
conn.querySync("CREATE REL TABLE Follows(FROM User TO User, since INT64)");
conn.querySync("CREATE REL TABLE LivesIn(FROM User TO City)");

Expand Down
Loading