@delali/sirannon-db 0.2.3-next.37 → 0.2.3-next.39

package/dist/driver/bun.d.ts

@@ -1,4 +1,4 @@
-import { a as SQLiteDriver } from '../types-Xb0L3o3w.js';
+import { S as SQLiteDriver } from '../types-DApb7dvw.js';
 import '../query-types-Cv8N7pXj.js';
 
 /**

package/dist/driver/expo.d.ts

@@ -1,4 +1,4 @@
-import { a as SQLiteDriver } from '../types-Xb0L3o3w.js';
+import { S as SQLiteDriver } from '../types-DApb7dvw.js';
 import '../query-types-Cv8N7pXj.js';
 
 /**

package/dist/driver/node.d.ts

@@ -1,4 +1,4 @@
-import { a as SQLiteDriver } from '../types-Xb0L3o3w.js';
+import { S as SQLiteDriver } from '../types-DApb7dvw.js';
 import '../query-types-Cv8N7pXj.js';
 
 /**

package/dist/driver/node.mjs

@@ -1,12 +1,15 @@
-import { nodeResolveExtensionPath, nodeWriterContext, createStatementCache, nodeBackupEngine, nodeStreamingSupport, WriterWorker, loadThroughRuntime, narrowSafeBigInt, narrowRowIntegers, narrowRowsIntegers } from '../chunk-ZKDBGX7H.mjs';
-import '../chunk-72I5UI5C.mjs';
-import '../chunk-BQTVNI5H.mjs';
-import '../chunk-GBM4AU24.mjs';
-import { defineDriver } from '../chunk-BQFQ65OL.mjs';
-import '../chunk-YVF2ZJTE.mjs';
+import { nodeResolveExtensionPath, nodeWriterContext, createStatementCache, nodeBackupEngine, nodeStreamingSupport, WriterWorker, loadThroughRuntime, narrowSafeBigInt, narrowRowIntegers, narrowRowsIntegers } from '../chunk-OJQHM4MT.mjs';
+import '../chunk-7SC2TZAS.mjs';
+import '../chunk-DXXCLTFF.mjs';
+import { defineDriver } from '../chunk-LXCGPZPA.mjs';
 import '../chunk-W67A4H2E.mjs';
 import '../chunk-YLAVDZCS.mjs';
+import '../chunk-W77EEVOT.mjs';
+import '../chunk-U445A3C4.mjs';
+import '../chunk-2QCPVE67.mjs';
+import '../chunk-DVS4QSIZ.mjs';
 import { synchronousPragmaValue } from '../chunk-OUSWVNWT.mjs';
+import '../chunk-YVF2ZJTE.mjs';
 import '../chunk-V5FUJEYY.mjs';
 import { ExtensionError, BackupError } from '../chunk-PBRXXISQ.mjs';
 import { createRequire } from 'module';

package/dist/driver/wa-sqlite.d.ts

@@ -1,4 +1,4 @@
-import { a as SQLiteDriver } from '../types-Xb0L3o3w.js';
+import { S as SQLiteDriver } from '../types-DApb7dvw.js';
 import '../query-types-Cv8N7pXj.js';
 
 /**

package/dist/file-migrations/index.d.ts

@@ -1,5 +1,5 @@
 import { B as BaselineFileOption } from '../baseline-D93hcIEE.js';
-import { M as Migration } from '../types-Xb0L3o3w.js';
+import { M as Migration } from '../types-DApb7dvw.js';
 import '../query-types-Cv8N7pXj.js';
 
 /**

package/dist/{protocol-BfiujBsE.d.ts → protocol-QekTGoKn.d.ts}

@@ -1,5 +1,5 @@
 import { W as WriteConcern, R as ReadConcern, E as ExecuteResult } from './query-types-Cv8N7pXj.js';
-import { B as BulkLoadDurability, a as BulkLoadResult } from './server-options-D4VmfTHw.js';
+import { B as BulkLoadDurability, a as BulkLoadResult } from './server-options-DeK6ZG8u.js';
 
 /**
  * Body of `POST /db/{id}/query`.
@@ -149,4 +149,4 @@ interface ErrorResponse {
  */
 declare function toExecuteResponse(result: ExecuteResult): ExecuteResponse;
 
