config

Documentation

Index

• type Config
  • func WithDefaults() *Config
  • func (c *Config) DeepCopy() *Config
  • func (c *Config) ToEndpointURL() string
• type UserConfig
  • func ParseDSN(dsn string) (UserConfig, error)
  • func (ucfg UserConfig) DeepCopy() UserConfig
  • func (ucfg UserConfig) WithDefaults() UserConfig

Types

type Config

type Config struct {
	UserConfig
	TLSConfig     *tls.Config // nil disables TLS
	Authenticator string      //TODO for oauth

	RunAsync                  bool // TODO
	PollInterval              time.Duration
	ConnectTimeout            time.Duration // max time to open session
	ClientTimeout             time.Duration // max time the http request can last
	PingTimeout               time.Duration //max time allowed for ping
	CanUseMultipleCatalogs    bool
	DriverName                string
	DriverVersion             string
	ThriftProtocol            string
	ThriftTransport           string
	ThriftProtocolVersion     cli_service.TProtocolVersion
	ThriftDebugClientProtocol bool
}

Driver Configurations. Only UserConfig are currently exposed to users

func WithDefaults

func WithDefaults() *Config

WithDefaults provides default settings for Config

func (*Config) DeepCopy

func (c *Config) DeepCopy() *Config

DeepCopy returns a true deep copy of Config

func (*Config) ToEndpointURL

func (c *Config) ToEndpointURL() string

ToEndpointURL generates the endpoint URL from Config that a Thrift client will connect to

type UserConfig

type UserConfig struct {
	Protocol       string
	Host           string // from databricks UI
	Port           int    // from databricks UI
	HTTPPath       string // from databricks UI
	Catalog        string
	Schema         string
	AccessToken    string        // from databricks UI
	MaxRows        int           // max rows per page
	QueryTimeout   time.Duration // Timeout passed to server for query processing
	UserAgentEntry string
	Location       *time.Location
	SessionParams  map[string]string
}

UserConfig is the set of configurations exposed to users

func ParseDSN

func ParseDSN(dsn string) (UserConfig, error)

ParseDSN constructs UserConfig by parsing DSN string supplied to `sql.Open()`

func (UserConfig) DeepCopy

func (ucfg UserConfig) DeepCopy() UserConfig

DeepCopy returns a true deep copy of UserConfig

func (UserConfig) WithDefaults

func (ucfg UserConfig) WithDefaults() UserConfig

WithDefaults provides default settings for optional fields in UserConfig