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
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/content/docs/client-apis/c.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: C API
description: "Use Kuzu embedded graph database in C applications with the official C API"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/cpp.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: C++
description: "Use Kuzu embedded graph database in C++ applications with the official C++ API"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/elixir.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Kuzu NIF for Elixir
description: "Use Kuzu graph database in Elixir applications through Native Implemented Functions (NIF)"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/go.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Go API
description: "Use Kuzu embedded graph database in Go applications with the official Go API"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Client APIs"
description: "Official and community client libraries for integrating Kuzu graph database into your applications"
---

import { LinkCard, CardGrid} from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/java.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Java API
description: "Use Kuzu embedded graph database in Java applications with the official Java API"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/net.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: .NET DLL wrapper
description: "Use Kuzu graph database in .NET applications with the community-contributed DLL wrapper"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/nim.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Nim API
description: "Use Kuzu graph database in Nim applications with the community-contributed Nim client"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/nodejs.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Node.js API
description: "Use Kuzu embedded graph database in Node.js applications with the official Node.js API"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/python.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Python API
description: "Use Kuzu embedded graph database in Python applications with the official Python API"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/ruby.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Ruby API
description: "Use Kuzu graph database in Ruby applications with the community-contributed Ruby client"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/rust.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Rust API
description: "Use Kuzu embedded graph database in Rust applications with the official Rust crate"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/swift.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Swift API
description: "Use Kuzu embedded graph database in Swift applications with the official Swift API"
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/client-apis/wasm.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: WebAssembly (Wasm)
description: "Run Kuzu graph database in web browsers using WebAssembly for client-side graph processing"
---

