Skip to content
Open
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
96 changes: 76 additions & 20 deletions data/search_data.json

Large diffs are not rendered by default.

235 changes: 227 additions & 8 deletions docs/api/c/api.md

Large diffs are not rendered by default.

45 changes: 43 additions & 2 deletions docs/api/c/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,14 @@ 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'

Expand All @@ -65,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 @@ -145,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 Down
6 changes: 3 additions & 3 deletions docs/api/c/data_chunk.md
Original file line number Diff line number Diff line change
Expand Up @@ -485,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 @@ -499,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 @@ -514,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
104 changes: 101 additions & 3 deletions docs/api/c/prepared.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ It is not required that the `duckdb_bind` family of functions matches the prepar
<span class="kt">idx_t</span> <span class="nf"><a href="#duckdb_nparams">duckdb_nparams</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>);
<span class="k">duckdb_type</span> <span class="nf"><a href="#duckdb_param_type">duckdb_param_type</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>, <span class="kt">idx_t</span> <span class="k">param_idx</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_clear_bindings">duckdb_clear_bindings</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_bind_value">duckdb_bind_value</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>, <span class="kt">idx_t</span> <span class="k">param_idx</span>, <span class="kt">duckdb_value</span> <span class="k">val</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_bind_parameter_index">duckdb_bind_parameter_index</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>, <span class="kt">idx_t</span> *<span class="k">param_idx_out</span>, <span class="kt">const</span> <span class="kt">char</span> *<span class="k">name</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_bind_boolean">duckdb_bind_boolean</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>, <span class="kt">idx_t</span> <span class="k">param_idx</span>, <span class="kt">bool</span> <span class="k">val</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_bind_int8">duckdb_bind_int8</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>, <span class="kt">idx_t</span> <span class="k">param_idx</span>, <span class="kt">int8_t</span> <span class="k">val</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_bind_int16">duckdb_bind_int16</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>, <span class="kt">idx_t</span> <span class="k">param_idx</span>, <span class="kt">int16_t</span> <span class="k">val</span>);
Expand All @@ -76,6 +78,8 @@ It is not required that the `duckdb_bind` family of functions matches the prepar
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_bind_null">duckdb_bind_null</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>, <span class="kt">idx_t</span> <span class="k">param_idx</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_execute_prepared">duckdb_execute_prepared</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>, <span class="kt">duckdb_result</span> *<span class="k">out_result</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_execute_prepared_arrow">duckdb_execute_prepared_arrow</a></span>(<span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>, <span class="kt">duckdb_arrow</span> *<span class="k">out_result</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_arrow_scan">duckdb_arrow_scan</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="k">table_name</span>, <span class="k">duckdb_arrow_stream</span> <span class="k">arrow</span>);
<span class="kt">duckdb_state</span> <span class="nf"><a href="#duckdb_arrow_array_scan">duckdb_arrow_array_scan</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="k">table_name</span>, <span class="kt">duckdb_arrow_schema</span> <span class="k">arrow_schema</span>, <span class="kt">duckdb_arrow_array</span> <span class="k">arrow_array</span>, <span class="k">duckdb_arrow_stream</span> *<span class="k">out_stream</span>);
</code></pre></div></div>
### duckdb_prepare
---
Expand Down Expand Up @@ -212,6 +216,34 @@ Clear the params bind to the prepared statement.
</code></pre></div></div>
<br>

### duckdb_bind_value
---
Binds a value to the prepared statement at the specified index.

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="k">duckdb_bind_value</span>(<span class="k">
</span> <span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>,<span class="k">
</span> <span class="kt">idx_t</span> <span class="k">param_idx</span>,<span class="k">
</span> <span class="kt">duckdb_value</span> <span class="k">val
</span>);
</code></pre></div></div>
<br>

### duckdb_bind_parameter_index
---
Retrieve the index of the parameter for the prepared statement, identified by name

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="k">duckdb_bind_parameter_index</span>(<span class="k">
</span> <span class="kt">duckdb_prepared_statement</span> <span class="k">prepared_statement</span>,<span class="k">
</span> <span class="kt">idx_t</span> *<span class="k">param_idx_out</span>,<span class="k">
</span> <span class="kt">const</span> <span class="kt">char</span> *<span class="k">name
</span>);
</code></pre></div></div>
<br>

### duckdb_bind_boolean
---
Binds a bool value to the prepared statement at the specified index.
Expand Down Expand Up @@ -284,7 +316,7 @@ Binds an int64_t value to the prepared statement at the specified index.

