tapirus 1.2.1

Embedded multi-model database with SQL, vector search and local AI memory
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
//! # S3 / Cloudflare R2 Remote Storage Adapter & Remote Pager for TapirusDB
//!
//! Provides cloud-native, on-demand block storage reading via HTTP Range Requests
//! (`Range: bytes=offset-(offset+4095)`) directly against AWS S3, Cloudflare R2, MinIO,
//! or GCP Cloud Storage.
//!
//! # Architecture
//! In serverless and edge environments (e.g. AWS Lambda, Cloudflare Workers), downloading
//! an entire multi-gigabyte `.tapir` database file causes prohibitive cold-start latency.
//! The `RemotePager` streams only the specific 4KB B+Tree and Vector pages accessed by
//! the query and caches them in local memory. Cache behavior and latency depend
//! on the remote store, network and workload.

use crate::crypto::DatabaseCipher;
use crate::error::{Error, Result};
use crate::pager::{DATABASE_HEADER_SIZE, DatabaseHeader, PageId};
use parking_lot::RwLock;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::sync::Arc;
use std::sync::atomic::{AtomicU64, AtomicUsize, Ordering};

/// Trait for fetching byte slices from remote cloud object stores
pub trait RemoteRangeReader: Send + Sync {
    /// Fetch exact byte range `[offset, offset + length)` from remote storage
    fn fetch_range(&self, offset: u64, length: usize) -> Result<Vec<u8>>;
    /// Get the total size of the database object in bytes
    fn total_size(&self) -> Result<u64>;
}

/// Trait for bidirectional remote cloud object storage (read range + put object)
pub trait RemoteStorageAdapter: RemoteRangeReader {
    /// Write back entire database bytes to remote object storage
    fn put_object(&self, data: &[u8]) -> Result<()>;
}

/// Delegate reads without trait-object upcasting, which is unavailable on Rust 1.85.
pub(crate) struct AdapterRangeReader(pub Arc<dyn RemoteStorageAdapter>);

impl RemoteRangeReader for AdapterRangeReader {
    fn fetch_range(&self, offset: u64, length: usize) -> Result<Vec<u8>> {
        self.0.fetch_range(offset, length)
    }

    fn total_size(&self) -> Result<u64> {
        self.0.total_size()
    }
}

/// In-memory mock range reader and writable storage for unit tests, local development, and simulated network environments
pub struct MockRemoteRangeStorage {
    data: RwLock<Vec<u8>>,
    fetch_count: AtomicUsize,
    bytes_read: AtomicU64,
    put_count: AtomicUsize,
}

impl MockRemoteRangeStorage {
    /// Create a new mock storage pre-loaded with raw database file bytes
    pub fn new(data: Vec<u8>) -> Self {
        Self {
            data: RwLock::new(data),
            fetch_count: AtomicUsize::new(0),
            bytes_read: AtomicU64::new(0),
            put_count: AtomicUsize::new(0),
        }
    }

    /// Create empty mock remote storage
    pub fn empty() -> Self {
        Self::new(Vec::new())
    }

    /// Length of currently stored data in bytes
    pub fn bytes_len(&self) -> usize {
        self.data.read().len()
    }

    /// Number of remote range calls made
    pub fn fetch_count(&self) -> usize {
        self.fetch_count.load(Ordering::Relaxed)
    }

    /// Total bytes transferred over mock remote network
    pub fn bytes_transferred(&self) -> u64 {
        self.bytes_read.load(Ordering::Relaxed)
    }

    /// Total number of put_object writes executed
    pub fn put_count(&self) -> usize {
        self.put_count.load(Ordering::Relaxed)
    }

    /// Extract snapshot of current storage bytes
    pub fn data(&self) -> Vec<u8> {
        self.data.read().clone()
    }
}

impl Default for MockRemoteRangeStorage {
    fn default() -> Self {
        Self::empty()
    }
}

