table/
table_name.rs

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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// Copyright 2023 Greptime Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::fmt::{Display, Formatter};

use api::v1::TableName as PbTableName;
use common_catalog::consts::{DEFAULT_CATALOG_NAME, DEFAULT_SCHEMA_NAME};
use serde::{Deserialize, Serialize};
use snafu::ensure;

use crate::error;
use crate::error::InvalidTableNameSnafu;
use crate::table_reference::TableReference;

#[derive(Debug, Clone, Hash, Eq, PartialEq, Deserialize, Serialize)]
pub struct TableName {
    pub catalog_name: String,
    pub schema_name: String,
    pub table_name: String,
}

impl Display for TableName {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str(&common_catalog::format_full_table_name(
            &self.catalog_name,
            &self.schema_name,
            &self.table_name,
        ))
    }
}

impl TableName {
    pub fn new(
        catalog_name: impl Into<String>,
        schema_name: impl Into<String>,
        table_name: impl Into<String>,
    ) -> Self {
        Self {
            catalog_name: catalog_name.into(),
            schema_name: schema_name.into(),
            table_name: table_name.into(),
        }
    }

    pub fn table_ref(&self) -> TableReference<'_> {
        TableReference {
            catalog: &self.catalog_name,
            schema: &self.schema_name,
            table: &self.table_name,
        }
    }
}

impl From<TableName> for PbTableName {
    fn from(table_name: TableName) -> Self {
        Self {
            catalog_name: table_name.catalog_name,
            schema_name: table_name.schema_name,
            table_name: table_name.table_name,
        }
    }
}

impl From<PbTableName> for TableName {
    fn from(table_name: PbTableName) -> Self {
        Self {
            catalog_name: table_name.catalog_name,
            schema_name: table_name.schema_name,
            table_name: table_name.table_name,
        }
    }
}

impl From<TableReference<'_>> for TableName {
    fn from(table_ref: TableReference) -> Self {
        Self::new(table_ref.catalog, table_ref.schema, table_ref.table)
    }
}

impl TryFrom<Vec<String>> for TableName {
    type Error = error::Error;

    fn try_from(v: Vec<String>) -> Result<Self, Self::Error> {
        ensure!(
            !v.is_empty() && v.len() <= 3,
            InvalidTableNameSnafu {
                s: format!("{v:?}")
            }
        );
        let mut v = v.into_iter();
        match (v.next(), v.next(), v.next()) {
            (Some(catalog_name), Some(schema_name), Some(table_name)) => Ok(Self {
                catalog_name,
                schema_name,
                table_name,
            }),
            (Some(schema_name), Some(table_name), None) => Ok(Self {
                catalog_name: DEFAULT_CATALOG_NAME.to_string(),
                schema_name,
                table_name,
            }),
            (Some(table_name), None, None) => Ok(Self {
                catalog_name: DEFAULT_CATALOG_NAME.to_string(),
                schema_name: DEFAULT_SCHEMA_NAME.to_string(),
                table_name,
            }),
            // Unreachable because it's ensured that "v" is not empty,
            // and its iterator will not yield `Some` after `None`.
            _ => unreachable!(),
        }
    }
}