@saptools/cf-hana 0.1.2 → 0.1.4

package/dist/index.d.ts

@@ -96,6 +96,32 @@ interface HanaClientInfo {
     readonly credentialSource: CredentialSource;
 }
 
+type WriteBackupOperation = "update" | "delete";
+interface WriteBackupPlan {
+    readonly operation: WriteBackupOperation;
+    readonly statementSql: string;
+    readonly selectSql: string;
+    readonly selectParams: readonly SqlParam[];
+}
+interface SqlBackupWriteInput {
+    readonly operation: WriteBackupOperation;
+    readonly statementSql: string;
+    readonly result: QueryResult;
+}
+interface SqlBackupWriteOptions {
+    readonly now?: Date;
+    readonly saptoolsRoot?: string;
+}
+interface SqlBackupRecord {
+    readonly directory: string;
+    readonly statementPath: string;
+    readonly backupPath: string;
+    readonly rowCount: number;
+}
+declare function cfHanaBackupRoot(saptoolsRoot?: string): string;
+declare function buildWriteBackupPlan(sql: string, params?: readonly SqlParam[]): WriteBackupPlan | undefined;
+declare function writeSqlBackup(input: SqlBackupWriteInput, options?: SqlBackupWriteOptions): Promise<SqlBackupRecord>;
+
 interface DriverExecResult {
     readonly rows: readonly Record<string, SqlParam>[];
     readonly columns: readonly QueryResultColumn[];
@@ -219,6 +245,8 @@ declare class HanaClient {
     query<TRow = QueryRow>(sql: string, params?: readonly SqlParam[], options?: QueryOptions): Promise<QueryResult<TRow>>;
     /** Run a DML/DDL statement and return its affected-row count. */
     execute(sql: string, params?: readonly SqlParam[], options?: QueryOptions): Promise<QueryResult>;
+    /** Back up rows matched by an UPDATE or DELETE before the caller runs it. */
+    backupWriteStatement(sql: string, params?: readonly SqlParam[], options?: QueryOptions): Promise<SqlBackupRecord | undefined>;
     /** Run a typed `SELECT` built from a spec. */
     selectFrom<TRow = QueryRow>(spec: SelectSpec): Promise<QueryResult<TRow>>;
     /** Count rows in a table, optionally filtered. */
@@ -241,6 +269,9 @@ declare class HanaClient {
     explain(sql: string, params?: readonly SqlParam[]): Promise<QueryResult>;
     /** Close every pooled connection. The client must not be used afterwards. */
     close(): Promise<void>;
+    private runQuery;
+    private runExecute;
+    private recordSqlHistory;
 }
 
 /**
@@ -313,4 +344,4 @@ declare class DestructiveStatementError extends CfHanaError {
 /** Narrow an unknown thrown value to a human-readable message. */
 declare function errorMessage(error: unknown): string;
 
-export { type BuiltStatement, CfHanaError, type CfHanaErrorCode, type ColumnInfo, type ConnectOptions, type CredentialSource, CredentialsNotFoundError, type DbUserRole, DestructiveStatementError, type DriverConnectParams, type DriverConnection, type DriverExecResult, HanaClient, type HanaClientInfo, type HanaDriver, type OutputFormat, type PoolOptions, QueryError, type QueryOptions, type QueryResult, type QueryResultColumn, type QueryRow, ReadOnlyViolationError, type SelectSpec, type SqlParam, type StatementKind, type TableInfo, Transaction, buildCount, buildDelete, buildInsert, buildSelect, buildUpdate, connect, createDriver, errorMessage, formatCsv, formatJson, formatResult, formatTable, query, withConnection };
+export { type BuiltStatement, CfHanaError, type CfHanaErrorCode, type ColumnInfo, type ConnectOptions, type CredentialSource, CredentialsNotFoundError, type DbUserRole, DestructiveStatementError, type DriverConnectParams, type DriverConnection, type DriverExecResult, HanaClient, type HanaClientInfo, type HanaDriver, type OutputFormat, type PoolOptions, QueryError, type QueryOptions, type QueryResult, type QueryResultColumn, type QueryRow, ReadOnlyViolationError, type SelectSpec, type SqlBackupRecord, type SqlBackupWriteInput, type SqlBackupWriteOptions, type SqlParam, type StatementKind, type TableInfo, Transaction, type WriteBackupOperation, type WriteBackupPlan, buildCount, buildDelete, buildInsert, buildSelect, buildUpdate, buildWriteBackupPlan, cfHanaBackupRoot, connect, createDriver, errorMessage, formatCsv, formatJson, formatResult, formatTable, query, withConnection, writeSqlBackup };