Databricks SDK for JavaScript
    Preparing search index...

    Interface DataApi

    DataApi represents the Data API (PostgREST) configuration for a Database. At most one DataApi per database. Create enables Data API, Delete disables it.

    interface DataApi {
        createTime?: Instant;
        name?: string;
        parent?: string;
        spec?: DataApi_DataApiSpec;
        status?: DataApi_DataApiStatus;
        updateTime?: Instant;
    }
    Index

    Properties

    createTime? name? parent? spec? status? updateTime?

    Properties

    createTime?: Instant

    A timestamp indicating when the Data API was first enabled.

    name?: string

    Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api

    parent?: string

    The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}

    spec?: DataApi_DataApiSpec

    The desired Data API configuration.

    status?: DataApi_DataApiStatus

    The observed Data API state (read-only).

    updateTime?: Instant

    A timestamp indicating when the Data API configuration was last updated.

    Settings

    Member Visibility

    On This Page

    Properties