server

package
v0.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 28, 2026 License: MIT Imports: 22 Imported by: 0

Documentation

Overview

Package server provides a production-grade DuckDB-backed Arrow Flight SQL server.

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrEmptyQuery = status.Error(codes.InvalidArgument, "empty query provided")
	ErrNotFound   = status.Error(codes.NotFound, "statement handle not found or expired")
	ErrInternal   = status.Error(codes.Internal, "internal server error")
	ErrCancelled  = status.Error(codes.Canceled, "execution cancelled by client")
	ErrInvalidSQL = status.Error(codes.InvalidArgument, "invalid SQL statement")
)

Functions

This section is empty.

Types

type BatchGuard added in v0.15.0 

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

BatchGuard provides deterministic ownership of an Arrow RecordBatch. It ensures that a batch is released exactly once, preventing double-frees and memory leaks on early returns, evictions, or overwrites.

func NewBatchGuard added in v0.15.0 

func NewBatchGuard(b arrow.RecordBatch) *BatchGuard

func (*BatchGuard) Release added in v0.15.0 

func (g *BatchGuard) Release()

Release drops the reference safely. It is idempotent.

func (*BatchGuard) Retain added in v0.15.0 

func (g *BatchGuard) Retain() arrow.RecordBatch

Retain returns the underlying batch and increments its reference count. The caller is now responsible for releasing the returned batch.

type Config added in v0.13.0 

type Config struct {
	DBPath               string
	HandleTTL            time.Duration
	GCInterval           time.Duration
	SchemaProbeTimeout   time.Duration
	MaxConcurrentQueries int
	ReadOnly             bool
	Logger               *slog.Logger
	DevMode              bool
	Engine               Engine
}

type Engine added in v0.18.0 

type Engine interface {
	BuildStream(ctx context.Context, sql string, params arrow.RecordBatch) (*arrow.Schema, <-chan flight.StreamChunk, error)
	AcquireQuerySlot(ctx context.Context) error
	ReleaseQuerySlot()
	DeriveSchema(ctx context.Context, sql string) (*arrow.Schema, error)
	ExecuteUpdate(ctx context.Context, sql string) (int64, error)
	Allocator() memory.Allocator
	Close() error
}

type Server 

type Server struct {
	fsql.BaseServer

	Engine Engine

	Alloc  memory.Allocator
	Logger *slog.Logger
	// contains filtered or unexported fields
}

func NewServer 

func NewServer(cfg Config) (*Server, error)

func (*Server) AsFlightServer 

func (s *Server) AsFlightServer() flight.FlightServer

func (*Server) Close 

func (s *Server) Close() error

func (*Server) ClosePreparedStatement 

func (s *Server) ClosePreparedStatement(
	_ context.Context,
	req fsql.ActionClosePreparedStatementRequest,
) error

func (*Server) CreatePreparedStatement 

func (s *Server) CreatePreparedStatement(
	ctx context.Context,
	req fsql.ActionCreatePreparedStatementRequest,
) (fsql.ActionCreatePreparedStatementResult, error)

func (*Server) DoExchange 

func (s *Server) DoExchange(
	ctx context.Context,
	stream flight.FlightService_DoExchangeServer,
) error

DoExchange operates outside the BaseServer routing and allows us to bypass channels entirely for true, zero-copy, synchronous streaming.

func (*Server) DoGetPreparedStatement 

func (s *Server) DoGetPreparedStatement(
	ctx context.Context,
	cmd fsql.PreparedStatementQuery,
) (*arrow.Schema, <-chan flight.StreamChunk, error)

func (*Server) DoGetStatement 

func (s *Server) DoGetStatement(
	ctx context.Context,
	ticket fsql.StatementQueryTicket,
) (*arrow.Schema, <-chan flight.StreamChunk, error)

func (*Server) DoPutCommandStatementUpdate 

func (s *Server) DoPutCommandStatementUpdate(
	ctx context.Context,
	cmd fsql.StatementUpdate,
) (int64, error)

func (*Server) DoPutPreparedStatementQuery 

func (s *Server) DoPutPreparedStatementQuery(
	_ context.Context,
	cmd fsql.PreparedStatementQuery,
	reader flight.MessageReader,
	_ flight.MetadataWriter,
) ([]byte, error)

func (*Server) GetFlightInfoPreparedStatement 

func (s *Server) GetFlightInfoPreparedStatement(
	ctx context.Context,
	cmd fsql.PreparedStatementQuery,
	desc *flight.FlightDescriptor,
) (*flight.FlightInfo, error)

func (*Server) GetFlightInfoStatement 

func (s *Server) GetFlightInfoStatement(
	ctx context.Context,
	cmd fsql.StatementQuery,
	desc *flight.FlightDescriptor,
) (*flight.FlightInfo, error)

func (*Server) GetSchemaPreparedStatement 

func (s *Server) GetSchemaPreparedStatement(
	ctx context.Context,
	cmd fsql.PreparedStatementQuery,
	_ *flight.FlightDescriptor,
) (*flight.SchemaResult, error)

func (*Server) GetSchemaStatement 

func (s *Server) GetSchemaStatement(
	ctx context.Context,
	cmd fsql.StatementQuery,
	_ *flight.FlightDescriptor,
) (*flight.SchemaResult, error)

func (*Server) Shutdown added in v0.15.0 

func (s *Server) Shutdown(ctx context.Context) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.