synadb 1.3.0

An AI-native embedded database
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321

//! FFI Integration Tests for Sparse Vector Store
//!
//! Tests the C-ABI interface for the Sparse Vector Store.
//! Note: svs_* functions are declared safe (not `unsafe extern "C"`),
//! so no `unsafe` blocks are needed for calling them.

use std::ffi::CString;
use std::ptr;

// Import FFI functions and constants
use synadb::ffi_sparse::*;

#[test]
fn test_svs_create_close_cycle() {
    let path = CString::new("test_svs_create_close.db").unwrap();

    let result = svs_new(path.as_ptr());
    assert_eq!(result, SVS_SUCCESS, "Failed to create store");

    let exists = svs_exists(path.as_ptr());
    assert_eq!(exists, 1, "Store should exist");

    let result = svs_close(path.as_ptr());
    assert_eq!(result, SVS_SUCCESS, "Failed to close store");

    let exists = svs_exists(path.as_ptr());
    assert_eq!(exists, 0, "Store should not exist after close");
}

#[test]
fn test_svs_create_already_exists() {
    let path = CString::new("test_svs_already_exists.db").unwrap();

    let result = svs_new(path.as_ptr());
    assert_eq!(result, SVS_SUCCESS);

    let result = svs_new(path.as_ptr());
    assert_eq!(result, SVS_ERR_ALREADY_EXISTS);

    svs_close(path.as_ptr());
}

#[test]
fn test_svs_close_not_found() {
    let path = CString::new("test_svs_close_not_found.db").unwrap();

    let result = svs_close(path.as_ptr());
    assert_eq!(result, SVS_ERR_NOT_FOUND);
}

#[test]
fn test_svs_null_pointer_handling() {
    let result = svs_new(ptr::null());
    assert_eq!(result, SVS_ERR_NULL_PTR);

    let result = svs_close(ptr::null());
    assert_eq!(result, SVS_ERR_NULL_PTR);

    let result = svs_exists(ptr::null());
    assert_eq!(result, SVS_ERR_NULL_PTR);
}

#[test]
fn test_svs_index_and_search() {
    let path = CString::new("test_svs_index_search.db").unwrap();
    let key1 = CString::new("doc1").unwrap();
    let key2 = CString::new("doc2").unwrap();

    svs_new(path.as_ptr());

    // Index document 1: terms 100, 200 with weights 2.0, 1.0
    let term_ids1: [u32; 2] = [100, 200];
    let weights1: [f32; 2] = [2.0, 1.0];
    let doc_id1 = svs_index(
        path.as_ptr(),
        key1.as_ptr(),
        term_ids1.as_ptr(),
        weights1.as_ptr(),
        2,
    );
    assert!(doc_id1 >= 0, "Failed to index doc1");

    // Index document 2: terms 100, 300 with weights 1.0, 3.0
    let term_ids2: [u32; 2] = [100, 300];
    let weights2: [f32; 2] = [1.0, 3.0];
    let doc_id2 = svs_index(
        path.as_ptr(),
        key2.as_ptr(),
        term_ids2.as_ptr(),
        weights2.as_ptr(),
        2,
    );
    assert!(doc_id2 >= 0, "Failed to index doc2");

    let len = svs_len(path.as_ptr());
    assert_eq!(len, 2, "Should have 2 documents");

    // Search for term 100
    let query_ids: [u32; 1] = [100];
    let query_weights: [f32; 1] = [1.0];
    let mut out_keys: [*mut i8; 10] = [ptr::null_mut(); 10];
    let mut out_scores: [f32; 10] = [0.0; 10];
    let mut out_count: u32 = 0;

    let result = svs_search(
        path.as_ptr(),
        query_ids.as_ptr(),
        query_weights.as_ptr(),
        1,
        10,
        out_keys.as_mut_ptr(),
        out_scores.as_mut_ptr(),
        &mut out_count,
    );
    assert_eq!(result, SVS_SUCCESS, "Search failed");
    assert_eq!(out_count, 2, "Should find 2 results");

    assert!(
        out_scores[0] > out_scores[1],
        "Results should be sorted by score"
    );

    // Free keys
    for i in 0..out_count as usize {
        svs_free_key(out_keys[i]);
    }

    svs_close(path.as_ptr());
}

#[test]
fn test_svs_delete() {
    let path = CString::new("test_svs_delete.db").unwrap();
    let key = CString::new("doc_to_delete").unwrap();

    svs_new(path.as_ptr());

    let term_ids: [u32; 1] = [100];
    let weights: [f32; 1] = [1.0];
    svs_index(
        path.as_ptr(),
        key.as_ptr(),
        term_ids.as_ptr(),
        weights.as_ptr(),
        1,
    );

    assert_eq!(svs_len(path.as_ptr()), 1);

    let result = svs_delete(path.as_ptr(), key.as_ptr());
    assert_eq!(result, SVS_SUCCESS);

    assert_eq!(svs_len(path.as_ptr()), 0);

    // Try to delete again - should fail
    let result = svs_delete(path.as_ptr(), key.as_ptr());
    assert_eq!(result, SVS_ERR_NOT_FOUND);

    svs_close(path.as_ptr());
}

