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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
use crate::{HdbError, HdbResult};
use serde_derive::Serialize;

/// ID of the value type of a database column or a parameter.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
pub enum TypeId {
    /// For database type TINYINT;
    /// used with [`HdbValue::TINYINT`](enum.HdbValue.html#variant.TINYINT).
    TINYINT,
    /// For database type SMALLINT;
    /// used with [`HdbValue::SMALLINT`](enum.HdbValue.html#variant.SMALLINT).
    SMALLINT,
    /// For database type INT;
    /// used with [`HdbValue::INT`](enum.HdbValue.html#variant.INT).
    INT,
    /// For database type BIGINT;
    /// used with [`HdbValue::BIGINT`](enum.HdbValue.html#variant.BIGINT).
    BIGINT,
    /// For database type DECIMAL and SMALLDECIMAL;
    /// used with [`HdbValue::DECIMAL`](enum.HdbValue.html#variant.DECIMAL).
    DECIMAL,
    /// For database type REAL;
    /// used with [`HdbValue::REAL`](enum.HdbValue.html#variant.REAL).
    REAL,
    /// For database type DOUBLE;
    /// used with [`HdbValue::DOUBLE`](enum.HdbValue.html#variant.DOUBLE).
    DOUBLE,
    /// For database type CHAR;
    /// used with [`HdbValue::STRING`](enum.HdbValue.html#variant.STRING).
    CHAR,
    /// For database type VARCHAR;
    /// used with [`HdbValue::STRING`](enum.HdbValue.html#variant.STRING).
    VARCHAR,
    /// For database type NCHAR;
    /// used with [`HdbValue::STRING`](enum.HdbValue.html#variant.STRING).
    NCHAR,
    /// For database type NVARCHAR;
    /// used with [`HdbValue::STRING`](enum.HdbValue.html#variant.STRING).
    NVARCHAR,
    /// For database type BINARY;
    /// used with [`HdbValue::BINARY`](enum.HdbValue.html#variant.BINARY).
    BINARY,
    /// For database type VARBINARY;
    /// used with [`HdbValue::BINARY`](enum.HdbValue.html#variant.BINARY).
    VARBINARY,
    /// For database type CLOB;
    /// used with [`HdbValue::CLOB`](enum.HdbValue.html#variant.CLOB).
    CLOB,
    /// For database type NCLOB;
    /// used with [`HdbValue::NCLOB`](enum.HdbValue.html#variant.NCLOB).
    NCLOB,
    /// For database type BLOB;
    /// used with [`HdbValue::BLOB`](enum.HdbValue.html#variant.BLOB).
    BLOB,
    /// For database type BOOLEAN;
    /// used with [`HdbValue::BOOLEAN`](enum.HdbValue.html#variant.BOOLEAN).
    BOOLEAN,
    /// For database type STRING;
    /// used with [`HdbValue::STRING`](enum.HdbValue.html#variant.STRING).
    STRING,
    /// For database type NSTRING;
    /// used with [`HdbValue::STRING`](enum.HdbValue.html#variant.STRING).
    NSTRING,
    /// Maps to [`HdbValue::BINARY`](enum.HdbValue.html#variant.BINARY)
    /// or [`HdbValue::BLOB`](enum.HdbValue.html#variant.BLOB).
    BLOCATOR,
    /// Used with [`HdbValue::BINARY`](enum.HdbValue.html#variant.BINARY).
    BSTRING,
    /// For database type TEXT;
    /// used with [`HdbValue::TEXT`](enum.HdbValue.html#variant.TEXT).
    TEXT,
    /// For database type SHORTTEXT;
    /// used with [`HdbValue::STRING`](enum.HdbValue.html#variant.STRING).
    SHORTTEXT,
    /// For database type BINTEXT;
    /// Used with [`HdbValue::BINARY`](enum.HdbValue.html#variant.BINARY) or
    /// [`HdbValue::BLOB`](enum.HdbValue.html#variant.BLOB).
    BINTEXT,
    /// For database type ALPHANUM;
    /// used with [`HdbValue::STRING`](enum.HdbValue.html#variant.STRING).
    ALPHANUM,
    /// For database type LONGDATE;
    /// used with [`HdbValue::LONGDATE`](enum.HdbValue.html#variant.LONGDATE).
    LONGDATE,
    /// For database type SECONDDATE;
    /// used with [`HdbValue::SECONDDATE`](enum.HdbValue.html#variant.SECONDDATE).
    SECONDDATE,
    /// For database type DAYDATE;
    /// used with [`HdbValue::DAYDATE`](enum.HdbValue.html#variant.DAYDATE).
    DAYDATE,
    /// For database type SECONDTIME;
    /// used with [`HdbValue::SECONDTIME`](enum.HdbValue.html#variant.SECONDTIME).
    SECONDTIME,
    /// For database type GEOMETRY;
    /// used with [`HdbValue::GEOMETRY`](enum.HdbValue.html#variant.GEOMETRY).
    GEOMETRY,
    /// For database type POINT;
    /// used with [`HdbValue::POINT`](enum.HdbValue.html#variant.POINT).
    POINT,
    /// Transport format for database type DECIMAL;
    /// used with [`HdbValue::DECIMAL`](enum.HdbValue.html#variant.DECIMAL).
    FIXED8,
    /// Transport format for database type DECIMAL;
    /// used with [`HdbValue::DECIMAL`](enum.HdbValue.html#variant.DECIMAL).
    FIXED12,
    /// Transport format for database type DECIMAL;
    /// used with [`HdbValue::DECIMAL`](enum.HdbValue.html#variant.DECIMAL).
    FIXED16,
}

impl TypeId {
    pub(crate) fn try_new(id: u8) -> HdbResult<TypeId> {
        Ok(match id {
            1 => TypeId::TINYINT,
            2 => TypeId::SMALLINT,
            3 => TypeId::INT,
            4 => TypeId::BIGINT,
            5 => TypeId::DECIMAL,
            6 => TypeId::REAL,
            7 => TypeId::DOUBLE,
            8 => TypeId::CHAR,
            9 => TypeId::VARCHAR,
            10 => TypeId::NCHAR,
            11 => TypeId::NVARCHAR,
            12 => TypeId::BINARY,
            13 => TypeId::VARBINARY,
            // DATE: 14, TIME: 15, TIMESTAMP: 16 (all deprecated with protocol version 3)
            // 17 - 24: reserved, do not use
            25 => TypeId::CLOB,
            26 => TypeId::NCLOB,
            27 => TypeId::BLOB,
            28 => TypeId::BOOLEAN,
            29 => TypeId::STRING,
            30 => TypeId::NSTRING,
            31 => TypeId::BLOCATOR,
            // 32 => TypeId::NLOCATOR,
            33 => TypeId::BSTRING,
            // 34 - 46: docu unclear, likely unused
            // 47 => SMALLDECIMAL not needed on client-side
            // 48, 49: ABAP only?
            // ARRAY: 50  FIXME not yet implemented
            51 => TypeId::TEXT,
            52 => TypeId::SHORTTEXT,
            53 => TypeId::BINTEXT,
            // 54: Reserved, do not use
            55 => TypeId::ALPHANUM,
            // 56: Reserved, do not use
            // 57 - 60: not documented
            61 => TypeId::LONGDATE,
            62 => TypeId::SECONDDATE,
            63 => TypeId::DAYDATE,
            64 => TypeId::SECONDTIME,
            // 65 - 80: Reserved, do not use

            // TypeCode_CLOCATOR                  =70,  // FIXME
            // TypeCode_BLOB_DISK_RESERVED        =71,
            // TypeCode_CLOB_DISK_RESERVED        =72,
            // TypeCode_NCLOB_DISK_RESERVE        =73,
            74 => TypeId::GEOMETRY,
            75 => TypeId::POINT,
            76 => TypeId::FIXED16,
            // TypeCode_ABAP_ITAB                 =77,  // FIXME
            // TypeCode_RECORD_ROW_STORE         = 78,  // FIXME
            // TypeCode_RECORD_COLUMN_STORE      = 79,  // FIXME
            81 => TypeId::FIXED8,
            82 => TypeId::FIXED12,
            // TypeCode_CIPHERTEXT               = 90,  // FIXME
            tc => return Err(HdbError::Impl(format!("Illegal type code {}", tc))),
        })
    }

    // hdb protocol uses ids < 128 for non-null values, and ids > 128 for nullable values
    pub(crate) fn type_code(self, nullable: bool) -> u8 {
        (if nullable { 128 } else { 0 })
            + match self {
                TypeId::TINYINT => 1,
                TypeId::SMALLINT => 2,
                TypeId::INT => 3,
                TypeId::BIGINT => 4,
                TypeId::DECIMAL => 5,
                TypeId::REAL => 6,
                TypeId::DOUBLE => 7,
                TypeId::CHAR => 8,
                TypeId::VARCHAR => 9,
                TypeId::NCHAR => 10,
                TypeId::NVARCHAR => 11,
                TypeId::BINARY => 12,
                TypeId::VARBINARY => 13,
                TypeId::CLOB => 25,
                TypeId::NCLOB => 26,
                TypeId::BLOB => 27,
                TypeId::BOOLEAN => 28,
                TypeId::STRING => 29,
                TypeId::NSTRING => 30,
                TypeId::BLOCATOR => 31,
                TypeId::BSTRING => 33,
                TypeId::TEXT => 51,
                TypeId::SHORTTEXT => 52,
                TypeId::BINTEXT => 53,
                TypeId::ALPHANUM => 55,
                TypeId::LONGDATE => 61,
                TypeId::SECONDDATE => 62,
                TypeId::DAYDATE => 63,
                TypeId::SECONDTIME => 64,
                TypeId::GEOMETRY => 74,
                TypeId::POINT => 75,
                TypeId::FIXED16 => 76,
                TypeId::FIXED8 => 81,
                TypeId::FIXED12 => 82,
            }
    }

    pub(crate) fn matches_value_type(self, value_type: TypeId) -> HdbResult<()> {
        if value_type == self {
            return Ok(());
        }
        // From To Conversions
        match (value_type, self) {
            (TypeId::BOOLEAN, TypeId::TINYINT) => return Ok(()),
            (TypeId::BOOLEAN, TypeId::SMALLINT) => return Ok(()),
            (TypeId::BOOLEAN, TypeId::INT) => return Ok(()),
            (TypeId::BOOLEAN, TypeId::BIGINT) => return Ok(()),

            (TypeId::STRING, TypeId::GEOMETRY) => {} // no clear strategy for GEO stuff yet, so be restrictive
            (TypeId::STRING, TypeId::POINT) => {} // no clear strategy for GEO stuff yet, so be restrictive
            (TypeId::STRING, _) => return Ok(()), // Allow all other cases

            (TypeId::BINARY, TypeId::BLOB) => return Ok(()),
            (TypeId::BINARY, TypeId::BLOCATOR) => return Ok(()),
            (TypeId::BINARY, TypeId::VARBINARY) => return Ok(()),
            (TypeId::BINARY, TypeId::GEOMETRY) => return Ok(()),
            (TypeId::BINARY, TypeId::POINT) => return Ok(()),

            (TypeId::DECIMAL, TypeId::FIXED8) => return Ok(()),
            (TypeId::DECIMAL, TypeId::FIXED12) => return Ok(()),
            (TypeId::DECIMAL, TypeId::FIXED16) => return Ok(()),
            _ => {}
        }

        Err(HdbError::Impl(format!(
            "value type id {:?} does not match metadata {:?}",
            value_type, self
        )))
    }
}