Samouczek: pokaz wszystkich widżetów interfejsu użytkownika

W tym samouczku utworzysz operator Python UDF dla narzędzia Lakeflow Designer, który wykonuje ćwiczenia każdego widżetu interfejsu użytkownika dostępnego w schemacieuser-defined-operator-v0.1.0. Użyj go jako szablonu podczas tworzenia własnych operatorów. Aby zapoznać się z szerszym omówieniem, zobacz Operatory zdefiniowane przez użytkownika w programie Lakeflow Designer.

Overview

Ten operator to demonstracyjna funkcja UDF, która akceptuje parametry przy użyciu każdego dostępnego typu widżetu interfejsu użytkownika. Łączy wszystkie wartości wejściowe w ciąg opisowy, co ułatwia sprawdzenie, jak każdy widżet przekazuje dane do funkcji.

Dostępne typy widżetów to:

Widget Description Typ danych
expression Selektor kolumn/wyrażeń z portu wejściowego wyrażenie
input Wprowadzanie tekstu jednowierszowego ciąg
textarea Wielowierszowe pole tekstowe ciąg
checkbox Przełączanie pola wyboru logiczny
toggle Przełącznik logiczny
number Dane wejściowe liczbowe z wartością minimalną/maksymalną number
slider Suwak liczbowy z zakresem number
select Lista rozwijana jednokrotnego wyboru (wartości stałe) ciąg
select Lista rozwijana jednokrotnego wyboru (z kolumn wejściowych) ciąg
multi-select Wybór wielokrotny (wartości statyczne) string[]
multi-select Wybór wielokrotny (z kolumn wejściowych) string[]

Krok 1: Pisanie i testowanie funkcji Python

Najpierw zdefiniuj funkcję Python, która akceptuje wszystkie różne typy parametrów. Ta funkcja po prostu łączy wszystkie dane wejściowe w ciąg opisowy w celach demonstracyjnych.

def concat_all_widgets(
    expression_widget_value: str,
    input_widget_value: str,
    textarea_widget_value: str,
    checkbox_widget_value: bool,
    toggle_widget_value: bool,
    number_widget_value: float,
    slider_widget_value: float,
    select_static_widget_value: str,
    select_columns_widget_value: str,
    multiselect_static_widget_value: list,
    multiselect_columns_widget_value: list
) -> str:
    """
    Concatenates all input parameters into a descriptive string.
    This demonstrates all UI widget types available in user-defined operators.
    """
    lines = [
        f"1: Expression (Column Picker) -> {expression_widget_value}",
        f"2: Text Input (Single Line) -> {input_widget_value}",
        f"3: Text Area (Multi-Line) -> {textarea_widget_value}",
        f"4: Checkbox Option -> {checkbox_widget_value}",
        f"5: Toggle Switch -> {toggle_widget_value}",
        f"6: Number Input -> {number_widget_value}",
        f"7: Slider Value -> {slider_widget_value}",
        f"8: Select (Static Options) -> {select_static_widget_value}",
        f"9: Select (From Input Columns) -> {select_columns_widget_value}",
        f"10: Multi-Select (Static Options) -> [{', '.join(multiselect_static_widget_value or [])}]",
        f"11: Multi-Select (From Input Columns) -> [{', '.join(multiselect_columns_widget_value or [])}]"
    ]
    return "\n".join(lines)

Przetestuj funkcję przy użyciu następującego kodu:

result = concat_all_widgets(
    expression_widget_value="column_value_123",
    input_widget_value="Hello World",
    textarea_widget_value="Line 1\nLine 2\nLine 3",
    checkbox_widget_value=True,
    toggle_widget_value=False,
    number_widget_value=42.5,
    slider_widget_value=75.0,
    select_static_widget_value="option_b",
    select_columns_widget_value="amount",
    multiselect_static_widget_value=["tag1", "tag3"],
    multiselect_columns_widget_value=["col1", "col3"]
)
print(result)

Krok 2. Tworzenie konfiguracji YAML

Konfiguracja YAML definiuje sposób wyświetlania operatora w projektancie lakeflow. W tym przykładzie pokazano każdy dostępny typ widżetu:

schema: user-defined-operator-v0.1.0
type: uc-udf
name: All Widgets Demo
id: demo.all_widgets
version: '1.0.0'
description: >
  A demonstration UDF that showcases all available UI widgets.
