sql-fun-server-api 0.1.0

API type crate for sql-fun-server
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

use std::path::PathBuf;

use crate::{AnalysisProbrem, Collection, ContextHandle};

/// Engine dialect selecting SQL syntax perser.
#[derive(serde::Serialize, serde::Deserialize)]
pub enum EngineDialect {
    /// `PostgreSQL` valiant, selects parser as `pg_query`
    PostgreSQL,
}

/// Selecting database builtin objects
#[derive(serde::Serialize, serde::Deserialize)]
pub enum EngineVersion {
    /// `PostgreSQL` and version string.
    PostgreSQL(String),
}

/// `PostgreSQL` extension
#[derive(serde::Serialize, serde::Deserialize, derive_getters::Getters)]
pub struct ExtensionSpec {
    /// Name for extension
    extension_name: String,
    /// Version for extension
    extension_version: String,
}

/// Load schema dump and initialize semantic analysis context
#[derive(serde::Serialize, serde::Deserialize, derive_getters::Getters)]
pub struct InitializeSchemaArgs {
    /// SQL dialect for schema
    engine_dialect: EngineDialect,

    /// Used for loading builtin schema objects
    engine_version: EngineVersion,

    /// Enabled extensions
    extensions: Vec<ExtensionSpec>,

    /// Search path
    search_path: Vec<String>,

    /// schema dump file
    schema_dump: PathBuf,
}

/// schema context
#[derive(serde::Serialize, serde::Deserialize, derive_getters::Getters)]
pub struct SchemaContext {
    /// context handle
    context_handle: Option<ContextHandle>,

    /// SHA 256 hash for schema dump
    schema_dump_hash: String,

    /// schema analysis problems
    problems: Collection<AnalysisProbrem>,
}