Expand description
Backend-independent query model and strict parameter protocol for SiftQuery.
Re-exports§
pub use query::bucket::BucketEntry;pub use query::bucket::BucketRequest;pub use query::bucket::BucketResult;pub use query::bucket::NumericBucketRequest;pub use query::bucket::TimeBucketRequest;pub use query::bucket::TimeBucketUnit;
Structs§
- Boolean
Codec - A strict pair of business boolean names (for example
enabled/disabled). - Bucket
Entry - Bucket
Result - Codec
Registry - A small, ordered collection of codecs.
- Condition
- Condition
Order - Cursor
- Cursor
Codec - Custom
Aggregate - Trusted server-side aggregate expression containing a
{field}placeholder. - Custom
Operator - Trusted server-side SQL template for a custom operator.
- Default
Param Filter - Adds trusted default parameters before strict parsing.
- Entity
Limits - Per-entity limits. Instance-level limits may only make these stricter.
- Entity
Meta - Static metadata generated for a search entity.
- Enum
Codec - Strict enum names mapped to an integer database field. Empty and unknown names/codes are errors; results use the same names accepted by input.
- Facet
Bucket - Facet
Request - A server-declared facet over one entity field.
- Facet
Result - Field
Access Policy - Server-owned field visibility and queryability policy.
- Field
Access Policy Builder - Builder for an explicit least-privilege field policy.
- FieldId
- Stable, entity-local field identifier.
- Field
Meta - Metadata for one query-visible field.
- Field
Ref - Typed reference to one entity field.
- Filter
Expr - Entity-bound predicate expression for programmatic queries.
- Filter
Only - Marker stored in result structs for fields that participate only in filtering.
- Group
Scope - Service-controlled predicate evaluated after
GROUP BY. - Group
Scope Builder - Builder for service-owned aggregate predicates evaluated in HAVING.
- Indexed
Array Param Filter - Converts repeated/indexed array keys to canonical indexed parameters.
- Json
Array Param Filter - Expands JSON arrays into indexed parameter values before strict parsing.
- List
Result Codec - Literal separated database text -> typed presentation list. This does not add PostgreSQL array-column operators or change the database bind type.
- NodeId
- Numeric
Bucket Request - Operator
Set - A compact static operator whitelist.
- OrderBy
- Order
Meta - A validated static ordering item.
- Paging
- Param
Names - Names of protocol-level control parameters.
- Param
Parser - Strict parser from
RawParamsto an entity-bound query. - Predicate
Arena - Compact predicate storage with index-based edges.
- Projection
Field - Query
Builder - Programmatic builder for a validated
UserQuery. - Query
Hard Limits - Absolute library guardrails. Ordinary configuration cannot exceed these values.
- Query
Limits - Runtime query limits. Entity limits can only make paging values stricter.
- Query
Plan - Immutable input to a backend renderer.
- Query
Policy - Immutable parser and execution policy.
- RawParams
- Decoded, ordered, multi-value query parameters.
- Registered
Operator - Scalar
Text Codec - Configurable text representation for a scalar field. Parsing and result conversion use the same logical type, so cursor and database binds remain typed while the public text format is centralized in one codec.
- Scope
Limits - Search
Options - Server
Scope - Service-controlled row-level predicate.
- Server
Scope Builder - Server
SqlExtension - A server-owned SQL extension declaration. The SQL template remains in the binary and only bound values can come from a request.
- Server
SqlRegistry - Bounded registry used by an HTTP/service boundary. Registration is a startup operation; lookup accepts only a name that was registered by the server and never parses SQL supplied by a caller.
- String
Codec - A strict text field codec with optional whitespace normalization. It is useful when an API’s representation must be explicit even though the underlying value is already a SQL text column.
- Suffix
Operator Param Filter - Rewrites operator suffixes to canonical parameters while preserving repeats.
- Summary
Request - Time
Bucket Request - Typed
List - A homogeneous array value used by PostgreSQL
ANY. - User
Query
Enums§
- Aggregate
Fn - Aggregate
Kind - Bucket
Request - Compatibility
Policy - Config
Error - Errors in static entity or policy configuration.
- Cursor
Value - Field
Kind - Determines whether a condition is evaluated before or after grouping.
- Filter
Only Kind - Group
KeyKind - Null
Order - Operator
- M1 field operators.
- Paging
Mode - Param
Error - Errors caused by untrusted query parameters or programmatic user queries.
- Plan
Error - Errors while combining a validated user query with server policy.
- Predicate
Node - Predicate
Phase - Projection
- Query
Target - RowValue
- Dynamic result value. Unlike
ScalarValue, this can represent SQL NULL. - Scalar
Kind - Scalar
Value - A typed, non-null scalar used in predicates.
- Sort
Order - Time
Bucket Unit - Value
Type - Supported logical value types.
Traits§
- Codec
- A server-owned input/result conversion codec.
- Field
Convertor - Compatibility name for reflection-based field converters. Implementations
use the typed
Codeccontract and cannot bypass bind typing. - Into
Cursor Value - Into
Scalar Value - Query
Input - RawParam
Filter - A server-owned parameter normalization step.
- RowPhase
Kind - Scope
Provider - Builds a server-owned authorization scope from a trusted request context.
- Search
Entity - Implemented by derive-generated query entities.
- Search
Projection - Summable
Kind