-export { type AckResponse as A, type BatchResponse as B, type ExecuteResponse as E, type LoadResponse as L, type QueryResponse as Q, type TransactionStatement as T, type TransactionResponse as a, type BatchRequest as b, type ErrorResponse as c, type ExecuteRequest as d, type LoadRequest as e, type QueryRequest as f, type TransactionRequest as g, toExecuteResponse as t };
+export { type AckResponse as A, type BatchResponse as B, type ExecuteResponse as E, type LoadResponse as L, type QueryResponse as Q, type TransactionResponse as T, type TransactionStatement as a, type BatchRequest as b, type ErrorResponse as c, type ExecuteRequest as d, type LoadRequest as e, type QueryRequest as f, type TransactionRequest as g, toExecuteResponse as t };

package/dist/replication/index.d.ts

@@ -1,18 +1,18 @@
 export { F as FieldMergeResolver, L as LWWResolver, P as PrimaryWinsResolver } from '../primary-wins-B0np8JS3.js';
-import { l as HLC, D as Database } from '../database-955qag_W.js';
-import { p as BackupGroupSource, P as ClusterReadEndpointInfo, C as ClusterStatusInfo, i as SQLiteConnection, T as Transaction } from '../types-Xb0L3o3w.js';
+import { l as HLC, D as Database } from '../database-BlhUdJAO.js';
+import { r as BackupGroupSource, a1 as ClusterReadEndpointInfo, H as ClusterStatusInfo, I as SQLiteConnection, T as Transaction } from '../types-DApb7dvw.js';
 import { C as ClusterCoordinator, c as ReplicationGroupState, e as CoordinatorWatchDisposer } from '../types-CMBcFPhb.js';
 export { A as AcquireControllerLeaseInput, a as AcquireControllerLeaseResult, h as AdmitNodeToInSyncSetInput, f as CompareAndAdvancePrimaryTermInput, g as CompareAndAdvancePrimaryTermResult, j as CoordinatorCompatibilityMetadata, k as CoordinatorLease, b as CoordinatorNodeSession, l as CoordinatorPrimary, P as PromoteEligibleReplicaInput, R as RegisterNodeSessionInput, d as ReplicationGroupWatcher, S as SetReplicationGroupStateInput, U as UpdateInSyncSetInput, i as UpdateNodeMaintenanceInput } from '../types-CMBcFPhb.js';
-import { R as ReplicationStatusInfo } from '../server-options-D4VmfTHw.js';
-import { C as CoordinatorRuntimeStatus, g as ReplicationStatus, h as SyncPhase, I as InFlightBatch, P as PeerState, a as ForwardedTransactionResult, b as SyncBatch, c as SyncComplete, d as SyncAck, S as SyncRequest, i as ReplicationConfig, j as SyncState, k as ReplicationErrorEvent, R as ReplicationAck, l as Topology, f as TopologyRole } from '../types-BEjS69rs.js';
-export { F as ForwardedTransaction, N as NodeInfo, e as ReplicationTransport, T as TransportConfig } from '../types-BEjS69rs.js';
+import { R as ReplicationStatusInfo } from '../server-options-DeK6ZG8u.js';
+import { C as CoordinatorRuntimeStatus, g as ReplicationStatus, h as SyncPhase, I as InFlightBatch, P as PeerState, a as ForwardedTransactionResult, b as SyncBatch, c as SyncComplete, d as SyncAck, S as SyncRequest, i as ReplicationConfig, j as SyncState, k as ReplicationErrorEvent, R as ReplicationAck, l as Topology, f as TopologyRole } from '../types-C1yBGTdx.js';
+export { F as ForwardedTransaction, N as NodeInfo, e as ReplicationTransport, T as TransportConfig } from '../types-C1yBGTdx.js';
 import { EventEmitter } from 'node:events';