config:
  type: object
  properties:
    # ============================================
    # EXPRESSION WIDGET
    # ============================================
    expression_widget_value:
      type: string
      format: expression
      title: 1. Expression (Column Picker)
      examples:
        - 'Select a column or enter an expression'
      x-ui:
        widget: expression
        port: in

    # ============================================
    # INPUT WIDGET (single-line text)
    # ============================================
    input_widget_value:
      type: string
      title: 2. Text Input (Single Line)
      default: default text
      examples:
        - 'Enter a single line of text'
      x-ui:
        widget: input

    # ============================================
    # TEXTAREA WIDGET (multi-line text)
    # ============================================
    textarea_widget_value:
      type: string
      title: 3. Text Area (Multi-Line)
      default: Sample text
      examples:
        - 'Enter multiple lines of text here...'
      x-ui:
        widget: textarea
        rows: 3

    # ============================================
    # CHECKBOX WIDGET (boolean)
    # ============================================
    checkbox_widget_value:
      type: boolean
      title: 4. Checkbox Option
      default: true
      x-ui:
        widget: checkbox

    # ============================================
    # TOGGLE WIDGET (boolean switch)
    # ============================================
    toggle_widget_value:
      type: boolean
      title: 5. Toggle Switch
      default: false
      x-ui:
        widget: toggle

    # ============================================
    # NUMBER WIDGET (numeric input with min/max)
    # ============================================
    number_widget_value:
      type: number
      title: 6. Number Input
      default: 50
      minimum: 0
      maximum: 100
      examples:
        - 'Enter a number (0-100)'
      x-ui:
        widget: number

    # ============================================
    # SLIDER WIDGET (numeric slider)
    # ============================================
    slider_widget_value:
      type: number
      title: 7. Slider Value
      default: 50
      minimum: 0
      maximum: 100
      x-ui:
        widget: slider
        step: 5

    # ============================================
    # SELECT WIDGET with STATIC options
    # ============================================
    select_static_widget_value:
      type: string
      title: 8. Select (Static Options)
      default: option_a
      examples:
        - 'Choose an option'
      x-ui:
        widget: select
        optionsSource:
          type: static
          values:
            - option_a
            - option_b
            - option_c

    # ============================================
    # SELECT WIDGET with INPUT COLUMNS options
    # ============================================
    select_columns_widget_value:
      type: string
      title: 9. Select (From Input Columns)
      examples:
        - 'Select a column from input'
      x-ui:
        widget: select
        optionsSource:
          type: inputColumns
          port: in

    # ============================================
    # MULTI-SELECT WIDGET with STATIC options
    # ============================================
    multiselect_static_widget_value:
      type: array
      items:
        type: string
      title: 10. Multi-Select (Static Options)
      default:
        - tag1
        - tag2
      examples:
        - 'Select one or more tags'
      x-ui:
        widget: multi-select
        optionsSource:
          type: static
          values:
            - tag1
            - tag2
            - tag3
            - tag4
            - tag5

    # ============================================
    # MULTI-SELECT WIDGET with INPUT COLUMNS options
    # ============================================
    multiselect_columns_widget_value:
      type: array
      items:
        type: string
      title: 11. Multi-Select (From Input Columns)
      examples:
        - 'Select one or more columns'
      x-ui:
        widget: multi-select
        optionsSource:
          type: inputColumns
          port: in

  required:
    - expression_widget_value
  additionalProperties: false
ports:
  input:
    - name: in
      title: Input Data
  output:
    - name: out
      title: Output

Wyróżnienia schematu

Klucz konfiguracji Widget Typ danych Purpose
expression_widget_value expression wyrażenie Wybierz kolumnę lub wyrażenie z danych wejściowych.
input_widget_value input ciąg Wpis tekstowy z jednym wierszem.
textarea_widget_value textarea ciąg Wprowadzanie tekstu wielowierszowego.
checkbox_widget_value checkbox logiczny Pole wyboru wartości logicznej.
toggle_widget_value toggle logiczny Przełącznik logiczny.
number_widget_value number number Dane wejściowe liczbowe z minimalną/maksymalną walidacją.
slider_widget_value slider number Suwak liczbowy z przyrostami kroków.
select_static_widget_value select ciąg Lista rozwijana z opcjami zakodowanymi na stałe.
select_columns_widget_value select ciąg Lista rozwijana wypełniona z kolumn wejściowych.
multiselect_static_widget_value multi-select string[] Wielokrotny wybór z opcjami zdefiniowanymi na stałe.
multiselect_columns_widget_value multi-select string[] Wielokrotny wybór uzupełniany na podstawie kolumn wejściowych.

Opcje typów źródłowych

Dla widżetów select i multi-select musisz określić optionsSource:

Opcje statyczne: Stała lista wartości:

optionsSource:
  type: static
  values:
    - value1
    - value2
    - value3

Kolumny wejściowe: Lista dynamiczna z kolumn portów wejściowych:

optionsSource:
  type: inputColumns
  port: in

Zapoznaj się z dokumentacją YAML operatora zdefiniowanego przez użytkownika , aby zapoznać się z kompleksowym przewodnikiem dotyczącym wszystkich dostępnych właściwości, typów danych, widżetów i opcji.

Krok 3. Utwórz funkcję w Unity Catalog

Połącz konfigurację YAML i funkcję Python w jedną instrukcję CREATE FUNCTION. Należy pamiętać, że wartości string[] (wielokrotnego wyboru) są przekazywane do funkcji UDF jako ARRAY<STRING>.

Przykład tworzy funkcję w main.example_output. Najpierw stwórz schemat, jeśli nie istnieje:

CREATE SCHEMA IF NOT EXISTS main.example_output

CREATE OR REPLACE FUNCTION main.example_output.all_widgets_demo(
    expression_widget_value STRING,
    input_widget_value STRING,
    textarea_widget_value STRING,
    checkbox_widget_value BOOLEAN,
    toggle_widget_value BOOLEAN,
    number_widget_value DOUBLE,
    slider_widget_value DOUBLE,
    select_static_widget_value STRING,
    select_columns_widget_value STRING,
    multiselect_static_widget_value ARRAY<STRING>,
    multiselect_columns_widget_value ARRAY<STRING>
)
RETURNS STRING
LANGUAGE PYTHON
AS $$
  """
  schema: user-defined-operator-v0.1.0
  type: uc-udf
  name: All Widgets Demo
  id: demo.all_widgets
  version: "1.0.0"
  description: >
    A demonstration UDF that showcases all available UI widgets.
  config:
    type: object
    properties:
      expression_widget_value:
        type: string
        format: expression
        title: 1. Expression (Column Picker)
        examples:
          - "Select a column or enter an expression"
        x-ui:
          widget: expression
          port: in
      input_widget_value:
        type: string
        title: 2. Text Input (Single Line)
        default: "default text"
        examples:
          - "Enter a single line of text"
        x-ui:
          widget: input
      textarea_widget_value:
        type: string
        title: 3. Text Area (Multi-Line)
        default: Sample text
        examples:
          - "Enter multiple lines of text here..."
        x-ui:
          widget: textarea
          rows: 3
      checkbox_widget_value:
        type: boolean
        title: 4. Checkbox Option
        default: true
        x-ui:
          widget: checkbox
      toggle_widget_value:
        type: boolean
        title: 5. Toggle Switch
        default: false
        x-ui:
          widget: toggle
      number_widget_value:
        type: number
        title: 6. Number Input
        default: 50
        minimum: 0
        maximum: 100
        examples:
          - "Enter a number (0-100)"
        x-ui:
          widget: number
      slider_widget_value:
        type: number
        title: 7. Slider Value
        default: 50
        minimum: 0
        maximum: 100
        x-ui:
          widget: slider
          step: 5
      select_static_widget_value:
        type: string
        title: 8. Select (Static Options)
        default: option_a
        examples:
          - "Choose an option"
        x-ui:
          widget: select
          optionsSource:
            type: static
            values:
              - option_a
              - option_b
              - option_c
      select_columns_widget_value:
        type: string
        title: 9. Select (From Input Columns)
        examples:
          - "Select a column from input"
        x-ui:
          widget: select
          optionsSource:
            type: inputColumns
            port: in
      multiselect_static_widget_value:
        type: array
        items:
          type: string
        title: 10. Multi-Select (Static Options)
        default:
          - tag1
          - tag2
        examples:
          - "Select one or more tags"
        x-ui:
          widget: multi-select
          optionsSource:
            type: static
            values:
              - tag1
              - tag2
              - tag3
              - tag4
              - tag5
      multiselect_columns_widget_value:
        type: array
        items:
          type: string
        title: 11. Multi-Select (From Input Columns)
        examples:
          - "Select one or more columns"
        x-ui:
          widget: multi-select
          optionsSource:
            type: inputColumns
            port: in
    required:
      - expression_widget_value
    additionalProperties: false
  ports:
    input:
      - name: in
        title: Input Data
    output:
      - name: out
        title: Output
  """

  def concat_all_widgets(
      expression_widget_value: str,
      input_widget_value: str,
      textarea_widget_value: str,
      checkbox_widget_value: bool,
      toggle_widget_value: bool,
      number_widget_value: float,
      slider_widget_value: float,
      select_static_widget_value: str,
      select_columns_widget_value: str,
      multiselect_static_widget_value: list,
      multiselect_columns_widget_value: list
  ) -> str:
      lines = [
          f"1: Expression (Column Picker) -> {expression_widget_value}",
          f"2: Text Input (Single Line) -> {input_widget_value}",
          f"3: Text Area (Multi-Line) -> {textarea_widget_value}",
          f"4: Checkbox Option -> {checkbox_widget_value}",
          f"5: Toggle Switch -> {toggle_widget_value}",
          f"6: Number Input -> {number_widget_value}",
          f"7: Slider Value -> {slider_widget_value}",
          f"8: Select (Static Options) -> {select_static_widget_value}",
          f"9: Select (From Input Columns) -> {select_columns_widget_value}",
          f"10: Multi-Select (Static Options) -> [{', '.join(multiselect_static_widget_value or [])}]",
          f"11: Multi-Select (From Input Columns) -> [{', '.join(multiselect_columns_widget_value or [])}]"
      ]
      return "\n".join(lines)

  return concat_all_widgets(
      expression_widget_value,
      input_widget_value,
      textarea_widget_value,
      checkbox_widget_value,
      toggle_widget_value,
      number_widget_value,
      slider_widget_value,
      select_static_widget_value,
      select_columns_widget_value,
      multiselect_static_widget_value,
      multiselect_columns_widget_value
  )
