@pipedream/platform/dist/sql-prop.d.ts

Pipedream platform globals (typing and runtime type checking)

import { JsonPrimitive } from "type-fest";
import { ExecuteQueryArgs } from "./sql";
export declare type ColumnSchema = {
    columnDefault: JsonPrimitive;
    dataType: string;
    isNullable: boolean;
    tableSchema?: string;
};
export declare type TableMetadata = {
    rowCount?: number;
};
export declare type TableSchema = {
    [columnName: string]: ColumnSchema;
};
export declare type TableInfo = {
    metadata: TableMetadata;
    schema: TableSchema;
};
export declare type DbInfo = {
    [tableName: string]: TableInfo;
};
export declare type SqlProp = {
    query: string;
    params?: string[];
};
declare const _default: {
    methods: {
        /**
         * A method that transforms the value of a prop of type `sql` so that it can
         * be fed to the `executeQuery` method.
         *
         * @param sqlProp - The prop of type `sql`
         * @returns The arguments to be passed to `executeQuery`
         */
        executeQueryAdapter(sqlProp: SqlProp): ExecuteQueryArgs;
        /**
         * A helper method to get the schema of the database. Used by other features
         * (like the `sql` prop) to enrich the code editor and provide the user with
         * auto-complete and fields suggestion.
         *
         * @returns {DbInfo} The schema of the database, which is a
         * JSON-serializable object.
         * @throws {ConfigurationError} If the method is not implemented.
         */
        getSchema(): DbInfo;
    };
};
export default _default;