bamboo-storage 2026.10.21

Session storage backends for the Bamboo agent framework
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
use super::{
    cjk_bigram_projection, literal_trigram_projection, params, to_io_error, Connection,
    OptionalExtension,
};

const VERSION: &str = "5";
const LEGACY_SESSION_COLUMNS: &str =
    "session_id, title, kind, root_session_id, parent_session_id, pinned, updated_at, summary";
const SESSION_COLUMNS: &str =
    "session_id, title, kind, root_session_id, parent_session_id, pinned, updated_at, summary, source_revision";
const LEGACY_MESSAGE_COLUMNS: &str =
    "session_id, message_id, message_index, role, content, compressed, created_at";
const MESSAGE_COLUMNS: &str =
    "session_id, message_id, message_index, role, content, compressed, created_at, history_search_artifact";
const SESSION_FIELDS: &str = "session_id TEXT NOT NULL UNIQUE, title TEXT NOT NULL,
    kind TEXT NOT NULL, root_session_id TEXT NOT NULL, parent_session_id TEXT,
    pinned INTEGER NOT NULL, updated_at TEXT NOT NULL, summary TEXT, source_revision TEXT";
const MESSAGE_FIELDS: &str = "session_id TEXT NOT NULL, message_id TEXT NOT NULL,
    message_index INTEGER NOT NULL, role TEXT NOT NULL, content TEXT NOT NULL,
    compressed INTEGER NOT NULL, created_at TEXT NOT NULL,
    history_search_artifact INTEGER NOT NULL DEFAULT 0, UNIQUE(session_id, message_id)";
const FTS_SCHEMA: &str = "
    CREATE VIRTUAL TABLE IF NOT EXISTS sessions_search_fts USING fts5(
        session_id UNINDEXED, title, summary
    );
    CREATE VIRTUAL TABLE IF NOT EXISTS session_messages_search_fts USING fts5(
        session_id UNINDEXED, message_id UNINDEXED, message_index UNINDEXED,
        role UNINDEXED, content
    );
    CREATE VIRTUAL TABLE IF NOT EXISTS session_messages_current_search_fts USING fts5(
        session_id UNINDEXED, message_id UNINDEXED, message_index UNINDEXED,
        role UNINDEXED, content, content_cjk_bigrams, content_literal_trigrams
    );";

fn sql_error(error: rusqlite::Error) -> std::io::Error {
    to_io_error(format!("sqlite search schema failed: {error}"))
}

fn create_table(conn: &Connection, name: &str, fields: &str) -> std::io::Result<()> {
    // Names/fields are static application definitions, never database input.
    conn.execute_batch(&format!(
        "CREATE TABLE {name} (search_rowid INTEGER PRIMARY KEY, {fields});"
    ))
    .map_err(sql_error)
}

fn validate_fts_shape(conn: &Connection, search_projections: bool) -> std::io::Result<()> {
    let mut definitions = vec![
        (
            "sessions_search_fts",
            "session_id,title,summary",
            "session_idunindexed,title,summary",
        ),
        (
            "session_messages_search_fts",
            "session_id,message_id,message_index,role,content",
            "session_idunindexed,message_idunindexed,message_indexunindexed,roleunindexed,content",
        ),
    ];
    if search_projections {
        definitions.push((
            "session_messages_current_search_fts",
            "session_id,message_id,message_index,role,content,content_cjk_bigrams,content_literal_trigrams",
            "session_idunindexed,message_idunindexed,message_indexunindexed,roleunindexed,content,content_cjk_bigrams,content_literal_trigrams",
        ));
    }
    for (table, expected, definition) in definitions {
        let sql: String = conn
            .query_row(
                "SELECT sql FROM sqlite_schema WHERE name=?1",
                [table],
                |row| row.get(0),
            )
            .optional()
            .map_err(sql_error)?
            .ok_or_else(|| to_io_error(format!("unsupported search FTS shape: {table}")))?;
        let columns = conn
            .prepare(&format!("PRAGMA table_info({table})"))
            .map_err(sql_error)?
            .query_map([], |row| row.get::<_, String>(1))
            .map_err(sql_error)?
            .collect::<Result<Vec<_>, _>>()
            .map_err(sql_error)?;
        let compact_sql: String = sql
            .to_ascii_lowercase()
            .chars()
            .filter(|ch| !ch.is_whitespace())
            .collect();
        if columns.join(",") != expected
            || !compact_sql.contains(&format!("usingfts5({definition})"))
        {
            return Err(to_io_error(format!(
                "unsupported search FTS shape: {table}"
            )));
        }
    }
    Ok(())
}