-import { C as ChangeTracker } from '../change-tracker-DXHPFe9J.js';
+import { C as ChangeTracker } from '../change-tracker-uG9gWvsY.js';
 import { P as Params, Q as QueryOptions, E as ExecuteResult } from '../query-types-Cv8N7pXj.js';
 import { R as ReplicationBatch, C as ConflictResolver, A as ApplyResult, S as SyncTableManifest } from '../types-CjhxcjhA.js';
 export { a as ConflictContext, b as ConflictResolution, H as HLCTimestamp, c as ReplicationChange } from '../types-CjhxcjhA.js';
 import { S as SirannonError } from '../errors-Dei4GdBb.js';
-import '../chain-queries-D5aZ-8v2.js';
+import '../database-backup-C090lMHc.js';
 import '../types-BCejqzNA.js';
 import '../operation-registry-C1FmwQWR.js';
 

package/dist/restore-options-C9MW9gpm.d.ts

@@ -0,0 +1,83 @@
+import { B as BackupDestination, S as SQLiteDriver } from './types-DApb7dvw.js';
+
+/** How far one restore has got, reported after every piece it fetches.
+ * @public
+ */
+interface BackupRestoreProgress {
+    /** Whether the restore is fetching the full copy or replaying the change pieces on top of it. */
+    phase: 'full-copy' | 'changes';
+    /** Pieces the restore has fetched. */
+    piecesFetched: number;
+    /** Bytes it has fetched. */
+    bytesFetched: number;
+    /** Change pieces it has replayed. */
+    changesApplied: number;
+    /** Change pieces the plan holds altogether. */
+    changesTotal: number;
+}
+/**
+ * How Sirannon rebuilds a database from a moment you name.
+ *
+ * @public
+ */
+interface BackupRestoreOptions {
+    /** Where the backups and their records are stored. */
+    destination: BackupDestination;
+    /** Driver the restore opens the rebuilt database through, so it can fold each batch of changes in. */
+    driver: SQLiteDriver;
+    /** Path Sirannon writes the rebuilt database to. A file already there stops the restore unless you set {@link BackupRestoreOptions.replaceExisting}. */
+    destPath: string;
+    /**
+     * Whether to replace a database already at that path. It defaults to false,
+     * because a restore removes the write-ahead log beside the path it writes to
+     * and any commit that log still held would go with it. Set this where you
+     * mean to restore over a database you no longer want.
+     */
+    replaceExisting?: boolean;
+    /** Epoch milliseconds you want back. Defaults to now, which reaches the newest backup the destination holds. */
+    moment?: number;
+    /** Name the list of chains is stored under. Defaults to `sirannon-backup-chain`. */
+    chainName?: string;
+    /**
+     * How many change pieces to replay between one checkpoint and the next.
+     * Defaults to 16, and 4096 is the most it accepts. This is what bounds the
+     * log the restore writes beside the database, so lower it where disk is tight
+     * and raise it where a long chain takes too many checkpoints.
+     */
+    batchSize?: number;
+    /** Milliseconds one call to the destination may take before the restore stops with an error. Defaults to 10 minutes, and zero leaves the calls unbounded. */
+    destinationTimeoutMs?: number;
+    /** Called after every piece the restore fetches. */
+    onProgress?: (progress: BackupRestoreProgress) => void;
+}
+/** What one finished restore produced.
+ * @public
+ */
+interface BackupRestoreReport {
+    /** The chain the restore read. */
+    chainId: string;
+    /** Path of the rebuilt database. */
+    destPath: string;
+    /** Name the full copy underneath it is stored under. */
+    baseName: string;
+    /** Epoch milliseconds the rebuilt database reflects, which is when the last piece replayed was captured. */
+    restoresTo: number;
+    /** Pieces the restore fetched, counting the full copy and every change piece. */
+    pieceCount: number;
+    /** Bytes it fetched. */
+    bytesFetched: number;
+    /** Change pieces it replayed. */
+    changesApplied: number;
+    /** Log frames those pieces held. */
+    framesApplied: number;
+    /** Batches it replayed them in, each one folded into the database by a checkpoint of its own. */
+    batchCount: number;
+    /** Epoch milliseconds the restore started. */
+    startedAt: number;
+    /** Epoch milliseconds it finished. */
+    finishedAt: number;
+    /** Milliseconds it took. */
+    durationMs: number;
+}
+
+export type { BackupRestoreOptions as B, BackupRestoreReport as a, BackupRestoreProgress as b };

