runtime

Documentation

Index

• func InstallDuckDBExtensionsCmd(cfg *config.Config) *cobra.Command
• func PingCmd(cfg *config.Config) *cobra.Command
• func RuntimeCmd(cfg *config.Config) *cobra.Command
• func StartCmd(cliCfg *config.Config) *cobra.Command
• type Config

Functions

func InstallDuckDBExtensionsCmd

func InstallDuckDBExtensionsCmd(cfg *config.Config) *cobra.Command

InstallDuckDBExtensionsCmd adds a CLI command that forces DuckDB to install all required extensions. It's used to pre-hydrate the extensions cache in Docker images.

func PingCmd

func PingCmd(cfg *config.Config) *cobra.Command

func RuntimeCmd

func RuntimeCmd(cfg *config.Config) *cobra.Command

RuntimeCmd represents the runtime command

func StartCmd

func StartCmd(cliCfg *config.Config) *cobra.Command

StartCmd starts a stand-alone runtime server. It only allows configuration using environment variables.

Types

type Config

type Config struct {
	HTTPPort                int                    `default:"8080" split_words:"true"`
	GRPCPort                int                    `default:"9090" split_words:"true"`
	LogLevel                zapcore.Level          `default:"info" split_words:"true"`
	MetricsExporter         observability.Exporter `default:"prometheus" split_words:"true"`
	TracesExporter          observability.Exporter `default:"" split_words:"true"`
	MetastoreDriver         string                 `default:"sqlite" split_words:"true"`
	MetastoreURL            string                 `default:"file:rill?mode=memory&cache=shared" split_words:"true"`
	AllowedOrigins          []string               `default:"*" split_words:"true"`
	SessionKeyPairs         []string               `split_words:"true"`
	AuthEnable              bool                   `default:"false" split_words:"true"`
	AuthIssuerURL           string                 `default:"" split_words:"true"`
	AuthAudienceURL         string                 `default:"" split_words:"true"`
	EmailSMTPHost           string                 `split_words:"true"`
	EmailSMTPPort           int                    `split_words:"true"`
	EmailSMTPUsername       string                 `split_words:"true"`
	EmailSMTPPassword       string                 `split_words:"true"`
	EmailSenderEmail        string                 `split_words:"true"`
	EmailSenderName         string                 `split_words:"true"`
	EmailBCC                string                 `split_words:"true"`
	DownloadRowLimit        int64                  `default:"10000" split_words:"true"`
	SafeSourceRefresh       bool                   `default:"false" split_words:"true"`
	ConnectionCacheSize     int                    `default:"100" split_words:"true"`
	QueryCacheSizeBytes     int64                  `default:"104857600" split_words:"true"` // 100MB by default
	SecurityEngineCacheSize int                    `default:"1000" split_words:"true"`
	LogBufferCapacity       int                    `default:"10000" split_words:"true"`    // 10k log lines
	LogBufferSizeBytes      int64                  `default:"16777216" split_words:"true"` // 16MB by default
	// AllowHostAccess controls whether instance can use host credentials and
	// local_file sources can access directory outside repo
	AllowHostAccess bool `default:"false" split_words:"true"`
	// Redis server address host:port
	RedisURL string `default:"" split_words:"true"`
	// Sink type of activity client: noop (or empty string), kafka
	ActivitySinkType string `default:"" split_words:"true"`
	// Sink period of a buffered activity client in millis
	ActivitySinkPeriodMs int `default:"1000" split_words:"true"`
	// Max queue size of a buffered activity client
	ActivityMaxBufferSize int `default:"1000" split_words:"true"`
	// Kafka brokers of an activity client's sink
	ActivitySinkKafkaBrokers string `default:"" split_words:"true"`
	// Kafka topic of an activity client's sink
	ActivitySinkKafkaTopic string `default:"" split_words:"true"`
}

Config describes runtime server config derived from environment variables. Env var keys must be prefixed with RILL_RUNTIME_ and are converted from snake_case to CamelCase. For example RILL_RUNTIME_HTTP_PORT is mapped to Config.HTTPPort.