impl RemoteRangeReader for MockRemoteRangeStorage {
    fn fetch_range(&self, offset: u64, length: usize) -> Result<Vec<u8>> {
        let guard = self.data.read();
        let start = offset as usize;
        let end = start + length;
        if start > guard.len() {
            return Err(Error::Corrupted(format!(
                "Remote fetch out of bounds: offset {} exceeds file size {}",
                offset,
                guard.len()
            )));
        }

        let actual_end = end.min(guard.len());
        let slice = guard[start..actual_end].to_vec();

        self.fetch_count.fetch_add(1, Ordering::Relaxed);
        self.bytes_read
            .fetch_add(slice.len() as u64, Ordering::Relaxed);

        Ok(slice)
    }

    fn total_size(&self) -> Result<u64> {
        Ok(self.data.read().len() as u64)
    }
}

impl RemoteStorageAdapter for MockRemoteRangeStorage {
    fn put_object(&self, data: &[u8]) -> Result<()> {
        let mut guard = self.data.write();
        *guard = data.to_vec();
        self.put_count.fetch_add(1, Ordering::Relaxed);
        Ok(())
    }
}

/// S3 / Cloudflare R2 connection parameters for HTTP Range query requests
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct S3StorageConfig {
    /// Target bucket name (e.g. "tapirus-db-prod")
    pub bucket: String,
    /// Object path key in bucket (e.g. "databases/ecommerce.tapir")
    pub key: String,
    /// S3-compatible API endpoint (e.g. "https://<account_id>.r2.cloudflarestorage.com")
    pub endpoint: String,
    /// AWS / Cloud region (e.g. "auto", "us-east-1")
    pub region: String,
    /// Optional bearer or API token for signed requests
    pub auth_token: Option<String>,
}

impl S3StorageConfig {
    /// Construct standard HTTP Range header string for page reading
    pub fn make_range_header(&self, offset: u64, length: usize) -> String {
        let end = offset + length as u64 - 1;
        format!("bytes={}-{}", offset, end)
    }
}

/// Remote Pager managing on-demand 4KB page streaming and caching over S3 / R2
pub struct RemotePager {
    header: DatabaseHeader,
    reader: Arc<dyn RemoteRangeReader>,
    in_memory_pages: HashMap<PageId, Vec<u8>>,
    cache_capacity: usize,
    cipher: Option<DatabaseCipher>,
    cache_hits: usize,
    network_fetches: usize,
}

impl RemotePager {
    /// Open a remote database using any `RemoteRangeReader` backend
    pub fn open(
        reader: Arc<dyn RemoteRangeReader>,
        cache_capacity: usize,
        cipher: Option<DatabaseCipher>,
    ) -> Result<Self> {
        let total_size = reader.total_size()?;
        if total_size < DATABASE_HEADER_SIZE as u64 {
            return Err(Error::Corrupted(
                "Remote database file is smaller than minimum header size".into(),
            ));
        }

        // Fetch 100-byte database header via Range request [0..100]
        let header_bytes = reader.fetch_range(0, DATABASE_HEADER_SIZE)?;
        let mut header_buf = [0u8; DATABASE_HEADER_SIZE];
        header_buf.copy_from_slice(&header_bytes[..DATABASE_HEADER_SIZE]);

        let header = DatabaseHeader::from_bytes(&header_buf)?;

        // Verify cryptographic verification code if database is encrypted
        if header.encryption_flags == 1 {
            if let Some(ref c) = cipher {
                if !c.verify_kcv(&header.kcv) {
                    return Err(Error::DecryptionFailed(1));
                }
            } else {
                return Err(Error::EncryptedDatabase);
            }
        }

        Ok(Self {
            header,
            reader,
            in_memory_pages: HashMap::new(),
            cache_capacity: cache_capacity.max(64),
            cipher,
            cache_hits: 0,
            network_fetches: 0,
        })
    }

    /// Return database header
    pub fn header(&self) -> &DatabaseHeader {
        &self.header
    }

    /// Return page size
    pub fn page_size(&self) -> usize {
        self.header.page_size as usize
    }

    /// Return total pages count
    pub fn total_pages(&self) -> u32 {
        self.header.total_pages
    }

    /// Number of cache hits served from memory
    pub fn cache_hits(&self) -> usize {
        self.cache_hits
    }

    /// Number of network fetches made to remote storage
    pub fn network_fetches(&self) -> usize {
        self.network_fetches
    }

