surrealdb_core/key/
mod.rs

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

surrealdb_core/key/
mod.rs
