sfdx-hardis/lib/common/utils/dataCloudUtils.d.ts

Swiss-army-knife Toolbox for Salesforce. Allows you to define a complete CD/CD Pipeline. Orchestrate base commands and assist users with interactive wizards

import { Connection } from "@salesforce/core";
import { AnyJson } from "@salesforce/ts-types";
export declare const DATA_CLOUD_QUERIES_FOLDER_ROOT: string;
export interface DataCloudQueryColumnMetadata {
    name: string;
    type: string;
    nullable?: boolean;
}
export interface DataCloudQueryStatus {
    chunkCount: number;
    completionStatus: string;
    queryId: string;
    rowCount?: number;
    expirationTime?: string;
    progress?: number;
}
export interface DataCloudSqlQueryOptions {
    dataspace?: string;
    workloadName?: string;
    rowLimit?: number;
    pollIntervalMs?: number;
    pollTimeoutMs?: number;
    waitTimeMs?: number;
    omitSchema?: boolean;
}
export type DataCloudRecord = Record<string, AnyJson>;
export interface DataCloudSqlQueryResult<RecordType = DataCloudRecord> {
    queryId: string;
    metadata: DataCloudQueryColumnMetadata[];
    status: DataCloudQueryStatus;
    records: RecordType[];
    rawData: AnyJson[][];
    returnedRows: number;
    hasMoreRows: boolean;
}
export declare function listAvailableDataCloudQueries(): Promise<string[]>;
export declare function loadDataCloudQueryFromFile(queryName: string): Promise<string>;
export declare function saveDataCloudQueryToFile(queryName: string, queryContent: string): Promise<string>;
export declare function dataCloudSqlQuery(query: string, conn: Connection, options?: DataCloudSqlQueryOptions): Promise<DataCloudSqlQueryResult>;