Expand description
Convenience re-exports for the most commonly used quack-rs items.
This prelude covers the types and functions needed in the src/lib.rs
of a typical DuckDB Rust extension. Import it with:
use quack_rs::prelude::*;
fn register(con: libduckdb_sys::duckdb_connection) -> Result<(), ExtensionError> {
let _ = con;
Ok(())
}
// The entry-point macros come with the glob import.
entry_point!(my_extension_init_c_api, |con| register(con));§What is included
| Item | From |
|---|---|
init_extension | entry_point module |
init_extension_v2 | entry_point module |
entry_point! | entry_point module (macro) |
entry_point_v2! | entry_point module (macro) |
AbiPolicy | abi module |
Connection | connection module |
Registrar | connection module |
CastFn | cast module |
CastFunctionBuilder | cast module |
CastFunctionInfo | cast module |
CastMode | cast module |
AggregateFunctionBuilder | aggregate module |
AggregateFunctionInfo | aggregate module |
AggregateFunctionSetBuilder | aggregate module |
AggregateOverloadBuilder | aggregate module |
AggregateState | aggregate module |
FfiState | aggregate module |
ScalarFunctionBuilder | scalar module |
ScalarFunctionInfo | scalar module |
ScalarFunctionSetBuilder | scalar module |
ScalarOverloadBuilder | scalar module |
TypedScalarFunctionBuilder | scalar module |
TableFunctionBuilder | table module |
TypedTableFunctionBuilder | table module |
BindInfo | table module |
InitInfo | table module |
FunctionInfo | table module |
FfiBindData | table module |
FfiInitData | table module |
FfiLocalInitData | table module |
ReplacementScanBuilder | replacement_scan module |
ReplacementScanInfo | replacement_scan module |
SqlMacro | sql_macro module |
ChunkWriter | chunk_writer module |
DataChunk | data_chunk module |
Value | value module |
VectorReader | vector module |
VectorWriter | vector module |
ListBuilder | vector module |
ValidityBitmap | vector::validity module |
ArrayVector | vector::complex module |
StructReader | vector::struct_reader module |
StructWriter | vector::struct_writer module |
StructVector | vector::complex module |
ListVector | vector::complex module |
MapVector | vector::complex module |
TypeId | types module |
LogicalType | types module |
NullHandling | types module |
DuckInterval | interval module |
interval_to_micros | interval module |
Date / Time / TimeTz / Timestamp | datetime module |
OwnedConnection / OwnedDataChunk / PreparedStatement / QueryResult | query module |
ExtensionError | error module |
ExtResult | error module |
SecretEntry | secrets module |
SecretsManager | secrets module |
TlsConfigProvider | tls module |
TlsVersion | tls module |
audit_tls_provider | tls module |
ExtensionWarning | warning module |
WarningCollector | warning module |
WarningSeverity | warning module |
DUCKDB_API_VERSION | crate root |
DUCKDB_API_VERSION_1_5_6 | crate root |
Appender | appender module |
§DuckDB 1.5.0+ items (require the duckdb-1-5 feature)
| Item | From |
|---|---|
ScalarBindInfo / ScalarInitInfo | scalar module |
ScalarBindData / ScalarLocalState | scalar module |
CopyFunctionBuilder and its callback types: CopyBindFn / CopyBindInfo, CopyGlobalInitFn / CopyGlobalInitInfo, CopySinkFn / CopySinkInfo, CopyFinalizeFn / CopyFinalizeInfo | copy_function module |
ErrorData / DuckDbErrorType | error_data module |
Expression | expression module |
FileSystem / FileHandle / FileOpenOptions / FileFlag | file_system module |
SelectionVector | selection_vector module |
InstanceCache | instance_cache module |
§What is NOT included
The following items are intentionally excluded from the prelude because they are used less frequently and benefit from explicit import paths:
crate::config::DbConfig— RAII wrapper for opening secondaryDuckDBdatabases; import explicitly viause quack_rs::config::DbConfigwhen neededvalidate::*— validation utilities (use explicitly to make intent clear)scaffold::*— project generation (use explicitly)testing::*— test harness (typically imported only in#[cfg(test)])interval::read_interval_at— low-level; useVectorReader::read_intervalinstead
§Example
use quack_rs::prelude::*;
// Your state struct
#[derive(Default)]
struct MyState { count: i64 }
impl AggregateState for MyState {}
// Registration (called from your entry point)
fn register(con: libduckdb_sys::duckdb_connection) -> ExtResult<()> {
let _ = AggregateFunctionBuilder::try_new("my_count")?
.param(TypeId::BigInt)
.returns(TypeId::BigInt)
.ffi_state::<MyState>()
// ... callbacks ...
;
Ok(())
}Re-exports§
pub use crate::entry_point::init_extension;pub use crate::entry_point::init_extension_v2;pub use crate::abi::AbiPolicy;pub use crate::connection::Connection;pub use crate::connection::Registrar;pub use crate::cast::CastFn;pub use crate::cast::CastFunctionBuilder;pub use crate::cast::CastFunctionInfo;pub use crate::cast::CastMode;pub use crate::aggregate::AggregateFunctionBuilder;pub use crate::aggregate::AggregateFunctionInfo;pub use crate::aggregate::AggregateFunctionSetBuilder;pub use crate::aggregate::AggregateOverloadBuilder;pub use crate::aggregate::AggregateState;pub use crate::aggregate::FfiState;pub use crate::scalar::ScalarBindData;pub use crate::scalar::ScalarBindInfo;pub use crate::scalar::ScalarInitInfo;pub use crate::scalar::ScalarLocalState;pub use crate::scalar::ScalarFunctionBuilder;pub use crate::scalar::ScalarFunctionInfo;pub use crate::scalar::ScalarFunctionSetBuilder;pub use crate::scalar::ScalarOverloadBuilder;pub use crate::scalar::TypedScalarFunctionBuilder;pub use crate::copy_function::CopyBindFn;pub use crate::copy_function::CopyBindInfo;pub use crate::copy_function::CopyFinalizeFn;pub use crate::copy_function::CopyFinalizeInfo;pub use crate::copy_function::CopyFunctionBuilder;pub use crate::copy_function::CopyGlobalInitFn;pub use crate::copy_function::CopyGlobalInitInfo;pub use crate::copy_function::CopySinkFn;pub use crate::copy_function::CopySinkInfo;pub use crate::appender::Appender;pub use crate::error_data::DuckDbErrorType;pub use crate::error_data::ErrorData;pub use crate::expression::Expression;pub use crate::file_system::FileFlag;pub use crate::file_system::FileHandle;pub use crate::file_system::FileOpenOptions;pub use crate::file_system::FileSystem;pub use crate::instance_cache::InstanceCache;pub use crate::selection_vector::SelectionVector;pub use crate::table::BindInfo;pub use crate::table::FfiBindData;pub use crate::table::FfiInitData;pub use crate::table::FfiLocalInitData;pub use crate::table::FunctionInfo;pub use crate::table::InitInfo;pub use crate::table::TableFunctionBuilder;pub use crate::table::TypedTableFunctionBuilder;pub use crate::replacement_scan::ReplacementScanBuilder;pub use crate::replacement_scan::ReplacementScanInfo;pub use crate::sql_macro::SqlMacro;pub use crate::chunk_writer::ChunkWriter;pub use crate::data_chunk::DataChunk;pub use crate::value::Value;pub use crate::vector::complex::ArrayVector;pub use crate::vector::complex::ListVector;pub use crate::vector::complex::MapVector;pub use crate::vector::complex::StructVector;pub use crate::vector::ListBuilder;pub use crate::vector::StructReader;pub use crate::vector::StructWriter;pub use crate::vector::ValidityBitmap;pub use crate::vector::VectorReader;pub use crate::vector::VectorWriter;pub use crate::types::LogicalType;pub use crate::types::NullHandling;pub use crate::types::TypeId;pub use crate::interval::interval_to_micros;pub use crate::interval::DuckInterval;pub use crate::datetime::Date;pub use crate::datetime::Time;pub use crate::datetime::TimeTz;pub use crate::datetime::Timestamp;pub use crate::query::OwnedConnection;pub use crate::query::OwnedDataChunk;pub use crate::query::PreparedStatement;pub use crate::query::QueryResult;pub use crate::error::ExtResult;pub use crate::error::ExtensionError;pub use crate::secrets::SecretEntry;pub use crate::secrets::SecretsManager;pub use crate::tls::audit_tls_provider;pub use crate::tls::TlsConfigProvider;pub use crate::tls::TlsVersion;pub use crate::warning::ExtensionWarning;pub use crate::warning::WarningCollector;pub use crate::warning::WarningSeverity;pub use crate::DUCKDB_API_VERSION;pub use crate::DUCKDB_API_VERSION_1_5_6;pub use crate::entry_point;pub use crate::entry_point;
Macros§
- entry_
point - Generates the
#[unsafe(no_mangle)] unsafe extern "C"entry point for aDuckDBextension. - entry_
point_ v2 - Generates the
#[unsafe(no_mangle)] unsafe extern "C"entry point using the version-agnosticConnectionfacade.