[WebAssembly](https://webassembly.org/), a.k.a. _Wasm_, is a standard defining any suitable low-level
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/concurrency.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Connections & Concurrency"
description: "Understanding Kuzu's concurrency model, connection handling, and best practices for parallel access"
---

:::caution[Note]
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/attach.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Attach/Detach to External Databases
description: "Connect to external Kuzu databases and other DBMSs for cross-database queries"
---
Using the `ATTACH` statement, you can connect to external Kuzu databases as well as several relational DBMSs.
These directories or files of external databases can be either local or in a remote file system. Here is a simple
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/data-definition/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Data definition language
description: "Commands to create, alter, and delete database objects including node and relationship tables"
---

import { CardGrid, LinkCard } from '@astrojs/starlight/components';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Example database
description: "Sample graph dataset with User and City nodes used in documentation examples"
---

We use the following example graph dataset that
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Data manipulation clauses
description: "CREATE, SET, DELETE, and MERGE commands for modifying graph data"
---

import { CardGrid, LinkCard } from '@astrojs/starlight/components';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: RETURN After Update
description: "Access and return data immediately after CREATE, MERGE, SET, or DELETE operations"
---

The `RETURN` clause following an update clause has access to the variables that are used in the immediately preceding update clause.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/data-types/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Data types
description: "Primitive and nested data types supported in Kuzu for properties and expressions"
---

import { LinkCard, CardGrid } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/data-types/list-and-array.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: LIST and ARRAY
description: "Variable-length LIST and fixed-length ARRAY data types for storing collections"
---

Kuzu supports two list-like data types: (i) variable-length lists, simply called `LIST`, and (ii)
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/difference.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Differences between Kuzu and Neo4j
description: "Key differences in syntax, schema requirements, and features between Kuzu and Neo4j"
---

If you're coming over from Neo4j, you can find the differences from Neo4j's keywords and syntax
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/expressions/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Functions, expressions & operators
description: "Built-in functions, expressions, and operators for data manipulation and computation"
---

import { LinkCard, CardGrid } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Cypher manual
description: High-level property graph query language manual with syntax, clauses, and features for graph database queries.
---

Cypher is a high-level query language for the property graph data model.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/macro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Create macros
description: "Define reusable Cypher expressions with parameters and default values using macros"
---

Kuzu allows you to define macros via custom C++ code in the catalog using the `create macro` statement.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/query-clauses/example-database.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Example database
description: "Sample graph dataset with User and City nodes used in query clause examples"
---

We use the following example graph dataset that
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/query-clauses/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Query clauses
description: "Core Cypher clauses for pattern matching, filtering, aggregation and result manipulation"
---

import { LinkCard, CardGrid } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/subquery.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Subqueries
description: "Use EXISTS and COUNT subqueries to check patterns and aggregate results within queries"
---

A subquery is a query that's called from an enclosing outer query, and executes within its own scope.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/cypher/transaction.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Transactions
description: "ACID-compliant transaction management with atomic, durable, and serializable operations"
---

Kuzu implements a transaction management subsystem that is atomic, durable and supports serializability.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Data type classes
description: "Understanding LogicalType and PhysicalType classes in Kuzu's internal architecture"
---

There are two data type classes in Kuzu, `LogicalType` and `PhysicalType`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Execution
description: "Query execution architecture including pipeline decomposition and morsel-driven parallelism"
---

## Pipeline
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Database internals
description: "Architecture overview of Kuzu's internal modules including parser, binder, planner, and storage"
---

## Database modules
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Vector types
description: "Kuzu's column-oriented in-memory data structures for efficient data processing"
---

## ValueVector
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/developer-guide/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Build Kuzu from source
description: Developer guide for building Kuzu from source code with CMake, Python, and C++20 compiler requirements.
---

:::caution[Note]
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/developer-guide/performance-debugging.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Performance Debugging
description: "Use EXPLAIN and PROFILE commands to debug query performance and view execution plans"
---

To see the query plans that Kuzu uses, you can
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/developer-guide/testing-framework.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Testing framework
description: "End-to-end testing framework for Kuzu using Cypher statements and .test files"
---

## Introduction
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/export/csv.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Export CSV
description: Export query results to CSV files with customizable formatting options including headers, delimiters, and quotes.
---

The `COPY TO` clause can export query results to a CSV file and is used as follows:
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/export/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Export data
description: Export query results from Kuzu to CSV, Parquet, and JSON file formats using the COPY TO command.
---

import { LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/export/json.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Export to JSON
description: Export query results to JSON files with support for nested data structures using the JSON extension.
---

The `COPY TO` clause can export query results to a JSON file. To use this feature, you have to install the
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/export/parquet.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Export Parquet
description: Export query results to Apache Parquet files with compression support for efficient columnar storage.
---

The `COPY TO` clause can export query results to a Parquet file. It can be combined with a subquery
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/algo/kcore.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: K-Core Decomposition
description: Find cohesive subgraphs where each node has at least k connections using the K-Core Decomposition algorithm.
---

K-Core Decomposition identifies subgraphs where every node has a degree of at least `k`.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/algo/louvain.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Louvain
description: Detect communities in large networks by maximizing modularity score using the hierarchical Louvain algorithm.
---

The Louvain algorithm extracts communities from large networks by maximizing their
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/algo/pagerank.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: PageRank
description: Rank node importance in networks by analyzing connections and link structure using the PageRank algorithm.
---

The PageRank algorithm ranks nodes in a network based on their importance by analyzing the connections
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/algo/path.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Shortest Paths
description: Compute shortest paths and weighted shortest paths between nodes using pattern matching in Cypher queries.
---

Kuzu supports shortest path and weighted shortest path through [pattern matching](/cypher/query-clauses/match#shortest-path).
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/algo/scc.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Strongly Connected Components
description: Identify maximal subgraphs with mutual reachability using parallel BFS or DFS-based SCC algorithms.
---

A strongly connected component (SCC) in a directed graph is a maximal subgraph where every pair of
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/algo/wcc.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Weakly Connected Components
description: Find connected components in directed graphs by treating edges as undirected using WCC algorithm.
---

Weak connectivity is a notion defined on undirected graphs. The weakly connected components (WCC) of an
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/attach/delta.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Delta Lake extension"
description: Scan and copy from Delta Lake tables using the delta extension with support for local and S3-hosted data.
---

The `delta` extension adds support for scanning/copying from the [`Delta Lake format`](https://delta.io/).
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/attach/duckdb.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: DuckDB extension
description: Attach to DuckDB databases for seamless data scanning and importing with comprehensive type mapping support.
---

The `duckdb` extension allows you to [attach](/extensions/attach/rdbms) DuckDB databases to Kuzu.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/attach/iceberg.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Iceberg extension"
description: Scan and copy from Apache Iceberg tables with metadata access and snapshot management capabilities.
---

The `iceberg` extension adds support for scanning and copying from the [Apache Iceberg format](https://iceberg.apache.org/).
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/attach/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Tabular data sources
description: Attach to external databases and data sources including PostgreSQL, DuckDB, SQLite, Delta Lake, and Iceberg tables.
---

import { Tabs, TabItem } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/attach/kuzu.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: External Kuzu databases
description: Attach to external Kuzu databases for read-only querying of local and remote database instances.
---

Using the `ATTACH` statement, you can connect to an external Kuzu database. The external Kuzu database can be local or remote, for example,
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/attach/postgres.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: PostgreSQL extension
description: Connect to PostgreSQL databases for scanning tables and importing data with SQL query support.
---

The `postgres` extension allows you to [attach](/extensions/attach/rdbms) PostgreSQL databases to Kuzu.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/attach/rdbms.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Attaching external RDBMS systems
description: Overview of relational database extensions for connecting to PostgreSQL, DuckDB, and SQLite databases.
---

import { CardGrid, LinkCard } from '@astrojs/starlight/components';
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/attach/sqlite.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: SQLite extension
description: Attach to SQLite databases for scanning and importing data with dynamic type system support.
---

The `sqlite` extension allows you to [attach](/extensions/attach/rdbms) SQLite databases to Kuzu.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/attach/unity.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Unity Catalog extension
description: Scan Delta Lake tables registered in Unity Catalog for lakehouse data integration (experimental feature).
---

This extension adds the ability to directly scan from delta tables registered in a Unity Catalog using the `LOAD FROM` statement.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/extensions/azure.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Azure extension"
description: "Scan and query data from Azure Blob Storage and Azure Data Lake Storage"
---
The `azure` extension allows you to scan data from [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-overview)
and [Azure Data Lake Storage (ADLS)](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction).
Expand Down
Loading