elefant-tools 0.0.2

A library for doing things like pg_dump and pg_restore, with extra features, and probably more bugs.
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

use crate::storage::DataFormat;
use thiserror::Error;

/// All the errors that can occur in the elefant-tools library
#[non_exhaustive]
#[derive(Error, Debug)]
pub enum ElefantToolsError {
    #[error("Error from postgres: `{0}`")]
    PostgresError(#[from] tokio_postgres::Error),

    #[error("Error from postgres: `{query}` when executing query: `{source}`")]
    PostgresErrorWithQuery {
        query: String,
        #[source]
        source: tokio_postgres::Error,
    },

    #[error(
        "Invalid number of results returned from query. Expected `{expected}`, got `{actual}`"
    )]
    InvalidNumberOfResults { actual: usize, expected: usize },

    #[error("Unknown constraint type '{0}'")]
    UnknownConstraintType(String),

    #[error("Unknown foreign key action '{0}'")]
    UnknownForeignKeyAction(String),

    #[error("Unknown function kind '{0}'")]
    UnknownFunctionKind(String),

    #[error("Unknown volatility '{0}'")]
    UnknownVolatility(String),

    #[error("Unknown parallel '{0}'")]
    UnknownParallel(String),

    #[error("Unknown aggregate function final modify '{0}'")]
    UnknownAggregateFinalFunctionModify(String),

    #[error("Unknown trigger level '{0}'")]
    UnknownTriggerLevel(String),

    #[error("Unknown trigger timing '{0}'")]
    UnknownTriggerTiming(String),

    #[error("Unknown trigger event '{0}'")]
    UnknownTriggerEvent(String),

    #[error("Unknown table type '{0}'")]
    InvalidTableType(String),

    #[error("Unknown keyword type '{0}'")]
    InvalidKeywordType(String),

    #[error("Unknown table partitioning strategy '{0}'")]
    InvalidTablePartitioningStrategy(String),

    #[error("The table '{0}' is a partitioned table and does not have a parent table")]
    PartitionedTableWithoutParent(String),

    #[error(
        "The table '{table}' is a partitioned table and has multiple parent tables: {parents:?}"
    )]
    PartitionedTableHasMultipleParent { table: String, parents: Vec<String> },

    #[error("The table '{0}' is a partitioned table and does not have a partition expression")]
    PartitionedTableWithoutExpression(String),

    #[error("The table '{0}' is a partitioned table and does not have partition columns")]
    PartitionedTableWithoutPartitionColumns(String),

    #[error("The table '{0}' is a partitioned table and has both partition columns and a partition expression")]
    PartitionedTableWithBothPartitionColumnsAndExpression(String),

    #[error("Unsupported postgres version: {0}. Minimum supported version is 12")]
    UnsupportedPostgresVersion(i32),

    #[error("Invalid response from postgres when checking version")]
    InvalidPostgresVersionResponse,

    #[error("Hypertable '{table_name}' dimension '{dimension_number}' does not have an interval")]
    HypertableDimensionWithoutInterval {
        table_name: String,
        dimension_number: i64,
    },

    #[error("io error: `{0}`")]
    IoError(#[from] std::io::Error),

    #[error("Data formats are not compatible between source and target. Supported by target: {supported_by_target:?}, supported by source: {supported_by_source:?}, required format: {required_format:?}")]
    DataFormatsNotCompatible {
        supported_by_target: Vec<DataFormat>,
        supported_by_source: Vec<DataFormat>,
        required_format: Option<DataFormat>,
    },

    #[error("join error: `{0}`")]
    JoinError(#[from] tokio::task::JoinError),

    #[error("Aggregate function '{0}' is missing transition type")]
    AggregateFunctionMissingTransitionType(String),

    #[error("Aggregate function '{0}' is missing transition function")]
    AggregateFunctionMissingTransitionFunction(String),
}

/// A result type that uses the ElefantToolsError as the error type
pub type Result<T = ()> = std::result::Result<T, ElefantToolsError>;