    /// Read a page by its ID (1-indexed)
    pub fn read_page(&mut self, page_id: PageId) -> Result<Vec<u8>> {
        let page_size = self.page_size();
        if page_id == 0 || page_id > self.header.total_pages {
            return Err(Error::PageNotFound(page_id));
        }

        // 1. Check in-memory LRU cache
        if let Some(page) = self.in_memory_pages.get(&page_id) {
            self.cache_hits += 1;
            return Ok(page.clone());
        }

        // 2. Fetch page bytes over remote storage range request
        let offset = (page_id as u64 - 1) * page_size as u64;
        let raw_bytes = self.reader.fetch_range(offset, page_size)?;
        self.network_fetches += 1;

        if raw_bytes.len() != page_size {
            return Err(Error::Corrupted(format!(
                "Incomplete page fetch: expected {} bytes, got {}",
                page_size,
                raw_bytes.len()
            )));
        }

        // 3. Decrypt page if encryption is active
        let plaintext = if let Some(ref cipher) = self.cipher {
            cipher.decrypt_page(page_id, &raw_bytes)?
        } else {
            raw_bytes
        };

        // Cache in memory for subsequent O(1) hits
        if self.in_memory_pages.len() >= self.cache_capacity {
            // Evict arbitrary entry if cache capacity reached
            if let Some(&first_key) = self.in_memory_pages.keys().next() {
                self.in_memory_pages.remove(&first_key);
            }
        }
        self.in_memory_pages.insert(page_id, plaintext.clone());

        Ok(plaintext)
    }
}

/// Real HTTP/HTTPS Cloud Object Storage Adapter for AWS S3, Cloudflare R2, MinIO, and GCP.
///
/// Executes genuine HTTP Range requests (`Range: bytes=offset-end`) to stream 4KB pages
/// on-demand into memory over TLS/TCP with zero local file footprint.
#[cfg(feature = "cloud-s3")]
pub struct CloudS3RemoteStorage {
    config: S3StorageConfig,
    agent: ureq::Agent,
}

#[cfg(feature = "cloud-s3")]
impl CloudS3RemoteStorage {
    /// Construct a new Cloud S3 / R2 storage adapter from configuration
    pub fn new(config: S3StorageConfig) -> Self {
        let agent = ureq::Agent::config_builder()
            .timeout_per_read(Some(web_time::Duration::from_secs(30)))
            .timeout_per_write(Some(web_time::Duration::from_secs(30)))
            .build()
            .new_agent();
        Self { config, agent }
    }

    /// Construct object URL from endpoint, bucket, and key
    pub fn object_url(&self) -> String {
        let base = self.config.endpoint.trim_end_matches('/');
        let bucket = self.config.bucket.trim_matches('/');
        let key = self.config.key.trim_start_matches('/');
        if bucket.is_empty() {
            format!("{base}/{key}")
        } else {
            format!("{base}/{bucket}/{key}")
        }
    }
}

#[cfg(feature = "cloud-s3")]
impl RemoteRangeReader for CloudS3RemoteStorage {
    fn fetch_range(&self, offset: u64, length: usize) -> Result<Vec<u8>> {
        let url = self.object_url();
        let range_header = self.config.make_range_header(offset, length);
        let mut req = self.agent.get(&url).header("Range", &range_header);

        if let Some(ref token) = self.config.auth_token {
            if token.starts_with("Bearer ") || token.starts_with("AWS ") {
                req = req.header("Authorization", token);
            } else {
                req = req.header("Authorization", format!("Bearer {token}"));
            }
        }

        let resp = req.call().map_err(|e| {
            Error::Io(std::io::Error::other(format!(
                "Cloud S3 range request failed for {url} [Range: {range_header}]: {e}"
            )))
        })?;

        let mut reader = resp.into_body().into_reader();
        let mut buf = Vec::with_capacity(length);
        std::io::Read::read_to_end(&mut reader, &mut buf)?;
        Ok(buf)
    }

