reveal-sdk-node/lib/dts/sdk-model/DuckDB/RVDuckDBDataSourceItem.d.ts

RevealBI Node.js SDK

import { RVDataSourceItem } from "../AbstractClasses/RVDataSourceItem";
import { RVDuckDBDataSource } from "./RVDuckDBDataSource";
import { nullableString } from "../types";
/**
 * DuckDB data source item.
 */
export declare class RVDuckDBDataSourceItem extends RVDataSourceItem {
    constructor(dataSource: RVDuckDBDataSource);
    /** @hidden */
    constructor(json: any);
    /** @hidden */
    toJson(): any;
    /** @hidden */
    getType(): string;
    private _schema;
    /** Name of the schema to use. */
    get schema(): nullableString;
    set schema(value: nullableString);
    private _table;
    /**
     * Name of the table (or view) to get data from
     */
    get table(): nullableString;
    set table(value: nullableString);
    private _customQuery;
    /**
     * (Optional) Custom SQL query to use when getting data
     */
    get customQuery(): nullableString;
    set customQuery(value: nullableString);
    private _procedure;
    /**
     * (Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might
     * have multiple parameters.
     */
    get procedure(): nullableString;
    set procedure(value: nullableString);
    private _procedureParameters;
    /** Parameters to be passed to the stored procedure, if there is such specified in {@link RVDuckDBDataSourceItem.procedure}. */
    get procedureParameters(): any;
    set procedureParameters(value: any);
    private _processDataOnServer;
    /**
     * Configures if the "Process Data on Server" option is turned on for this item (table or view), defaults to "true"
     */
    get processDataOnServer(): boolean;
    set processDataOnServer(value: boolean);
}