surrealdb-expr 3.3.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

//! The parsed index-parameter clause of a DEFINE INDEX statement.
//!
//! Mirrors the catalog's `Index` with the COUNT condition held as a parsed
//! expression rather than canonical text; lowering to a definition renders it
//! through the catalog's stored-text funnel.

use surrealdb_types::{SqlFormat, ToSql};

use crate::expr::Cond;
use crate::sql;
use crate::sql::index::{DiskAnnParams, FullTextParams, HnswParams};

#[derive(Clone, Debug, Default, Eq, PartialEq, Hash)]
pub enum Index {
	/// (Basic) non unique
	#[default]
	Idx,
	/// Unique index
	Uniq,
	/// HNSW index for distance-based metrics
	Hnsw(HnswParams),
	/// Index with Full-Text search capabilities
	FullText(FullTextParams),
	/// Count index
	Count(Option<Cond>),
	/// DiskANN index for distance-based metrics
	DiskAnn(DiskAnnParams),
}

impl From<sql::index::Index> for Index {
	fn from(v: sql::index::Index) -> Self {
		match v {
			sql::index::Index::Idx => Self::Idx,
			sql::index::Index::Uniq => Self::Uniq,
			sql::index::Index::Hnsw(p) => Self::Hnsw(p),
			sql::index::Index::FullText(p) => Self::FullText(p),
			sql::index::Index::Count(c) => Self::Count(c.map(Into::into)),
			sql::index::Index::DiskAnn(p) => Self::DiskAnn(p),
		}
	}
}

impl From<Index> for sql::index::Index {
	fn from(v: Index) -> Self {
		match v {
			Index::Idx => Self::Idx,
			Index::Uniq => Self::Uniq,
			Index::Hnsw(p) => Self::Hnsw(p),
			Index::FullText(p) => Self::FullText(p),
			Index::Count(c) => Self::Count(c.map(Into::into)),
			Index::DiskAnn(p) => Self::DiskAnn(p),
		}
	}
}

impl ToSql for Index {
	fn fmt_sql(&self, f: &mut String, fmt: SqlFormat) {
		let stmt: sql::index::Index = self.clone().into();
		stmt.fmt_sql(f, fmt);
	}
}