uqa-storage 0.3.6

Document store, inverted index, IVF/HNSW vectors, B-tree, R*Tree, catalog
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

//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! Ordered key layouts for durable scalar and vector physical indexes.

use uqa_core::DocId;

use super::codec::{push_str, push_u64, table_prefixed_key, usize_to_u64};
use super::{
    StorageBackendResult, TAG_BTREE_ENTRY, TAG_BTREE_INDEX, TAG_HNSW_METADATA, TAG_HNSW_NODE,
    TAG_IVF_ASSIGNMENT, TAG_IVF_CENTROID, TAG_IVF_METADATA,
};

pub(super) fn btree_index_key_prefix(table: &str) -> StorageBackendResult<Vec<u8>> {
    table_prefixed_key(TAG_BTREE_INDEX, table)
}

pub(super) fn btree_entry_key_prefix(table: &str) -> StorageBackendResult<Vec<u8>> {
    table_prefixed_key(TAG_BTREE_ENTRY, table)
}

pub(super) fn btree_index_key(
    table: &str,
    field: &crate::ValueIndexKey,
) -> StorageBackendResult<Vec<u8>> {
    let mut key = table_prefixed_key(
        if matches!(field, crate::ValueIndexKey::Column(_)) {
            TAG_BTREE_INDEX
        } else {
            super::TAG_NAMED_BTREE_INDEX
        },
        table,
    )?;
    push_str(&mut key, field.name())?;
    Ok(key)
}

pub(super) fn btree_entry_field_prefix(
    table: &str,
    field: &crate::ValueIndexKey,
) -> StorageBackendResult<Vec<u8>> {
    let mut key = table_prefixed_key(
        if matches!(field, crate::ValueIndexKey::Column(_)) {
            TAG_BTREE_ENTRY
        } else {
            super::TAG_NAMED_BTREE_ENTRY
        },
        table,
    )?;
    push_str(&mut key, field.name())?;
    Ok(key)
}

pub(super) fn btree_entry_key(
    table: &str,
    field: &crate::ValueIndexKey,
    doc_id: DocId,
) -> StorageBackendResult<Vec<u8>> {
    let mut key = btree_entry_field_prefix(table, field)?;
    push_u64(&mut key, doc_id);
    Ok(key)
}

fn vector_physical_field_key(tag: u8, table: &str, field: &str) -> StorageBackendResult<Vec<u8>> {
    let mut key = vector_physical_table_prefix(tag, table)?;
    push_str(&mut key, field)?;
    Ok(key)
}

fn vector_physical_table_prefix(tag: u8, table: &str) -> StorageBackendResult<Vec<u8>> {
    table_prefixed_key(tag, table)
}

pub(super) fn ivf_metadata_table_prefix(table: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_table_prefix(TAG_IVF_METADATA, table)
}

pub(super) fn ivf_metadata_key(table: &str, field: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_field_key(TAG_IVF_METADATA, table, field)
}

pub(super) fn ivf_centroid_table_prefix(table: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_table_prefix(TAG_IVF_CENTROID, table)
}

pub(super) fn ivf_centroid_prefix(table: &str, field: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_field_key(TAG_IVF_CENTROID, table, field)
}

pub(super) fn ivf_centroid_key(
    table: &str,
    field: &str,
    centroid: usize,
) -> StorageBackendResult<Vec<u8>> {
    let mut key = ivf_centroid_prefix(table, field)?;
    push_u64(&mut key, usize_to_u64(centroid, "IVF centroid id")?);
    Ok(key)
}

pub(super) fn ivf_assignment_prefix(table: &str, field: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_field_key(TAG_IVF_ASSIGNMENT, table, field)
}

pub(super) fn ivf_assignment_table_prefix(table: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_table_prefix(TAG_IVF_ASSIGNMENT, table)
}

pub(super) fn ivf_assignment_doc_prefix(
    table: &str,
    field: &str,
    doc_id: DocId,
) -> StorageBackendResult<Vec<u8>> {
    let mut key = ivf_assignment_prefix(table, field)?;
    push_u64(&mut key, doc_id);
    Ok(key)
}

pub(super) fn ivf_assignment_key(
    table: &str,
    field: &str,
    doc_id: DocId,
    ordinal: u32,
) -> StorageBackendResult<Vec<u8>> {
    let mut key = ivf_assignment_doc_prefix(table, field, doc_id)?;
    push_u64(&mut key, u64::from(ordinal));
    Ok(key)
}

pub(super) fn hnsw_metadata_key(table: &str, field: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_field_key(TAG_HNSW_METADATA, table, field)
}

pub(super) fn hnsw_metadata_table_prefix(table: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_table_prefix(TAG_HNSW_METADATA, table)
}

pub(super) fn hnsw_node_prefix(table: &str, field: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_field_key(TAG_HNSW_NODE, table, field)
}

pub(super) fn hnsw_node_table_prefix(table: &str) -> StorageBackendResult<Vec<u8>> {
    vector_physical_table_prefix(TAG_HNSW_NODE, table)
}

pub(super) fn hnsw_node_key(
    table: &str,
    field: &str,
    node_id: u64,
) -> StorageBackendResult<Vec<u8>> {
    let mut key = hnsw_node_prefix(table, field)?;
    push_u64(&mut key, node_id);
    Ok(key)
}