config

Documentation

Index

• Constants
• Variables
• func ContextWithConfig(ctx context.Context, config *Config) context.Context
• type Config
  • func FromContext(ctx context.Context) *Config
  • func Read() (*Config, error)
• type DatabaseConfig
• type FilesConfig
• type JSONConfig
• type PluginReference
  • func (r *PluginReference) String() string
  • func (r *PluginReference) UnmarshalText(text []byte) error
• type YamlUnmarshallableVersionConstraint
  • func NewYamlUnmarshallableVersionConstraint(v *semver.Constraints) *YamlUnmarshallableVersionConstraint
  • func (constraint *YamlUnmarshallableVersionConstraint) Raw() *semver.Constraints
  • func (constraint *YamlUnmarshallableVersionConstraint) UnmarshalText(text []byte) error

Constants

const ApplicationName = "octosql"

Variables

var OctosqlCacheDir = func() string {
	cacheDirPath, err := xdg.SearchCacheFile(ApplicationName)
	if err != nil {
		return octosqlHomeDir
	}
	return cacheDirPath
}()

var OctosqlConfigDir = func() string {
	configDirPath, err := xdg.SearchConfigFile(ApplicationName)
	if err != nil {
		return octosqlHomeDir
	}
	return configDirPath
}()

var OctosqlDataDir = func() string {
	dataDirPath, err := xdg.SearchDataFile(ApplicationName)
	if err != nil {
		return octosqlHomeDir
	}
	return dataDirPath
}()

Functions

func ContextWithConfig

func ContextWithConfig(ctx context.Context, config *Config) context.Context

Types

type Config

type Config struct {
	Databases []DatabaseConfig `yaml:"databases"`
	Files     FilesConfig      `yaml:"files"`
}

func FromContext

func FromContext(ctx context.Context) *Config

func Read

func Read() (*Config, error)

type DatabaseConfig

type DatabaseConfig struct {
	Name    string                               `yaml:"name"`
	Type    PluginReference                      `yaml:"type"`
	Version *YamlUnmarshallableVersionConstraint `yaml:"version"`
	Config  yaml.Node                            `yaml:"config"`
}

type FilesConfig

type FilesConfig struct {
	JSON            JSONConfig `yaml:"json"`
	BufferSizeBytes int        `yaml:"buffer_size_bytes"`
}

type JSONConfig

type JSONConfig struct {
	MaxLineSizeBytes int `yaml:"max_line_size_bytes"`
}

type PluginReference

type PluginReference struct {
	Name       string
	Repository string
}

func (*PluginReference) String

func (r *PluginReference) String() string

func (*PluginReference) UnmarshalText

func (r *PluginReference) UnmarshalText(text []byte) error

type YamlUnmarshallableVersionConstraint

type YamlUnmarshallableVersionConstraint semver.Constraints

func NewYamlUnmarshallableVersionConstraint

func NewYamlUnmarshallableVersionConstraint(v *semver.Constraints) *YamlUnmarshallableVersionConstraint

func (*YamlUnmarshallableVersionConstraint) Raw

func (constraint *YamlUnmarshallableVersionConstraint) Raw() *semver.Constraints

func (*YamlUnmarshallableVersionConstraint) UnmarshalText

func (constraint *YamlUnmarshallableVersionConstraint) UnmarshalText(text []byte) error