query

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

type ErrorDetails struct {
	Type     string `json:"error_type"`
	Subtype  string `json:"error_subtype"`
	Message  string `json:"error_message"`
	Position string `json:"position"`
}

type Extension struct {
	Name        string `json:"name"`
	Version     string `json:"version"`
	Repository  string `json:"repository"`
	InstallMode string `json:"install_mode"`
}

type OptionFunc func(*Options) error

type Options struct {
	// MaxConnections sets the maximum number of open connections to the database.
	MaxConnections int

	// MaxCacheEntries sets the maximum size of the query result cache.
	MaxCacheEntries int

	// MaxCacheBytes sets the maximum total size in bytes of all entries in the query result cache.
	MaxCacheBytes int

	// TTL sets the time-to-live for cache entries. If zero, entries do not expire.
	TTL time.Duration

	// Logger is the logger to use for logging. If nil, defaults to slog.Default().
	Logger *slog.Logger

	// FunctionBlocklist is a list of function names that are not allowed to be used in queries.
	// This is useful for blocking functions that may pose security or performance risks.
	FunctionBlocklist []string
}

type Validator interface {
	// CheckNode is called once for each node in the AST
	// - node: the current node being processed
	// - keyStack: contains the stack of keys leading to this node, with the root being the first element,
	//   and the parent key being the last element
	//
	// This explicitly does not not return an error. Any errors found should be collected and returned
	// in the Validate() method.
	CheckNode(node map[string]any, keyStack []string)

	// Validate is called after the entire AST has been processed. It should return any errors found during
	// the CheckNode calls, or any additional validation errors that can only be determined after
	// processing the entire AST. This allows validators to collect state during the AST traversal and perform more
	// complex validation that may depend on multiple nodes or the overall structure of the AST.
	//
	// It returns a slice of errors, to encourage collecting all errors rather than stopping at the first one.
	// If no errors are found, it should return nil.
	Validate() []error
}