ic-sqlite-vfs 0.1.1

SQLite VFS backed directly by Internet Computer stable 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

type DbMeta = record {
  db_size : nat64;
  schema_version : nat64;
  last_tx_id : nat64;
  flags : nat64;
  checksum : nat64;
  checksum_stale : bool;
  checksum_refreshing : bool;
  checksum_refresh_offset : nat64;
  importing : bool;
  import_written_until : nat64;
};

type ChecksumRefresh = record {
  complete : bool;
  checksum : nat64;
  scanned_bytes : nat64;
  db_size : nat64;
};

service : {
  kv_put : (text, text) -> (variant { Ok : null; Err : text });
  kv_get : (text) -> (variant { Ok : opt text; Err : text }) query;
  kv_set_note : (text, text) -> (variant { Ok : null; Err : text });
  kv_get_note : (text) -> (variant { Ok : opt text; Err : text }) query;
  kv_count : () -> (variant { Ok : nat64; Err : text }) query;
  db_meta : () -> (variant { Ok : DbMeta; Err : text }) query;
  db_integrity_check : () -> (variant { Ok : text; Err : text }) query;
  db_checksum : () -> (variant { Ok : nat64; Err : text }) query;
  db_refresh_checksum : () -> (variant { Ok : nat64; Err : text });
  db_refresh_checksum_chunk : (nat64) -> (variant { Ok : ChecksumRefresh; Err : text });
  db_export_chunk : (nat64, nat64) -> (variant { Ok : vec nat8; Err : text }) query;
  db_begin_import : (nat64, nat64) -> (variant { Ok : null; Err : text });
  db_import_chunk : (nat64, vec nat8) -> (variant { Ok : null; Err : text });
  db_finish_import : () -> (variant { Ok : null; Err : text });
}