surrealdb/key/
mod.rs

1//! How the keys are structured in the key value store
2///
3/// crate::key::root::all                /
4/// crate::key::root::hb                 /!hb{ts}/{nd}
5/// crate::key::root::nd                 /!nd{nd}
6/// crate::key::root::ni                 /!ni
7/// crate::key::root::ns                 /!ns{ns}
8/// crate::key::root::us                 /!us{us}
9///
10/// crate::key::node::all                /${nd}
11/// crate::key::node::lq                 /${nd}!lq{lq}{ns}{db}
12///
13/// crate::key::namespace::all           /*{ns}
14/// crate::key::namespace::db            /*{ns}!db{db}
15/// crate::key::namespace::di            /+{ns id}!di
16/// crate::key::namespace::lg            /*{ns}!lg{lg}
17/// crate::key::namespace::tk            /*{ns}!tk{tk}
18/// crate::key::namespace::us            /*{ns}!us{us}
19///
20/// crate::key::database::all            /*{ns}*{db}
21/// crate::key::database::az             /*{ns}*{db}!az{az}
22/// crate::key::database::fc             /*{ns}*{db}!fn{fc}
23/// crate::key::database::lg             /*{ns}*{db}!lg{lg}
24/// crate::key::database::pa             /*{ns}*{db}!pa{pa}
25/// crate::key::database::sc             /*{ns}*{db}!sc{sc}
26/// crate::key::database::tb             /*{ns}*{db}!tb{tb}
27/// crate::key::database::ti             /+{ns id}*{db id}!ti
28/// crate::key::database::tk             /*{ns}*{db}!tk{tk}
29/// crate::key::database::ts             /*{ns}*{db}!ts{ts}
30/// crate::key::database::us             /*{ns}*{db}!us{us}
31/// crate::key::database::vs             /*{ns}*{db}!vs
32///
33/// crate::key::scope::all               /*{ns}*{db}±{sc}
34/// crate::key::scope::tk                /*{ns}*{db}±{sc}!tk{tk}
35///
36/// crate::key::table::all               /*{ns}*{db}*{tb}
37/// crate::key::table::ev                /*{ns}*{db}*{tb}!ev{ev}
38/// crate::key::table::fd                /*{ns}*{db}*{tb}!fd{fd}
39/// crate::key::table::ft                /*{ns}*{db}*{tb}!ft{ft}
40/// crate::key::table::ix                /*{ns}*{db}*{tb}!ix{ix}
41/// crate::key::table::lq                /*{ns}*{db}*{tb}!lq{lq}
42///
43/// crate::key::index::all               /*{ns}*{db}*{tb}+{ix}
44/// crate::key::index::bc                /*{ns}*{db}*{tb}+{ix}!bc{id}
45/// crate::key::index::bd                /*{ns}*{db}*{tb}+{ix}!bd{id}
46/// crate::key::index::bf                /*{ns}*{db}*{tb}+{ix}!bf{id}
47/// crate::key::index::bi                /*{ns}*{db}*{tb}+{ix}!bi{id}
48/// crate::key::index::bk                /*{ns}*{db}*{tb}+{ix}!bk{id}
49/// crate::key::index::bl                /*{ns}*{db}*{tb}+{ix}!bl{id}
50/// crate::key::index::bo                /*{ns}*{db}*{tb}+{ix}!bo{id}
51/// crate::key::index::bp                /*{ns}*{db}*{tb}+{ix}!bp{id}
52/// crate::key::index::bs                /*{ns}*{db}*{tb}+{ix}!bs
53/// crate::key::index::bt                /*{ns}*{db}*{tb}+{ix}!bt{id}
54/// crate::key::index::bu                /*{ns}*{db}*{tb}+{ix}!bu{id}
55/// crate::key::index                    /*{ns}*{db}*{tb}+{ix}*{fd}{id}
56///
57/// crate::key::change                   /*{ns}*{db}#{ts}
58///
59/// crate::key::thing                    /*{ns}*{db}*{tb}*{id}
60///
61/// crate::key::graph                    /*{ns}*{db}*{tb}~{id}{eg}{fk}
62///
63pub mod change;
64pub mod database;
65pub mod debug;
66pub(crate) mod error;
67pub mod graph;
68pub mod index;
69pub(crate) mod key_req;
70pub mod namespace;
71pub mod node;
72pub mod root;
73pub mod scope;
74pub mod table;
75pub mod thing;