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
//! Utility functions for creating OwnedTables and OwnedColumns.
//! These functions are primarily intended for use in tests.
//!
//! # Example
//! ```
//! use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
//! let result = owned_table::<Curve25519Scalar>([
//! bigint("a", [1, 2, 3]),
//! boolean("b", [true, false, true]),
//! int128("c", [1, 2, 3]),
//! scalar("d", [1, 2, 3]),
//! varchar("e", ["a", "b", "c"]),
//! decimal75("f", 12, 1, [1, 2, 3]),
//! ]);
//! ```
use super::{OwnedColumn, OwnedTable};
use crate::base::scalar::Scalar;
use core::ops::Deref;
use proof_of_sql_parser::{
posql_time::{PoSQLTimeUnit, PoSQLTimeZone},
Identifier,
};
/// Creates an OwnedTable from a list of (Identifier, OwnedColumn) pairs.
/// This is a convenience wrapper around OwnedTable::try_from_iter primarily for use in tests and
/// intended to be used along with the other methods in this module (e.g. [bigint], [boolean], etc).
/// The function will panic under a variety of conditions. See [OwnedTable::try_from_iter] for more details.
///
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
/// let result = owned_table::<Curve25519Scalar>([
/// bigint("a", [1, 2, 3]),
/// boolean("b", [true, false, true]),
/// int128("c", [1, 2, 3]),
/// scalar("d", [1, 2, 3]),
/// varchar("e", ["a", "b", "c"]),
/// decimal75("f", 12, 1, [1, 2, 3]),
/// ]);
/// ```
pub fn owned_table<S: Scalar>(
iter: impl IntoIterator<Item = (Identifier, OwnedColumn<S>)>,
) -> OwnedTable<S> {
OwnedTable::try_from_iter(iter).unwrap()
}
/// Creates a (Identifier, OwnedColumn) pair for a smallint column.
/// This is primarily intended for use in conjunction with [owned_table].
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
/// let result = owned_table::<Curve25519Scalar>([
/// smallint("a", [1_i16, 2, 3]),
/// ]);
pub fn smallint<S: Scalar>(
name: impl Deref<Target = str>,
data: impl IntoIterator<Item = impl Into<i16>>,
) -> (Identifier, OwnedColumn<S>) {
(
name.parse().unwrap(),
OwnedColumn::SmallInt(data.into_iter().map(Into::into).collect()),
)
}
/// Creates a (Identifier, OwnedColumn) pair for an int column.
/// This is primarily intended for use in conjunction with [owned_table].
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
/// let result = owned_table::<Curve25519Scalar>([
/// int("a", [1, 2, 3]),
/// ]);
pub fn int<S: Scalar>(
name: impl Deref<Target = str>,
data: impl IntoIterator<Item = impl Into<i32>>,
) -> (Identifier, OwnedColumn<S>) {
(
name.parse().unwrap(),
OwnedColumn::Int(data.into_iter().map(Into::into).collect()),
)
}
/// Creates a (Identifier, OwnedColumn) pair for a bigint column.
/// This is primarily intended for use in conjunction with [owned_table].
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
/// let result = owned_table::<Curve25519Scalar>([
/// bigint("a", [1, 2, 3]),
/// ]);
pub fn bigint<S: Scalar>(
name: impl Deref<Target = str>,
data: impl IntoIterator<Item = impl Into<i64>>,
) -> (Identifier, OwnedColumn<S>) {
(
name.parse().unwrap(),
OwnedColumn::BigInt(data.into_iter().map(Into::into).collect()),
)
}
/// Creates a (Identifier, OwnedColumn) pair for a boolean column.
/// This is primarily intended for use in conjunction with [owned_table].
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
/// let result = owned_table::<Curve25519Scalar>([
/// boolean("a", [true, false, true]),
/// ]);
/// ```
pub fn boolean<S: Scalar>(
name: impl Deref<Target = str>,
data: impl IntoIterator<Item = impl Into<bool>>,
) -> (Identifier, OwnedColumn<S>) {
(
name.parse().unwrap(),
OwnedColumn::Boolean(data.into_iter().map(Into::into).collect()),
)
}
/// Creates a (Identifier, OwnedColumn) pair for a int128 column.
/// This is primarily intended for use in conjunction with [owned_table].
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
/// let result = owned_table::<Curve25519Scalar>([
/// int128("a", [1, 2, 3]),
/// ]);
/// ```
pub fn int128<S: Scalar>(
name: impl Deref<Target = str>,
data: impl IntoIterator<Item = impl Into<i128>>,
) -> (Identifier, OwnedColumn<S>) {
(
name.parse().unwrap(),
OwnedColumn::Int128(data.into_iter().map(Into::into).collect()),
)
}
/// Creates a (Identifier, OwnedColumn) pair for a scalar column.
/// This is primarily intended for use in conjunction with [owned_table].
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
/// let result = owned_table::<Curve25519Scalar>([
/// scalar("a", [1, 2, 3]),
/// ]);
/// ```
pub fn scalar<S: Scalar>(
name: impl Deref<Target = str>,
data: impl IntoIterator<Item = impl Into<S>>,
) -> (Identifier, OwnedColumn<S>) {
(
name.parse().unwrap(),
OwnedColumn::Scalar(data.into_iter().map(Into::into).collect()),
)
}
/// Creates a (Identifier, OwnedColumn) pair for a varchar column.
/// This is primarily intended for use in conjunction with [owned_table].
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
/// let result = owned_table::<Curve25519Scalar>([
/// varchar("a", ["a", "b", "c"]),
/// ]);
/// ```
pub fn varchar<S: Scalar>(
name: impl Deref<Target = str>,
data: impl IntoIterator<Item = impl Into<String>>,
) -> (Identifier, OwnedColumn<S>) {
(
name.parse().unwrap(),
OwnedColumn::VarChar(data.into_iter().map(Into::into).collect()),
)
}
/// Creates a (Identifier, OwnedColumn) pair for a decimal75 column.
/// This is primarily intended for use in conjunction with [owned_table].
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*, scalar::Curve25519Scalar};
/// let result = owned_table::<Curve25519Scalar>([
/// decimal75("a", 12, 1, [1, 2, 3]),
/// ]);
/// ```
pub fn decimal75<S: Scalar>(
name: impl Deref<Target = str>,
precision: u8,
scale: i8,
data: impl IntoIterator<Item = impl Into<S>>,
) -> (Identifier, OwnedColumn<S>) {
(
name.parse().unwrap(),
OwnedColumn::Decimal75(
crate::base::math::decimal::Precision::new(precision).unwrap(),
scale,
data.into_iter().map(Into::into).collect(),
),
)
}
/// Creates a (Identifier, OwnedColumn) pair for a timestamp column.
/// This is primarily intended for use in conjunction with [owned_table].
///
/// # Parameters
/// - `name`: The name of the column.
/// - `time_unit`: The time unit of the timestamps.
/// - `timezone`: The timezone for the timestamps.
/// - `data`: The data for the column, provided as an iterator over `i64` values representing time since the unix epoch.
///
/// # Example
/// ```
/// use proof_of_sql::base::{database::owned_table_utility::*,
/// scalar::Curve25519Scalar,
/// };
/// use proof_of_sql_parser::{
/// posql_time::{PoSQLTimeZone, PoSQLTimeUnit}};
///
/// let result = owned_table::<Curve25519Scalar>([
/// timestamptz("event_time", PoSQLTimeUnit::Second, PoSQLTimeZone::Utc, vec![1625072400, 1625076000, 1625079600]),
/// ]);
/// ```
pub fn timestamptz<S: Scalar>(
name: impl Deref<Target = str>,
time_unit: PoSQLTimeUnit,
timezone: PoSQLTimeZone,
data: impl IntoIterator<Item = i64>,
) -> (Identifier, OwnedColumn<S>) {
(
name.parse().unwrap(),
OwnedColumn::TimestampTZ(time_unit, timezone, data.into_iter().collect()),
)
}