Liking cljdoc? Tell your friends :D
Clojure only.

tmducken.duckdb.ffi

blob-def*clj

column-def*clj

define-datatypes!clj

(define-datatypes!)

duckdb-type-mapclj

duckdb_append_blobclj

(duckdb_append_blob appender data length)

No documentation!

No documentation!
raw docstring

duckdb_append_boolclj

(duckdb_append_bool appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_dateclj

(duckdb_append_date appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_doubleclj

(duckdb_append_double appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_floatclj

(duckdb_append_float appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_hugeintclj

(duckdb_append_hugeint appender lower upper)

No documentation!

No documentation!
raw docstring

duckdb_append_int16clj

(duckdb_append_int16 appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_int32clj

(duckdb_append_int32 appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_int64clj

(duckdb_append_int64 appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_int8clj

(duckdb_append_int8 appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_nullclj

(duckdb_append_null appender)

No documentation!

No documentation!
raw docstring

duckdb_append_timeclj

(duckdb_append_time appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_timestampclj

(duckdb_append_timestamp appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_uint16clj

(duckdb_append_uint16 appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_uint32clj

(duckdb_append_uint32 appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_uint64clj

(duckdb_append_uint64 appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_uint8clj

(duckdb_append_uint8 appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_varcharclj

(duckdb_append_varchar appender value)

No documentation!

No documentation!
raw docstring

duckdb_append_varchar_lengthclj

(duckdb_append_varchar_length appender value length)

No documentation!

No documentation!
raw docstring

duckdb_appender_createclj

(duckdb_appender_create connection schema table out_appender)

No documentation!

No documentation!
raw docstring

duckdb_appender_destroyclj

(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.

  • appender: The appender to flush, close and destroy.
  • returns: 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.
raw docstring

duckdb_appender_end_rowclj

(duckdb_appender_end_row appender)

End the current row.

End the current row.
raw docstring

duckdb_appender_errorclj

(duckdb_appender_error appender)

Returns the error message associated with the given appender. If the appender has no error message, this returns nullptr instead.

The error message should not be freed. It will be de-allocated when duckdb_appender_destroy is called.

  • appender: The appender to get the error from.
  • returns: The error message, or nullptr if there is none.
Returns the error message associated with the given appender.
If the appender has no error message, this returns `nullptr` instead.

The error message should not be freed. It will be de-allocated when `duckdb_appender_destroy` is called.

* appender: The appender to get the error from.
* returns: The error message, or `nullptr` if there is none.
raw docstring

duckdb_closeclj

(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.

  • database: The database object to shut down.
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.
raw docstring

duckdb_config_countclj

(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.

  • returns: The amount of config options available.
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.
raw docstring

duckdb_connectclj

(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.

  • database: The database file to connect to.
  • out_connection: The result connection object.
  • returns: 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.
raw docstring

duckdb_create_configclj

(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.

  • out_config: The result configuration object.
  • returns: 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.
raw docstring

duckdb_destroy_configclj

(duckdb_destroy_config config)

Destroys the specified configuration option and de-allocates all memory allocated for the object.

  • config: The configuration object to destroy.
Destroys the specified configuration option and de-allocates all memory allocated for the object.

* config: The configuration object to destroy.
raw docstring

duckdb_destroy_resultclj

(duckdb_destroy_result result)

No documentation!

No documentation!
raw docstring

duckdb_disconnectclj

(duckdb_disconnect connection)

Closes the specified connection and de-allocates all memory allocated for that connection.

  • connection: The connection to close.
Closes the specified connection and de-allocates all memory allocated for that connection.

* connection: The connection to close.
raw docstring

duckdb_freeclj

(duckdb_free ptr)

No documentation!

No documentation!
raw docstring

duckdb_get_config_flagclj

(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.

  • 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.
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.
raw docstring

duckdb_mallocclj

(duckdb_malloc size)

No documentation!

No documentation!
raw docstring

duckdb_openclj

(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.

  • 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.
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.
raw docstring

duckdb_open_extclj

(duckdb_open_ext path out_datatypes config out_error)

No documentation!

No documentation!
raw docstring

duckdb_queryclj

(duckdb_query connection query out_result)

No documentation!

No documentation!
raw docstring

duckdb_set_configclj

(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.

  • 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.
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.
raw docstring

DUCKDB_TYPE_BIGINTclj

DUCKDB_TYPE_BLOBclj

DUCKDB_TYPE_BOOLEANclj

DUCKDB_TYPE_DATEclj

DUCKDB_TYPE_DOUBLEclj

DUCKDB_TYPE_FLOATclj

DUCKDB_TYPE_HUGEINTclj

DUCKDB_TYPE_INTEGERclj

DUCKDB_TYPE_INTERVALclj

DUCKDB_TYPE_INVALIDclj

DUCKDB_TYPE_SMALLINTclj

DUCKDB_TYPE_TIMEclj

DUCKDB_TYPE_TIMESTAMPclj

DUCKDB_TYPE_TINYINTclj

DUCKDB_TYPE_UBIGINTclj

DUCKDB_TYPE_UINTEGERclj

DUCKDB_TYPE_USMALLINTclj

DUCKDB_TYPE_UTINYINTclj

DUCKDB_TYPE_VARCHARclj

DuckDBErrorclj

DuckDBSuccessclj

libclj

lib-fnsclj

lib-symbolsclj

ptr-dtype*clj

result-def*clj

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcutsReport a problemcljdoc on GitHub
× close