fn validate_fts(conn: &Connection) -> std::io::Result<()> {
    validate_fts_shape(conn, true)
}

fn has_v5_column(conn: &Connection) -> std::io::Result<bool> {
    conn.query_row(
        "SELECT EXISTS(SELECT 1 FROM pragma_table_info('sessions_search')
         WHERE name = 'source_revision')",
        [],
        |row| row.get(0),
    )
    .map_err(sql_error)
}

fn validate_columns(
    conn: &Connection,
    table: &str,
    columns: &str,
    stable_ids: bool,
) -> std::io::Result<()> {
    let mut stmt = conn
        .prepare(&format!("PRAGMA table_info({table})"))
        .map_err(sql_error)?;
    let actual = stmt
        .query_map([], |row| {
            Ok((
                row.get::<_, String>(1)?,
                row.get::<_, String>(2)?,
                row.get::<_, i64>(5)?,
                row.get::<_, bool>(3)?,
            ))
        })
        .map_err(sql_error)?
        .collect::<Result<Vec<_>, _>>()
        .map_err(sql_error)?;
    let expected = columns.split(", ").collect::<Vec<_>>();
    let offset = usize::from(stable_ids);
    if actual.len() != expected.len() + offset
        || !actual[offset..]
            .iter()
            .map(|column| column.0.as_str())
            .eq(expected)
        || (stable_ids
            && (actual[0].0 != "search_rowid"
                || !actual[0].1.eq_ignore_ascii_case("INTEGER")
                || actual[0].2 != 1))
    {
        return Err(to_io_error(format!(
            "unsupported search index table shape: {table}"
        )));
    }
    for (name, kind, primary_key, not_null) in &actual[offset..] {
        let expected_type = match name.as_str() {
            "pinned" | "message_index" | "compressed" | "history_search_artifact" => "INTEGER",
            _ => "TEXT",
        };
        let expected_pk = if stable_ids {
            0
        } else {
            match name.as_str() {
                "session_id" => 1,
                "message_id" => 2,
                _ => 0,
            }
        };
        let expected_not_null =
            !matches!(
                name.as_str(),
                "parent_session_id" | "summary" | "source_revision"
            ) && (stable_ids || table != "sessions_search" || name != "session_id");
        if !kind.eq_ignore_ascii_case(expected_type)
            || *primary_key != expected_pk
            || *not_null != expected_not_null
        {
            return Err(to_io_error(format!(
                "unsupported search column: {table}.{name}"
            )));
        }
    }
    if stable_ids {
        let unique_keys = conn
            .prepare(&format!("PRAGMA index_list({table})"))
            .map_err(sql_error)?
            .query_map([], |row| {
                Ok((
                    row.get::<_, String>(1)?,
                    row.get::<_, bool>(2)?,
                    row.get::<_, String>(3)?,
                    row.get::<_, bool>(4)?,
                ))
            })
            .map_err(sql_error)?
            .collect::<Result<Vec<_>, _>>()
            .map_err(sql_error)?;
        let expected_key: &[&str] = if table == "sessions_search" {
            &["session_id"]
        } else {
            &["session_id", "message_id"]
        };
        let mut found_key = false;
        for (name, unique, origin, partial) in unique_keys {
            // INTEGER PRIMARY KEY DESC is not a rowid alias and creates a PK
            // index. Reject it (and composite PKs) rather than trust VACUUM.
            if origin == "pk" {
                return Err(to_io_error(format!(
                    "search_rowid must alias rowid: {table}"
                )));
            }
            if unique && !partial {
                let names = conn
                    .prepare("SELECT name FROM pragma_index_info(?1) ORDER BY seqno")
                    .map_err(sql_error)?
                    .query_map([name], |row| row.get::<_, Option<String>>(0))
                    .map_err(sql_error)?
                    .collect::<Result<Vec<_>, _>>()
                    .map_err(sql_error)?;
                found_key |= names
                    .iter()
                    .map(Option::as_deref)
                    .eq(expected_key.iter().copied().map(Some));
            }
        }
        if !found_key {
            return Err(to_io_error(format!(
                "missing search identity constraint: {table}"
            )));
        }
    }
    Ok(())
}

