Databricks SDK for JavaScript
    Preparing search index...

    Interface CreatePipelineRequest

    interface CreatePipelineRequest {
        allowDuplicateNames?: boolean;
        budgetPolicyId?: string;
        catalog?: string;
        channel?: string;
        clusters?: PipelineCluster[];
        configuration?: Record<string, string>;
        continuous?: boolean;
        deployment?: PipelineDeployment;
        development?: boolean;
        dryRun?: boolean;
        edition?: string;
        environment?: PipelinesEnvironment;
        eventLog?: EventLogSpec;
        filters?: Filters;
        gatewayDefinition?: IngestionGatewayPipelineDefinition;
        id?: string;
        ingestionDefinition?: IngestionPipelineDefinition;
        libraries?: PipelineLibrary[];
        name?: string;
        notifications?: Notifications[];
        parameters?: Record<string, string>;
        photon?: boolean;
        restartWindow?: RestartWindow;
        rootPath?: string;
        runAs?: PipelinesJobRunAs;
        schema?: string;
        serverless?: boolean;
        serverlessComputeId?: string;
        storage?: string;
        tags?: Record<string, string>;
        target?: string;
        trigger?: PipelineTrigger;
        usagePolicyId?: string;
    }
    Index

    Properties

    allowDuplicateNames? budgetPolicyId? catalog? channel? clusters? configuration? continuous? deployment? development? dryRun? edition? environment? eventLog? filters? gatewayDefinition? id? ingestionDefinition? libraries? name? notifications? parameters? photon? restartWindow? rootPath? runAs? schema? serverless? serverlessComputeId? storage? tags? target? trigger? usagePolicyId?

    Properties

    allowDuplicateNames?: boolean

    If false, deployment will fail if name conflicts with that of another pipeline.

    budgetPolicyId?: string

    Budget policy of this pipeline.

    catalog?: string

    A catalog in Unity Catalog to publish data from this pipeline to. If target is specified, tables in this pipeline are published to a target schema inside catalog (for example, catalog.target.table). If target is not specified, no data is published to Unity Catalog.

    channel?: string

    SDP Release Channel that specifies which version to use.

    clusters?: PipelineCluster[]

    Cluster settings for this pipeline deployment.

    configuration?: Record<string, string>

    String-String configuration for this pipeline execution.

    continuous?: boolean

    Whether the pipeline is continuous or triggered. This replaces trigger.

    deployment?: PipelineDeployment

    Deployment type of this pipeline.

    development?: boolean

    Whether the pipeline is in Development mode. Defaults to false.

    dryRun?: boolean
    edition?: string

    Pipeline product edition.

    environment?: PipelinesEnvironment

    Environment specification for this pipeline used to install dependencies.

    eventLog?: EventLogSpec

    Event log configuration for this pipeline

    filters?: Filters

    Filters on which Pipeline packages to include in the deployed graph.

    gatewayDefinition?: IngestionGatewayPipelineDefinition

    The definition of a gateway pipeline to support change data capture.

    id?: string

    Unique identifier for this pipeline.

    ingestionDefinition?: IngestionPipelineDefinition

    The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.

    libraries?: PipelineLibrary[]

    Libraries or code needed by this deployment.

    name?: string

    Friendly identifier for this pipeline.

    notifications?: Notifications[]

    List of notification settings for this pipeline.

    parameters?: Record<string, string>

    Key/value map of default parameters to use for pipeline execution. Maximum total size: 10k characters (JSON format)

    photon?: boolean

    Whether Photon is enabled for this pipeline.

    restartWindow?: RestartWindow

    Restart window of this pipeline.

    rootPath?: string

    Root path for this pipeline. This is used as the root directory when editing the pipeline in the user interface and it is added to sys.path when executing Python sources during pipeline execution.

    runAs?: PipelinesJobRunAs
    schema?: string

    The default schema (database) where tables are read from or published to.

    serverless?: boolean

    Whether serverless compute is enabled for this pipeline.

    serverlessComputeId?: string

    Serverless compute ID specified by the user for serverless pipelines.

    storage?: string

    DBFS root directory for storing checkpoints and tables.

    tags?: Record<string, string>

    A map of tags associated with the pipeline. These are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations. A maximum of 25 tags can be added to the pipeline.

    target?: string

    Target schema (database) to add tables in this pipeline to. Exactly one of schema or target must be specified. To publish to Unity Catalog, also specify catalog. This legacy field is deprecated for pipeline creation in favor of the schema field.

    trigger?: PipelineTrigger

    Which pipeline trigger to use. Deprecated: Use continuous instead.

    usagePolicyId?: string

    Usage policy of this pipeline.

    Settings

    Member Visibility

    On This Page

    Properties