surrealdb-core 3.2.0

A scalable, distributed, collaborative, document-graph database, for the realtime web
Documentation 
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

use std::collections::BTreeMap;

use revision::revisioned;
use surrealdb_types::{SqlFormat, ToSql};
use uuid::Uuid;

use crate::catalog::{DatabaseId, NamespaceId};
use crate::expr::statements::info::InfoStructure;
use crate::expr::{Expr, Fetchs, Fields};
use crate::iam::Auth;
use crate::kvs::impl_kv_value_revisioned;
use crate::sql::statements::live::LiveFields;
use crate::val::{TableName, Value};

#[revisioned(revision = 1)]
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub(crate) enum SubscriptionFields {
	Diff,
	Select(Fields),
}

impl InfoStructure for SubscriptionFields {
	fn structure(self) -> Value {
		match self {
			SubscriptionFields::Diff => "diff".to_string().into(),
			SubscriptionFields::Select(x) => x.to_sql().into(),
		}
	}
}

#[revisioned(revision = 1)]
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub struct SubscriptionDefinition {
	pub(crate) id: Uuid,
	pub(crate) node: Uuid,
	pub(crate) fields: SubscriptionFields,
	pub(crate) what: Expr,
	pub(crate) cond: Option<Expr>,
	pub(crate) fetch: Option<Fetchs>,
	// When a live query is created, we must also store the
	// authenticated session of the user who made the query,
	// so we can check it later when sending notifications.
	// This is optional as it is only set by the database
	// runtime when storing the live query to storage.
	pub(crate) auth: Option<Auth>,
	// When a live query is created, we must also store the
	// authenticated session of the user who made the query,
	// so we can check it later when sending notifications.
	// This is optional as it is only set by the database
	// runtime when storing the live query to storage.
	pub(crate) session: Option<Value>,
	// When a live query is created, we analyze the query
	// and store the variables that are used in the query.
	pub(crate) vars: BTreeMap<String, Value>,
}

impl_kv_value_revisioned!(SubscriptionDefinition);

impl SubscriptionDefinition {
	fn to_sql_definition(&self) -> crate::sql::LiveStatement {
		let fields = match &self.fields {
			SubscriptionFields::Diff => LiveFields::Diff,
			SubscriptionFields::Select(x) => LiveFields::Select(x.clone().into()),
		};

		crate::sql::LiveStatement {
			fields,
			what: self.what.clone().into(),
			cond: self.cond.clone().map(|c| crate::sql::Cond(c.into())),
			fetch: self.fetch.clone().map(|f| f.into()),
		}
	}
}

impl InfoStructure for SubscriptionDefinition {
	fn structure(self) -> Value {
		Value::from(map! {
			"id" => crate::val::Uuid(self.id).into(),
			"node" => crate::val::Uuid(self.node).into(),
			"fields" => self.fields.structure(),
			"what" => self.what.structure(),
			"cond", if let Some(v) = self.cond => v.structure(),
			"fetch", if let Some(v) = self.fetch => v.structure(),
		})
	}
}

impl ToSql for &SubscriptionDefinition {
	fn fmt_sql(&self, f: &mut String, fmt: SqlFormat) {
		self.to_sql_definition().fmt_sql(f, fmt)
	}
}

#[revisioned(revision = 1)]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub(crate) struct NodeLiveQuery {
	pub(crate) ns: NamespaceId,
	pub(crate) db: DatabaseId,
	pub(crate) tb: TableName,
}
impl_kv_value_revisioned!(NodeLiveQuery);