config

package
v0.1.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 9, 2026 License: MIT Imports: 21 Imported by: 0

Documentation

Overview

Package config defines the runtime configuration model: database, entities, per-tool toggles, cost thresholds, cache, rate limits, and audit. It contains defaults, validation, encoding-independent presence tracking, and presence-aware JSON decoding. Schema exports YAML editor assistance and documentation; it is not an encoding/json input contract.

Field rules live in `schema` struct tags (see schema_rules.go) and field help in fields.yaml; schema.json and the field reference in docs/configuration.md are generated from them.

Index

Constants

View Source 
const DefaultConnection = "default"

DefaultConnection names the single connection a DSN shorthand declares.

View Source 
const StoreTablePrefix = "smcp_"

StoreTablePrefix prefixes every configuration store table. Entities may not use such a source and introspection skips such tables, so the store is never exposed through the governed data plane.

View Source 
const TokenHashPrefix = "sha256:"

TokenHashPrefix is the only supported tokenHash algorithm.

View Source 
const UserPrincipalPrefix = "user:"

UserPrincipalPrefix prefixes the principal key of a configured user. Role and user names cannot contain ':', so the prefix never collides with a role.

Variables

View Source 
var (
	// ErrInvalidDriver is returned when Database.Driver is empty or malformed.
	ErrInvalidDriver = errors.New("config: invalid database driver")
	// ErrEmptyDSN is returned when Database.DSN is empty.
	ErrEmptyDSN = errors.New("config: empty database DSN")
	// ErrEmptyEntityName is returned when an entity has an empty name.
	ErrEmptyEntityName = errors.New("config: empty entity name")
)

Sentinel validation errors.

View Source 
var (
	// ErrUnknownEntity reports an entity reference naming no entity.
	ErrUnknownEntity = errors.New("unknown entity")
	// ErrAmbiguousEntity reports an entity reference naming several entities.
	ErrAmbiguousEntity = errors.New("ambiguous entity")
)

Functions

func DefaultSecretRoots added in v0.1.11 

func DefaultSecretRoots() []string

DefaultSecretRoots are the directories ${file:...} secrets may be read from when server.secrets.allowedRoots is unset.

func IsStoreTable added in v0.1.11 

func IsStoreTable(name string) bool

IsStoreTable reports whether a table name is reserved for the store.

func NewUserToken added in v0.1.11 

func NewUserToken() (string, error)

NewUserToken returns a 256-bit random bearer token ("smcp_" + base64url).

func RestartFieldChanges added in v0.1.11 

func RestartFieldChanges(old, next *Config) []string

RestartFieldChanges returns the paths of fields tagged restart whose value differs between old and next. Empty and unset lists or maps compare equal, and unexported bookkeeping is ignored.

func Schema 

func Schema() json.RawMessage

Schema returns a JSON Schema for YAML editor assistance and documentation. Duration fields therefore describe the YAML string form (for example "30s"); this schema is not a standard encoding/json input contract. Runtime validation and provider capability checks still run when the configuration is loaded.

func TokenHash added in v0.1.11 

func TokenHash(token string) string

TokenHash returns the tokenHash form ("sha256:<hex>") of a bearer token.

func YAMLName added in v0.1.11 

func YAMLName(f reflect.StructField) string

YAMLName returns a field's configuration key, or "" when it has none.

Types

type AQEConfig 

type AQEConfig struct {
	WindowSize        int           `yaml:"windowSize"        json:"windowSize" schema:"min=0"`
	AnomalyFactor     float64       `yaml:"anomalyFactor"     json:"anomalyFactor" schema:"min=0"`
	AnomalyMinSamples int           `yaml:"anomalyMinSamples" json:"anomalyMinSamples" schema:"min=0"`
	ExplainAnalyze    bool          `yaml:"explainAnalyze"    json:"explainAnalyze"`
	ReadOnly          bool          `yaml:"readOnly"          json:"readOnly"`
	SampleRate        float64       `yaml:"sampleRate"        json:"sampleRate" schema:"min=0,max=1"`
	Timeout           time.Duration `yaml:"timeout"           json:"timeout" schema:"min=0,max=5s"`
	MaxFingerprints   int           `yaml:"maxFingerprints"   json:"maxFingerprints" schema:"min=1"`
	// contains filtered or unexported fields
}