#[test]
fn test_svs_stats() {
    let path = CString::new("test_svs_stats.db").unwrap();
    let key1 = CString::new("doc1").unwrap();
    let key2 = CString::new("doc2").unwrap();

    svs_new(path.as_ptr());

    let term_ids1: [u32; 2] = [100, 200];
    let weights1: [f32; 2] = [1.0, 2.0];
    svs_index(
        path.as_ptr(),
        key1.as_ptr(),
        term_ids1.as_ptr(),
        weights1.as_ptr(),
        2,
    );

    let term_ids2: [u32; 2] = [100, 300];
    let weights2: [f32; 2] = [1.0, 3.0];
    svs_index(
        path.as_ptr(),
        key2.as_ptr(),
        term_ids2.as_ptr(),
        weights2.as_ptr(),
        2,
    );

    let mut num_docs: u32 = 0;
    let mut num_terms: u32 = 0;
    let mut num_postings: u32 = 0;
    let mut avg_doc_len: f32 = 0.0;

    let result = svs_stats(
        path.as_ptr(),
        &mut num_docs,
        &mut num_terms,
        &mut num_postings,
        &mut avg_doc_len,
    );

    assert_eq!(result, SVS_SUCCESS);
    assert_eq!(num_docs, 2);
    assert_eq!(num_terms, 3); // 100, 200, 300
    assert_eq!(num_postings, 4); // 2 docs × 2 terms each
    assert!((avg_doc_len - 2.0).abs() < 0.001);

    svs_close(path.as_ptr());
}

#[test]
fn test_svs_index_not_found() {
    let path = CString::new("test_svs_index_not_found.db").unwrap();
    let key = CString::new("doc1").unwrap();

    let term_ids: [u32; 1] = [100];
    let weights: [f32; 1] = [1.0];
    let result = svs_index(
        path.as_ptr(),
        key.as_ptr(),
        term_ids.as_ptr(),
        weights.as_ptr(),
        1,
    );
    assert_eq!(result, SVS_ERR_NOT_FOUND as i64);
}

#[test]
fn test_svs_save_and_open() {
    let path = CString::new("test_svs_save_open.db").unwrap();
    let file_path = CString::new("target/test_svs_save_open.svs").unwrap();
    let key1 = CString::new("doc1").unwrap();
    let key2 = CString::new("doc2").unwrap();

    svs_new(path.as_ptr());

    let term_ids1: [u32; 2] = [100, 200];
    let weights1: [f32; 2] = [2.0, 1.0];
    svs_index(
        path.as_ptr(),
        key1.as_ptr(),
        term_ids1.as_ptr(),
        weights1.as_ptr(),
        2,
    );

    let term_ids2: [u32; 2] = [100, 300];
    let weights2: [f32; 2] = [1.0, 3.0];
    svs_index(
        path.as_ptr(),
        key2.as_ptr(),
        term_ids2.as_ptr(),
        weights2.as_ptr(),
        2,
    );

    let result = svs_save(path.as_ptr(), file_path.as_ptr());
    assert_eq!(result, SVS_SUCCESS, "Failed to save");

    svs_close(path.as_ptr());

    // Open from file with a new registry key
    let path2 = CString::new("test_svs_save_open_loaded.db").unwrap();
    let result = svs_open(path2.as_ptr(), file_path.as_ptr());
    assert_eq!(result, SVS_SUCCESS, "Failed to open");

    let len = svs_len(path2.as_ptr());
    assert_eq!(len, 2, "Should have 2 documents after load");

    // Search should work
    let query_ids: [u32; 1] = [100];
    let query_weights: [f32; 1] = [1.0];
    let mut out_keys: [*mut i8; 10] = [ptr::null_mut(); 10];
    let mut out_scores: [f32; 10] = [0.0; 10];
    let mut out_count: u32 = 0;

    let result = svs_search(
        path2.as_ptr(),
        query_ids.as_ptr(),
        query_weights.as_ptr(),
        1,
        10,
        out_keys.as_mut_ptr(),
        out_scores.as_mut_ptr(),
        &mut out_count,
    );
    assert_eq!(result, SVS_SUCCESS, "Search failed after load");
    assert_eq!(out_count, 2, "Should find 2 results after load");

    for i in 0..out_count as usize {
        svs_free_key(out_keys[i]);
    }

    svs_close(path2.as_ptr());
    let _ = std::fs::remove_file("target/test_svs_save_open.svs");
}

#[test]
fn test_svs_save_not_found() {
    let path = CString::new("test_svs_save_not_found.db").unwrap();
    let file_path = CString::new("target/test_svs_save_not_found.svs").unwrap();

    let result = svs_save(path.as_ptr(), file_path.as_ptr());
    assert_eq!(result, SVS_ERR_NOT_FOUND);
}

#[test]
fn test_svs_open_already_exists() {
    let path = CString::new("test_svs_open_exists.db").unwrap();
    let file_path = CString::new("target/test_svs_open_exists.svs").unwrap();

    svs_new(path.as_ptr());
    svs_save(path.as_ptr(), file_path.as_ptr());

    let result = svs_open(path.as_ptr(), file_path.as_ptr());
    assert_eq!(result, SVS_ERR_ALREADY_EXISTS);

    svs_close(path.as_ptr());
    let _ = std::fs::remove_file("target/test_svs_open_exists.svs");
}