nodedb 0.2.0

Local-first, real-time, edge-to-cloud hybrid database for multi-modal workloads
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

// SPDX-License-Identifier: BUSL-1.1

//! ParsedStatement — the result of parsing SQL in the extended query protocol.
//!
//! Stored in pgwire's `StoredStatement<ParsedStatement>` after a Parse message.
//! Contains the original SQL text and pre-inferred parameter/result types.

use pgwire::api::results::FieldInfo;

/// A parsed SQL statement for the extended query protocol.
///
/// Created by `NodeDbQueryParser::parse_sql` during a Parse message.
/// The pgwire crate stores this as `StoredStatement<ParsedStatement>`.
/// On Bind + Execute, we re-plan the SQL with bound parameter values.
#[derive(Debug, Clone)]
pub struct ParsedStatement {
    /// Original SQL text (may contain `$1`, `$2` placeholders).
    pub sql: String,
    /// Inferred parameter types from DataFusion plan analysis.
    /// Indexed by position: param_types[0] = type of `$1`, etc.
    /// `None` if inference failed or type is unknown.
    pub param_types: Vec<Option<pgwire::api::Type>>,
    /// Result column schema inferred from the logical plan.
    /// Empty for DML statements (INSERT/UPDATE/DELETE).
    pub result_fields: Vec<FieldInfo>,
    /// True when the SQL is a DSL statement (SEARCH, GRAPH, MATCH, UPSERT INTO,
    /// etc.) that `plan_sql` cannot parse. The Execute handler routes these
    /// through the full DSL dispatcher instead of `execute_planned_sql_with_params`.
    pub is_dsl: bool,
    /// Name of the targeted pg_catalog virtual table, if any. When set, the
    /// Execute handler bypasses the planner and dispatches to `try_pg_catalog`.
    /// Describe-time `result_fields` are populated from the catalog's static
    /// schema so drivers can introspect types before Bind.
    pub pg_catalog_table: Option<&'static str>,
}