class DuckDB::InitInfo

The DuckDB::InitInfo provides context during table function initialization.

It is passed to the init callback to set up execution state.

Example:

table_function.init do |init_info|
  # Initialize execution state
  # Can report errors if initialization fails
  init_info.set_error('Initialization failed')
end

rubocop:disable Lint/EmptyClass

Public Instance Methods

set_error(error_message) → self

Source

static VALUE rbduckdb_init_info_set_error(VALUE self, VALUE error) {
    rubyDuckDBInitInfo *ctx;
    const char *error_msg;

    TypedData_Get_Struct(self, rubyDuckDBInitInfo, &init_info_data_type, ctx);

    error_msg = StringValueCStr(error);
    duckdb_init_set_error(ctx->info, error_msg);

    return self;
}

Sets an error message for the init phase. This will cause the query to fail with the specified error.

init_info.set_error('Invalid initialization')