duckdb.ffi vocabulary
Factor handbook ยป Vocabulary index


Summary

Metadata
Authors:Doug Coleman


Words

Tuple classes
ClassSuperclassSlots
duckdb-string-pointer struct
duckdb_appender struct
duckdb_arrow struct
duckdb_arrow_array struct
duckdb_arrow_schema struct
duckdb_blob struct
duckdb_column struct
duckdb_config struct
duckdb_connection struct
duckdb_data_chunk struct
duckdb_database struct
duckdb_date struct
duckdb_date_struct struct
duckdb_decimal struct
duckdb_extracted_statements struct
duckdb_hugeint struct
duckdb_interval struct
duckdb_list_entry struct
duckdb_logical_type struct
duckdb_pending_result struct
duckdb_prepared_statement struct
duckdb_result struct
duckdb_string struct
duckdb_string_t struct
duckdb_time struct
duckdb_time_struct struct
duckdb_timestamp struct
duckdb_timestamp_struct struct
duckdb_value struct
duckdb_vector struct
inlined-duckdb-string struct


Singleton classes
DUCKDB_PENDING_ERROR
DUCKDB_PENDING_RESULT_NOT_READY
DUCKDB_PENDING_RESULT_READY
DUCKDB_TYPE_BIGINT
DUCKDB_TYPE_BIT
DUCKDB_TYPE_BLOB
DUCKDB_TYPE_BOOLEAN
DUCKDB_TYPE_DATE
DUCKDB_TYPE_DECIMAL
DUCKDB_TYPE_DOUBLE
DUCKDB_TYPE_ENUM
DUCKDB_TYPE_FLOAT
DUCKDB_TYPE_HUGEINT
DUCKDB_TYPE_INTEGER
DUCKDB_TYPE_INTERVAL
DUCKDB_TYPE_INVALID
DUCKDB_TYPE_LIST
DUCKDB_TYPE_MAP
DUCKDB_TYPE_SMALLINT
DUCKDB_TYPE_STRUCT
DUCKDB_TYPE_TIME
DUCKDB_TYPE_TIMESTAMP
DUCKDB_TYPE_TIMESTAMP_MS
DUCKDB_TYPE_TIMESTAMP_NS
DUCKDB_TYPE_TIMESTAMP_S
DUCKDB_TYPE_TINYINT
DUCKDB_TYPE_UBIGINT
DUCKDB_TYPE_UINTEGER
DUCKDB_TYPE_UNION
DUCKDB_TYPE_USMALLINT
DUCKDB_TYPE_UTINYINT
DUCKDB_TYPE_UUID
DUCKDB_TYPE_VARCHAR
DuckDBError
DuckDBSuccess


Symbol words
duckdb_bind_info
duckdb_delete_callback_t
duckdb_function_info
duckdb_init_info
duckdb_pending_state
duckdb_replacement_callback_t
duckdb_replacement_scan_info
duckdb_state
duckdb_table_function
duckdb_table_function_bind_t
duckdb_table_function_init_t
duckdb_table_function_t
duckdb_task_state
duckdb_type
idx_t


