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

use std::path::PathBuf;

use crate::{Collection, Nullability, TextSpan, TypeReference};

/// column definition
#[derive(serde::Serialize, serde::Deserialize, derive_getters::Getters)]
pub struct ColumnDefinition {
    /// column name
    name: String,
    /// column type
    column_type: TypeReference,
    /// nullability
    nullability: Nullability,
    /// column contraints
    constraint: Vec<ColumnConstraint>,
}

/// constraint for column
#[derive(serde::Serialize, serde::Deserialize)]
pub enum ColumnConstraint {
    // TODO: definition
}

/// constraint for column
#[derive(serde::Serialize, serde::Deserialize)]
pub struct TableConstraint {
    // TODO: definition
}

/// argument for [`SqlFunServerApi::describe_table`]
#[derive(serde::Serialize, serde::Deserialize, derive_getters::Getters)]
pub struct DescribeTableArgs {
    schema_name: String,
    local_name: String,
}

/// response type for [`SqlFunServerApi::describe_table`]
#[derive(serde::Serialize, serde::Deserialize, derive_getters::Getters)]
pub struct DescribeTableResponse {
    definition_file: PathBuf,
    definition_span: TextSpan,

    columns: Collection<ColumnDefinition>,
    constraints: Collection<TableConstraint>,
}