$$

Krok 4. Testowanie funkcji

Przetestuj funkcję UC bezpośrednio przy użyciu języka SQL:

SELECT main.example_output.all_widgets_demo(
    expression_widget_value => 'my_column_value',
    input_widget_value => 'Hello World',
    textarea_widget_value => 'Multi\nLine\nText',
    checkbox_widget_value => TRUE,
    toggle_widget_value => FALSE,
    number_widget_value => 42.5,
    slider_widget_value => 75.0,
    select_static_widget_value => 'option_b',
    select_columns_widget_value => 'amount',
    multiselect_static_widget_value => array('tag1', 'tag3'),
    multiselect_columns_widget_value => array('col1', 'col2', 'col3')
) AS result;

Krok 5. Rejestrowanie operatora

Dodaj operator do pliku .user_defined_operators.yaml:

operators:
  - catalog: main
    schema: example_output
    functionName: all_widgets_demo

Krok 6. Konfigurowanie uprawnień

Udziel dostępu użytkownikom, którzy muszą używać tego operatora:

GRANT USE SCHEMA ON SCHEMA main.example_output TO `<user>`;
GRANT EXECUTE ON FUNCTION main.example_output.all_widgets_demo TO `<user>`;

Używanie operatora w programie Lakeflow Designer

Po zarejestrowaniu się operator pojawi się w Lakeflow Designer z rozbudowanym panelem konfiguracji obejmującym:

  • Selektor wyrażeń do wyboru kolumn
  • Wprowadzanie tekstu (jednowierszowe i wielowierszowe)
  • Kontrolki logiczne (pole wyboru i przełącznik)
  • Dane wejściowe liczbowe (pole liczbowe i suwak)
  • Listy rozwijane z opcjami statycznymi i dynamicznymi
  • Kontrolki wielokrotnego wyboru do wybierania wielu wartości

Ten operator służy jako przydatny punkt odniesienia, pomagający zrozumieć, w jaki sposób każdy typ widżetu jest wyświetlany i przekazuje dane do Twojej funkcji.

Aby uzyskać informacje o typie danych i opcjach każdego widżetu, zobacz Widżety interfejsu użytkownika.

  • Last updated on