sift-query-sqlx 0.1.0

PostgreSQL renderer and sqlx executor for SiftQuery
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

use sift_query_core::{ParamError, PlanError};
use thiserror::Error;

use crate::ExtensionError;

#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[non_exhaustive]
pub enum RenderError {
    #[error("query plan references unknown field id {0}")]
    UnknownField(u16),
    #[error("field {0} has no result alias")]
    MissingAlias(String),
    #[error("condition {0} has invalid values")]
    InvalidCondition(String),
    #[error("PostgreSQL binding is not implemented for {0}")]
    UnsupportedBindType(String),
    #[error("query target cannot be rendered by this operation")]
    WrongTarget,
}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[error("failed to decode column {column}: {reason}")]
pub struct DecodeError {
    pub column: String,
    pub reason: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
#[error("schema result contract failed for {entity}: {details}")]
pub struct SchemaValidationError {
    pub entity: &'static str,
    pub details: String,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TimeoutStage {
    PoolAcquire,
    SchemaValidation,
    ListQuery,
    ClusterQuery,
    Scan,
    Export,
    Enrichment,
}

impl std::fmt::Display for TimeoutStage {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter.write_str(match self {
            Self::PoolAcquire => "pool acquire",
            Self::SchemaValidation => "schema validation",
            Self::ListQuery => "list query",
            Self::ClusterQuery => "cluster query",
            Self::Scan => "scan",
            Self::Export => "export",
            Self::Enrichment => "enrichment",
        })
    }
}

#[derive(Debug, Error)]
#[non_exhaustive]
pub enum PgSearchError {
    #[error(transparent)]
    Param(#[from] ParamError),
    #[error(transparent)]
    Plan(#[from] PlanError),
    #[error(transparent)]
    Render(#[from] RenderError),
    #[error("failed to encode PostgreSQL arguments: {0}")]
    Bind(String),
    #[error("parallel execution gate is closed")]
    ParallelGateClosed,
    #[error(transparent)]
    Sql(#[from] sqlx::Error),
    #[error(transparent)]
    Decode(#[from] DecodeError),
    #[error(transparent)]
    Extension(#[from] ExtensionError),
    #[error("query timed out during {0}")]
    Timeout(TimeoutStage),
    #[error("scan exceeded its maximum row budget of {max_rows}")]
    ScanLimitExceeded { max_rows: u32 },
    #[error("external PostgreSQL execution only supports SequentialBestEffort")]
    ExternalExecutionStrategy,
    #[error("scan waiting queue is full")]
    ScanQueueFull,
    #[error("CSV output failed")]
    ExportIo(#[source] std::io::Error),
    #[error(transparent)]
    SchemaValidation(#[from] SchemaValidationError),
}