### duckdb_bind_hugeint
---
Binds an duckdb_hugeint value to the prepared statement at the specified index.
Binds a duckdb_hugeint value to the prepared statement at the specified index.

#### Syntax
---
Expand Down Expand Up @@ -368,7 +400,7 @@ Binds an uint64_t value to the prepared statement at the specified index.

### duckdb_bind_float
---
Binds an float value to the prepared statement at the specified index.
Binds a float value to the prepared statement at the specified index.

#### Syntax
---
Expand All @@ -382,7 +414,7 @@ Binds an float value to the prepared statement at the specified index.

### duckdb_bind_double
---
Binds an double value to the prepared statement at the specified index.
Binds a double value to the prepared statement at the specified index.

#### Syntax
---
Expand Down Expand Up @@ -560,3 +592,69 @@ The query result.

<br>

### duckdb_arrow_scan
---
Scans the Arrow stream and creates a view with the given name.

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="k">duckdb_arrow_scan</span>(<span class="k">
</span> <span class="kt">duckdb_connection</span> <span class="k">connection</span>,<span class="k">
</span> <span class="kt">const</span> <span class="kt">char</span> *<span class="k">table_name</span>,<span class="k">
</span> <span class="k">duckdb_arrow_stream</span> <span class="k">arrow
</span>);
</code></pre></div></div>
#### Parameters
---
* `connection`

The connection on which to execute the scan.
* `table_name`

Name of the temporary view to create.
* `arrow`

Arrow stream wrapper.
* `returns`

`DuckDBSuccess` on success or `DuckDBError` on failure.

<br>

### duckdb_arrow_array_scan
---
Scans the Arrow array and creates a view with the given name.

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="k">duckdb_arrow_array_scan</span>(<span class="k">
</span> <span class="kt">duckdb_connection</span> <span class="k">connection</span>,<span class="k">
</span> <span class="kt">const</span> <span class="kt">char</span> *<span class="k">table_name</span>,<span class="k">
</span> <span class="kt">duckdb_arrow_schema</span> <span class="k">arrow_schema</span>,<span class="k">
</span> <span class="kt">duckdb_arrow_array</span> <span class="k">arrow_array</span>,<span class="k">
</span> <span class="k">duckdb_arrow_stream</span> *<span class="k">out_stream
</span>);
</code></pre></div></div>
#### Parameters
---
* `connection`

The connection on which to execute the scan.
* `table_name`

Name of the temporary view to create.
* `arrow_schema`

Arrow schema wrapper.
* `arrow_array`

Arrow array wrapper.
* `out_stream`

Output array stream that wraps around the passed schema, for releasing/deleting once done.
* `returns`

`DuckDBSuccess` on success or `DuckDBError` on failure.

<br>

