@saptools/cf-hana 0.2.1 → 0.3.0

package/dist/index.d.ts

@@ -7,7 +7,7 @@ type StatementKind = "select" | "dml" | "ddl" | "unknown";
 /** Which HANA user from a service binding to authenticate as. */
 type DbUserRole = "runtime" | "hdi";
 /** Where resolved credentials came from. */
-type CredentialSource = "cache" | "fresh";
+type CredentialSource = "live";
 /** Output rendering for CLI results. */
 type OutputFormat = "table" | "json" | "csv";
 interface QueryResultColumn {
@@ -96,7 +96,7 @@ interface HanaClientInfo {
     readonly credentialSource: CredentialSource;
 }
 
-type WriteBackupOperation = "update" | "delete";
+type WriteBackupOperation = "update" | "upsert" | "delete";
 interface WriteBackupPlan {
     readonly operation: WriteBackupOperation;
     readonly statementSql: string;
@@ -107,6 +107,7 @@ interface SqlBackupWriteInput {
     readonly operation: WriteBackupOperation;
     readonly statementSql: string;
     readonly result: QueryResult;
+    readonly selector?: string;
 }
 interface SqlBackupWriteOptions {
     readonly now?: Date;
@@ -116,12 +117,19 @@ interface SqlBackupRecord {
     readonly directory: string;
     readonly statementPath: string;
     readonly backupPath: string;
+    readonly metadataPath: 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 CatalogObjectInfo {
+    readonly schema: string;
+    readonly name: string;
+    readonly type: "TABLE" | "VIEW";
+}
+
 interface DriverExecResult {
     readonly rows: readonly Record<string, SqlParam>[];
     readonly columns: readonly QueryResultColumn[];
@@ -263,6 +271,8 @@ declare class HanaClient {
     listSchemas(): Promise<readonly string[]>;
     /** List the tables in a schema. */
     listTables(schema: string): Promise<readonly TableInfo[]>;
+    /** List table and view names in a schema for typo suggestions. */
+    listCatalogObjects(schema: string): Promise<readonly CatalogObjectInfo[]>;
     /** List the columns of a table. */
     listColumns(schema: string, table: string): Promise<readonly ColumnInfo[]>;
     /** Return the HANA execution plan for a statement. */
@@ -344,4 +354,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 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 { 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 };