Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
6fb12ff
chore: auto update docs
Oct 3, 2022
9a31223
chore: auto update docs
Oct 17, 2022
6cdc96b
chore: auto update docs
Oct 24, 2022
f798877
chore: auto update docs
Oct 31, 2022
d176e3e
chore: auto update docs
Nov 14, 2022
3201192
chore: auto update docs
Nov 21, 2022
d51b6b8
chore: auto update docs
Nov 28, 2022
9993be6
chore: auto update docs
Dec 5, 2022
d2ccb8b
chore: auto update docs
Dec 12, 2022
d98d755
chore: auto update docs
Dec 19, 2022
4b304fd
chore: auto update docs
Dec 26, 2022
b18fb0f
chore: auto update docs
Jan 16, 2023
cc7ef0b
chore: auto update docs
Jan 23, 2023
a9aef53
chore: auto update docs
Jan 30, 2023
83ba13f
chore: auto update docs
Feb 13, 2023
2c261a5
chore: auto update docs
Feb 20, 2023
ee6c987
chore: auto update docs
Mar 6, 2023
666a1c1
chore: auto update docs
Mar 13, 2023
362e94b
chore: auto update docs
Mar 27, 2023
818b70d
chore: auto update docs
Apr 3, 2023
44f1f04
chore: auto update docs
Apr 10, 2023
717842d
chore: auto update docs
Apr 17, 2023
58d05ae
chore: auto update docs
Apr 24, 2023
79a73ef
chore: auto update docs
May 1, 2023
b65031e
chore: auto update docs
May 8, 2023
eb8cc17
chore: auto update docs
May 15, 2023
2c6181d
chore: auto update docs
May 22, 2023
ad7309a
chore: auto update docs
May 29, 2023
22c99f7
chore: auto update docs
Jun 5, 2023
ca580f7
chore: auto update docs
Jun 12, 2023
a36f167
chore: auto update docs
Jun 19, 2023
8c83a2f
chore: auto update docs
Jun 26, 2023
e8167fd
chore: auto update docs
Jul 3, 2023
6f9f6cb
chore: auto update docs
Jul 10, 2023
4be61af
chore: auto update docs
Jul 24, 2023
88046a2
chore: auto update docs
Jul 31, 2023
0a9ebb9
chore: auto update docs
Aug 7, 2023
91a7e0e
chore: auto update docs
Aug 14, 2023
c284ee5
chore: auto update docs
Aug 21, 2023
6a6611d
chore: auto update docs
Aug 28, 2023
9afe316
chore: auto update docs
Sep 4, 2023
952b763
chore: auto update docs
Sep 11, 2023
508c5d4
chore: auto update docs
Sep 18, 2023
790dfe8
chore: auto update docs
Sep 25, 2023
c27b89f
chore: auto update docs
Oct 2, 2023
35bd750
chore: auto update docs
Oct 9, 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
1,294 changes: 647 additions & 647 deletions _data/search_data.json

Large diffs are not rendered by default.

805 changes: 792 additions & 13 deletions docs/api/c/api.md

Large diffs are not rendered by default.

62 changes: 60 additions & 2 deletions docs/api/c/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,16 @@ duckdb_close(&db);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_open_ext">duckdb_open_ext</a></span>(<span class="kt">const</span> <span class="kt">char</span> *<span class="k">path</span>, <span class="kt">duckdb_database</span> *<span class="k">out_database</span>, <span class="kt">duckdb_config</span> <span class="k">config</span>, <span class="kt">char</span> **<span class="k">out_error</span>);
<span class="kt">void</span> <span class="nf"><a href="#duckdb_close">duckdb_close</a></span>(<span class="kt">duckdb_database</span> *<span class="k">database</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_connect">duckdb_connect</a></span>(<span class="kt">duckdb_database</span> <span class="k">database</span>, <span class="kt">duckdb_connection</span> *<span class="k">out_connection</span>);
<span class="kt">void</span> <span class="nf"><a href="#duckdb_interrupt">duckdb_interrupt</a></span>(<span class="kt">duckdb_connection</span> <span class="k">connection</span>);
<span class="kt">double</span> <span class="nf"><a href="#duckdb_query_progress">duckdb_query_progress</a></span>(<span class="kt">duckdb_connection</span> <span class="k">connection</span>);
<span class="kt">void</span> <span class="nf"><a href="#duckdb_disconnect">duckdb_disconnect</a></span>(<span class="kt">duckdb_connection</span> *<span class="k">connection</span>);
<span class="kt">const</span> <span class="kt">char</span> *<span class="nf"><a href="#duckdb_library_version">duckdb_library_version</a></span>();
</code></pre></div></div>
### duckdb_open
---
Creates a new database or opens an existing database file stored at the the given path.
Creates a new database or opens an existing database file stored at the given path.
If no path is given a new in-memory database is created instead.
The instantiated database should be closed with 'duckdb_close'

#### Syntax
---
Expand All @@ -63,7 +67,7 @@ The result database object.

### duckdb_open_ext
---
Extended version of duckdb_open. Creates a new database or opens an existing database file stored at the the given path.
Extended version of duckdb_open. Creates a new database or opens an existing database file stored at the given path.

#### Syntax
---
Expand Down Expand Up @@ -120,6 +124,7 @@ The database object to shut down.
---
Opens a connection to a database. Connections are required to query the database, and store transactional state
associated with the connection.
The instantiated connection should be closed using 'duckdb_disconnect'

#### Syntax
---
Expand All @@ -142,6 +147,45 @@ The result connection object.

<br>

### duckdb_interrupt
---
Interrupt running query

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="k">duckdb_interrupt</span>(<span class="k">
</span> <span class="kt">duckdb_connection</span> <span class="k">connection
</span>);
</code></pre></div></div>
#### Parameters
---
* `connection`

The connection to interruot

<br>

### duckdb_query_progress
---
Get progress of the running query

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">double</span> <span class="k">duckdb_query_progress</span>(<span class="k">
</span> <span class="kt">duckdb_connection</span> <span class="k">connection
</span>);
</code></pre></div></div>
#### Parameters
---
* `connection`