Ordinary words
WordStack effect
<duckdb_pending_state>( number -- enum )
<duckdb_state>( number -- enum )
<duckdb_type>( number -- enum )
DUCKDB_API_0_3_2( -- value )
duckdb_add_replacement_scan( db replacement extra_data delete_callback -- )
duckdb_append_blob( appender data length -- duckdb_state )
duckdb_append_bool( appender value -- duckdb_state )
duckdb_append_data_chunk( appender chunk -- duckdb_state )
duckdb_append_date( appender value -- duckdb_state )
duckdb_append_double( appender value -- duckdb_state )
duckdb_append_float( appender value -- duckdb_state )
duckdb_append_hugeint( appender value -- duckdb_state )
duckdb_append_int16( appender value -- duckdb_state )
duckdb_append_int32( appender value -- duckdb_state )
duckdb_append_int64( appender value -- duckdb_state )
duckdb_append_int8( appender value -- duckdb_state )
duckdb_append_interval( appender value -- duckdb_state )
duckdb_append_null( appender -- duckdb_state )
duckdb_append_time( appender value -- duckdb_state )
duckdb_append_timestamp( appender value -- duckdb_state )
duckdb_append_uint16( appender value -- duckdb_state )
duckdb_append_uint32( appender value -- duckdb_state )
duckdb_append_uint64( appender value -- duckdb_state )
duckdb_append_uint8( appender value -- duckdb_state )
duckdb_append_varchar( appender val -- duckdb_state )
duckdb_append_varchar_length( appender val length -- duckdb_state )
duckdb_appender_begin_row( appender -- duckdb_state )
duckdb_appender_close( appender -- duckdb_state )
duckdb_appender_create( connection schema table out_appender -- duckdb_state )
duckdb_appender_destroy( appender -- duckdb_state )
duckdb_appender_end_row( appender -- duckdb_state )
duckdb_appender_error( appender -- c-string )
duckdb_appender_flush( appender -- duckdb_state )
duckdb_arrow_column_count( result -- idx_t )
duckdb_arrow_row_count( result -- idx_t )
duckdb_arrow_rows_changed( result -- idx_t )
duckdb_bind_add_result_column( info name type -- )
duckdb_bind_blob( prepared_statement param_idx data length -- duckdb_state )
duckdb_bind_boolean( prepared_statement param_idx val -- duckdb_state )
duckdb_bind_double( prepared_statement param_idx val -- duckdb_state )
duckdb_bind_float( prepared_statement param_idx val -- duckdb_state )
duckdb_bind_get_extra_info( info -- void* )
duckdb_bind_get_named_parameter( info name -- duckdb_value )
duckdb_bind_get_parameter( info index -- duckdb_value )
duckdb_bind_get_parameter_count( info -- idx_t )
duckdb_bind_int16( prepared_statement param_idx val -- duckdb_state )
duckdb_bind_int32( prepared_statement param_idx val -- duckdb_state )
duckdb_bind_int8( prepared_statement param_idx val -- duckdb_state )
duckdb_bind_null( prepared_statement param_idx -- duckdb_state )
duckdb_bind_set_bind_data( info bind_data destroy -- )
duckdb_bind_set_cardinality( info cardinality is_exact -- )
duckdb_bind_set_error( info error -- )
duckdb_bind_uint64( prepared_statement param_idx val -- duckdb_state )
duckdb_bind_varchar( prepared_statement param_idx val -- duckdb_state )
duckdb_bind_varchar_length( prepared_statement param_idx val length -- duckdb_state )
duckdb_clear_bindings( prepared_statement -- duckdb_state )
duckdb_close( database -- )
duckdb_column_count( result -- idx_t )
duckdb_column_data( result col -- void* )
duckdb_column_logical_type( result col -- duckdb_logical_type )
duckdb_column_name( result col -- c-string )
duckdb_column_type( result col -- duckdb_type )
duckdb_config_count( -- size_t )
duckdb_connect( database out_connection -- duckdb_state )
duckdb_create_config( out_config -- duckdb_state )
duckdb_create_data_chunk( types column_count -- duckdb_data_chunk )
duckdb_create_int64( val -- duckdb_value )
duckdb_create_list_type( type -- duckdb_logical_type )
duckdb_create_logical_type( type -- duckdb_logical_type )
duckdb_create_map_type( key_type value_type -- duckdb_logical_type )
duckdb_create_table_function( -- duckdb_table_function )
duckdb_create_task_state( database -- duckdb_task_state )
duckdb_create_varchar( text -- duckdb_value )
duckdb_create_varchar_length( text length -- duckdb_value )
duckdb_data_chunk_get_column_count( chunk -- idx_t )
duckdb_data_chunk_get_size( chunk -- idx_t )
duckdb_data_chunk_get_vector( chunk col_idx -- duckdb_vector )
duckdb_data_chunk_reset( chunk -- )
duckdb_data_chunk_set_size( chunk size -- )
duckdb_decimal_to_double( val -- double )
duckdb_destroy_arrow( result -- )
duckdb_destroy_config( config -- )
duckdb_destroy_data_chunk( chunk -- )
duckdb_destroy_extracted( extracted_statements -- )
duckdb_destroy_logical_type( type -- )
duckdb_destroy_pending( pending_result -- )
duckdb_destroy_prepare( prepared_statement -- )
duckdb_destroy_result( result -- )
duckdb_destroy_table_function( table_function -- )
duckdb_destroy_task_state( state -- )
duckdb_destroy_value( value -- )
duckdb_disconnect( connection -- )
duckdb_double_to_decimal( val width scale -- duckdb_decimal )
duckdb_double_to_hugeint( val -- duckdb_hugeint )
duckdb_execute_n_tasks_state( state max_tasks -- idx_t )
duckdb_execute_pending( pending_result out_result -- duckdb_state )
duckdb_execute_prepared( prepared_statement out_result -- duckdb_state )
duckdb_execute_prepared_arrow( prepared_statement out_result -- duckdb_state )
duckdb_execute_tasks( database max_tasks -- )
duckdb_execute_tasks_state( state -- )
duckdb_execution_is_finished( con -- bool )
duckdb_extract_statements( connection query out_extracted_statements -- idx_t )
duckdb_extract_statements_error( extracted_statements -- c-string )
duckdb_finish_execution( state -- )
duckdb_free( ptr -- )
duckdb_from_date( date -- duckdb_date_struct )
duckdb_from_time( time -- duckdb_time_struct )
duckdb_from_timestamp( ts -- duckdb_timestamp_struct )
duckdb_function_get_bind_data( info -- void* )
duckdb_function_get_extra_info( info -- void* )
duckdb_function_get_init_data( info -- void* )
duckdb_function_get_local_init_data( info -- void* )
duckdb_function_set_error( info error -- )
duckdb_get_config_flag( index out_name out_description -- duckdb_state )
duckdb_get_int64( value -- int64_t )
duckdb_get_varchar( value -- char* )
duckdb_hugeint_to_double( val -- double )
duckdb_init_get_bind_data( info -- void* )
duckdb_init_get_column_count( info -- idx_t )
duckdb_init_get_column_index( info column_index -- idx_t )
duckdb_init_get_extra_info( info -- void* )
duckdb_init_set_error( info error -- )
duckdb_init_set_init_data( info init_data destroy -- )
duckdb_init_set_max_threads( info max_threads -- )
duckdb_library_version( -- c-string )
duckdb_list_vector_get_child( vector -- duckdb_vector )
duckdb_list_vector_get_size( vector -- idx_t )
duckdb_list_vector_reserve( vector required_capacity -- duckdb_state )
duckdb_list_vector_set_size( vector size -- duckdb_state )
duckdb_malloc( size -- void* )
duckdb_nparams( prepared_statement -- idx_t )
duckdb_nullmask_data( result col -- bool* )
duckdb_open( path out_database -- duckdb_state )
duckdb_open_ext( path out_database config out_error -- duckdb_state )
duckdb_param_type( prepared_statement param_idx -- duckdb_type )
duckdb_pending_error( pending_result -- c-string )
duckdb_pending_execute_task( pending_result -- duckdb_pending_state )
duckdb_pending_prepared( prepared_statement out_result -- duckdb_state )
duckdb_pending_prepared_streaming( prepared_statement out_result -- duckdb_state )
duckdb_prepare( connection query out_prepared_statement -- duckdb_state )
duckdb_prepare_error( prepared_statement -- c-string )
duckdb_prepare_extracted_statement( connection extracted_statements index out_prepared_statement -- duckdb_state )
duckdb_query( connection query out_result -- duckdb_state )
duckdb_query_arrow( connection query out_result -- duckdb_state )
duckdb_query_arrow_array( result out_array -- duckdb_state )
duckdb_query_arrow_error( result -- c-string )
duckdb_query_arrow_schema( result out_schema -- duckdb_state )
duckdb_register_table_function( con function -- duckdb_state )
duckdb_replacement_scan_add_parameter( info parameter -- )
duckdb_replacement_scan_set_error( info error -- )
duckdb_replacement_scan_set_function_name( info function_name -- )
duckdb_result_chunk_count( result -- idx_t )
duckdb_result_error( result -- c-string )
duckdb_result_get_chunk( result chunk_index -- duckdb_data_chunk )
duckdb_result_is_streaming( result -- bool )
duckdb_row_count( result -- idx_t )
duckdb_rows_changed( result -- idx_t )
duckdb_set_config( config name option -- duckdb_state )
duckdb_stream_fetch_chunk( result -- duckdb_data_chunk )
duckdb_string_is_inlined( string -- bool )
duckdb_struct_vector_get_child( vector index -- duckdb_vector )
duckdb_table_function_add_named_parameter( table_function name type -- )
duckdb_table_function_add_parameter( table_function type -- )
duckdb_table_function_set_bind( table_function bind -- )
duckdb_table_function_set_extra_info( table_function extra_info destroy -- )
duckdb_table_function_set_function( table_function function -- )
duckdb_table_function_set_init( table_function init -- )
duckdb_table_function_set_local_init( table_function init -- )
duckdb_table_function_set_name( table_function name -- )
duckdb_table_function_supports_projection_pushdown( table_function pushdown -- )
duckdb_task_state_is_finished( state -- bool )
duckdb_to_date( date -- duckdb_date )
duckdb_to_time( time -- duckdb_time )
duckdb_to_timestamp( ts -- duckdb_timestamp )
duckdb_validity_row_is_valid( validity row -- bool )
duckdb_validity_set_row_invalid( validity row -- )
duckdb_validity_set_row_valid( validity row -- )
duckdb_validity_set_row_validity( validity row valid -- )
duckdb_value_blob( result col row -- duckdb_blob )
duckdb_value_boolean( result col row -- bool )
duckdb_value_date( result col row -- duckdb_date )
duckdb_value_decimal( result col row -- duckdb_decimal )
duckdb_value_double( result col row -- double )
duckdb_value_float( result col row -- float )
duckdb_value_hugeint( result col row -- duckdb_hugeint )
duckdb_value_int16( result col row -- int16_t )
duckdb_value_int32( result col row -- int32_t )
duckdb_value_int64( result col row -- int64_t )
duckdb_value_int8( result col row -- int8_t )
duckdb_value_interval( result col row -- duckdb_interval )
duckdb_value_is_null( result col row -- bool )
duckdb_value_string( result col row -- duckdb_string )
duckdb_value_string_internal( result col row -- duckdb_string )
duckdb_value_time( result col row -- duckdb_time )
duckdb_value_timestamp( result col row -- duckdb_timestamp )
duckdb_value_uint16( result col row -- uint16_t )
duckdb_value_uint32( result col row -- uint32_t )
duckdb_value_uint64( result col row -- uint64_t )
duckdb_value_uint8( result col row -- uint8_t )
duckdb_value_varchar( result col row -- char* )
duckdb_value_varchar_internal( result col row -- char* )
duckdb_vector_assign_string_element( vector index str -- )
duckdb_vector_assign_string_element_len( vector index str str_len -- )
duckdb_vector_ensure_validity_writable( vector -- )
duckdb_vector_get_column_type( vector -- duckdb_logical_type )
duckdb_vector_get_data( vector -- void* )
duckdb_vector_get_validity( vector -- uint64_t* )
duckdb_vector_size( -- idx_t )


