client

Documentation

Index

• Variables
• func New(ctx context.Context, logger zerolog.Logger, spec []byte, ...) (plugin.Client, error)
• func TestConnection(ctx context.Context, _ zerolog.Logger, specBytes []byte) error
• type Client
  • func (c *Client) Close(ctx context.Context) error
  • func (c *Client) DeleteStale(ctx context.Context, msgs message.WriteDeleteStales) error
  • func (c *Client) MigrateTables(ctx context.Context, msgs message.WriteMigrateTables) error
  • func (c *Client) Read(ctx context.Context, table *schema.Table, res chan<- arrow.Record) error
  • func (c *Client) Write(ctx context.Context, msgs <-chan message.WriteMessage) error
  • func (c *Client) WriteTableBatch(ctx context.Context, name string, msgs message.WriteInserts) error
• type Spec
  • func (s *Spec) SetDefaults()

Variables

var JSONSchema string

Functions

func New

func New(ctx context.Context, logger zerolog.Logger, spec []byte, _ plugin.NewClientOptions) (plugin.Client, error)

func TestConnection

func TestConnection(ctx context.Context, _ zerolog.Logger, specBytes []byte) error

Types

type Client

type Client struct {
	plugin.UnimplementedSource
	batchwriter.UnimplementedDeleteRecord
	// contains filtered or unexported fields
}

func (*Client) Close

func (c *Client) Close(ctx context.Context) error

func (*Client) DeleteStale

func (c *Client) DeleteStale(ctx context.Context, msgs message.WriteDeleteStales) error

func (*Client) MigrateTables

func (c *Client) MigrateTables(ctx context.Context, msgs message.WriteMigrateTables) error

Migrate migrates to the latest schema

func (*Client) Read

func (c *Client) Read(ctx context.Context, table *schema.Table, res chan<- arrow.Record) error

func (*Client) Write

func (c *Client) Write(ctx context.Context, msgs <-chan message.WriteMessage) error

func (*Client) WriteTableBatch

func (c *Client) WriteTableBatch(ctx context.Context, name string, msgs message.WriteInserts) error

type Spec

type Spec struct {
	// Absolute or relative path to a file, such as `./example.duckdb`
	ConnectionString string `json:"connection_string,omitempty" jsonschema:"required,minLength=1"`

	// Maximum number of items that may be grouped together to be written in a single write.
	BatchSize int64 `json:"batch_size,omitempty" jsonschema:"minimum=1,default=1000"`

	// Maximum size of items that may be grouped together to be written in a single write.
	BatchSizeBytes int64 `json:"batch_size_bytes,omitempty" jsonschema:"minimum=1,default=4194304"`

	// Enables debug logging
	Debug bool `json:"debug,omitempty" jsonschema:"default=false"`
}

func (*Spec) SetDefaults

func (s *Spec) SetDefaults()