The working connection
* `returns`

-1 if no progress or a percentage of the progress

<br>

### duckdb_disconnect
---
Closes the specified connection and de-allocates all memory allocated for that connection.
Expand All @@ -160,3 +204,17 @@ The connection to close.

<br>

### duckdb_library_version
---
Returns the version of the linked DuckDB, with a version postfix for dev versions

Usually used for developing C extensions that must return this for a compatibility check.

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">const</span> <span class="kt">char</span> *<span class="k">duckdb_library_version</span>(<span class="k">
</span> <span class="k">
</span>);
</code></pre></div></div>
<br>

58 changes: 55 additions & 3 deletions docs/api/c/data_chunk.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ The primary manner of interfacing with data chunks is by obtaining the internal
<span class="kt">void</span> <span class="nf"><a href="#duckdb_vector_assign_string_element_len">duckdb_vector_assign_string_element_len</a></span>(<span class="kt">duckdb_vector</span> <span class="k">vector</span>, <span class="kt">idx_t</span> <span class="k">index</span>, <span class="kt">const</span> <span class="kt">char</span> *<span class="k">str</span>, <span class="kt">idx_t</span> <span class="k">str_len</span>);
<span class="kt">duckdb_vector</span> <span class="nf"><a href="#duckdb_list_vector_get_child">duckdb_list_vector_get_child</a></span>(<span class="kt">duckdb_vector</span> <span class="k">vector</span>);
<span class="kt">idx_t</span> <span class="nf"><a href="#duckdb_list_vector_get_size">duckdb_list_vector_get_size</a></span>(<span class="kt">duckdb_vector</span> <span class="k">vector</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_list_vector_set_size">duckdb_list_vector_set_size</a></span>(<span class="kt">duckdb_vector</span> <span class="k">vector</span>, <span class="kt">idx_t</span> <span class="k">size</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_list_vector_reserve">duckdb_list_vector_reserve</a></span>(<span class="kt">duckdb_vector</span> <span class="k">vector</span>, <span class="kt">idx_t</span> <span class="k">required_capacity</span>);
<span class="kt">duckdb_vector</span> <span class="nf"><a href="#duckdb_struct_vector_get_child">duckdb_struct_vector_get_child</a></span>(<span class="kt">duckdb_vector</span> <span class="k">vector</span>, <span class="kt">idx_t</span> <span class="k">index</span>);
</code></pre></div></div>
#### Validity Mask Functions
Expand Down Expand Up @@ -391,6 +393,56 @@ The size of the child list

<br>

### duckdb_list_vector_set_size
---
Sets the total size of the underlying child-vector of a list vector.

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="k">duckdb_list_vector_set_size</span>(<span class="k">
</span> <span class="kt">duckdb_vector</span> <span class="k">vector</span>,<span class="k">
</span> <span class="kt">idx_t</span> <span class="k">size
</span>);
</code></pre></div></div>
#### Parameters
---
* `vector`

The list vector.
* `size`

The size of the child list.
* `returns`

The duckdb state. Returns DuckDBError if the vector is nullptr.

<br>

### duckdb_list_vector_reserve
---
Sets the total capacity of the underlying child-vector of a list.

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="k">duckdb_list_vector_reserve</span>(<span class="k">
</span> <span class="kt">duckdb_vector</span> <span class="k">vector</span>,<span class="k">
</span> <span class="kt">idx_t</span> <span class="k">required_capacity
</span>);
</code></pre></div></div>
#### Parameters
---
* `vector`

The list vector.
* `required_capacity`

the total capacity to reserve.
* `return`

The duckdb state. Returns DuckDBError if the vector is nullptr.

<br>

### duckdb_struct_vector_get_child
---
Retrieves the child vector of a struct vector.
Expand Down Expand Up @@ -433,7 +485,7 @@ Returns whether or not a row is valid (i.e. not NULL) in the given validity mask
---
* `validity`

The validity mask, as obtained through `duckdb_data_chunk_get_validity`
The validity mask, as obtained through `duckdb_vector_get_validity`
* `row`

The row index
Expand All @@ -447,7 +499,7 @@ true if the row is valid, false otherwise
---
In a validity mask, sets a specific row to either valid or invalid.

Note that `duckdb_data_chunk_ensure_validity_writable` should be called before calling `duckdb_data_chunk_get_validity`,
Note that `duckdb_vector_ensure_validity_writable` should be called before calling `duckdb_vector_get_validity`,
to ensure that there is a validity mask to write to.

#### Syntax
Expand All @@ -462,7 +514,7 @@ to ensure that there is a validity mask to write to.
---
* `validity`

The validity mask, as obtained through `duckdb_data_chunk_get_validity`.
The validity mask, as obtained through `duckdb_vector_get_validity`.
* `row`

The row index
Expand Down
Loading