duckdb

README

duck

Documentation

Overview

Package duckdb implements a database/sql driver for the DuckDB database.

Index

• type Appender
  • func NewAppenderFromConn(driverConn driver.Conn, schema, table string) (*Appender, error)
  • func (a *Appender) AppendRow(args ...driver.Value) error
  • func (a *Appender) Close() error
  • func (a *Appender) Flush() error
• type Arrow
  • func NewArrowFromConn(driverConn driver.Conn) (*Arrow, error)
  • func (a *Arrow) QueryContext(ctx context.Context, query string, args ...any) (array.RecordReader, error)
• type Composite
  • func (s Composite[T]) Get() T
  • func (s *Composite[T]) Scan(v any) error
• type Connector
  • func NewConnector(dsn string, connInitFn func(execer driver.ExecerContext) error) (*Connector, error)
  • func (c *Connector) Close() error
  • func (c *Connector) Connect(context.Context) (driver.Conn, error)
  • func (*Connector) Driver() driver.Driver
• type Decimal
  • func (d *Decimal) Float64() float64
• type Driver
  • func (d Driver) Open(dsn string) (driver.Conn, error)
  • func (Driver) OpenConnector(dsn string) (driver.Connector, error)
• type Interval
• type Map
  • func (m *Map) Scan(v any) error
• type UUID
  • func (u *UUID) Scan(v any) error

Types

type Appender

type Appender struct {
	// contains filtered or unexported fields
}

Appender holds the DuckDB appender. It allows efficient bulk loading into a DuckDB database.

func NewAppenderFromConn

func NewAppenderFromConn(driverConn driver.Conn, schema, table string) (*Appender, error)

NewAppenderFromConn returns a new Appender from a DuckDB driver connection.

func (*Appender) AppendRow

func (a *Appender) AppendRow(args ...driver.Value) error

AppendRow loads a row of values into the appender. The values are provided as separate arguments.

func (*Appender) Close

func (a *Appender) Close() error

Close the appender. This will flush the appender to the underlying table. It is vital to call this when you are done with the appender to avoid leaking memory.

func (*Appender) Flush

func (a *Appender) Flush() error

Flush the data chunks to the underlying table and clear the internal cache. Does not close the appender, even if it returns an error. Unless you have a good reason to call this, call Close when you are done with the appender.

type Arrow

type Arrow struct {
	// contains filtered or unexported fields
}

Arrow exposes DuckDB Apache Arrow interface. https://duckdb.org/docs/api/c/api#arrow-interface

func NewArrowFromConn

func NewArrowFromConn(driverConn driver.Conn) (*Arrow, error)

NewArrowFromConn returns a new Arrow from a DuckDB driver connection.

func (*Arrow) QueryContext

func (a *Arrow) QueryContext(ctx context.Context, query string, args ...any) (array.RecordReader, error)

QueryContext prepares statements, executes them, returns Apache Arrow array.RecordReader as a result of the last executed statement. Arguments are bound to the last statement.

type Composite

type Composite[T any] struct {
	// contains filtered or unexported fields
}

Use as the `Scanner` type for any composite types (maps, lists, structs)

func (Composite[T]) Get

func (s Composite[T]) Get() T

func (*Composite[T]) Scan

func (s *Composite[T]) Scan(v any) error

type Connector

type Connector struct {
	// contains filtered or unexported fields
}

func NewConnector

func NewConnector(dsn string, connInitFn func(execer driver.ExecerContext) error) (*Connector, error)

NewConnector opens a new Connector for a DuckDB database. The user must close the Connector, if it is not passed to the sql.OpenDB function. Otherwise, sql.DB closes the Connector when calling sql.DB.Close().

func (*Connector) Close

func (c *Connector) Close() error

func (*Connector) Connect

func (c *Connector) Connect(context.Context) (driver.Conn, error)

func (*Connector) Driver

func (*Connector) Driver() driver.Driver

type Decimal

type Decimal struct {
	Width uint8
	Scale uint8
	Value *big.Int
}

func (*Decimal) Float64

func (d *Decimal) Float64() float64

type Driver

type Driver struct{}

func (Driver) Open

func (d Driver) Open(dsn string) (driver.Conn, error)

func (Driver) OpenConnector

func (Driver) OpenConnector(dsn string) (driver.Connector, error)

type Interval

type Interval struct {
	Days   int32 `json:"days"`
	Months int32 `json:"months"`
	Micros int64 `json:"micros"`
}

type Map

type Map map[any]any

func (*Map) Scan

func (m *Map) Scan(v any) error

type UUID

type UUID [16]byte

func (*UUID) Scan

func (u *UUID) Scan(v any) error