Databricks SDK for JavaScript
    Preparing search index...

    Interface QueryParameter

    interface QueryParameter {
        name?: string;
        parameterValue?:
            | { $case: "textValue"; textValue: TextValue }
            | { $case: "numericValue"; numericValue: NumericValue }
            | { $case: "enumValue"; enumValue: EnumValue }
            | { $case: "dateValue"; dateValue: DateValue }
            | { $case: "dateRangeValue"; dateRangeValue: DateRangeValue }
            | { $case: "queryBackedValue"; queryBackedValue: QueryBackedValue };
        title?: string;
    }
    Index

    Properties

    name? parameterValue? title?

    Properties

    name?: string

    Literal parameter marker that appears between double curly braces in the query text.

    parameterValue?:
        | { $case: "textValue"; textValue: TextValue }
        | { $case: "numericValue"; numericValue: NumericValue }
        | { $case: "enumValue"; enumValue: EnumValue }
        | { $case: "dateValue"; dateValue: DateValue }
        | { $case: "dateRangeValue"; dateRangeValue: DateRangeValue }
        | { $case: "queryBackedValue"; queryBackedValue: QueryBackedValue }

    Only one of the following fields may be set, depending on the type of parameter.

    Type Declaration

    • { $case: "textValue"; textValue: TextValue }
      • $case: "textValue"
      • textValue: TextValue

        Text query parameter value.

    • { $case: "numericValue"; numericValue: NumericValue }
      • $case: "numericValue"
      • numericValue: NumericValue

        Numeric query parameter value.

    • { $case: "enumValue"; enumValue: EnumValue }
      • $case: "enumValue"
      • enumValue: EnumValue

        Dropdown query parameter value.

    • { $case: "dateValue"; dateValue: DateValue }
      • $case: "dateValue"
      • dateValue: DateValue

        Date query parameter value. Can only specify one of dynamic_date_value or date_value.

    • { $case: "dateRangeValue"; dateRangeValue: DateRangeValue }
      • $case: "dateRangeValue"
      • dateRangeValue: DateRangeValue

        Date-range query parameter value. Can only specify one of dynamic_date_range_value or date_range_value.

    • { $case: "queryBackedValue"; queryBackedValue: QueryBackedValue }
      • $case: "queryBackedValue"
      • queryBackedValue: QueryBackedValue

        Query-based dropdown query parameter value.

    title?: string

    Text displayed in the user-facing parameter widget in the UI.

    Settings

    Member Visibility

    On This Page

    Properties