31 changes: 31 additions & 0 deletions docs/api/c/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ For more information about data chunks, see the [documentation on data chunks](d
<span class="kt">duckdb_logical_type</span> <span class="nf"><a href="#duckdb_create_list_type">duckdb_create_list_type</a></span>(<span class="kt">duckdb_logical_type</span> <span class="k">type</span>);
<span class="kt">duckdb_logical_type</span> <span class="nf"><a href="#duckdb_create_map_type">duckdb_create_map_type</a></span>(<span class="kt">duckdb_logical_type</span> <span class="k">key_type</span>, <span class="kt">duckdb_logical_type</span> <span class="k">value_type</span>);
<span class="kt">duckdb_logical_type</span> <span class="nf"><a href="#duckdb_create_union_type">duckdb_create_union_type</a></span>(<span class="kt">duckdb_logical_type</span> <span class="k">member_types</span>, <span class="kt">const</span> <span class="kt">char</span> **<span class="k">member_names</span>, <span class="kt">idx_t</span> <span class="k">member_count</span>);
<span class="kt">duckdb_logical_type</span> <span class="nf"><a href="#duckdb_create_struct_type">duckdb_create_struct_type</a></span>(<span class="kt">duckdb_logical_type</span> *<span class="k">member_types</span>, <span class="kt">const</span> <span class="kt">char</span> **<span class="k">member_names</span>, <span class="kt">idx_t</span> <span class="k">member_count</span>);
<span class="kt">duckdb_logical_type</span> <span class="nf"><a href="#duckdb_create_decimal_type">duckdb_create_decimal_type</a></span>(<span class="kt">uint8_t</span> <span class="k">width</span>, <span class="kt">uint8_t</span> <span class="k">scale</span>);
<span class="k">duckdb_type</span> <span class="nf"><a href="#duckdb_get_type_id">duckdb_get_type_id</a></span>(<span class="kt">duckdb_logical_type</span> <span class="k">type</span>);
<span class="kt">uint8_t</span> <span class="nf"><a href="#duckdb_decimal_width">duckdb_decimal_width</a></span>(<span class="kt">duckdb_logical_type</span> <span class="k">type</span>);
Expand Down Expand Up @@ -938,6 +939,36 @@ The logical type.

<br>

### duckdb_create_struct_type
---
Creates a STRUCT type from the passed member name and type arrays.
The resulting type should be destroyed with `duckdb_destroy_logical_type`.

#### Syntax
---
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_logical_type</span> <span class="k">duckdb_create_struct_type</span>(<span class="k">
</span> <span class="kt">duckdb_logical_type</span> *<span class="k">member_types</span>,<span class="k">
</span> <span class="kt">const</span> <span class="kt">char</span> **<span class="k">member_names</span>,<span class="k">
</span> <span class="kt">idx_t</span> <span class="k">member_count
</span>);
</code></pre></div></div>
#### Parameters
---
* `member_types`

The array of types that the struct should consist of.
* `member_names`

The array of names that the struct should consist of.
* `member_count`

The number of members that were specified for both arrays.
* `returns`

The logical type.

<br>

### duckdb_create_decimal_type
---
Creates a `duckdb_logical_type` of type decimal with the specified width and scale
Expand Down
19 changes: 16 additions & 3 deletions docs/api/nodejs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ selected: Client APIs
<a name="module_duckdb"></a>

## duckdb
**Summary**: these jsdoc annotations are still a work in progress - feedback and suggestions are welcome!
**Summary**: DuckDB is an embeddable SQL OLAP Database Management System

* [duckdb](#module_duckdb)
* [~Connection](#module_duckdb..Connection)
Expand All @@ -43,6 +43,7 @@ selected: Client APIs
* [.unregister_udf(name, return_type, callback)](#module_duckdb..Connection+unregister_udf) ⇒ <code>void</code>
* [.register_buffer(name, array, force, callback)](#module_duckdb..Connection+register_buffer) ⇒ <code>void</code>
* [.unregister_buffer(name, callback)](#module_duckdb..Connection+unregister_buffer) ⇒ <code>void</code>
* [.close(callback)](#module_duckdb..Connection+close) ⇒ <code>void</code>
* [~Statement](#module_duckdb..Statement)
* [.sql](#module_duckdb..Statement+sql) ⇒
* [.get()](#module_duckdb..Statement+get)
Expand Down Expand Up @@ -106,6 +107,7 @@ selected: Client APIs
* [.unregister_udf(name, return_type, callback)](#module_duckdb..Connection+unregister_udf) ⇒ <code>void</code>
* [.register_buffer(name, array, force, callback)](#module_duckdb..Connection+register_buffer) ⇒ <code>void</code>
* [.unregister_buffer(name, callback)](#module_duckdb..Connection+unregister_buffer) ⇒ <code>void</code>
* [.close(callback)](#module_duckdb..Connection+close) ⇒ <code>void</code>

<a name="module_duckdb..Connection+run"></a>

Expand Down Expand Up @@ -277,6 +279,17 @@ Unregister the Buffer
| name |
| callback |

<a name="module_duckdb..Connection+close"></a>

#### connection.close(callback) ⇒ <code>void</code>
Closes connection

**Kind**: instance method of [<code>Connection</code>](#module_duckdb..Connection)

| Param |
| --- |
| callback |

<a name="module_duckdb..Statement"></a>

### duckdb~Statement
Expand Down Expand Up @@ -476,7 +489,7 @@ Triggers callback when all scheduled database tasks have completed.
<a name="module_duckdb..Database+serialize"></a>

#### database.serialize(callback) ⇒ <code>void</code>
TODO: what does this do?
Currently a no-op. Provided for SQLite compatibility

**Kind**: instance method of [<code>Database</code>](#module_duckdb..Database)

Expand All @@ -487,7 +500,7 @@ TODO: what does this do?
<a name="module_duckdb..Database+parallelize"></a>

#### database.parallelize(callback) ⇒ <code>void</code>
TODO: what does this do?
Currently a no-op. Provided for SQLite compatibility

**Kind**: instance method of [<code>Database</code>](#module_duckdb..Database)

Expand Down
Loading