package/dist/server/index.d.ts

@@ -1,16 +1,106 @@
-import { T as TransactionStatement, Q as QueryResponse, E as ExecuteResponse, a as TransactionResponse, B as BatchResponse, L as LoadResponse, A as AckResponse } from '../protocol-BfiujBsE.js';
-export { b as BatchRequest, c as ErrorResponse, d as ExecuteRequest, e as LoadRequest, f as QueryRequest, g as TransactionRequest, t as toExecuteResponse } from '../protocol-BfiujBsE.js';
-import { S as Sirannon } from '../sirannon-DaGUawHs.js';
-import { B as BulkLoadDurability, S as ServerOptions, W as WSHandlerOptions } from '../server-options-D4VmfTHw.js';
+import { g as BackupChain, k as BackupChainRecord, o as BackupCycleStatus, z as BackupVerifyResult } from '../types-DApb7dvw.js';
+import { b as BackupRestoreProgress, a as BackupRestoreReport } from '../restore-options-C9MW9gpm.js';
+import { a as TransactionStatement, Q as QueryResponse, E as ExecuteResponse, T as TransactionResponse, B as BatchResponse, L as LoadResponse, A as AckResponse } from '../protocol-QekTGoKn.js';
+export { b as BatchRequest, c as ErrorResponse, d as ExecuteRequest, e as LoadRequest, f as QueryRequest, g as TransactionRequest, t as toExecuteResponse } from '../protocol-QekTGoKn.js';
+import { S as Sirannon } from '../sirannon-C9cTgFrw.js';
+import { B as BulkLoadDurability, S as ServerOptions, W as WSHandlerOptions } from '../server-options-DeK6ZG8u.js';
 import { W as WriteConcern, R as ReadConcern } from '../query-types-Cv8N7pXj.js';
-import '../database-955qag_W.js';
-import '../chain-queries-D5aZ-8v2.js';
-import '../types-Xb0L3o3w.js';
-import '../change-tracker-DXHPFe9J.js';
+import '../database-BlhUdJAO.js';
+import '../database-backup-C090lMHc.js';
+import '../change-tracker-uG9gWvsY.js';
 import '../types-CjhxcjhA.js';
 import '../types-BCejqzNA.js';
 import '../operation-registry-C1FmwQWR.js';
 
