@pulumi/databricks/query.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * ## Import
 *
 * This resource can be imported using query ID:
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/query:Query this <query-id>
 * ```
 */
export declare class Query extends pulumi.CustomResource {
    /**
     * Get an existing Query resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QueryState, opts?: pulumi.CustomResourceOptions): Query;
    /**
     * Returns true if the given object is an instance of Query.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Query;
    /**
     * Whether to apply a 1000 row limit to the query result.
     */
    readonly applyAutoLimit: pulumi.Output<boolean | undefined>;
    /**
     * Name of the catalog where this query will be executed.
     */
    readonly catalog: pulumi.Output<string | undefined>;
    /**
     * The timestamp string indicating when the query was created.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * General description that conveys additional information about this query such as usage notes.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Name of the query.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * Username of the user who last saved changes to this query.
     */
    readonly lastModifierUserName: pulumi.Output<string>;
    /**
     * The workspace state of the query. Used for tracking trashed status. (Possible values are `ACTIVE` or `TRASHED`).
     */
    readonly lifecycleState: pulumi.Output<string>;
    /**
     * Query owner's username.
     */
    readonly ownerUserName: pulumi.Output<string | undefined>;
    /**
     * Query parameter definition.  Consists of following attributes (one of `*_value` is required):
     */
    readonly parameters: pulumi.Output<outputs.QueryParameter[] | undefined>;
    /**
     * The path to a workspace folder containing the query. The default is the user's home folder.  If changed, the query will be recreated.
     */
    readonly parentPath: pulumi.Output<string | undefined>;
    /**
     * Text of SQL query.
     */
    readonly queryText: pulumi.Output<string>;
    /**
     * Sets the "Run as" role for the object.  Should be one of `OWNER`, `VIEWER`.
     */
    readonly runAsMode: pulumi.Output<string | undefined>;
    /**
     * Name of the schema where this query will be executed.
     */
    readonly schema: pulumi.Output<string | undefined>;
    /**
     * Tags that will be added to the query.
     */
    readonly tags: pulumi.Output<string[] | undefined>;
    /**
     * The timestamp string indicating when the query was updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * ID of a SQL warehouse which will be used to execute this query.
     */
    readonly warehouseId: pulumi.Output<string>;
    /**
     * Create a Query resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: QueryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Query resources.
 */
export interface QueryState {
    /**
     * Whether to apply a 1000 row limit to the query result.
     */
    applyAutoLimit?: pulumi.Input<boolean>;
    /**
     * Name of the catalog where this query will be executed.
     */
    catalog?: pulumi.Input<string>;
    /**
     * The timestamp string indicating when the query was created.
     */
    createTime?: pulumi.Input<string>;
    /**
     * General description that conveys additional information about this query such as usage notes.
     */
    description?: pulumi.Input<string>;
    /**
     * Name of the query.
     */
    displayName?: pulumi.Input<string>;
    /**
     * Username of the user who last saved changes to this query.
     */
    lastModifierUserName?: pulumi.Input<string>;
    /**
     * The workspace state of the query. Used for tracking trashed status. (Possible values are `ACTIVE` or `TRASHED`).
     */
    lifecycleState?: pulumi.Input<string>;
    /**
     * Query owner's username.
     */
    ownerUserName?: pulumi.Input<string>;
    /**
     * Query parameter definition.  Consists of following attributes (one of `*_value` is required):
     */
    parameters?: pulumi.Input<pulumi.Input<inputs.QueryParameter>[]>;
    /**
     * The path to a workspace folder containing the query. The default is the user's home folder.  If changed, the query will be recreated.
     */
    parentPath?: pulumi.Input<string>;
    /**
     * Text of SQL query.
     */
    queryText?: pulumi.Input<string>;
    /**
     * Sets the "Run as" role for the object.  Should be one of `OWNER`, `VIEWER`.
     */
    runAsMode?: pulumi.Input<string>;
    /**
     * Name of the schema where this query will be executed.
     */
    schema?: pulumi.Input<string>;
    /**
     * Tags that will be added to the query.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The timestamp string indicating when the query was updated.
     */
    updateTime?: pulumi.Input<string>;
    /**
     * ID of a SQL warehouse which will be used to execute this query.
     */
    warehouseId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Query resource.
 */
export interface QueryArgs {
    /**
     * Whether to apply a 1000 row limit to the query result.
     */
    applyAutoLimit?: pulumi.Input<boolean>;
    /**
     * Name of the catalog where this query will be executed.
     */
    catalog?: pulumi.Input<string>;
    /**
     * General description that conveys additional information about this query such as usage notes.
     */
    description?: pulumi.Input<string>;
    /**
     * Name of the query.
     */
    displayName: pulumi.Input<string>;
    /**
     * Query owner's username.
     */
    ownerUserName?: pulumi.Input<string>;
    /**
     * Query parameter definition.  Consists of following attributes (one of `*_value` is required):
     */
    parameters?: pulumi.Input<pulumi.Input<inputs.QueryParameter>[]>;
    /**
     * The path to a workspace folder containing the query. The default is the user's home folder.  If changed, the query will be recreated.
     */
    parentPath?: pulumi.Input<string>;
    /**
     * Text of SQL query.
     */
    queryText: pulumi.Input<string>;
    /**
     * Sets the "Run as" role for the object.  Should be one of `OWNER`, `VIEWER`.
     */
    runAsMode?: pulumi.Input<string>;
    /**
     * Name of the schema where this query will be executed.
     */
    schema?: pulumi.Input<string>;
    /**
     * Tags that will be added to the query.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * ID of a SQL warehouse which will be used to execute this query.
     */
    warehouseId: pulumi.Input<string>;
}