tool

package

Go to main page

Versions in this module

v0

v0.1.19

Oct 17, 2026

v0.1.18

Oct 17, 2026

Changes in this version

+ func VisibleIndexes(e entity.Entity, visible []string) []map[string]any

type Limits

+ SQLEscapeMetadata bool

type Result

+ NextCursor map[string]any

v0.1.17

Oct 16, 2026

Changes in this version

+ const CodeDatasourceUnavailable

+ const CodeEntityUnavailable

+ const CodeOverloaded

+ const CodeRateLimited

+ var ErrCallerRateLimited = errors.New("tool: the caller's request limit is reached")

+ var ErrEntityUnavailable = errors.New("tool: entity unavailable")

type Info

+ Destructive bool

+ Idempotent bool

+ Object bool

+ Title string

type Limits

+ Tightening cost.Tightening

type ProcedureTool

+ Name string

+ type SchemaDrift struct

+ func (d *SchemaDrift) Pending() bool

+ func (d *SchemaDrift) Report() bool

+ func (d *SchemaDrift) Take() bool

type Services

+ Callers *ratelimit.Keyed

+ Drift *SchemaDrift

type TransactionManager

+ func (m *TransactionManager) SetIdleTimeout(d time.Duration)

+ type TransactionRolledBackError struct

+ Err error

+ func (e *TransactionRolledBackError) Error() string

+ func (e *TransactionRolledBackError) Unwrap() error

v0.1.16

Oct 16, 2026

v0.1.15

Oct 14, 2026

Changes in this version

+ const ActionSQL

+ const CodeAuditUnavailable

+ var ErrAuditUnavailable = errors.New("tool: the audit log is unavailable; execute_sql is audited fail closed")

+ type EscapeRoute struct

+ Connection string

+ DB store.DB

+ Dialect dialect.Dialect

+ Explainer cost.Explainer

+ Threshold cost.Threshold

+ type ExecuteSQLTool struct

+ func (ExecuteSQLTool) Enabled(f config.ToolFlags) bool

+ func (ExecuteSQLTool) Info() Info

