(define-datatypes!)(define-long-enums)(duckdb_append_data_chunk appender data-chunk)No documentation!
No documentation!
(duckdb_appender_create connection schema table out_appender)No documentation!
No documentation!
(duckdb_appender_destroy appender)Close the appender and destroy it. Flushing all intermediate state in the appender to the table, and de-allocating all memory associated with the appender.
DuckDBSuccess on success or DuckDBError on failure.Close the appender and destroy it. Flushing all intermediate state in the appender to the table, and de-allocating all memory associated with the appender. * appender: The appender to flush, close and destroy. * returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
(duckdb_appender_error_data appender)Returns the error data associated with the given appender.
The result must be destroyed with duckdb_destroy_error_data.
Returns the error data associated with the given appender. The result must be destroyed with `duckdb_destroy_error_data`. * appender: The appender to get the error data from. * returns: The error data.
(duckdb_bind_boolean prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_date prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_double prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_float prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_int16 prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_int32 prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_int64 prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_int8 prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_null prepared-statement param-idx)No documentation!
No documentation!
(duckdb_bind_time prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_timestamp prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_uint16 prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_uint32 prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_uint64 prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_uint8 prepared-statement param-idx val)No documentation!
No documentation!
(duckdb_bind_varchar_length prepared-statement param-idx val length)No documentation!
No documentation!
(duckdb_clear_bindings prepared-statement)No documentation!
No documentation!
(duckdb_close database)Closes the specified database and de-allocates all memory allocated for that database.
This should be called after you are done with any database allocated through duckdb_open.
Note that failing to call duckdb_close (in case of e.g. a program crash) will not cause data corruption.
Still it is recommended to always correctly close a database object after you are done with it.
Closes the specified database and de-allocates all memory allocated for that database. This should be called after you are done with any database allocated through `duckdb_open`. Note that failing to call `duckdb_close` (in case of e.g. a program crash) will not cause data corruption. Still it is recommended to always correctly close a database object after you are done with it. * database: The database object to shut down.
(duckdb_column_logical_type result cidx)No documentation!
No documentation!
(duckdb_column_name result col)No documentation!
No documentation!
(duckdb_column_type result col)No documentation!
No documentation!
(duckdb_config_count)This returns the total amount of configuration options available for usage with duckdb_get_config_flag.
This should not be called in a loop as it internally loops over all the options.
This returns the total amount of configuration options available for usage with `duckdb_get_config_flag`. This should not be called in a loop as it internally loops over all the options. * returns: The amount of config options available.
(duckdb_connect database out_connection)Opens a connection to a database. Connections are required to query the database, and store transactional state associated with the connection.
DuckDBSuccess on success or DuckDBError on failure.Opens a connection to a database. Connections are required to query the database, and store transactional state associated with the connection. * database: The database file to connect to. * out_connection: The result connection object. * returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
(duckdb_create_config out_config)Initializes an empty configuration object that can be used to provide start-up options for the DuckDB instance
through duckdb_open_ext.
This will always succeed unless there is a malloc failure.
DuckDBSuccess on success or DuckDBError on failure.Initializes an empty configuration object that can be used to provide start-up options for the DuckDB instance through `duckdb_open_ext`. This will always succeed unless there is a malloc failure. * out_config: The result configuration object. * returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
(duckdb_create_data_chunk types column-count)No documentation!
No documentation!
(duckdb_create_logical_type duckdb_type)No documentation!
No documentation!
(duckdb_data_chunk_get_column_count chunk)No documentation!
No documentation!
(duckdb_data_chunk_get_size chunk)No documentation!
No documentation!
(duckdb_data_chunk_get_vector chunk col-idx)No documentation!
No documentation!
(duckdb_data_chunk_reset chunk)No documentation!
No documentation!
(duckdb_data_chunk_set_size chunk size)No documentation!
No documentation!
(duckdb_destroy_config config)Destroys the specified configuration option and de-allocates all memory allocated for the object.
Destroys the specified configuration option and de-allocates all memory allocated for the object. * config: The configuration object to destroy.
(duckdb_destroy_data_chunk chunk)No documentation!
No documentation!
(duckdb_destroy_error_data error-data)No documentation!
No documentation!
(duckdb_destroy_extracted extracted-statements)No documentation!
No documentation!
(duckdb_destroy_logical_type type)No documentation!
No documentation!
(duckdb_destroy_pending pending-result)No documentation!
No documentation!
(duckdb_destroy_prepare prepared-statement)No documentation!
No documentation!
(duckdb_destroy_result result)No documentation!
No documentation!
(duckdb_disconnect connection)Closes the specified connection and de-allocates all memory allocated for that connection.
Closes the specified connection and de-allocates all memory allocated for that connection. * connection: The connection to close.
(duckdb_error_data_message error-data)Returns the error message of the error data. Must not be freed - it is de-allocated along with the error data.
Returns the error message of the error data. Must not be freed - it is de-allocated along with the error data.
(duckdb_execute_pending pending-result duckdb-result)No documentation!
No documentation!
(duckdb_extract_statements connection query out-extracted-statements)No documentation!
No documentation!
(duckdb_extract_statements_error statements)No documentation!
No documentation!
(duckdb_fetch_chunk result)Fetches a data chunk from a duckdb_result, returning nil once the result is
exhausted. Works for both streaming and materialized results. Supersedes
duckdb_stream_fetch_chunk.
Fetches a data chunk from a duckdb_result, returning nil once the result is exhausted. Works for both streaming and materialized results. Supersedes `duckdb_stream_fetch_chunk`.
(duckdb_get_config_flag index out_name out_description)Obtains a human-readable name and description of a specific configuration option. This can be used to e.g.
display configuration options. This will succeed unless index is out of range (i.e. >= duckdb_config_count).
The result name or description MUST NOT be freed.
duckdb_config_count)DuckDBSuccess on success or DuckDBError on failure.Obtains a human-readable name and description of a specific configuration option. This can be used to e.g. display configuration options. This will succeed unless `index` is out of range (i.e. `>= duckdb_config_count`). The result name or description MUST NOT be freed. * index: The index of the configuration option (between 0 and `duckdb_config_count`) * out_name: A name of the configuration flag. * out_description: A description of the configuration flag. * returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
(duckdb_list_type_child_type type)No documentation!
No documentation!
(duckdb_list_vector_get_child vector)No documentation!
No documentation!
(duckdb_list_vector_get_size vector)No documentation!
No documentation!
(duckdb_nparams prepared-statement)No documentation!
No documentation!
(duckdb_open path out_database)Creates a new database or opens an existing database file stored at the the given path. If no path is given a new in-memory database is created instead.
nullptr or :memory: to open an in-memory database.DuckDBSuccess on success or DuckDBError on failure.Creates a new database or opens an existing database file stored at the the given path. If no path is given a new in-memory database is created instead. * path: Path to the database file on disk, or `nullptr` or `:memory:` to open an in-memory database. * out_database: The result database object. * returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
(duckdb_open_ext path out_database config out_error)No documentation!
No documentation!
(duckdb_param_type prepared-statement param-idx)No documentation!
No documentation!
(duckdb_pending_error pending-result)No documentation!
No documentation!
(duckdb_pending_prepared prepared-statement out-pending-result)No documentation!
No documentation!
(duckdb_pending_prepared_streaming prepared-statement out-pending-result)No documentation!
No documentation!
(duckdb_prepare connection query out-prepared-statement)No documentation!
No documentation!
(duckdb_prepare_error prepared-statement)No documentation!
No documentation!
(duckdb_prepare_extracted_statement connection
statement
statement-idx
out-prepared-statement)No documentation!
No documentation!
(duckdb_prepared_statement_type statement)No documentation!
No documentation!
(duckdb_query connection query out_result)No documentation!
No documentation!
(duckdb_result_chunk_count result)No documentation!
No documentation!
(duckdb_result_error result)Returns the error message contained within the result, or nil if the result
did not error. Must not be freed - it is de-allocated by duckdb_destroy_result.
Returns the error message contained within the result, or nil if the result did not error. Must not be freed - it is de-allocated by `duckdb_destroy_result`.
(duckdb_result_get_chunk result chunk-index)No documentation!
No documentation!
(duckdb_result_return_type result)No documentation!
No documentation!
(duckdb_result_statement_type result)No documentation!
No documentation!
(duckdb_set_config config name option)Sets the specified option for the specified configuration. The configuration option is indicated by name.
To obtain a list of config options, see duckdb_get_config_flag.
In the source code, configuration options are defined in config.cpp.
This can fail if either the name is invalid, or if the value provided for the option is invalid.
DuckDBSuccess on success or DuckDBError on failure.Sets the specified option for the specified configuration. The configuration option is indicated by name. To obtain a list of config options, see `duckdb_get_config_flag`. In the source code, configuration options are defined in `config.cpp`. This can fail if either the name is invalid, or if the value provided for the option is invalid. * duckdb_config: The configuration object to set the option on. * name: The name of the configuration flag to set. * option: The value to set the configuration flag to. * returns: `DuckDBSuccess` on success or `DuckDBError` on failure.
(duckdb_vector_ensure_validity_writable vector)No documentation!
No documentation!
(duckdb_vector_get_column_type vector)No documentation!
No documentation!
(duckdb_vector_get_data vector)No documentation!
No documentation!
(duckdb_vector_get_validity vector)No documentation!
No documentation!
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |