surrealdb-core 3.2.2

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
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

#![cfg(any(
	feature = "kv-mem",
	feature = "kv-rocksdb",
	feature = "kv-indxdb",
	feature = "kv-tikv",
	feature = "kv-surrealkv",
))]

use std::future::Future;

use uuid::Uuid;

use super::Datastore;

macro_rules! include_tests {
	($new_ds:ident => $($name:ident),* $(,)?) => {
		$(
			super::$name::define_tests!($new_ds);
		)*
	};
}

#[cfg(feature = "kv-rocksdb")]
mod metrics;

mod multireader;
mod multiwriter_different_keys;
mod multiwriter_same_keys_allow;
mod multiwriter_same_keys_conflict;
mod raw;
#[cfg(feature = "kv-mem")]
mod reclaim_test;
#[cfg(feature = "kv-mem")]
mod rpc_session_test;
mod snapshot;
#[cfg(feature = "kv-mem")]
mod tx_cache_test;

#[derive(Clone, Debug)]
pub(crate) enum Kvs {
	#[cfg_attr(not(feature = "kv-mem"), expect(dead_code))]
	Mem,
	#[cfg_attr(not(feature = "kv-rocksdb"), expect(dead_code))]
	Rocksdb,
	#[cfg_attr(not(feature = "kv-tikv"), expect(dead_code))]
	Tikv,
	#[cfg_attr(not(feature = "kv-surrealkv"), expect(dead_code))]
	SurrealKV,
}

trait CreateDs {
	async fn create_ds(&self, id: Uuid) -> (Datastore, Kvs);
}

impl<F, Fut> CreateDs for F
where
	F: Fn(Uuid) -> Fut,
	Fut: Future<Output = (Datastore, Kvs)>,
{
	async fn create_ds(&self, id: Uuid) -> (Datastore, Kvs) {
		(self)(id).await
	}
}

#[cfg(feature = "kv-mem")]
mod mem {
	use uuid::Uuid;

	use super::Kvs;
	use crate::CommunityComposer;
	use crate::kvs::Datastore;

	async fn new_ds(id: Uuid) -> (Datastore, Kvs) {
		// Use a memory datastore instance
		let path = "memory";
		// Setup the in-memory datastore
		let ds = Datastore::builder()
			.with_id(id)
			.build_with_factory_path(path, CommunityComposer())
			.await
			.unwrap();
		// Return the datastore
		(ds, Kvs::Mem)
	}

	include_tests!(new_ds =>
		raw,
		snapshot,
		multireader,
		multiwriter_different_keys,
		multiwriter_same_keys_conflict,
	);
}

#[cfg(feature = "kv-rocksdb")]
mod rocksdb {
	use temp_dir::TempDir;
	use uuid::Uuid;

	use super::Kvs;
	use crate::CommunityComposer;
	use crate::kvs::Datastore;

	async fn new_ds(id: Uuid) -> (Datastore, Kvs) {
		// Setup the temporary data storage path
		let path = TempDir::new().unwrap().path().to_string_lossy().to_string();
		let path = format!("rocksdb:{path}");
		// Setup the RocksDB datastore
		let ds = Datastore::builder()
			.with_id(id)
			.build_with_factory_path(&path, CommunityComposer())
			.await
			.unwrap();
		// Return the datastore
		(ds, Kvs::Rocksdb)
	}

	include_tests!(new_ds =>
		raw,
		snapshot,
		multireader,
		multiwriter_different_keys,
		multiwriter_same_keys_conflict,
		metrics
	);
}

#[cfg(feature = "kv-surrealkv")]
mod surrealkv {
	use temp_dir::TempDir;
	use uuid::Uuid;

	use super::Kvs;
	use crate::CommunityComposer;
	use crate::kvs::Datastore;

	async fn new_ds(id: Uuid) -> (Datastore, Kvs) {
		// Setup the temporary data storage path
		let path = TempDir::new().unwrap().path().to_string_lossy().to_string();
		let path = format!("surrealkv:{path}");
		// Setup the SurrealKV datastore
		let ds = Datastore::builder()
			.with_id(id)
			.build_with_factory_path(&path, CommunityComposer())
			.await
			.unwrap();
		// Return the datastore
		(ds, Kvs::SurrealKV)
	}

	include_tests!(new_ds =>
		raw,
		snapshot,
		multireader,
		multiwriter_different_keys,
		multiwriter_same_keys_conflict,
	);
}

#[cfg(feature = "kv-tikv")]
mod tikv {
	use uuid::Uuid;

	use super::Kvs;
	use crate::CommunityComposer;
	use crate::kvs::{Datastore, LockType, TransactionType};

	async fn new_ds(id: Uuid) -> (Datastore, Kvs) {
		// Setup the cluster connection string
		let path = "tikv:127.0.0.1:2379";
		// Setup the TiKV datastore
		let ds = Datastore::builder()
			.with_id(id)
			.build_with_factory_path(path, CommunityComposer())
			.await
			.unwrap();
		// Clear any previous test entries
		let tx = ds.transaction(TransactionType::Write, LockType::Optimistic).await.unwrap();
		tx.delr(vec![0u8]..vec![0xffu8]).await.unwrap();
		tx.commit().await.unwrap();
		// Return the datastore
		(ds, Kvs::Tikv)
	}

	include_tests!(new_ds =>
		raw,
		snapshot,
		multireader,
		multiwriter_different_keys,
		multiwriter_same_keys_allow,
	);
}