flightsql

Documentation

Overview

Package flightsql is an ADBC Driver Implementation for Flight SQL natively in go.

It can be used to register a driver for database/sql by importing github.com/apache/arrow-adbc/go/adbc/sqldriver and running:

sql.Register("flightsql", sqldriver.Driver{flightsql.Driver{}})

You can then open a flightsql connection with the database/sql standard package by using:

db, err := sql.Open("flightsql", "uri=<flight sql db url>")

The URI passed *must* contain a scheme, most likely "grpc+tcp://"

Index

• Constants
• func NewDriver(alloc memory.Allocator) adbc.Driver

Constants

const (
	OptionAuthority                     = "adbc.flight.sql.client_option.authority"
	OptionMTLSCertChain                 = "adbc.flight.sql.client_option.mtls_cert_chain"
	OptionMTLSPrivateKey                = "adbc.flight.sql.client_option.mtls_private_key"
	OptionSSLOverrideHostname           = "adbc.flight.sql.client_option.tls_override_hostname"
	OptionSSLSkipVerify                 = "adbc.flight.sql.client_option.tls_skip_verify"
	OptionSSLRootCerts                  = "adbc.flight.sql.client_option.tls_root_certs"
	OptionWithBlock                     = "adbc.flight.sql.client_option.with_block"
	OptionWithMaxMsgSize                = "adbc.flight.sql.client_option.with_max_msg_size"
	OptionAuthorizationHeader           = "adbc.flight.sql.authorization_header"
	OptionTimeoutConnect                = "adbc.flight.sql.rpc.timeout_seconds.connect"
	OptionTimeoutFetch                  = "adbc.flight.sql.rpc.timeout_seconds.fetch"
	OptionTimeoutQuery                  = "adbc.flight.sql.rpc.timeout_seconds.query"
	OptionTimeoutUpdate                 = "adbc.flight.sql.rpc.timeout_seconds.update"
	OptionRPCCallHeaderPrefix           = "adbc.flight.sql.rpc.call_header."
	OptionCookieMiddleware              = "adbc.flight.sql.rpc.with_cookie_middleware"
	OptionSessionOptions                = "adbc.flight.sql.session.options"
	OptionSessionOptionPrefix           = "adbc.flight.sql.session.option."
	OptionEraseSessionOptionPrefix      = "adbc.flight.sql.session.optionerase."
	OptionBoolSessionOptionPrefix       = "adbc.flight.sql.session.optionbool."
	OptionStringListSessionOptionPrefix = "adbc.flight.sql.session.optionstringlist."
	OptionLastFlightInfo                = "adbc.flight.sql.statement.exec.last_flight_info"
)

const (
	OptionStatementQueueSize = "adbc.rpc.result_queue_size"
	// Explicitly set substrait version for Flight SQL
	// substrait *does* include the version in the serialized plan
	// so this is not entirely necessary depending on the version
	// of substrait and the capabilities of the server.
	OptionStatementSubstraitVersion = "adbc.flight.sql.substrait.version"
)

Functions

func NewDriver

func NewDriver(alloc memory.Allocator) adbc.Driver

NewDriver creates a new Flight SQL driver using the given Arrow allocator.