surrealdb_core/sql/id/
mod.rs

1use super::Range;
2use crate::cnf::ID_CHARS;
3use crate::ctx::Context;
4use crate::dbs::Options;
5use crate::doc::CursorDoc;
6use crate::err::Error;
7use crate::sql::{escape::escape_rid, Array, Number, Object, Strand, Thing, Uuid, Value};
8use nanoid::nanoid;
9use range::IdRange;
10use reblessive::tree::Stk;
11use revision::revisioned;
12use serde::{Deserialize, Serialize};
13use std::collections::BTreeMap;
14use std::fmt::{self, Display, Formatter};
15use std::ops::{Bound, Deref};
16use ulid::Ulid;
17
18pub mod range;
19
20#[revisioned(revision = 1)]
21#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Serialize, Deserialize, Hash)]
22#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
23#[non_exhaustive]
24pub enum Gen {
25	Rand,
26	Ulid,
27	Uuid,
28}
29
30#[revisioned(revision = 2)]
31#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Serialize, Deserialize, Hash)]
32#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
33#[non_exhaustive]
34pub enum Id {
35	Number(i64),
36	String(String),
37	#[revision(start = 2)]
38	Uuid(Uuid),
39	Array(Array),
40	Object(Object),
41	Generate(Gen),
42	Range(Box<IdRange>),
43}
44
45impl From<i64> for Id {
46	fn from(v: i64) -> Self {
47		Self::Number(v)
48	}
49}
50
51impl From<i32> for Id {
52	fn from(v: i32) -> Self {
53		Self::Number(v as i64)
54	}
55}
56
57impl From<u64> for Id {
58	fn from(v: u64) -> Self {
59		Self::Number(v as i64)
60	}
61}
62
63impl From<String> for Id {
64	fn from(v: String) -> Self {
65		Self::String(v)
66	}
67}
68
69impl From<Array> for Id {
70	fn from(v: Array) -> Self {
71		Self::Array(v)
72	}
73}
74
75impl From<Object> for Id {
76	fn from(v: Object) -> Self {
77		Self::Object(v)
78	}
79}
80
81impl From<Uuid> for Id {
82	fn from(v: Uuid) -> Self {
83		Self::Uuid(v)
84	}
85}
86
87impl From<Strand> for Id {
88	fn from(v: Strand) -> Self {
89		Self::String(v.as_string())
90	}
91}
92
93impl From<&str> for Id {
94	fn from(v: &str) -> Self {
95		Self::String(v.to_owned())
96	}
97}
98
99impl From<&String> for Id {
100	fn from(v: &String) -> Self {
101		Self::String(v.to_owned())
102	}
103}
104
105impl From<Vec<&str>> for Id {
106	fn from(v: Vec<&str>) -> Self {
107		Self::Array(v.into())
108	}
109}
110
111impl From<Vec<String>> for Id {
112	fn from(v: Vec<String>) -> Self {
113		Self::Array(v.into())
114	}
115}
116
117impl From<Vec<Value>> for Id {
118	fn from(v: Vec<Value>) -> Self {
119		Self::Array(v.into())
120	}
121}
122
123impl From<BTreeMap<String, Value>> for Id {
124	fn from(v: BTreeMap<String, Value>) -> Self {
125		Self::Object(v.into())
126	}
127}
128
129impl From<Number> for Id {
130	fn from(v: Number) -> Self {
131		match v {
132			Number::Int(v) => v.into(),
133			Number::Float(v) => v.to_string().into(),
134			Number::Decimal(v) => v.to_string().into(),
135		}
136	}
137}
138
139impl From<IdRange> for Id {
140	fn from(v: IdRange) -> Self {
141		Self::Range(Box::new(v))
142	}
143}
144
145impl TryFrom<(Bound<Id>, Bound<Id>)> for Id {
146	type Error = Error;
147	fn try_from(v: (Bound<Id>, Bound<Id>)) -> Result<Self, Self::Error> {
148		Ok(Self::Range(Box::new(v.try_into()?)))
149	}
150}
151
152impl TryFrom<Range> for Id {
153	type Error = Error;
154	fn try_from(v: Range) -> Result<Self, Self::Error> {
155		Ok(Id::Range(Box::new(v.try_into()?)))
156	}
157}
158
159impl TryFrom<Value> for Id {
160	type Error = Error;
161	fn try_from(v: Value) -> Result<Self, Self::Error> {
162		match v {
163			Value::Number(Number::Int(v)) => Ok(v.into()),
164			Value::Strand(v) => Ok(v.into()),
165			Value::Array(v) => Ok(v.into()),
166			Value::Object(v) => Ok(v.into()),
167			Value::Range(v) => v.deref().to_owned().try_into(),
168			v => Err(Error::IdInvalid {
169				value: v.kindof().to_string(),
170			}),
171		}
172	}
173}
174
175impl From<Thing> for Id {
176	fn from(v: Thing) -> Self {
177		v.id
178	}
179}
180
181impl Id {
182	/// Generate a new random ID
183	pub fn rand() -> Self {
184		Self::String(nanoid!(20, &ID_CHARS))
185	}
186	/// Generate a new random ULID
187	pub fn ulid() -> Self {
188		Self::String(Ulid::new().to_string())
189	}
190	/// Generate a new random UUID
191	pub fn uuid() -> Self {
192		Self::Uuid(Uuid::new_v7())
193	}
194	/// Check if this Id matches a value
195	pub fn is(&self, val: &Value) -> bool {
196		match (self, val) {
197			(Self::Number(i), Value::Number(Number::Int(j))) if *i == *j => true,
198			(Self::String(i), Value::Strand(j)) if *i == j.0 => true,
199			(Self::Uuid(i), Value::Uuid(j)) if i == j => true,
200			(Self::Array(i), Value::Array(j)) if i == j => true,
201			(Self::Object(i), Value::Object(j)) if i == j => true,
202			(i, Value::Thing(t)) if i == &t.id => true,
203			_ => false,
204		}
205	}
206	/// Convert the Id to a raw String
207	pub fn to_raw(&self) -> String {
208		match self {
209			Self::Number(v) => v.to_string(),
210			Self::String(v) => v.to_string(),
211			Self::Uuid(v) => v.to_string(),
212			Self::Array(v) => v.to_string(),
213			Self::Object(v) => v.to_string(),
214			Self::Generate(v) => match v {
215				Gen::Rand => "rand()".to_string(),
216				Gen::Ulid => "ulid()".to_string(),
217				Gen::Uuid => "uuid()".to_string(),
218			},
219			Self::Range(v) => v.to_string(),
220		}
221	}
222}
223
224impl Display for Id {
225	fn fmt(&self, f: &mut Formatter) -> fmt::Result {
226		match self {
227			Self::Number(v) => Display::fmt(v, f),
228			Self::String(v) => Display::fmt(&escape_rid(v), f),
229			Self::Uuid(v) => Display::fmt(v, f),
230			Self::Array(v) => Display::fmt(v, f),
231			Self::Object(v) => Display::fmt(v, f),
232			Self::Generate(v) => match v {
233				Gen::Rand => Display::fmt("rand()", f),
234				Gen::Ulid => Display::fmt("ulid()", f),
235				Gen::Uuid => Display::fmt("uuid()", f),
236			},
237			Self::Range(v) => Display::fmt(v, f),
238		}
239	}
240}
241
242impl Id {
243	/// Process this type returning a computed simple Value
244	pub(crate) async fn compute(
245		&self,
246		stk: &mut Stk,
247		ctx: &Context,
248		opt: &Options,
249		doc: Option<&CursorDoc>,
250	) -> Result<Id, Error> {
251		match self {
252			Id::Number(v) => Ok(Id::Number(*v)),
253			Id::String(v) => Ok(Id::String(v.clone())),
254			Id::Uuid(v) => Ok(Id::Uuid(*v)),
255			Id::Array(v) => match v.compute(stk, ctx, opt, doc).await? {
256				Value::Array(v) => Ok(Id::Array(v)),
257				v => Err(fail!("Expected a Value::Array but found {v:?}")),
258			},
259			Id::Object(v) => match v.compute(stk, ctx, opt, doc).await? {
260				Value::Object(v) => Ok(Id::Object(v)),
261				v => Err(fail!("Expected a Value::Object but found {v:?}")),
262			},
263			Id::Generate(v) => match v {
264				Gen::Rand => Ok(Self::rand()),
265				Gen::Ulid => Ok(Self::ulid()),
266				Gen::Uuid => Ok(Self::uuid()),
267			},
268			Id::Range(v) => Ok(Id::Range(Box::new(v.compute(stk, ctx, opt, doc).await?))),
269		}
270	}
271}
surrealdb_core/sql/id/mod.rs

surrealdb_core/sql/id/
mod.rs