+/** The answer to a backup a caller triggered, which the server takes on and does not wait for.
+ * @public
+ */
+interface BackupTriggerResponse {
+    /** True whenever the server answers, since it answers only once it has accepted the turn. */
+    started: true;
+}
+/** What the cycle is doing, and what its recent turns produced.
+ * @public
+ */
+type BackupStatusResponse = BackupCycleStatus;
+/** Every chain the destination stores.
+ * @public
+ */
+interface BackupChainResponse {
+    /** One entry per chain, newest first, each with its full copy and its change pieces in order. */
+    chains: BackupChain[];
+}
+/** Names the backup to read back out of the destination.
+ * @public
+ */
+interface BackupVerifyRequest {
+    /** Name the backup is stored under, which every chain record states. */
+    name?: unknown;
+}
+/** What Sirannon found when it read one backup back.
+ * @public
+ */
+type BackupVerifyResponse = BackupVerifyResult;
+/** How far back a restore must still reach.
+ * @public
+ */
+interface BackupSafeToDeleteRequest {
+    /** Epoch milliseconds of the earliest moment a restore must still reach. Leave it out and the answer covers only the backups no restore could ever use. */
+    restorableFrom?: unknown;
+}
+/** The records no restore still needs.
+ * @public
+ */
+interface BackupSafeToDeleteResponse {
+    /** The records you may delete, oldest first. */
+    records: BackupChainRecord[];
+}
+/** The moment to rebuild the database at, and how many change pieces one batch replays.
+ * @public
+ */
+interface BackupRestoreRequest {
+    /** Epoch milliseconds you want back. Leave it out for the newest backup the destination stores. */
+    moment?: unknown;
+    /** How many change pieces to replay between one checkpoint and the next. Leave it out for the default of 16. */
+    batchSize?: unknown;
+}
+
+/** Where one database's restore stands. `idle` means that none has started since the server did.
+ * @public
+ */
+type BackupRestoreState = 'idle' | 'running' | 'done' | 'failed';
+/** What the server reports about the restore of one database.
+ * @public
+ */
+interface BackupRestoreStatus {
+    /** Where the restore stands. */
+    state: BackupRestoreState;
+    /** Epoch milliseconds the caller asked to be taken back to. */
+    moment?: number;
+    /** Epoch milliseconds the restore started. */
+    startedAt?: number;
+    /** Epoch milliseconds it finished, whether it succeeded or failed. */
+    finishedAt?: number;
+    /** How far it has got, reported after every piece it fetches. */
+    progress?: BackupRestoreProgress;
+    /** What a finished restore produced. */
+    report?: BackupRestoreReport;
+    /**
+     * Why the database it replaced would not open again. The rebuilt data is on
+     * disk and the registry has nothing open under the identifier, so an operator
+     * who sees this restarts the process.
+     */
+    reopenError?: {
+        code: string;
+        message: string;
+    };
+    /** Why a failed restore stopped. */
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+
 /**
  * Every message a client sends over the WebSocket. Each carries a `type` and a
  * client-chosen `id` the reply echoes.
@@ -377,6 +467,8 @@ declare class SirannonServer<Identity = unknown> {
     private readonly cors;
     private readonly authenticateHook;
     private readonly acceptSql;
+    private readonly acceptBackupRestore;
+    private readonly restoreRuns;
     private readonly operations;
     private readonly registryDigest;
     private readonly resolveExecutionTarget;
@@ -403,6 +495,7 @@ declare class SirannonServer<Identity = unknown> {
      */
     get listeningPort(): number;
     private registerRoutes;
+    private registerBackupRoutes;
     private registerWebSocketRoute;
     private withCors;
     private wrapDbRoute;
@@ -511,4 +604,4 @@ declare class WSHandler<Identity = unknown> {
  */
 declare function createWSHandler<Identity = unknown>(sirannon: Sirannon, options?: WSHandlerOptions<Identity>): WSHandler<Identity>;
 
-export { BatchResponse, ExecuteResponse, LoadResponse, QueryResponse, SirannonServer, TransactionResponse, TransactionStatement, type WSBatchMessage, type WSChangeMessage, type WSClientMessage, type WSConnection, type WSErrorMessage, type WSExecuteMessage, WSHandler, type WSLoadMessage, type WSQueryMessage, type WSResultMessage, type WSServerMessage, type WSSubscribeMessage, type WSSubscribedMessage, type WSTransactionMessage, type WSUnsubscribeMessage, type WSUnsubscribedMessage, createServer, createWSHandler };
+export { type BackupChainResponse, type BackupRestoreRequest, type BackupRestoreState, type BackupRestoreStatus, type BackupSafeToDeleteRequest, type BackupSafeToDeleteResponse, type BackupStatusResponse, type BackupTriggerResponse, type BackupVerifyRequest, type BackupVerifyResponse, BatchResponse, ExecuteResponse, LoadResponse, QueryResponse, SirannonServer, TransactionResponse, TransactionStatement, type WSBatchMessage, type WSChangeMessage, type WSClientMessage, type WSConnection, type WSErrorMessage, type WSExecuteMessage, WSHandler, type WSLoadMessage, type WSQueryMessage, type WSResultMessage, type WSServerMessage, type WSSubscribeMessage, type WSSubscribedMessage, type WSTransactionMessage, type WSUnsubscribeMessage, type WSUnsubscribedMessage, createServer, createWSHandler };