AQEConfig controls bounded estimate feedback and optional read-only EXPLAIN ANALYZE sampling.

func (*AQEConfig) UnmarshalJSON 

func (c *AQEConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON tracks optional safety fields.

type AuditConfig 

type AuditConfig struct {
	Enabled   bool   `yaml:"enabled"   json:"enabled"`
	Path      string `yaml:"path"      json:"path"`
	QueueSize int    `yaml:"queueSize" json:"queueSize" schema:"min=0"`
}

AuditConfig configures the audit sink.

type AuthConfig 

type AuthConfig struct {
	Token             string    `yaml:"token"             json:"token"`
	TrustProxyHeaders bool      `yaml:"trustProxyHeaders" json:"trustProxyHeaders"`
	TrustedProxyCIDRs []string  `yaml:"trustedProxyCIDRs" json:"trustedProxyCIDRs"`
	TLS               TLSConfig `yaml:"tls"               json:"tls"`
}

AuthConfig configures HTTP transport authentication. When the listener is not bound to loopback, at least one of Token or TLS.ClientCA (mTLS) must be configured or startup is refused (fail-closed). The caller identity headers (X-MCP-Role / X-MCP-Subject) are trusted only when TrustProxyHeaders is true, and either mTLS or TrustedProxyCIDRs establishes the proxy trust boundary.

type BudgetConfig 

type BudgetConfig struct {
	Roles   map[string]BudgetLimits `yaml:"roles"   json:"roles"`
	Tenants map[string]BudgetLimits `yaml:"tenants" json:"tenants"`
	Users   map[string]BudgetLimits `yaml:"users,omitempty" json:"users,omitempty"`
}

BudgetConfig contains role and tenant scoped resource limits.

type BudgetLimits 

type BudgetLimits struct {
	MaxConcurrent           int           `yaml:"maxConcurrent"            json:"maxConcurrent" schema:"min=0"`
	MaxExecution            time.Duration `yaml:"maxExecution"             json:"maxExecution" schema:"min=0"`
	MaxEstimatedScannedRows int64         `yaml:"maxEstimatedScannedRows"  json:"maxEstimatedScannedRows" schema:"min=0"`
	MaxReturnedRows         int64         `yaml:"maxReturnedRows"          json:"maxReturnedRows" schema:"min=0"`
	MaxReturnedBytes        int64         `yaml:"maxReturnedBytes"         json:"maxReturnedBytes" schema:"min=0"`
	MaxSessionCost          int64         `yaml:"maxSessionCost"           json:"maxSessionCost" schema:"min=0"`
}

BudgetLimits is unlimited when all fields are zero.

type CacheConfig 

type CacheConfig struct {
	Enabled         bool          `yaml:"enabled"         json:"enabled"`
	TTL             time.Duration `yaml:"ttl"             json:"ttl" schema:"min=0"`
	MaxSize         int           `yaml:"maxSize"         json:"maxSize" schema:"min=0"`
	MaxEntryRows    int           `yaml:"maxEntryRows"    json:"maxEntryRows" schema:"min=0"`
	MaxEntryBytes   int64         `yaml:"maxEntryBytes"   json:"maxEntryBytes" schema:"min=0"`
	PreparedMaxSize int           `yaml:"preparedMaxSize" json:"preparedMaxSize" schema:"min=0"`
}

CacheConfig configures the read cache.

type Config 

type Config struct {
	Version      string                    `yaml:"version"         json:"version"`
	Server       ServerConfig              `yaml:"server"          json:"server"`
	Database     DatabaseConfig            `yaml:"database"        json:"database" schema:"nodefault"`
	Databases    map[string]DatabaseConfig `yaml:"databases"       json:"databases" schema:"nodefault,keys=@pathSegment"`
	Entities     []EntityConfig            `yaml:"entities"        json:"entities"`
	Roles        map[string]RoleDefinition `yaml:"roles,omitempty" json:"roles,omitempty" schema:"keys=@accessName"`
	Users        map[string]UserConfig     `yaml:"users,omitempty" json:"users,omitempty" schema:"keys=@accessName"`
	Tools        ToolFlags                 `yaml:"tools"           json:"tools" schema:"nodefault"`
	Cost         CostConfig                `yaml:"cost"            json:"cost"`
	Budget       BudgetConfig              `yaml:"budget"          json:"budget"`
	Cache        CacheConfig               `yaml:"cache"           json:"cache"`
	RateLimit    RateLimitConfig           `yaml:"rateLimit"       json:"rateLimit"`
	Mask         MaskConfig                `yaml:"mask"            json:"mask"`
	Audit        AuditConfig               `yaml:"audit"           json:"audit"`
	Transactions TransactionConfig         `yaml:"transactions"    json:"transactions"`
}

Config is the top-level configuration. Version is the configuration contract marker; the current value is "1" and loaders currently preserve it without rejecting other values.

func (*Config) ApplyDefaults 

func (c *Config) ApplyDefaults()

ApplyDefaults fills unset fields with safe defaults. An omitted Tools section receives DefaultToolFlags; entities with unset MCP get DMLTools=true; each omitted cost safety field receives its own default; rate limits default to conservative bounds.

func (*Config) ApplyPresence 

func (c *Config) ApplyPresence(p Presence)

ApplyPresence applies encoding-specific field presence to a decoded Config.

func (*Config) Validate 

func (c *Config) Validate() error

Validate checks a configuration whose defaults are applied (ApplyDefaults; every loader does this). DSN placeholder resolution happens later in x/bootstrap; here we only require non-empty.

type ConnectionConfig added in v0.1.11 

type ConnectionConfig struct {
	DSN string `yaml:"dsn" json:"dsn" schema:"required,minLength=1"`
	// Role is primary (the default) or replica; a replica serves reads only.
	Role string `yaml:"role,omitempty" json:"role,omitempty" schema:"enum=@connectionRole"`
	// Pooler is "transaction" behind a transaction-mode pooler (pgbouncer,
	// ProxySQL): no session state such as prepared statements is kept.
	Pooler string `yaml:"pooler,omitempty" json:"pooler,omitempty" schema:"enum=@pooler"`
}

ConnectionConfig is one way to reach a database: an endpoint and account.

type Connections added in v0.1.11 

type Connections map[string]ConnectionConfig

Connections are a database's connections by name.

type CostConfig 

type CostConfig struct {
	Enabled             *bool         `yaml:"enabled,omitempty"           json:"enabled,omitempty"`
	SoftScore           int           `yaml:"softScore"                   json:"softScore" schema:"min=0,max=100"`
	HardScore           int           `yaml:"hardScore"                   json:"hardScore" schema:"min=0,max=100"`
	MaxRows             int64         `yaml:"maxRows"                     json:"maxRows" schema:"min=1"`
	MaxBytes            int64         `yaml:"maxBytes"                    json:"maxBytes" schema:"min=1"`
	MaxINListSize       int           `yaml:"maxINListSize"               json:"maxINListSize" schema:"min=1"`
	MaxFilterConditions int           `yaml:"maxFilterConditions"         json:"maxFilterConditions" schema:"min=1"`
	MaxGroupByFields    int           `yaml:"maxGroupByFields"            json:"maxGroupByFields" schema:"min=1"`
	MaxAggregates       int           `yaml:"maxAggregates"               json:"maxAggregates" schema:"min=1"`
	MaxExpand           int           `yaml:"maxExpand"                   json:"maxExpand" schema:"min=1"`
	MaxProcedureRows    int64         `yaml:"maxProcedureRows"            json:"maxProcedureRows" schema:"min=1"`
	RejectFullScan      bool          `yaml:"rejectFullScan"              json:"rejectFullScan"`
	WhitelistPKPoint    bool          `yaml:"whitelistPKPoint"            json:"whitelistPKPoint"`
	RequirePKForWrite   *bool         `yaml:"requirePKForWrite,omitempty" json:"requirePKForWrite,omitempty"`
	RequireKnownScan    bool          `yaml:"requireKnownScan"            json:"requireKnownScan"`
	RequireFreshStats   bool          `yaml:"requireFreshStats"           json:"requireFreshStats"`
	QueryTimeout        time.Duration `yaml:"queryTimeout"                json:"queryTimeout" schema:"min=0"`
	AllowTemplates      []string      `yaml:"allowTemplates"              json:"allowTemplates"`
	RejectTemplates     []string      `yaml:"rejectTemplates"             json:"rejectTemplates"`
	AQE                 AQEConfig     `yaml:"aqe"                         json:"aqe"`
	// contains filtered or unexported fields
}

CostConfig configures the defense-in-depth cost gate. SoftScore/HardScore are the 0-100 normalized thresholds (from cost.ScorePlan) for soft/hard reject.

func (CostConfig) EnabledOrDefault 

func (c CostConfig) EnabledOrDefault() bool

EnabledOrDefault reports whether cost protection is on; nil means default true. A pointer preserves an explicit enabled: false through YAML decoding.

func (CostConfig) RequirePKForWriteOrDefault 

func (c CostConfig) RequirePKForWriteOrDefault() bool

RequirePKForWriteOrDefault reports whether writes must be primary-key scoped. A nil setting defaults to true (safe): a non-point UPDATE/DELETE is rejected unless explicitly allowed via allowTemplates.

func (*CostConfig) UnmarshalJSON 

func (c *CostConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON tracks each cost field independently.

type DatabaseConfig 

type DatabaseConfig struct {
	Driver      string        `yaml:"driver"                json:"driver" schema:"required,pattern=@driver"`
	DSN         string        `yaml:"dsn,omitempty"         json:"dsn,omitempty"`
	Connections Connections   `yaml:"connections,omitempty" json:"connections,omitempty" schema:"keys=@accessName"`
	Routing     RoutingConfig `yaml:"routing,omitempty"     json:"routing,omitempty"`
	// ReadAfterWrite routes a session's reads to the write connection for
	// this long after it writes, so it reads its own writes on a replica.
	ReadAfterWrite time.Duration `yaml:"readAfterWrite,omitempty" json:"readAfterWrite,omitempty" schema:"min=0"`
}

DatabaseConfig is one database (a datasource): one connection given by DSN, or several connections, such as accounts with different privileges or read replicas, with Routing choosing one per kind of action. DSNs may contain ${ENV} or ${file:/path} placeholders resolved by x/bootstrap.

func (DatabaseConfig) ConnectionsOrDSN added in v0.1.11 

func (d DatabaseConfig) ConnectionsOrDSN() Connections

ConnectionsOrDSN returns the database's connections: the DSN shorthand as one primary connection named DefaultConnection, or Connections.

func (DatabaseConfig) Route added in v0.1.11 

func (d DatabaseConfig) Route() RoutingConfig

Route returns the connections for reads, writes and procedure calls; a single connection without routing serves every route.

type EntityConfig 

type EntityConfig struct {
	Name          string                    `yaml:"name" json:"name" schema:"required,minLength=1,pattern=@pathSegment"`
	Source        string                    `yaml:"source,omitempty"        json:"source,omitempty"`
	DataSource    string                    `yaml:"datasource,omitempty"    json:"datasource,omitempty"`
	Schema        string                    `yaml:"schema,omitempty" json:"schema,omitempty" schema:"pattern=@pathSegment"`
	Kind          string                    `yaml:"kind,omitempty" json:"kind,omitempty" schema:"enum=@entityKind"`
	Description   string                    `yaml:"description,omitempty"   json:"description,omitempty"`
	PrimaryKey    []string                  `yaml:"primaryKey,omitempty"    json:"primaryKey,omitempty"`
	UniqueKeys    [][]string                `yaml:"uniqueKeys,omitempty"    json:"uniqueKeys,omitempty"`
	Fields        []FieldConfig             `yaml:"fields,omitempty"        json:"fields,omitempty"`
	Roles         RoleConfig                `yaml:"roles,omitempty"         json:"roles,omitempty"`
	FieldACL      map[string]FieldACLConfig `yaml:"fieldACL,omitempty"      json:"fieldACL,omitempty"`
	MCP           MCPFlags                  `yaml:"mcp"                     json:"mcp"`
	RowPolicies   RowPolicies               `yaml:"rowPolicies,omitempty"   json:"rowPolicies,omitempty"`
	Relationships []RelationshipConfig      `yaml:"relationships,omitempty" json:"relationships,omitempty"`
	// TenantPolicy is ANDed for every principal and never merged across grants.
	TenantPolicy FilterConfig `yaml:"tenantPolicy,omitempty"  json:"tenantPolicy,omitempty"`
	// Params is the ordered formal-parameter list for a procedure entity, bound
	// positionally by execute_entity. Required for procedures.
	Params []string `yaml:"params,omitempty"        json:"params,omitempty"`
	// Affects lists the entities a procedure writes, for cache invalidation;
	// empty invalidates every cached read of its datasource.
	Affects []string `yaml:"affects,omitempty"       json:"affects,omitempty"`
	// AllowCascade admits deletes and key updates that foreign keys cascade
	// to other relations without the caller's permissions on them.
	AllowCascade bool `yaml:"allowCascade,omitempty"  json:"allowCascade,omitempty"`
}

EntityConfig is the configuration view of one entity. Kind is table, view or procedure.

func (EntityConfig) DatasourceName added in v0.1.11 

func (e EntityConfig) DatasourceName() string

DatasourceName is the entity's datasource: DataSource, or "default" (the single database section) when empty.

func (EntityConfig) ID added in v0.1.12 

func (e EntityConfig) ID() string

ID is the canonical identity of the entity (see entity.ID).

func (EntityConfig) PhysicalSource added in v0.1.11 

func (e EntityConfig) PhysicalSource() string

PhysicalSource is the table or procedure the entity reads: Source, or the entity name when Source is empty.

type EntityRefs added in v0.1.12 

type EntityRefs struct {
	// contains filtered or unexported fields
}

EntityRefs resolves entity references the way the gateway does (see entity.Registry.Match): an entity's ID names it, otherwise any of its entity.ReferencesOf. A configuration's references must each name exactly one entity, so adding an entity can never silently change what an existing reference names: the configuration fails validation instead.

func NewEntityRefs added in v0.1.12 

func NewEntityRefs(entities []EntityConfig) EntityRefs

NewEntityRefs indexes entities; the last of several with one ID wins.

func (EntityRefs) Resolve added in v0.1.12 

func (r EntityRefs) Resolve(ref string) (EntityConfig, error)

Resolve returns the one entity ref names.

type FieldACLConfig 

type FieldACLConfig struct {
	Read  []string `yaml:"read,omitempty"  json:"read,omitempty"`
	Write []string `yaml:"write,omitempty" json:"write,omitempty"`
}

FieldACLConfig restricts one role to named readable and writable fields. Omitting a role leaves existing entity-level authorization behavior intact.

type FieldConfig 

type FieldConfig struct {
	Name        string `yaml:"name"                  json:"name" schema:"required,minLength=1"`
	Alias       string `yaml:"alias,omitempty"       json:"alias,omitempty"`
	Description string `yaml:"description,omitempty" json:"description,omitempty"`
	Mask        string `yaml:"mask,omitempty"        json:"mask,omitempty" schema:"examples=@maskRule"`
	Exclude     bool   `yaml:"exclude,omitempty"     json:"exclude,omitempty"`
}

FieldConfig configures one column.

type FilterConfig 

type FilterConfig = map[string]any

FilterConfig is a declarative filter (JSON object) for row-level policies, converted to a relalg.Predicate by x/bootstrap.

type GrantConfig added in v0.1.11 

type GrantConfig struct {
	Entity  string          `yaml:"entity"           json:"entity" schema:"required,minLength=1"`
	Actions []string        `yaml:"actions"          json:"actions" schema:"required,minItems=1,enum=@grantAction"`
	Fields  *FieldACLConfig `yaml:"fields,omitempty" json:"fields,omitempty"`
	Rows    FilterConfig    `yaml:"rows,omitempty"   json:"rows,omitempty"`
}

GrantConfig is one entity permission. A nil Fields grants every visible field; a present Fields behaves like a fieldACL entry. Empty Rows grants all rows.

type MCPFlags 

type MCPFlags struct {
	DMLTools         bool `yaml:"dmlTools"                   json:"dmlTools"`
	CustomTool       bool `yaml:"customTool,omitempty"       json:"customTool,omitempty"`
	TrustedProcedure bool `yaml:"trustedProcedure,omitempty" json:"trustedProcedure,omitempty"`
	// contains filtered or unexported fields
}

MCPFlags controls entity participation in MCP. Zero value means "not set"; ApplyDefaults sets DMLTools=true for unset entities.

func MCPFlagsWithDMLTools 

func MCPFlagsWithDMLTools(enabled bool) MCPFlags

MCPFlagsWithDMLTools constructs MCP flags with an explicit dmlTools value. Use it for programmatic configuration when false must differ from omission.

func (*MCPFlags) UnmarshalJSON 

func (f *MCPFlags) UnmarshalJSON(data []byte) error

UnmarshalJSON preserves an explicit false dmlTools value.

type MaskConfig 

type MaskConfig struct {
	Enabled *bool `yaml:"enabled,omitempty" json:"enabled,omitempty"`
}

MaskConfig controls field masking. Enabled defaults to true when unset.

func (MaskConfig) EnabledOrDefault 

func (c MaskConfig) EnabledOrDefault() bool

EnabledOrDefault reports whether masking is on; nil means default true.

type Presence 

type Presence struct {
	Tools          bool
	Cost           map[string]bool
	CostAQE        map[string]bool
	EntityDMLTools []bool
}

Presence records fields whose explicit presence affects defaulting. Loaders for any encoding can populate it after decoding and call ApplyPresence.

type RateLimitConfig 

type RateLimitConfig struct {
	Enabled          *bool         `yaml:"enabled,omitempty" json:"enabled,omitempty"`
	RPS              float64       `yaml:"rps"               json:"rps" schema:"min=0"`
	MaxInflight      int           `yaml:"maxInflight"       json:"maxInflight" schema:"min=0"`
	IOPool           int           `yaml:"ioPool"            json:"ioPool" schema:"min=0"`
	MinConcurrency   int           `yaml:"minConcurrency"    json:"minConcurrency" schema:"min=0"`
	RTTThreshold     time.Duration `yaml:"rttThreshold"      json:"rttThreshold" schema:"min=0"`
	BreakerThreshold int           `yaml:"breakerThreshold"  json:"breakerThreshold" schema:"min=0"`
	BreakerCooldown  time.Duration `yaml:"breakerCooldown"   json:"breakerCooldown" schema:"min=0"`
	ConnMaxIdleTime  time.Duration `yaml:"connMaxIdleTime"   json:"connMaxIdleTime" schema:"min=0"`
	ConnMaxLifetime  time.Duration `yaml:"connMaxLifetime"   json:"connMaxLifetime" schema:"min=0"`
}

RateLimitConfig configures the engine's concurrency and rate limits.

func (RateLimitConfig) EnabledOrDefault 

func (c RateLimitConfig) EnabledOrDefault() bool

EnabledOrDefault reports whether rate limiting is on; nil means default true.

type RelationshipConfig 

type RelationshipConfig struct {
	Name        string            `yaml:"name"        json:"name" schema:"required,minLength=1"`
	Target      string            `yaml:"target"      json:"target" schema:"required,minLength=1"`
	Cardinality string            `yaml:"cardinality" json:"cardinality" schema:"required,enum=@cardinality"`
	JoinOn      map[string]string `yaml:"joinOn"      json:"joinOn" schema:"required"`
}

RelationshipConfig configures a same-data-source batch expansion.

type RoleConfig 

type RoleConfig struct {
	Read      []string `yaml:"read,omitempty"      json:"read,omitempty"`
	Create    []string `yaml:"create,omitempty"    json:"create,omitempty"`
	Update    []string `yaml:"update,omitempty"    json:"update,omitempty"`
	Delete    []string `yaml:"delete,omitempty"    json:"delete,omitempty"`
	Execute   []string `yaml:"execute,omitempty"   json:"execute,omitempty"`
	Aggregate []string `yaml:"aggregate,omitempty" json:"aggregate,omitempty"`
}

RoleConfig lists allowed roles per action.

type RoleDefinition added in v0.1.11 

type RoleDefinition struct {
	Description string        `yaml:"description,omitempty" json:"description,omitempty"`
	Grants      []GrantConfig `yaml:"grants,omitempty"      json:"grants,omitempty"`
	// Permissions holds system permissions such as "sql:execute@<datasource>".
	// None is supported yet; any value fails validation.
	Permissions []string `yaml:"permissions,omitempty" json:"permissions,omitempty"`
}

RoleDefinition is a named set of grants declared at the top level. Entity level roles/fieldACL/rowPolicies remain valid and merge into the same role.

type RoutingConfig added in v0.1.11 

type RoutingConfig struct {
	Read    string `yaml:"read,omitempty"    json:"read,omitempty"`
	Write   string `yaml:"write,omitempty"   json:"write,omitempty"`
	Execute string `yaml:"execute,omitempty" json:"execute,omitempty"`
}

RoutingConfig names the connection each kind of action uses: Read for reads, aggregates, EXPLAIN and read-only transactions; Write for creates, updates, deletes and read-write transactions; Execute for procedures.

type RowPolicies 

type RowPolicies map[string]FilterConfig

RowPolicies maps a role name to its row-level filter.

type Rule added in v0.1.11 

type Rule struct {
	Required, Restart, NoDefault bool
	// Min and Max are numbers, or Go durations on duration fields.
	Min, Max            string
	MinLength, MinItems int
	Enum                []string
	Examples            []string
	// Pattern and Keys are regular expressions; the names are their keys in
	// the named pattern table.
	Pattern, Keys         string
	PatternName, KeysName string
}

Rule is the parsed `schema` tag of one field.

func ParseRule added in v0.1.11 

func ParseRule(tag string) (Rule, error)

ParseRule parses a `schema` struct tag.

type SecretsConfig 

type SecretsConfig struct {
	AllowedRoots []string `yaml:"allowedRoots" json:"allowedRoots"`
}

SecretsConfig restricts ${file:...} expansion to explicitly trusted roots.

type ServerConfig 

type ServerConfig struct {
	Transport string `yaml:"transport" json:"transport" schema:"enum=@transport,restart"`
	// Addr is the HTTP listen address.
	Addr string `yaml:"addr" json:"addr" schema:"restart"`
	// Role is the runtime role; the --role flag overrides it.
	Role string `yaml:"role" json:"role"`
	// Auth configures HTTP transport authentication.
	Auth    AuthConfig    `yaml:"auth"    json:"auth"`
	Secrets SecretsConfig `yaml:"secrets" json:"secrets"`

	// User is the default user for requests without a user identity; it takes
	// precedence over Role and may be overridden by the --user flag.
	User string `yaml:"user,omitempty" json:"user,omitempty"`
}

ServerConfig holds transport and role settings.

type TLSConfig 

type TLSConfig struct {
	Cert     string `yaml:"cert"     json:"cert"`
	Key      string `yaml:"key"      json:"key"`
	ClientCA string `yaml:"clientCA" json:"clientCA"`
}

TLSConfig configures TLS/mTLS for the HTTP transport. Cert+Key enable TLS; setting ClientCA additionally requires and verifies a client certificate.

type ToolFlags 

type ToolFlags struct {
	DescribeEntities    bool `yaml:"describeEntities"    json:"describeEntities"`
	ReadRecords         bool `yaml:"readRecords"         json:"readRecords"`
	CreateRecord        bool `yaml:"createRecord"        json:"createRecord"`
	UpdateRecord        bool `yaml:"updateRecord"        json:"updateRecord"`
	DeleteRecord        bool `yaml:"deleteRecord"        json:"deleteRecord"`
	ExecuteEntity       bool `yaml:"executeEntity"       json:"executeEntity"`
	AggregateRecords    bool `yaml:"aggregateRecords"    json:"aggregateRecords"`
	BeginTransaction    bool `yaml:"beginTransaction"    json:"beginTransaction"`
	CommitTransaction   bool `yaml:"commitTransaction"   json:"commitTransaction"`
	RollbackTransaction bool `yaml:"rollbackTransaction" json:"rollbackTransaction"`
	// contains filtered or unexported fields
}

ToolFlags toggles each DML tool. Decoding tracks whether the tools node was present so an explicit all-false object differs from omission.

func DefaultToolFlags 

func DefaultToolFlags() ToolFlags

DefaultToolFlags returns the safe default tool set: all tools enabled except delete_record, which is off by default to prevent accidental data loss.

func (*ToolFlags) UnmarshalJSON 

func (f *ToolFlags) UnmarshalJSON(data []byte) error

UnmarshalJSON records that the tools object was present.

type TransactionConfig 

type TransactionConfig struct {
	TTL             time.Duration `yaml:"ttl"             json:"ttl" schema:"min=0"`
	MaxOpen         int           `yaml:"maxOpen"         json:"maxOpen" schema:"min=0"`
	BeginTimeout    time.Duration `yaml:"beginTimeout"    json:"beginTimeout" schema:"min=0"`
	CommitTimeout   time.Duration `yaml:"commitTimeout"   json:"commitTimeout" schema:"min=0"`
	RollbackTimeout time.Duration `yaml:"rollbackTimeout" json:"rollbackTimeout" schema:"min=0"`
}

TransactionConfig bounds explicit transaction lifetime and cardinality.

type UserConfig added in v0.1.11 

type UserConfig struct {
	Description string         `yaml:"description,omitempty" json:"description,omitempty"`
	TokenHash   string         `yaml:"tokenHash,omitempty"   json:"tokenHash,omitempty" schema:"pattern=@tokenHash"`
	Roles       []string       `yaml:"roles,omitempty"       json:"roles,omitempty" schema:"pattern=@accessName"`
	Subject     map[string]any `yaml:"subject,omitempty"     json:"subject,omitempty"`
	Grants      []GrantConfig  `yaml:"grants,omitempty"      json:"grants,omitempty"`
	Permissions []string       `yaml:"permissions,omitempty" json:"permissions,omitempty"`
	Disabled    bool           `yaml:"disabled,omitempty"    json:"disabled,omitempty"`
}

UserConfig is one authenticated caller. TokenHash is "sha256:<hex>" of the bearer token; the plaintext token never appears in configuration.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.