Struct CopyFunctionBuilder 

pub struct CopyFunctionBuilder { /* private fields */ }

Builder for registering a custom COPY TO function.

All four lifecycle callbacks (bind, global_init, sink, finalize) should be set before calling register.

Implementations

impl CopyFunctionBuilder

pub fn try_new(name: &str) -> Result<Self, ExtensionError>

Creates a new copy function builder with the given format name.

The name corresponds to the format identifier used in COPY table TO 'file' (FORMAT name).

Errors

Returns ExtensionError if the name contains a null byte.

pub fn name(&self) -> &str

Returns the name of this copy function.

pub fn bind(self, f: CopyBindFn) -> Self

Sets the bind callback.

pub fn global_init(self, f: CopyGlobalInitFn) -> Self

Sets the global init callback.

pub fn sink(self, f: CopySinkFn) -> Self

Sets the sink callback.

pub fn finalize(self, f: CopyFinalizeFn) -> Self

Sets the finalize callback.

pub unsafe fn register( self, con: duckdb_connection, ) -> Result<(), ExtensionError>

Registers the copy function on the given connection.

Errors

Returns ExtensionError if required callbacks are missing or registration fails.

Safety

con must be a valid, open duckdb_connection.