surrealpatch/lib/src/sql/model.rs
Rushmore Mushambi 3e80aa9914
Implement to_value for sql::Value (#1659)
`sql::Value` is an integral part of `surrealdb`. It's the internal type used by our storage layer. Because of this, we do a lot of converting between this type and native Rust types. Currently this conversion is done through `JSON` using the `serde_json` crate because we do not have our own custom data format implementation. This works because `SQL` is a superset of `JSON`.  This, however, means that this conversion is lossy and can cause surprises in some cases. For example expecting record IDs to be deserialized into a `String` instead of its corresponding Rust native type.

This change implements a custom data format around `sql::Value` and introduces a `to_value` function that facilitates that conversion.
2023-03-30 11:41:44 +01:00

159 lines
3.4 KiB
Rust

use crate::sql::common::take_u64;
use crate::sql::error::IResult;
use crate::sql::escape::escape_ident;
use crate::sql::id::Id;
use crate::sql::ident::ident_raw;
use crate::sql::serde::is_internal_serialization;
use crate::sql::thing::Thing;
use nom::branch::alt;
use nom::character::complete::char;
use serde::ser::SerializeTupleVariant;
use serde::{Deserialize, Serialize};
use std::fmt;
pub(crate) const TOKEN: &str = "$surrealdb::private::sql::Model";
pub struct IntoIter {
model: Model,
index: u64,
}
impl Iterator for IntoIter {
type Item = Thing;
fn next(&mut self) -> Option<Thing> {
match &self.model {
Model::Count(tb, c) => {
if self.index < *c {
self.index += 1;
Some(Thing {
tb: tb.to_string(),
id: Id::rand(),
})
} else {
None
}
}
Model::Range(tb, b, e) => {
if self.index + b <= *e {
self.index += 1;
Some(Thing {
tb: tb.to_string(),
id: Id::from(self.index),
})
} else {
None
}
}
}
}
}
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Deserialize, Hash)]
pub enum Model {
Count(String, u64),
Range(String, u64, u64),
}
impl IntoIterator for Model {
type Item = Thing;
type IntoIter = IntoIter;
fn into_iter(self) -> Self::IntoIter {
IntoIter {
model: self,
index: 0,
}
}
}
impl fmt::Display for Model {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
Model::Count(tb, c) => {
write!(f, "|{}:{}|", escape_ident(tb), c)
}
Model::Range(tb, b, e) => {
write!(f, "|{}:{}..{}|", escape_ident(tb), b, e)
}
}
}
}
impl Serialize for Model {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
if is_internal_serialization() {
match self {
Self::Count(tb, c) => {
let mut serializer =
serializer.serialize_tuple_variant(TOKEN, 0, "Count", 2)?;
serializer.serialize_field(tb)?;
serializer.serialize_field(c)?;
serializer.end()
}
Self::Range(tb, b, e) => {
let mut serializer =
serializer.serialize_tuple_variant(TOKEN, 1, "Range", 3)?;
serializer.serialize_field(tb)?;
serializer.serialize_field(b)?;
serializer.serialize_field(e)?;
serializer.end()
}
}
} else {
serializer.serialize_none()
}
}
}
pub fn model(i: &str) -> IResult<&str, Model> {
alt((model_count, model_range))(i)
}
fn model_count(i: &str) -> IResult<&str, Model> {
let (i, _) = char('|')(i)?;
let (i, t) = ident_raw(i)?;
let (i, _) = char(':')(i)?;
let (i, c) = take_u64(i)?;
let (i, _) = char('|')(i)?;
Ok((i, Model::Count(t, c)))
}
fn model_range(i: &str) -> IResult<&str, Model> {
let (i, _) = char('|')(i)?;
let (i, t) = ident_raw(i)?;
let (i, _) = char(':')(i)?;
let (i, b) = take_u64(i)?;
let (i, _) = char('.')(i)?;
let (i, _) = char('.')(i)?;
let (i, e) = take_u64(i)?;
let (i, _) = char('|')(i)?;
Ok((i, Model::Range(t, b, e)))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn model_count() {
let sql = "|test:1000|";
let res = model(sql);
assert!(res.is_ok());
let out = res.unwrap().1;
assert_eq!("|test:1000|", format!("{}", out));
assert_eq!(out, Model::Count(String::from("test"), 1000));
}
#[test]
fn model_range() {
let sql = "|test:1..1000|";
let res = model(sql);
assert!(res.is_ok());
let out = res.unwrap().1;
assert_eq!("|test:1..1000|", format!("{}", out));
assert_eq!(out, Model::Range(String::from("test"), 1, 1000));
}
}