Class predicate words
WordStack effect
DUCKDB_PENDING_ERROR?( object -- ? )
DUCKDB_PENDING_RESULT_NOT_READY?( object -- ? )
DUCKDB_PENDING_RESULT_READY?( object -- ? )
DUCKDB_TYPE_BIGINT?( object -- ? )
DUCKDB_TYPE_BIT?( object -- ? )
DUCKDB_TYPE_BLOB?( object -- ? )
DUCKDB_TYPE_BOOLEAN?( object -- ? )
DUCKDB_TYPE_DATE?( object -- ? )
DUCKDB_TYPE_DECIMAL?( object -- ? )
DUCKDB_TYPE_DOUBLE?( object -- ? )
DUCKDB_TYPE_ENUM?( object -- ? )
DUCKDB_TYPE_FLOAT?( object -- ? )
DUCKDB_TYPE_HUGEINT?( object -- ? )
DUCKDB_TYPE_INTEGER?( object -- ? )
DUCKDB_TYPE_INTERVAL?( object -- ? )
DUCKDB_TYPE_INVALID?( object -- ? )
DUCKDB_TYPE_LIST?( object -- ? )
DUCKDB_TYPE_MAP?( object -- ? )
DUCKDB_TYPE_SMALLINT?( object -- ? )
DUCKDB_TYPE_STRUCT?( object -- ? )
DUCKDB_TYPE_TIME?( object -- ? )
DUCKDB_TYPE_TIMESTAMP?( object -- ? )
DUCKDB_TYPE_TIMESTAMP_MS?( object -- ? )
DUCKDB_TYPE_TIMESTAMP_NS?( object -- ? )
DUCKDB_TYPE_TIMESTAMP_S?( object -- ? )
DUCKDB_TYPE_TINYINT?( object -- ? )
DUCKDB_TYPE_UBIGINT?( object -- ? )
DUCKDB_TYPE_UINTEGER?( object -- ? )
DUCKDB_TYPE_UNION?( object -- ? )
DUCKDB_TYPE_USMALLINT?( object -- ? )
DUCKDB_TYPE_UTINYINT?( object -- ? )
DUCKDB_TYPE_UUID?( object -- ? )
DUCKDB_TYPE_VARCHAR?( object -- ? )
DuckDBError?( object -- ? )
DuckDBSuccess?( object -- ? )
duckdb-string-pointer?( object -- ? )
duckdb_appender?( object -- ? )
duckdb_arrow?( object -- ? )
duckdb_arrow_array?( object -- ? )
duckdb_arrow_schema?( object -- ? )
duckdb_blob?( object -- ? )
duckdb_column?( object -- ? )
duckdb_config?( object -- ? )
duckdb_connection?( object -- ? )
duckdb_data_chunk?( object -- ? )
duckdb_database?( object -- ? )
duckdb_date?( object -- ? )
duckdb_date_struct?( object -- ? )
duckdb_decimal?( object -- ? )
duckdb_extracted_statements?( object -- ? )
duckdb_hugeint?( object -- ? )
duckdb_interval?( object -- ? )
duckdb_list_entry?( object -- ? )
duckdb_logical_type?( object -- ? )
duckdb_pending_result?( object -- ? )
duckdb_prepared_statement?( object -- ? )
duckdb_result?( object -- ? )
duckdb_string?( object -- ? )
duckdb_string_t?( object -- ? )
duckdb_time?( object -- ? )
duckdb_time_struct?( object -- ? )
duckdb_timestamp?( object -- ? )
duckdb_timestamp_struct?( object -- ? )
duckdb_value?( object -- ? )
duckdb_vector?( object -- ? )
inlined-duckdb-string?( object -- ? )


Files


Metadata files