Databricks SDK for JavaScript
    Preparing search index...

    Interface DataApi_DataApiSpec

    Desired PostgREST configuration (input).

    interface DataApi_DataApiSpec {
        dbAggregatesEnabled?: boolean;
        dbExtraSearchPath?: string[];
        dbMaxRows?: number;
        dbSchemas?: string[];
        jwtCacheMaxLifetime?: Duration;
        jwtRoleClaimKey?: string;
        openapiMode?: OpenApiMode;
        serverCorsAllowedOrigins?: string[];
        serverTimingEnabled?: boolean;
    }
    Index

    Properties

    dbAggregatesEnabled? dbExtraSearchPath? dbMaxRows? dbSchemas? jwtCacheMaxLifetime? jwtRoleClaimKey? openapiMode? serverCorsAllowedOrigins? serverTimingEnabled?

    Properties

    dbAggregatesEnabled?: boolean

    Enable aggregate functions (count, sum, avg, etc.) in Data API responses. Default: true.

    dbExtraSearchPath?: string[]

    Additional schemas to include in the PostgreSQL search path. Each entry must be a valid PostgreSQL schema name.

    dbMaxRows?: number

    Maximum number of rows returned in a single Data API response. Must be a positive integer.

    dbSchemas?: string[]

    Database schemas exposed through the Data API. Each entry must be a valid PostgreSQL schema name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*). Maximum 100 entries. Default: ["public"].

    jwtCacheMaxLifetime?: Duration

    Maximum lifetime for cached JWT tokens. Zero duration disables caching.

    jwtRoleClaimKey?: string

    JSON path to the role claim in JWT tokens (e.g., ".sub"). Default: ".sub".

    openapiMode?: OpenApiMode

    OpenAPI documentation mode for the Data API endpoint.

    serverCorsAllowedOrigins?: string[]

    Allowed origins for CORS requests. Each entry should be a valid origin URL, or use "*" to allow all origins.

    serverTimingEnabled?: boolean

    Enable the Server-Timing header in Data API responses.

    Settings

    Member Visibility

    On This Page

    Properties