fn rebuild_fts(conn: &Connection) -> std::io::Result<()> {
    conn.execute_batch(
        "DROP TABLE IF EXISTS sessions_search_fts;
         DROP TABLE IF EXISTS session_messages_search_fts;
         DROP TABLE IF EXISTS session_messages_current_search_fts;",
    )
    .map_err(sql_error)?;
    conn.execute_batch(FTS_SCHEMA).map_err(sql_error)?;
    validate_fts(conn)?;
    conn.execute_batch(
        "INSERT INTO sessions_search_fts (rowid, session_id, title, summary)
            SELECT search_rowid, session_id, title, COALESCE(summary, '') FROM sessions_search;",
    )
    .map_err(sql_error)?;

    let mut select = conn
        .prepare(
            "SELECT search_rowid, session_id, message_id, message_index, role, content
             FROM session_messages_search ORDER BY search_rowid",
        )
        .map_err(sql_error)?;
    let mut messages = select.query([]).map_err(sql_error)?;
    let mut insert = conn
        .prepare(
            "INSERT INTO session_messages_current_search_fts
             (rowid, session_id, message_id, message_index, role, content, content_cjk_bigrams,
              content_literal_trigrams)
             VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8)",
        )
        .map_err(sql_error)?;
    let mut canonical_insert = conn
        .prepare(
            "INSERT INTO session_messages_search_fts
             (rowid, session_id, message_id, message_index, role, content)
             VALUES (?1, ?2, ?3, ?4, ?5, ?6)",
        )
        .map_err(sql_error)?;
    while let Some(row) = messages.next().map_err(sql_error)? {
        let rowid = row.get::<_, i64>(0).map_err(sql_error)?;
        let session_id = row.get::<_, String>(1).map_err(sql_error)?;
        let message_id = row.get::<_, String>(2).map_err(sql_error)?;
        let message_index = row.get::<_, i64>(3).map_err(sql_error)?;
        let role = row.get::<_, String>(4).map_err(sql_error)?;
        let content = row.get::<_, String>(5).map_err(sql_error)?;
        let cjk_projection = cjk_bigram_projection(&content);
        let literal_projection = literal_trigram_projection(&content);
        insert
            .execute(params![
                rowid,
                session_id,
                message_id,
                message_index,
                role,
                content,
                cjk_projection,
                literal_projection
            ])
            .map_err(sql_error)?;
        canonical_insert
            .execute(params![
                rowid,
                session_id,
                message_id,
                message_index,
                role,
                content
            ])
            .map_err(sql_error)?;
    }
    Ok(())
}

fn migrate_v3(conn: &Connection) -> std::io::Result<()> {
    validate_columns(conn, "sessions_search", LEGACY_SESSION_COLUMNS, false)?;
    validate_columns(
        conn,
        "session_messages_search",
        LEGACY_MESSAGE_COLUMNS,
        false,
    )?;
    validate_fts_shape(conn, false)?;

    // DROP TABLE removes its indexes/triggers. Preserve their exact SQL,
    // including user objects; SQLite-owned autoindexes come from constraints.
    let objects = conn
        .prepare(
            "SELECT type, name, sql FROM sqlite_schema WHERE tbl_name IN
            ('sessions_search', 'session_messages_search')
            AND type IN ('index', 'trigger') AND sql IS NOT NULL ORDER BY type, name",
        )
        .map_err(sql_error)?
        .query_map([], |row| {
            Ok((
                row.get::<_, String>(0)?,
                row.get::<_, String>(1)?,
                row.get::<_, String>(2)?,
            ))
        })
        .map_err(sql_error)?
        .collect::<Result<Vec<_>, _>>()
        .map_err(sql_error)?;

    // Remove attached triggers together before either table is replaced: a
    // trigger on one table can reference the other during schema validation.
    for (kind, name, _) in &objects {
        if kind == "trigger" {
            conn.execute_batch(&format!("DROP TRIGGER \"{}\"", name.replace('"', "\"\"")))
                .map_err(sql_error)?;
        }
    }
    for (table, fields, columns) in [
        ("sessions_search", SESSION_FIELDS, LEGACY_SESSION_COLUMNS),
        (
            "session_messages_search",
            MESSAGE_FIELDS,
            LEGACY_MESSAGE_COLUMNS,
        ),
    ] {
        let replacement = format!("{table}_v5");
        create_table(conn, &replacement, fields)?;
        conn.execute_batch(&format!(
            "INSERT INTO {replacement} (search_rowid, {columns})
                SELECT rowid, {columns} FROM {table};
             DROP TABLE {table};
             ALTER TABLE {replacement} RENAME TO {table};"
        ))
        .map_err(sql_error)?;
    }
    for (_, _, sql) in objects {
        conn.execute_batch(&sql).map_err(sql_error)?;
    }

    // The legacy FTS rowids were independent. Rebuild this derived cache once
    // so every FTS row uses the stable ordinary-table ID and carries the v5 CJK
    // projection.
    rebuild_fts(conn)
}

