Struct CompiledQuery 

pub struct CompiledQuery {
    pub sql: String,
    pub param_names: Vec<String>,
    pub params: Vec<QueryParam>,
    pub shape: ShapeDescriptor,
    pub warnings: Vec<String>,
    pub inference_plan: Option<InferencePlan>,
    pub tags: Vec<String>,
    pub mutates: bool,
    pub analyze_paths: Option<Vec<ShapePathAlias>>,
    pub shape_id: Arc<str>,
}

The output of a successful PyQL compilation. Immutable and safe to cache and reuse across requests.

Fields

sql: String

PostgreSQL SQL string ready for execution.

param_names: Vec<String>

Ordered parameter names matching $1, $2, … in the SQL. The client uses this to map kwargs to positional arguments.

params: Vec<QueryParam>

Typed bound parameters — populated at execution time, empty after compilation.

shape: ShapeDescriptor

Opaque shape handle — consumed by the Rust deserializer.

warnings: Vec<String>

Non-fatal warnings produced during compilation.

inference_plan: Option<InferencePlan>

Set when the query requires a pre-execution model call.

tags: Vec<String>

Every schema-qualified table ("schema.table") this statement reads from or writes to — see ir::tags::collect_tags. For a SELECT, the set of tags to cache this result under; for an INSERT/UPDATE/DELETE, the set of tags a cache layer must invalidate after the write commits.

mutates: bool

True when executing this statement writes to any of tags. Lets a cache layer act on the invalidation duty described above without re-parsing the SQL to guess whether a write happened.

analyze_paths: Option<Vec<ShapePathAlias>>

Some only for analyze <query> — the shape-path↔SQL-alias map an analyze execution needs to correlate Postgres’s EXPLAIN plan nodes back to the query’s own shape (see analyze module). None for every other query, which doesn’t pay for this extra shape walk.

shape_id: Arc<str>

This query’s stable shape id — see crate::shape_id and shape_id(). Computed once at compile time; fill it with derive_shape_id if you ever build a CompiledQuery outside compile_uncached.

Implementations

impl CompiledQuery

pub fn shape_id(&self) -> Arc<str>

This query’s stable shape id — see crate::shape_id.

Independent of the values bound to it, which is what makes it safe as a metric label: a query run a million times with different parameters reports one label value, not a million.

Precomputed rather than derived per call. Every execution reports this label, and deriving it meant Debug-formatting the entire shape tree into a throwaway String and hashing it — measured at 3.65 µs per execution on a 20-field shape, all of it repeated work, since a CompiledQuery is immutable.

pub fn sql_id(&self) -> &str

A stable hash of this query’s SQL, for callers that need to key a cache entry on the statement without moving the SQL text itself around. Same derivation as shape_id, minus the shape.

Trait Implementations

impl Clone for CompiledQuery

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompiledQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.