databricks

Documentation

Index

• Constants
• func GoquDialectOptions() *sqlgen.SQLDialectOptions
• func GoquExpressions() *base.Expressions
• type Config
  • func (c *Config) Parse(input json.RawMessage) error
• type DB
  • func NewDB(configJson json.RawMessage) (*DB, error)
  • func (db *DB) ListColumns(ctx context.Context, relation sqlconnect.RelationRef) ([]sqlconnect.ColumnRef, error)
  • func (db *DB) ListColumnsForSqlQuery(ctx context.Context, sql string) ([]sqlconnect.ColumnRef, error)
  • func (db *DB) RenameTable(ctx context.Context, oldRef, newRef sqlconnect.RelationRef) error

Constants

const (
	DatabaseType = "databricks"
)

Functions

func GoquDialectOptions

func GoquDialectOptions() *sqlgen.SQLDialectOptions

func GoquExpressions

func GoquExpressions() *base.Expressions

Types

type Config

type Config struct {
	Host    string `json:"host"`
	Port    int    `json:"port"`
	Path    string `json:"path"`
	Token   string `json:"token"`
	Catalog string `json:"catalog"`
	Schema  string `json:"schema"`

	TunnelInfo *sshtunnel.Config `json:"tunnel_info,omitempty"`

	RetryAttempts    int           `json:"retryAttempts"`    // default: 4
	MinRetryWaitTime time.Duration `json:"minRetryWaitTime"` // default: 1s
	MaxRetryWaitTime time.Duration `json:"maxRetryWaitTime"` // default: 30s
	MaxConnIdleTime  time.Duration `json:"maxConnIdleTime"`  // default: disabled

	Timeout time.Duration `json:"timeout"` // default: no timeout

	SessionParams map[string]string `json:"sessionParams"`

	UseOAuth          bool   `json:"useOauth"`
	OAuthClientID     string `json:"oauthClientId"`
	OAuthClientSecret string `json:"oauthClientSecret"`

	UseLegacyMappings bool `json:"useLegacyMappings"`
	// SkipColumnNormalization skips normalizing column names during ListColumns and ListColumnsForSqlQuery.
	// Databricks is returning column names case sensitive from information schema, even though it is case insensitive.
	// So, by default table names are returned normalized by databricks, whereas column names are not.
	// To avoid this inconsistency, we are normalizing column names by default.
	// If you want to skip this normalization, set this flag to true.
	SkipColumnNormalization bool `json:"skipColumnNormalisation"`
}

func (*Config) Parse

func (c *Config) Parse(input json.RawMessage) error

type DB

type DB struct {
	*base.DB
	// contains filtered or unexported fields
}

func NewDB

func NewDB(configJson json.RawMessage) (*DB, error)

NewDB creates a new databricks db client

func (*DB) ListColumns

func (db *DB) ListColumns(ctx context.Context, relation sqlconnect.RelationRef) ([]sqlconnect.ColumnRef, error)

ListColumns returns a list of columns for the given table

func (*DB) ListColumnsForSqlQuery

func (db *DB) ListColumnsForSqlQuery(ctx context.Context, sql string) ([]sqlconnect.ColumnRef, error)

func (*DB) RenameTable

func (db *DB) RenameTable(ctx context.Context, oldRef, newRef sqlconnect.RelationRef) error

RenameTable in databricks falls back to MoveTable if rename is not supported