@pulumi/databricks/onlineTable.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";
/**
 * > This resource can only be used on a Unity Catalog-enabled workspace!
 *
 * This resource allows you to create [Online Table](https://docs.databricks.com/en/machine-learning/feature-store/online-tables.html) in Databricks.  An online table is a read-only copy of a Delta Table that is stored in row-oriented format optimized for online access. Online tables are fully serverless tables that auto-scale throughput capacity with the request load and provide low latency and high throughput access to data of any scale. Online tables are designed to work with Databricks Model Serving, Feature Serving, and retrieval-augmented generation (RAG) applications where they are used for fast data lookups.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = new databricks.OnlineTable("this", {
 *     name: "main.default.online_table",
 *     spec: {
 *         sourceTableFullName: "main.default.source_table",
 *         primaryKeyColumns: ["id"],
 *         runTriggered: {},
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * The resource can be imported using the name of the Online Table:
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/onlineTable:OnlineTable this <endpoint-name>
 * ```
 */
export declare class OnlineTable extends pulumi.CustomResource {
    /**
     * Get an existing OnlineTable 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?: OnlineTableState, opts?: pulumi.CustomResourceOptions): OnlineTable;
    /**
     * Returns true if the given object is an instance of OnlineTable.  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 OnlineTable;
    /**
     * 3-level name of the Online Table to create.
     */
    readonly name: pulumi.Output<string>;
    /**
     * object containing specification of the online table:
     */
    readonly spec: pulumi.Output<outputs.OnlineTableSpec | undefined>;
    /**
     * object describing status of the online table:
     */
    readonly statuses: pulumi.Output<outputs.OnlineTableStatus[]>;
    /**
     * Data serving REST API URL for this table.
     */
    readonly tableServingUrl: pulumi.Output<string>;
    /**
     * The provisioning state of the online table entity in Unity Catalog. This is distinct from the state of the data synchronization pipeline (i.e. the table may be in "ACTIVE" but the pipeline may be in "PROVISIONING" as it runs asynchronously).
     */
    readonly unityCatalogProvisioningState: pulumi.Output<string>;
    /**
     * Create a OnlineTable 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?: OnlineTableArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering OnlineTable resources.
 */
export interface OnlineTableState {
    /**
     * 3-level name of the Online Table to create.
     */
    name?: pulumi.Input<string>;
    /**
     * object containing specification of the online table:
     */
    spec?: pulumi.Input<inputs.OnlineTableSpec>;
    /**
     * object describing status of the online table:
     */
    statuses?: pulumi.Input<pulumi.Input<inputs.OnlineTableStatus>[]>;
    /**
     * Data serving REST API URL for this table.
     */
    tableServingUrl?: pulumi.Input<string>;
    /**
     * The provisioning state of the online table entity in Unity Catalog. This is distinct from the state of the data synchronization pipeline (i.e. the table may be in "ACTIVE" but the pipeline may be in "PROVISIONING" as it runs asynchronously).
     */
    unityCatalogProvisioningState?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a OnlineTable resource.
 */
export interface OnlineTableArgs {
    /**
     * 3-level name of the Online Table to create.
     */
    name?: pulumi.Input<string>;
    /**
     * object containing specification of the online table:
     */
    spec?: pulumi.Input<inputs.OnlineTableSpec>;
}