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
2 changes: 1 addition & 1 deletion astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +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: 'Files', link: '/developer-guide/files' },
{ label: 'On-disk files', link: '/developer-guide/files' },
{
label: 'Database internals',
items: [
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/client-apis/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 @@ -258,7 +258,7 @@ The `:max_rows` and `:max_width` commands can be used to control the number of r
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
4 changes: 2 additions & 2 deletions src/content/docs/client-apis/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,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
2 changes: 1 addition & 1 deletion 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 Down
4 changes: 2 additions & 2 deletions src/content/docs/client-apis/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ You can return all the columns of a node table by using the `*` wildcard in the
1 Karissa 40
2 Zhang 50
```
Return specific columns by name and optionally, alias them, as follows:
Return specific columns by name and optionally alias them as follows:
```py
result = conn.execute("MATCH (p:Person) RETURN p.name AS name")
print(result.get_as_df())
Expand Down Expand Up @@ -245,7 +245,7 @@ shape: (3, 2)
│ Zhang ┆ 50 │
└─────────┴───────┘
```
Return specific columns by name and optionally, alias them, as follows:
Return specific columns by name and optionally alias them as follows:
```py
result = conn.execute("MATCH (p:Person) RETURN p.name AS name")
print(result.get_as_pl())
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/concurrency.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ section below to get answers to common questions.
:::

In this section, we will go over the basics of how applications connect to a Kuzu database and list some
best practices on how to do so concurrently.
best practices for concurrent connection handling.

Kuzu supports both **on-disk** and **in-memory** modes of operation.
When operating under on-disk mode, your data and the underlying database files are stored in a
Expand Down Expand Up @@ -62,7 +62,7 @@ When working with in-memory databases, there are a few restrictions to keep in m

### Limitations of creating multiple Database objects
Kuzu is an embedded database, i.e., it is a library you embed inside an application process and run as part
of this application process, instead of a separate process.
of this application process, rather than as a separate process.
You can think of the Database object as the Kuzu database software.
Specifically, the Database object contains
different components of the Kuzu database software, such as its buffer manager, storage manager, transaction manager, etc.
Expand Down Expand Up @@ -165,7 +165,7 @@ as HTTP or gRPC). You are free to open any number of client processes that issue

Note that in terms of processes that embed Kuzu, this design pattern follows
[scenario 1](#scenario-1-one-process-that-creates-a-read_write-database) above as there is actually
one process that creates a `READ_WRITE` Database object. To enable users to get up and running with such an architecture,
one process that creates a `READ_WRITE` Database object. To enable you to get up and running with such an architecture,
we provide a REST-style [Kuzu API server](https://github.com/kuzudb/api-server) powered by Express.js.
Pictorially, this design pattern looks as follows:

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/cypher/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Connection and database configuration"
---

The configuration of a Kuzu database or a connection to the database can be changed through a standalone `CALL`
statement, described in this section. Different from [the `CALL` clause](/cypher/query-clauses/call), this statement of changing
statement, described in this section. Different from [the `CALL` clause](/cypher/query-clauses/call), this statement for changing
configuration **cannot** be used with other query clauses, such as `RETURN`.

### Connection configuration
Expand All @@ -19,7 +19,7 @@ configuration **cannot** be used with other query clauses, such as `RETURN`.
| `PROGRESS_BAR` | enable progress bar in CLI | false |
| `CHECKPOINT_THRESHOLD` | the WAL size threshold in bytes at which to automatically trigger a checkpoint | 16777216 (16MB) |
| `WARNING_LIMIT` | maximum number of [warnings](/import#warnings-table-inspecting-skipped-rows) that can be stored in a single connection. | 8192 |
| `SPILL_TO_DISK` | spill data disk if there is not enough memory when running `COPY FROM (cannot be set to TRUE under in-memory or read-only mode) | true |
| `SPILL_TO_DISK` | spill data to disk if there is not enough memory when running `COPY FROM` (cannot be set to TRUE under in-memory or read-only mode) | true |

### Database configuration
| Option | Description | Default |
Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/cypher/data-definition/alter.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: Alter DDL statements

## Add column

`ADD COLUMN` allows you to add a new column to a node/rel table. If you don't specify a default value, the newly added column is filled with `NULLs`.
`ADD COLUMN` allows you to add a new column to a node or relationship table. If you don't specify a default value, the newly added column is filled with `NULL` values.

Column names must be unique within a node/relationship table.
Column names must be unique within a node or relationship table.

For example, consider that you try to run the following command to add a column `age`, but it
already exists in the `User` table:
Expand Down Expand Up @@ -105,7 +105,7 @@ ALTER TABLE Follows DROP IF EXISTS FROM User TO Celebrity;

## Rename table

`RENAME TABLE` allows the user to rename a table.
`RENAME TABLE` allows you to rename a table.

The following query renames table User to Student.
```sql
Expand All @@ -114,7 +114,7 @@ ALTER TABLE User RENAME TO Student;

## Rename column

`RENAME COLUMN` allows the user to rename a column of a table.<br />
`RENAME COLUMN` allows you to rename a column of a table.<br />

The following query renames the age column to grade.
```sql
Expand All @@ -129,7 +129,7 @@ The following query adds a comment to `User` table.
```sql
COMMENT ON TABLE User IS 'User information';
```
Comments can be extracted through `SHOW_TABLES()` function. See [CALL](https://docs.kuzudb.com/query-clauses/call) for more information.
Comments can be extracted through the `SHOW_TABLES()` function. See [CALL](/cypher/query-clauses/call) for more information.
```sql
CALL SHOW_TABLES() RETURN *;
--------------------------------------------
Expand Down
Loading