Skip to content

Commit 8d2ddcd

Browse files
authored
Merge pull request #3729 from szarnyasg/c-api-regen
C API scripts fix and regeneration
2 parents e1ea900 + 1075639 commit 8d2ddcd

File tree

15 files changed

+6923
-1694
lines changed

15 files changed

+6923
-1694
lines changed

docs/api/c/api.md

Lines changed: 4325 additions & 1029 deletions
Large diffs are not rendered by default.

docs/api/c/appender.md

Lines changed: 101 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ duckdb_appender_destroy(&appender);
4040
4141
<!-- This section is generated by scripts/generate_c_api_docs.py -->
4242
43-
<span class="kt">duckdb_state</span> <a href="#duckdb_appender_create"><span class="nf">duckdb_appender_create</span></a>(<span class="kt">duckdb_connection</span> <span class="nv">connection</span>, <span class="kt">const</span> <span class="kt">char</span> *<span class="nv">schema</span>, <span class="kt">const</span> <span class="kt">char</span> *<span class="nv">table</span>, <span class="kt">duckdb_appender</span> *<span class="nv">out_appender</span>);
43+
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <a href="#duckdb_appender_create"><span class="nf">duckdb_appender_create</span></a>(<span class="kt">duckdb_connection</span> <span class="nv">connection</span>, <span class="kt">const</span> <span class="kt">char</span> *<span class="nv">schema</span>, <span class="kt">const</span> <span class="kt">char</span> *<span class="nv">table</span>, <span class="kt">duckdb_appender</span> *<span class="nv">out_appender</span>);
4444
<span class="kt">idx_t</span> <a href="#duckdb_appender_column_count"><span class="nf">duckdb_appender_column_count</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>);
4545
<span class="kt">duckdb_logical_type</span> <a href="#duckdb_appender_column_type"><span class="nf">duckdb_appender_column_type</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>, <span class="kt">idx_t</span> <span class="nv">col_idx</span>);
4646
<span class="kt">const</span> <span class="kt">char</span> *<a href="#duckdb_appender_error"><span class="nf">duckdb_appender_error</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>);
@@ -49,6 +49,7 @@ duckdb_appender_destroy(&appender);
4949
<span class="kt">duckdb_state</span> <a href="#duckdb_appender_destroy"><span class="nf">duckdb_appender_destroy</span></a>(<span class="kt">duckdb_appender</span> *<span class="nv">appender</span>);
5050
<span class="kt">duckdb_state</span> <a href="#duckdb_appender_begin_row"><span class="nf">duckdb_appender_begin_row</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>);
5151
<span class="kt">duckdb_state</span> <a href="#duckdb_appender_end_row"><span class="nf">duckdb_appender_end_row</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>);
52+
<span class="kt">duckdb_state</span> <a href="#duckdb_append_default"><span class="nf">duckdb_append_default</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>);
5253
<span class="kt">duckdb_state</span> <a href="#duckdb_append_bool"><span class="nf">duckdb_append_bool</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>, <span class="kt">bool</span> <span class="nv">value</span>);
5354
<span class="kt">duckdb_state</span> <a href="#duckdb_append_int8"><span class="nf">duckdb_append_int8</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>, <span class="kt">int8_t</span> <span class="nv">value</span>);
5455
<span class="kt">duckdb_state</span> <a href="#duckdb_append_int16"><span class="nf">duckdb_append_int16</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>, <span class="kt">int16_t</span> <span class="nv">value</span>);
@@ -71,19 +72,14 @@ duckdb_appender_destroy(&appender);
7172
<span class="kt">duckdb_state</span> <a href="#duckdb_append_blob"><span class="nf">duckdb_append_blob</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>, <span class="kt">const</span> <span class="kt">void</span> *<span class="nv">data</span>, <span class="kt">idx_t</span> <span class="nv">length</span>);
7273
<span class="kt">duckdb_state</span> <a href="#duckdb_append_null"><span class="nf">duckdb_append_null</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>);
7374
<span class="kt">duckdb_state</span> <a href="#duckdb_append_data_chunk"><span class="nf">duckdb_append_data_chunk</span></a>(<span class="kt">duckdb_appender</span> <span class="nv">appender</span>, <span class="kt">duckdb_data_chunk</span> <span class="nv">chunk</span>);
75+
</code></pre></div></div>
7476
7577
#### `duckdb_appender_create`
7678
7779
Creates an appender object.
7880
7981
Note that the object must be destroyed with `duckdb_appender_destroy`.
8082
81-
* connection: The connection context to create the appender in.
82-
* schema: The schema of the table to append to, or `nullptr` for the default schema.
83-
* table: The table name to append to.
84-
* out_appender: The resulting appender object.
85-
* returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
86-
8783
##### Syntax
8884
8985
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="nv">duckdb_appender_create</span>(<span class="nv">
@@ -93,21 +89,39 @@ Note that the object must be destroyed with `duckdb_appender_destroy`.
9389
</span> <span class="kt">duckdb_appender</span> *<span class="nv">out_appender
9490
</span>);
9591
</code></pre></div></div>
92+
93+
##### Parameters
94+
95+
* `connection`: The connection context to create the appender in.
96+
* `schema`: The schema of the table to append to, or `nullptr` for the default schema.
97+
* `table`: The table name to append to.
98+
* `out_appender`: The resulting appender object.
99+
100+
##### Return Value
101+
102+
`DuckDBSuccess` on success or `DuckDBError` on failure.
103+
96104
<br>
97105
98106
#### `duckdb_appender_column_count`
99107
100108
Returns the number of columns in the table that belongs to the appender.
101109
102-
* appender The appender to get the column count from.
103-
* returns: The number of columns in the table.
104-
105110
##### Syntax
106111
107112
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">idx_t</span> <span class="nv">duckdb_appender_column_count</span>(<span class="nv">
108113
</span> <span class="kt">duckdb_appender</span> <span class="nv">appender
109114
</span>);
110115
</code></pre></div></div>
116+
117+
##### Parameters
118+
119+
* `appender`: The appender to get the column count from.
120+
121+
##### Return Value
122+
123+
The number of columns in the table.
124+
111125
<br>
112126
113127
#### `duckdb_appender_column_type`
@@ -116,17 +130,23 @@ Returns the type of the column at the specified index.
116130
117131
Note: The resulting type should be destroyed with `duckdb_destroy_logical_type`.
118132
119-
* appender The appender to get the column type from.
120-
* col_idx The index of the column to get the type of.
121-
* returns: The duckdb_logical_type of the column.
122-
123133
##### Syntax
124134
125135
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_logical_type</span> <span class="nv">duckdb_appender_column_type</span>(<span class="nv">
126136
</span> <span class="kt">duckdb_appender</span> <span class="nv">appender</span>,<span class="nv">
127137
</span> <span class="kt">idx_t</span> <span class="nv">col_idx
128138
</span>);
129139
</code></pre></div></div>
140+
141+
##### Parameters
142+
143+
* `appender`: The appender to get the column type from.
144+
* `col_idx`: The index of the column to get the type of.
145+
146+
##### Return Value
147+
148+
The duckdb_logical_type of the column.
149+
130150
<br>
131151
132152
#### `duckdb_appender_error`
@@ -136,15 +156,21 @@ If the appender has no error message, this returns `nullptr` instead.
136156
137157
The error message should not be freed. It will be de-allocated when `duckdb_appender_destroy` is called.
138158
139-
* appender: The appender to get the error from.
140-
* returns: The error message, or `nullptr` if there is none.
141-
142159
##### Syntax
143160
144161
<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="nv">duckdb_appender_error</span>(<span class="nv">
145162
</span> <span class="kt">duckdb_appender</span> <span class="nv">appender
146163
</span>);
147164
</code></pre></div></div>
165+
166+
##### Parameters
167+
168+
* `appender`: The appender to get the error from.
169+
170+
##### Return Value
171+
172+
The error message, or `nullptr` if there is none.
173+
148174
<br>
149175
150176
#### `duckdb_appender_flush`
@@ -154,15 +180,21 @@ constraint violation or any other error, then all data is invalidated, and this
154180
It is not possible to append more values. Call duckdb_appender_error to obtain the error message followed by
155181
duckdb_appender_destroy to destroy the invalidated appender.
156182
157-
* appender: The appender to flush.
158-
* returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
159-
160183
##### Syntax
161184
162185
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="nv">duckdb_appender_flush</span>(<span class="nv">
163186
</span> <span class="kt">duckdb_appender</span> <span class="nv">appender
164187
</span>);
165188
</code></pre></div></div>
189+
190+
##### Parameters
191+
192+
* `appender`: The appender to flush.
193+
194+
##### Return Value
195+
196+
`DuckDBSuccess` on success or `DuckDBError` on failure.
197+
166198
<br>
167199
168200
#### `duckdb_appender_close`
@@ -172,15 +204,21 @@ triggers a constraint violation or any other error, then all data is invalidated
172204
Call duckdb_appender_error to obtain the error message followed by duckdb_appender_destroy to destroy the invalidated
173205
appender.
174206
175-
* appender: The appender to flush and close.
176-
* returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
177-
178207
##### Syntax
179208
180209
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="nv">duckdb_appender_close</span>(<span class="nv">
181210
</span> <span class="kt">duckdb_appender</span> <span class="nv">appender
182211
</span>);
183212
</code></pre></div></div>
213+
214+
##### Parameters
215+
216+
* `appender`: The appender to flush and close.
217+
218+
##### Return Value
219+
220+
`DuckDBSuccess` on success or `DuckDBError` on failure.
221+
184222
<br>
185223
186224
#### `duckdb_appender_destroy`
@@ -191,15 +229,21 @@ then all data is invalidated, and this function returns DuckDBError. Due to the
191229
longer possible to obtain the specific error message with duckdb_appender_error. Therefore, call duckdb_appender_close
192230
before destroying the appender, if you need insights into the specific error.
193231
194-
* appender: The appender to flush, close and destroy.
195-
* returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
196-
197232
##### Syntax
198233
199234
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="nv">duckdb_appender_destroy</span>(<span class="nv">
200235
</span> <span class="kt">duckdb_appender</span> *<span class="nv">appender
201236
</span>);
202237
</code></pre></div></div>
238+
239+
##### Parameters
240+
241+
* `appender`: The appender to flush, close and destroy.
242+
243+
##### Return Value
244+
245+
`DuckDBSuccess` on success or `DuckDBError` on failure.
246+
203247
<br>
204248
205249
#### `duckdb_appender_begin_row`
@@ -218,15 +262,33 @@ A nop function, provided for backwards compatibility reasons. Does nothing. Only
218262
219263
Finish the current row of appends. After end_row is called, the next row can be appended.
220264
221-
* appender: The appender.
222-
* returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
223-
224265
##### Syntax
225266
226267
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="nv">duckdb_appender_end_row</span>(<span class="nv">
227268
</span> <span class="kt">duckdb_appender</span> <span class="nv">appender
228269
</span>);
229270
</code></pre></div></div>
271+
272+
##### Parameters
273+
274+
* `appender`: The appender.
275+
276+
##### Return Value
277+
278+
`DuckDBSuccess` on success or `DuckDBError` on failure.
279+
280+
<br>
281+
282+
#### `duckdb_append_default`
283+
284+
Append a DEFAULT value (NULL if DEFAULT not available for column) to the appender.
285+
286+
##### Syntax
287+
288+
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="nv">duckdb_append_default</span>(<span class="nv">
289+
</span> <span class="kt">duckdb_appender</span> <span class="nv">appender
290+
</span>);
291+
</code></pre></div></div>
230292
<br>
231293
232294
#### `duckdb_append_bool`
@@ -511,15 +573,21 @@ The types of the data chunk must exactly match the types of the table, no castin
511573
If the types do not match or the appender is in an invalid state, DuckDBError is returned.
512574
If the append is successful, DuckDBSuccess is returned.
513575
514-
* appender: The appender to append to.
515-
* chunk: The data chunk to append.
516-
* returns: The return state.
517-
518576
##### Syntax
519577
520578
<div class="language-c highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">duckdb_state</span> <span class="nv">duckdb_append_data_chunk</span>(<span class="nv">
521579
</span> <span class="kt">duckdb_appender</span> <span class="nv">appender</span>,<span class="nv">
522580
</span> <span class="kt">duckdb_data_chunk</span> <span class="nv">chunk
523581
</span>);
524582
</code></pre></div></div>
583+
584+
##### Parameters
585+
586+
* `appender`: The appender to append to.
587+
* `chunk`: The data chunk to append.
588+
589+
##### Return Value
590+
591+
The return state.
592+
525593
<br>

0 commit comments

Comments
 (0)