    fn total_size(&self) -> Result<u64> {
        let url = self.object_url();
        let mut req = self.agent.head(&url);

        if let Some(ref token) = self.config.auth_token {
            if token.starts_with("Bearer ") || token.starts_with("AWS ") {
                req = req.header("Authorization", token);
            } else {
                req = req.header("Authorization", format!("Bearer {token}"));
            }
        }

        if let Ok(resp) = req.call()
            && let Some(cl) = resp
                .headers()
                .get("content-length")
                .and_then(|v| v.to_str().ok())
            && let Ok(size) = cl.parse::<u64>()
        {
            return Ok(size);
        }

        // Fallback: request 1-byte range to inspect Content-Range header
        let mut req_range = self.agent.get(&url).header("Range", "bytes=0-0");
        if let Some(ref token) = self.config.auth_token {
            if token.starts_with("Bearer ") || token.starts_with("AWS ") {
                req_range = req_range.header("Authorization", token);
            } else {
                req_range = req_range.header("Authorization", format!("Bearer {token}"));
            }
        }

        let resp = req_range.call().map_err(|e| {
            Error::Io(std::io::Error::other(format!(
                "Failed to determine S3 object size for {url}: {e}"
            )))
        })?;

        if let Some(cr) = resp
            .headers()
            .get("content-range")
            .and_then(|v| v.to_str().ok())
            && let Some(slash_idx) = cr.rfind('/')
        {
            let total_str = &cr[slash_idx + 1..];
            if let Ok(size) = total_str.trim().parse::<u64>() {
                return Ok(size);
            }
        }

        if let Some(cl) = resp
            .headers()
            .get("content-length")
            .and_then(|v| v.to_str().ok())
            && let Ok(size) = cl.parse::<u64>()
        {
            return Ok(size);
        }

        Err(Error::Corrupted(format!(
            "Cloud S3 response missing Content-Length or Content-Range headers for {url}"
        )))
    }
}

#[cfg(feature = "cloud-s3")]
impl RemoteStorageAdapter for CloudS3RemoteStorage {
    fn put_object(&self, data: &[u8]) -> Result<()> {
        let url = self.object_url();
        let mut req = self
            .agent
            .put(&url)
            .header("Content-Type", "application/octet-stream");

        if let Some(ref token) = self.config.auth_token {
            if token.starts_with("Bearer ") || token.starts_with("AWS ") {
                req = req.header("Authorization", token);
            } else {
                req = req.header("Authorization", format!("Bearer {token}"));
            }
        }

        req.send(data).map_err(|e| {
            Error::Io(std::io::Error::other(format!(
                "Cloud S3 PUT request failed for {url}: {e}"
            )))
        })?;
        Ok(())
    }
}

#[cfg(all(test, feature = "cloud-s3"))]
mod tests {
    use super::*;

    #[test]
    #[cfg(feature = "cloud-s3")]
    fn test_cloud_s3_http_range_streaming_live() {
        use std::io::{Read, Write};
        use std::net::TcpListener;
        use std::sync::Arc;
        use std::sync::atomic::{AtomicBool, Ordering};

        let listener = TcpListener::bind("127.0.0.1:0").expect("Failed to bind test HTTP server");
        let port = listener.local_addr().unwrap().port();

        let running = Arc::new(AtomicBool::new(true));
        let running_clone = running.clone();

        let payload_data: Arc<parking_lot::RwLock<Vec<u8>>> = Arc::new(parking_lot::RwLock::new(
            (0..8192).map(|i| (i % 256) as u8).collect(),
        ));
        let server_payload = payload_data.clone();

        let server_thread = std::thread::spawn(move || {
            listener.set_nonblocking(true).unwrap();
            while running_clone.load(Ordering::Relaxed) {
                if let Ok((mut stream, _)) = listener.accept() {
                    // Accepted sockets can inherit nonblocking mode on some hosts.
                    stream.set_nonblocking(false).unwrap();
                    stream
                        .set_read_timeout(Some(std::time::Duration::from_secs(5)))
                        .unwrap();
                    let mut req_buf = [0u8; 2048];
                    let mut n = 0;
                    while n < req_buf.len() {
                        let read = stream.read(&mut req_buf[n..]).unwrap_or(0);
                        if read == 0 {
                            break;
                        }
                        n += read;
                        if req_buf[..n].windows(4).any(|part| part == b"\r\n\r\n") {
                            break;
                        }
                    }
                    let req_str = String::from_utf8_lossy(&req_buf[..n]);

                    if req_str.starts_with("HEAD ") {
                        let len = server_payload.read().len();
                        let resp = format!(
                            "HTTP/1.1 200 OK\r\nContent-Length: {len}\r\nAccept-Ranges: bytes\r\nConnection: close\r\n\r\n"
                        );
                        let _ = stream.write_all(resp.as_bytes());
                    } else if req_str.starts_with("GET ") {
                        let range_header = req_str
                            .lines()
                            .find(|l| l.to_lowercase().starts_with("range:"))
                            .unwrap_or("");
                        let data = server_payload.read().clone();
                        let total = data.len();

                        if let Some(range_val) = range_header.split(':').nth(1) {
                            let range_val = range_val.trim();
                            if let Some(bytes_part) = range_val.strip_prefix("bytes=") {
                                let parts: Vec<&str> = bytes_part.split('-').collect();
                                let start: usize = parts[0].parse().unwrap_or(0);
                                let end: usize = parts[1].parse().unwrap_or(total - 1);
                                let end = end.min(total - 1);
                                let slice = &data[start..=end];

                                let resp = format!(
                                    "HTTP/1.1 206 Partial Content\r\nContent-Length: {}\r\nContent-Range: bytes {start}-{end}/{total}\r\nConnection: close\r\n\r\n",
                                    slice.len()
                                );
                                let _ = stream.write_all(resp.as_bytes());
                                let _ = stream.write_all(slice);
                            }
                        }
                    } else if req_str.starts_with("PUT ") {
                        // Read headers to find Content-Length
                        let cl_line = req_str
                            .lines()
                            .find(|l| l.to_lowercase().starts_with("content-length:"))
                            .unwrap_or("");
                        let body_len: usize = cl_line
                            .split(':')
                            .nth(1)
                            .and_then(|v| v.trim().parse().ok())
                            .unwrap_or(0);

                        let double_crlf = req_str.find("\r\n\r\n").unwrap_or(0);
                        let body_start = if double_crlf > 0 { double_crlf + 4 } else { 0 };
                        let mut body_bytes = req_buf[body_start..n].to_vec();

                        while body_bytes.len() < body_len {
                            let mut extra = [0u8; 1024];
                            let extra_n = stream.read(&mut extra).unwrap_or(0);
                            if extra_n == 0 {
                                break;
                            }
                            body_bytes.extend_from_slice(&extra[..extra_n]);
                        }

                        *server_payload.write() = body_bytes;
                        let resp =
                            "HTTP/1.1 200 OK\r\nContent-Length: 0\r\nConnection: close\r\n\r\n";
                        let _ = stream.write_all(resp.as_bytes());
                    }
                }
                std::thread::sleep(web_time::Duration::from_millis(5));
            }
        });

        let config = S3StorageConfig {
            bucket: "test-bucket".into(),
            key: "db.tapir".into(),
            endpoint: format!("http://127.0.0.1:{port}"),
            region: "us-east-1".into(),
            auth_token: Some("secret-token-xyz".into()),
        };

        let storage = CloudS3RemoteStorage::new(config);

        // 1. Test total_size
        let size = storage.total_size().expect("Failed to get total size");
        assert_eq!(size, 8192);

        // 2. Test fetch_range [0..4096]
        let page1 = storage
            .fetch_range(0, 4096)
            .expect("Failed to fetch page 1");
        assert_eq!(page1.len(), 4096);
        assert_eq!(page1[0], 0);
        assert_eq!(page1[1], 1);

        // 3. Test fetch_range [4096..8192]
        let page2 = storage
            .fetch_range(4096, 4096)
            .expect("Failed to fetch page 2");
        assert_eq!(page2.len(), 4096);

        // 4. Test put_object
        let new_data = vec![42u8; 1024];
        storage.put_object(&new_data).expect("Failed to put object");
        let new_size = storage.total_size().expect("Failed to get updated size");
        assert_eq!(new_size, 1024);

        let fetched_new = storage
            .fetch_range(0, 1024)
            .expect("Failed to fetch updated data");
        assert_eq!(fetched_new, new_data);

        running.store(false, Ordering::Relaxed);
        let _ = server_thread.join();
    }
}