@saptools/cf-hana 0.3.4 → 0.4.0

package/dist/index.d.ts

@@ -8,8 +8,10 @@ type StatementKind = "select" | "dml" | "ddl" | "unknown";
 type DbUserRole = "runtime" | "hdi";
 /** Where resolved credentials came from. */
 type CredentialSource = "live";
+/** Whether the app selector was pinned by the caller or inherited from `cf target`. */
+type SelectorSource = "explicit" | "ambient";
 /** Output rendering for CLI results. */
-type OutputFormat = "table" | "json" | "csv";
+type OutputFormat = "table" | "json" | "json-compact" | "csv";
 interface QueryResultColumn {
     readonly name: string;
     readonly typeName: string;
@@ -94,15 +96,23 @@ interface HanaClientInfo {
     readonly role: DbUserRole;
     readonly driver: string;
     readonly credentialSource: CredentialSource;
+    readonly selectorSource?: SelectorSource;
+    readonly regionConfirmed?: boolean;
+    readonly selectorCanBePinned?: boolean;
+    readonly bindingName?: string;
+    readonly bindingIndex?: number;
+    readonly availableBindingNames?: readonly string[];
 }
 
-type WriteBackupOperation = "update" | "upsert" | "delete";
+type WriteBackupOperation = "update" | "upsert" | "replace" | "merge" | "delete";
 interface WriteBackupPlan {
     readonly operation: WriteBackupOperation;
     readonly statementSql: string;
     readonly selectSql: string;
     readonly selectParams: readonly SqlParam[];
 }
+declare function buildWriteBackupPlan(sql: string, params?: readonly SqlParam[]): WriteBackupPlan | undefined;
+
 interface SqlBackupWriteInput {
     readonly operation: WriteBackupOperation;
     readonly statementSql: string;
@@ -112,6 +122,7 @@ interface SqlBackupWriteInput {
 interface SqlBackupWriteOptions {
     readonly now?: Date;
     readonly saptoolsRoot?: string;
+    readonly maxBytes?: number;
 }
 interface SqlBackupRecord {
     readonly directory: string;
@@ -121,7 +132,6 @@ interface SqlBackupRecord {
     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 CatalogObjectInfo {
@@ -246,14 +256,15 @@ declare class Transaction {
 declare class HanaClient {
     private readonly pool;
     readonly info: HanaClientInfo;
-    constructor(pool: ConnectionPool, info: HanaClientInfo);
+    readonly databaseUser: string;
+    constructor(pool: ConnectionPool, info: HanaClientInfo, databaseUser?: string);
     /** Open a client for a `region/org/space/app` selector (or a bare app name). */
     static connect(selector: string, options?: ConnectOptions): Promise<HanaClient>;
     /** Run a SELECT (or any read) statement and return typed rows. */
     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. */
+    /** Back up pre-image rows required by a supported write 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>>;
@@ -320,9 +331,9 @@ declare function formatJson(result: QueryResult): string;
 /** Render a result as RFC 4180 CSV. */
 declare function formatCsv(result: QueryResult): string;
 /** Render a query result in the requested output format. */
-declare function formatResult(result: QueryResult, format: OutputFormat): string;
+declare function formatResult(result: QueryResult, format: OutputFormat, compactColumn?: string): string;
 
-type CfHanaErrorCode = "CONFIG" | "CREDENTIALS_NOT_FOUND" | "AMBIGUOUS_BINDING" | "CONNECTION" | "QUERY" | "READ_ONLY_VIOLATION" | "DESTRUCTIVE_BLOCKED" | "TIMEOUT" | "POOL_CLOSED";
+type CfHanaErrorCode = "CONFIG" | "CREDENTIALS_NOT_FOUND" | "AMBIGUOUS_BINDING" | "CONNECTION" | "QUERY" | "BACKUP_REQUIRED" | "READ_ONLY_VIOLATION" | "DESTRUCTIVE_BLOCKED" | "TIMEOUT" | "POOL_CLOSED";
 interface CfHanaErrorOptions {
     readonly cause?: unknown;
 }
@@ -345,6 +356,10 @@ declare class QueryError extends CfHanaError {
     readonly databaseCode: number | undefined;
     constructor(message: string, options?: QueryErrorOptions);
 }
+/** A CLI write was refused because its required pre-image could not be preserved. */
+declare class BackupRequiredError extends CfHanaError {
+    constructor(message: string, options?: CfHanaErrorOptions);
+}
 /** A write/DDL statement was issued on a read-only client. */
 declare class ReadOnlyViolationError extends CfHanaError {
     constructor(message: string, options?: CfHanaErrorOptions);
@@ -356,4 +371,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, type CatalogObjectInfo, 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 };
+export { BackupRequiredError, type BuiltStatement, type CatalogObjectInfo, 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 SelectorSource, 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 };