fn migrate_v4(conn: &Connection) -> std::io::Result<()> {
    validate_columns(conn, "sessions_search", LEGACY_SESSION_COLUMNS, true)?;
    validate_columns(
        conn,
        "session_messages_search",
        LEGACY_MESSAGE_COLUMNS,
        true,
    )?;
    validate_fts_shape(conn, false)?;
    conn.execute_batch("ALTER TABLE sessions_search ADD COLUMN source_revision TEXT;")
        .map_err(sql_error)?;
    conn.execute_batch(
        "ALTER TABLE session_messages_search
         ADD COLUMN history_search_artifact INTEGER NOT NULL DEFAULT 0;",
    )
    .map_err(sql_error)?;
    rebuild_fts(conn)
}

fn validate_v5(conn: &Connection) -> std::io::Result<()> {
    validate_columns(conn, "sessions_search", SESSION_COLUMNS, true)?;
    validate_columns(conn, "session_messages_search", MESSAGE_COLUMNS, true)?;
    validate_fts(conn)
}

pub(super) fn initialize(conn: &mut Connection) -> std::io::Result<()> {
    let tx = conn
        .transaction_with_behavior(rusqlite::TransactionBehavior::Immediate)
        .map_err(sql_error)?;
    let has_meta: bool = tx
        .query_row(
            "SELECT EXISTS(SELECT 1 FROM sqlite_schema WHERE name = 'session_search_meta')",
            [],
            |row| row.get(0),
        )
        .map_err(sql_error)?;
    let version: Option<String> = if has_meta {
        tx.query_row(
            "SELECT value FROM session_search_meta WHERE key = 'schema_version'",
            [],
            |row| row.get(0),
        )
        .optional()
        .map_err(sql_error)?
    } else {
        None
    };
    match version.as_deref() {
        Some("3" | "4") if has_v5_column(&tx)? => {
            // A stale version row must not send an already migrated index
            // through an older migration. Republish it only after validating
            // every v5 table and FTS definition inside this transaction.
            validate_v5(&tx)?;
        }
        Some("3") => migrate_v3(&tx)?,
        Some("4") => migrate_v4(&tx)?,
        Some(VERSION) => {
            // Validate before any IF NOT EXISTS creation so a partial v5
            // schema is rejected instead of silently creating an empty FTS.
            validate_v5(&tx)?;
        }
        None => {
            // Never overwrite an unversioned/partial owned schema as a new DB.
            let existing: bool = tx
                .query_row(
                    "SELECT EXISTS(SELECT 1 FROM sqlite_schema WHERE name IN
                    ('sessions_search', 'session_messages_search',
                     'sessions_search_fts', 'session_messages_search_fts',
                     'session_messages_current_search_fts'))",
                    [],
                    |row| row.get(0),
                )
                .map_err(sql_error)?;
            if existing {
                return Err(to_io_error("unversioned existing search index schema"));
            }
            tx.execute_batch(
                "CREATE TABLE IF NOT EXISTS session_search_meta
                (key TEXT PRIMARY KEY, value TEXT NOT NULL);",
            )
            .map_err(sql_error)?;
            create_table(&tx, "sessions_search", SESSION_FIELDS)?;
            create_table(&tx, "session_messages_search", MESSAGE_FIELDS)?;
        }
        Some(unknown) => {
            return Err(to_io_error(format!(
                "unsupported search index schema version: {unknown}"
            )));
        }
    }
    tx.execute_batch(
        "CREATE INDEX IF NOT EXISTS idx_session_messages_search_session_id
        ON session_messages_search(session_id, message_index);",
    )
    .map_err(sql_error)?;
    tx.execute_batch(FTS_SCHEMA).map_err(sql_error)?;
    validate_fts(&tx)?;
    tx.execute(
        "INSERT INTO session_search_meta (key, value) VALUES ('schema_version', ?1)
         ON CONFLICT(key) DO UPDATE SET value = excluded.value WHERE value != excluded.value",
        [VERSION],
    )
    .map_err(sql_error)?;
    tx.commit().map_err(sql_error)
}