+ func (ExecuteSQLTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

type Limits

+ SQLEscapeEstimateRequired bool

+ type RawDBError struct

+ Cause error

+ Kind error

+ func (e *RawDBError) Error() string

+ func (e *RawDBError) Is(target error) bool

+ func (e *RawDBError) SQLState() string

+ func (e *RawDBError) Unwrap() error

type Result

+ Counted bool

type Services

+ Escapes map[string]EscapeRoute

+ type UnestimableError struct

+ Cause error

+ func (e *UnestimableError) Error() string

+ func (e *UnestimableError) Unwrap() error

v0.1.13

Oct 11, 2026

Changes in this version

+ const CodeOutcomeUnknown

+ const OutcomeCommitted

+ const OutcomeExpired

+ const OutcomeRolledBack

+ const OutcomeUnknown

+ var ErrOutcomeUnknown = errors.New("tool: the database may or may not have carried out the write")

+ type Caller struct

+ Role string

+ Session string

+ Subject map[string]any

+ type ResultMemory struct

+ func NewResultMemory(capacity int64) *ResultMemory

+ func (r *ResultMemory) InUse() int64

+ func (r *ResultMemory) SetCapacity(capacity int64)

+ type Services struct

+ Auditor audit.Auditor

+ Authorizer rbac.Authorizer

+ Budget budget.Manager

+ Cache cache.Cache[[]map[string]any]

+ Engine *engine.Engine

+ Feedback cost.FeedbackStore

+ Generation uint64

+ Hooks *hook.Hooks

+ Masker mask.Masker

+ Registry *entity.Registry

+ ResultMemory *ResultMemory

+ Sources map[string]DataSource

+ Transactions *TransactionManager

+ TxBeginners map[string]store.TxBeginner

+ WriteTargets *WriteTargets

+ Writes *WriteTracker

+ type TransactionEndedError struct

+ Outcome string

+ func (e *TransactionEndedError) Error() string

+ func (e *TransactionEndedError) Unwrap() error

type TransactionManager

+ func (m *TransactionManager) SetConnectionLimit(n int)

+ func (m *TransactionManager) UseBus(b *bus.Bus)

v0.1.12

Oct 9, 2026

Changes in this version

+ const CodeAmbiguousEntity

+ const CodeTransactionStale

+ var ErrTransactionStale = errors.New("tool: transaction datasource was reconfigured; roll it back and begin again")

+ func UsableBy(ctx context.Context, authz rbac.Authorizer, role string, ...) func(entity.Entity) bool

+ type AmbiguousEntityError struct

+ Candidates []string

+ Ref string

+ func (e *AmbiguousEntityError) Error() string

+ func (e *AmbiguousEntityError) Unwrap() error

type CacheTarget

+ Physical string

type Context

+ Generation uint64

+ WriteTargets *WriteTargets

type TransactionManager

+ func (m *TransactionManager) UpdateLimits(ttl time.Duration, maxOpen int)

+ type WriteTargets struct

+ func BuildWriteTargets(reg *entity.Registry) *WriteTargets

v0.1.11

Oct 8, 2026

Changes in this version

+ const CodeAmbiguousFieldScope

+ const CodeConstraintViolation

+ const CodeDatasourceForbidden

+ var ErrConstraintViolation = errors.New("tool: constraint violation")

+ var ErrDatasourceForbidden = errors.New("tool: the datasource connection is not permitted to do this")

+ func VisibleKeys(e entity.Entity, visible []string) [][]string

+ type AmbiguousFieldScopeError struct

+ FieldScopes [][]string

+ Reason string

+ func (e *AmbiguousFieldScopeError) Error() string

+ func (e *AmbiguousFieldScopeError) Unwrap() error

+ type CacheTarget struct

+ Database string

+ Relation string

+ type ConstraintViolationError struct

+ Fields []string

+ Kind string

+ func (e *ConstraintViolationError) Error() string

+ func (e *ConstraintViolationError) Unwrap() error

type Context

+ User string

+ UserRoles []string

+ Writes *WriteTracker

type DataSource

+ Execute store.DB

+ ReadAfterWrite time.Duration

+ ReadTx store.TxBeginner

+ Write store.DB

type Info

+ Action string

+ type Limits struct

+ CacheMaxEntryBytes int64

+ CacheMaxEntryRows int

+ MaxAggregates int

+ MaxExpand int

+ MaxFilterConditions int

+ MaxGroupByFields int

+ MaxINListSize int

+ MaxProcedureRows int64

+ MaxReturnedBytes int64

+ MaxRows int64

+ Timeout time.Duration

+ TransactionBeginTimeout time.Duration

+ TransactionCommitTimeout time.Duration

+ TransactionRollbackTimeout time.Duration

type ProcedureTool

+ func FindProcedureTool(reg *entity.Registry, name string) (ProcedureTool, bool)

+ func ProcedureTools(reg *entity.Registry) []ProcedureTool

type Result

+ Grants []string

+ type WriteTracker struct

+ func NewWriteTracker() *WriteTracker

+ func (w *WriteTracker) Forget(session string)

+ func (w *WriteTracker) Recent(session, datasource string, window time.Duration) bool

+ func (w *WriteTracker) Record(session, datasource string)

+ func (w *WriteTracker) Wrote(session string) bool

v0.1.10

Jul 12, 2026

v0.1.9

Jul 12, 2026

v0.1.8

Jul 12, 2026

v0.1.6

Jul 11, 2026

v0.1.5

Jul 11, 2026

Changes in this version

+ const CodeBudgetExceeded

+ const CodeCostExceeded

+ const CodeDMLToolsDisabled

+ const CodeDatabaseError

+ const CodeEntityNotFound

+ const CodeInvalidInput

+ const CodeNotImplemented

+ const CodeTransactionCapacity

+ const CodeTransactionNotFound

+ const CodeTransactionScope

+ const CodeUnauthorized

+ const CodeUnsafeWrite

+ func DecisionIDFromContext(ctx context.Context) string

+ func NewDecisionID() string

+ func WithDecisionID(ctx context.Context, id string) context.Context

type Context

+ DecisionID string

+ type Denial struct

+ Code string

+ Constraints map[string]any

+ DecisionID string

+ Hints []string

+ Reason string

+ Retryable bool

+ func DenialFor(err error, decisionID string) (Denial, bool)

v0.1.4

Jul 11, 2026

Changes in this version

+ var ErrDMLToolsDisabled = errors.New("tool: entity DML tools disabled")

+ var ErrDatabase = errors.New("tool: database error")

+ var ErrDuplicateTool = errors.New("tool: duplicate name")

+ var ErrEntityNotFound = errors.New("tool: entity not found")

+ var ErrInvalidInput = errors.New("tool: invalid input")

+ var ErrNotImplemented = errors.New("tool: not implemented")

+ var ErrTransactionCapacity = errors.New("tool: transaction capacity reached")

+ var ErrTransactionNotFound = errors.New("tool: transaction not found")

+ var ErrTransactionScope = errors.New("tool: transaction scope mismatch")

+ var ErrUnauthorized = errors.New("tool: unauthorized")

+ var ErrUnsafeWrite = errors.New("tool: unsafe write without primary-key filter")

+ func ProcedureToolName(entityName string) string

+ func WrapDBError(err error) error

+ type AggregateTool struct

+ func (AggregateTool) CostGated()

+ func (AggregateTool) Enabled(f config.ToolFlags) bool

+ func (AggregateTool) Info() Info

+ func (AggregateTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type BeginTransactionTool struct

+ func (BeginTransactionTool) Enabled(f config.ToolFlags) bool

+ func (BeginTransactionTool) Info() Info

+ func (BeginTransactionTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type CommitTransactionTool struct

+ func (CommitTransactionTool) Enabled(f config.ToolFlags) bool

+ func (CommitTransactionTool) Info() Info

+ func (CommitTransactionTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type Context struct

+ Analyze cost.AnalyzePolicy

+ Auditor audit.Auditor

+ Authorizer rbac.Authorizer

+ Budget budget.Manager

+ BudgetLimits budget.Limits

+ Cache cache.Cache[[]map[string]any]

+ CacheMaxEntryBytes int64

+ CacheMaxEntryRows int

+ DB store.DB

+ DataSource string

+ Dialect dialect.Dialect

+ Engine *engine.Engine

+ Feedback cost.FeedbackStore

+ Gate cost.Gate

+ Hooks *hook.Hooks

+ Masker mask.Masker

+ MaxAggregates int

+ MaxExpand int

+ MaxFilterConditions int

+ MaxGroupByFields int

+ MaxINListSize int

+ MaxProcedureRows int64

+ MaxReturnedBytes int64

+ MaxRows int64

+ Registry *entity.Registry

+ Role string

+ Session string

+ Sources map[string]DataSource

+ Subject map[string]any

+ Timeout time.Duration

+ Transaction string

+ TransactionBeginTimeout time.Duration

+ TransactionCommitTimeout time.Duration

+ TransactionRollbackTimeout time.Duration

+ Transactions *TransactionManager

+ TxBeginners map[string]store.TxBeginner

+ type CostGated interface

+ CostGated func()

+ type CreateTool struct

+ func (CreateTool) Enabled(f config.ToolFlags) bool

+ func (CreateTool) Info() Info

+ func (CreateTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type DataSource struct

+ Analyze cost.AnalyzePolicy

+ DB store.DB

+ Dialect dialect.Dialect

+ Gate cost.Gate

+ type DeleteTool struct

+ func (DeleteTool) CostGated()

+ func (DeleteTool) Enabled(f config.ToolFlags) bool

+ func (DeleteTool) Info() Info

+ func (DeleteTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type DescribeTool struct

+ func (DescribeTool) Enabled(f config.ToolFlags) bool

+ func (DescribeTool) Info() Info

+ func (DescribeTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type ExecuteTool struct

+ func (ExecuteTool) CostGated()

+ func (ExecuteTool) Enabled(f config.ToolFlags) bool

+ func (ExecuteTool) Info() Info

+ func (ExecuteTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type Info struct

+ Description string

+ InputSchema json.RawMessage

+ Name string

+ ReadOnly bool

+ type ProcedureTool struct

+ Entity entity.Entity

+ func (ProcedureTool) CostGated()

+ func (ProcedureTool) Enabled(config.ToolFlags) bool

+ func (t ProcedureTool) Info() Info

+ func (t ProcedureTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type ReadTool struct

+ func (ReadTool) CostGated()

+ func (ReadTool) Enabled(f config.ToolFlags) bool

+ func (ReadTool) Info() Info

+ func (ReadTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type Registry struct

+ func NewRegistry(tools []Tool) (*Registry, error)

+ func (r *Registry) Enabled(flags config.ToolFlags) []Tool

+ func (r *Registry) Get(name string) (Tool, bool)

+ func (r *Registry) Tools() []Tool

+ type Result struct

+ Content []map[string]any

+ EstimatedScannedRows int64

+ IsError bool

+ ReturnedBytes int64

+ ReturnedRows int64

+ StructuredResult any

+ func RunTool(ctx context.Context, t Tool, input json.RawMessage, tc Context) (Result, error)

+ type RollbackTransactionTool struct

+ func (RollbackTransactionTool) Enabled(f config.ToolFlags) bool

+ func (RollbackTransactionTool) Info() Info

+ func (RollbackTransactionTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ type Tool interface

+ Enabled func(flags config.ToolFlags) bool

+ Info func() Info

+ Run func(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

+ func DefaultTools() []Tool

+ type TransactionManager struct

+ func NewTransactionManager(ttl time.Duration, maxOpen int) *TransactionManager

+ func (m *TransactionManager) Begin(ctx context.Context, beginner store.TxBeginner, session, role string, ...) (string, error)

+ func (m *TransactionManager) Close()

+ func (m *TransactionManager) Commit(token, session, role string, subject map[string]any) error

+ func (m *TransactionManager) CommitWithEntities(token, session, role string, subject map[string]any) ([]string, error)

+ func (m *TransactionManager) Configuration() (time.Duration, int)

+ func (m *TransactionManager) DB(token, session, role string, subject map[string]any, datasource string) (store.DB, error)

+ func (m *TransactionManager) MarkDirty(token, session, role string, subject map[string]any, datasource, entity string) error

+ func (m *TransactionManager) Rollback(token, session, role string, subject map[string]any) error

+ func (m *TransactionManager) RollbackSession(session string)

+ func (m *TransactionManager) Validate(token, session, role string, subject map[string]any) error

+ type UpdateTool struct

+ func (UpdateTool) CostGated()

+ func (UpdateTool) Enabled(f config.ToolFlags) bool

+ func (UpdateTool) Info() Info

+ func (UpdateTool) Run(ctx context.Context, input json.RawMessage, tc Context) (Result, error)

v0.1.3-rc.4

Jul 11, 2026

v0.1.3-rc.3

Jul 11, 2026

v0.1.3-rc.2

Jul 11, 2026

v0.1.3-rc.1

Jul 11, 2026

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL