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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.

//! Fundamental data representation.
//!
//! This module contains the types for representing data in Materialize that all
//! layers of the stack can understand. Think of it as the _lingua franca_:
//! individual layers may use different representations internally, but they all
//! agree to use this representation at their boundaries.
//!
//! * The core value type is the [`Datum`] enum, which represents a literal value.
//! * [`Row`] extends a `Datum` horizontally, and has features for efficiently
//!   doing so.
//! * [`RelationDesc`] describes what it takes to extend a `Row` vertically, and
//!   corresponds most closely to what is returned from querying our dataflows

#![warn(missing_debug_implementations)]

mod datum_vec;
mod relation;
mod relation_and_scalar;
mod row;
mod scalar;

pub mod adt;
pub mod antichain;
pub mod chrono;
pub mod explain_new;
pub mod global_id;
pub mod strconv;
pub mod url;
pub mod util;

use std::{convert::TryFrom, num::TryFromIntError, time::Duration};

use adt::numeric::Numeric;
pub use datum_vec::{DatumVec, DatumVecBorrow};
use dec::TryFromDecimalError;
pub use global_id::GlobalId;
use mz_avro::{define_unexpected, error::DecodeError, types::Scalar, AvroRead};
use proptest_derive::Arbitrary;
pub use relation::{
    ColumnName, ColumnType, NotNullViolation, ProtoColumnName, ProtoColumnType, ProtoRelationDesc,
    ProtoRelationType, RelationDesc, RelationType,
};
pub use row::{
    datum_list_size, datum_size, datums_size, row_size, DatumList, DatumMap, ProtoRow, Row,
    RowArena, RowPacker, RowRef,
};
pub use scalar::{
    arb_datum, AsColumnType, Datum, DatumType, PropArray, PropDatum, PropDict, PropList,
    ProtoScalarType, ScalarBaseType, ScalarType,
};
use serde::{Deserialize, Serialize, Serializer};

// Concrete types used throughout Materialize for the generic parameters in Timely/Differential Dataflow.
/// System-wide timestamp type.
#[derive(
    Clone,
    // TODO: De-implement Copy, which is widely used.
    Copy,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash,
    Default,
    Arbitrary,
)]
pub struct Timestamp {
    /// note no `pub`.
    internal: u64,
}

impl Timestamp {
    pub const MAX: Self = Self { internal: u64::MAX };
    pub const MIN: Self = Self { internal: u64::MIN };

    pub const fn new(timestamp: u64) -> Self {
        Self {
            internal: timestamp,
        }
    }

    pub fn to_bytes(&self) -> [u8; 8] {
        self.internal.to_le_bytes()
    }

    pub fn from_bytes(bytes: [u8; 8]) -> Self {
        Self {
            internal: u64::from_le_bytes(bytes),
        }
    }

    pub fn saturating_sub<I: Into<Self>>(self, rhs: I) -> Self {
        Self {
            internal: self.internal.saturating_sub(rhs.into().internal),
        }
    }

    pub fn saturating_add<I: Into<Self>>(self, rhs: I) -> Self {
        Self {
            internal: self.internal.saturating_add(rhs.into().internal),
        }
    }

    pub fn checked_add<I: Into<Self>>(self, rhs: I) -> Option<Self> {
        self.internal
            .checked_add(rhs.into().internal)
            .map(|internal| Self { internal })
    }

    pub fn checked_sub<I: Into<Self>>(self, rhs: I) -> Option<Self> {
        self.internal
            .checked_sub(rhs.into().internal)
            .map(|internal| Self { internal })
    }

    /// Advance a timestamp by the least amount possible such that
    /// `ts.less_than(ts.step_forward())` is true. Panic if unable to do so.
    pub fn step_forward(&self) -> Self {
        match self.checked_add(1) {
            Some(ts) => ts,
            None => panic!("could not step forward"),
        }
    }

    /// Advance a timestamp forward by the given `amount`. Panic if unable to do so.
    pub fn step_forward_by(&self, amount: &Self) -> Self {
        match self.checked_add(*amount) {
            Some(ts) => ts,
            None => panic!("could not step {self} forward by {amount}"),
        }
    }

    /// Retreat a timestamp by the least amount possible such that
    /// `ts.step_back().unwrap().less_than(ts)` is true. Return `None` if unable,
    /// which must only happen if the timestamp is `Timestamp::minimum()`.
    pub fn step_back(&self) -> Option<Self> {
        self.checked_sub(1)
    }
}

impl From<u64> for Timestamp {
    fn from(internal: u64) -> Self {
        Self { internal }
    }
}

impl From<Timestamp> for u64 {
    fn from(ts: Timestamp) -> Self {
        ts.internal
    }
}

impl TryFrom<Timestamp> for i64 {
    type Error = TryFromIntError;

    fn try_from(value: Timestamp) -> Result<Self, Self::Error> {
        value.internal.try_into()
    }
}

impl From<&Timestamp> for u64 {
    fn from(ts: &Timestamp) -> Self {
        ts.internal
    }
}

impl From<Timestamp> for Numeric {
    fn from(ts: Timestamp) -> Self {
        ts.internal.into()
    }
}

impl std::ops::Rem<Timestamp> for Timestamp {
    type Output = Timestamp;

    fn rem(self, rhs: Timestamp) -> Self::Output {
        Self {
            internal: self.internal % rhs.internal,
        }
    }
}

impl Serialize for Timestamp {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        self.internal.serialize(serializer)
    }
}

impl<'de> Deserialize<'de> for Timestamp {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        Ok(Self {
            internal: u64::deserialize(deserializer)?,
        })
    }
}

impl timely::order::PartialOrder for Timestamp {
    fn less_equal(&self, other: &Self) -> bool {
        self.internal.less_equal(&other.internal)
    }
}

impl timely::order::TotalOrder for Timestamp {}

impl timely::progress::Timestamp for Timestamp {
    type Summary = Timestamp;

    fn minimum() -> Self {
        Self::MIN
    }
}

impl timely::progress::PathSummary<Timestamp> for Timestamp {
    #[inline]
    fn results_in(&self, src: &Timestamp) -> Option<Timestamp> {
        self.internal
            .checked_add(src.internal)
            .map(|internal| Self { internal })
    }
    #[inline]
    fn followed_by(&self, other: &Timestamp) -> Option<Timestamp> {
        self.internal
            .checked_add(other.internal)
            .map(|internal| Self { internal })
    }
}

impl timely::progress::timestamp::Refines<()> for Timestamp {
    fn to_inner(_: ()) -> Timestamp {
        Default::default()
    }
    fn to_outer(self) -> () {
        ()
    }
    fn summarize(_: <Timestamp as timely::progress::timestamp::Timestamp>::Summary) -> () {
        ()
    }
}

impl differential_dataflow::lattice::Lattice for Timestamp {
    #[inline]
    fn join(&self, other: &Self) -> Self {
        ::std::cmp::max(*self, *other)
    }
    #[inline]
    fn meet(&self, other: &Self) -> Self {
        ::std::cmp::min(*self, *other)
    }
}

impl mz_persist_types::Codec64 for Timestamp {
    fn codec_name() -> String {
        u64::codec_name()
    }

    fn encode(&self) -> [u8; 8] {
        self.internal.encode()
    }

    fn decode(buf: [u8; 8]) -> Self {
        Self {
            internal: u64::decode(buf),
        }
    }
}

impl std::fmt::Display for Timestamp {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Display::fmt(&self.internal, f)
    }
}

impl std::fmt::Debug for Timestamp {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Debug::fmt(&self.internal, f)
    }
}

impl std::str::FromStr for Timestamp {
    type Err = &'static str;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(Self {
            internal: s.parse().map_err(|_| "could not parse mztimestamp")?,
        })
    }
}

impl TryFrom<Duration> for Timestamp {
    type Error = TryFromIntError;

    fn try_from(value: Duration) -> Result<Self, Self::Error> {
        Ok(Self {
            internal: value.as_millis().try_into()?,
        })
    }
}

impl TryFrom<u128> for Timestamp {
    type Error = TryFromIntError;

    fn try_from(value: u128) -> Result<Self, Self::Error> {
        Ok(Self {
            internal: value.try_into()?,
        })
    }
}

impl TryFrom<i64> for Timestamp {
    type Error = TryFromIntError;

    fn try_from(value: i64) -> Result<Self, Self::Error> {
        Ok(Self {
            internal: value.try_into()?,
        })
    }
}

impl TryFrom<Numeric> for Timestamp {
    type Error = TryFromDecimalError;

    fn try_from(value: Numeric) -> Result<Self, Self::Error> {
        Ok(Self {
            internal: value.try_into()?,
        })
    }
}

/// System-wide record count difference type.
pub type Diff = i64;

#[derive(Debug)]
pub struct TimestampDecoder {}

impl mz_avro::AvroDecode for TimestampDecoder {
    type Out = Timestamp;

    define_unexpected! {
        array, record, union_branch, map, enum_variant, decimal, bytes, string, json, uuid, fixed
    }

    fn scalar(self, scalar: mz_avro::types::Scalar) -> Result<Self::Out, mz_avro::error::Error> {
        let out = match scalar {
            Scalar::Int(inner) => i64::from(inner).try_into()?,
            Scalar::Long(inner) => inner.try_into()?,
            other => {
                return Err(mz_avro::error::Error::Decode(
                    DecodeError::UnexpectedScalarKind(other.into()),
                ))
            }
        };
        Ok(out)
    }
}

impl mz_avro::StatefulAvroDecodable for Timestamp {
    type Decoder = TimestampDecoder;
    type State = ();

    fn new_decoder(_state: Self::State) -> Self::Decoder {
        Self::Decoder {}
    }
}