Skip to content

Query

laktory.models.resources.databricks.Query ¤

Bases: QueryBase

Databricks Query

Examples:

import io

from laktory import models

query_yaml = '''
display_name: stock-prices
parent_path: /queries
query_text: SELECT * FROM dev.finance.slv_stock_prices
warehouse_id: a7d9f2kl8mp3q6rt
access_controls:
- group_name: account users
  permission_level: CAN_RUN
'''
query = models.resources.databricks.Query.model_validate_yaml(
    io.StringIO(query_yaml)
)
References
BASE DESCRIPTION
apply_auto_limit

Whether to apply a 1000 row limit to the query result

TYPE: bool | None | VariableType DEFAULT: None

catalog

Name of the catalog where this query will be executed

TYPE: str | None | VariableType DEFAULT: None

description

General description that conveys additional information about this query such as usage notes

TYPE: str | None | VariableType DEFAULT: None

display_name

Name of the query

TYPE: str | VariableType

owner_user_name

Query owner's username

TYPE: str | None | VariableType DEFAULT: None

parameter

Query parameter definition. Consists of following attributes (one of *_value is required):

TYPE: list[QueryParameter] | None | VariableType DEFAULT: None

query_text

Text of SQL query

TYPE: str | VariableType

run_as_mode

Sets the 'Run as' role for the object. Should be one of OWNER, VIEWER

TYPE: str | None | VariableType DEFAULT: None

schema_

Name of the schema where this query will be executed

TYPE: str | None | VariableType DEFAULT: None

tags

Tags that will be added to the query

TYPE: list[str] | None | VariableType DEFAULT: None

warehouse_id

ID of a SQL warehouse which will be used to execute this query

TYPE: str | VariableType

LAKTORY DESCRIPTION
access_controls

Access controls list

TYPE: list[AccessControl | VariableType] | VariableType DEFAULT: []

name_prefix

TYPE: str | VariableType DEFAULT: None

name_suffix

TYPE: str | VariableType DEFAULT: None

parent_path_

The path to a workspace folder (inside laktory root) containing the query. If changed, the query will be recreated.

TYPE: str | None | VariableType DEFAULT: None

ATTRIBUTE DESCRIPTION
additional_core_resources
  • permissions

TYPE: list

additional_core_resources property ¤

  • permissions
  • alert

laktory.models.resources.databricks.query.QueryParameter ¤

Bases: BaseModel

PARAMETER DESCRIPTION
date_range_value

(Block) Manually specified date-time range value. Consists of the following attributes: * start (Required, String) - begin of the date range. * end (Required, String) - end of the date range

TYPE: QueryParameterDateRangeValue | None | VariableType DEFAULT: None

date_value

(String) Manually specified date-time value

TYPE: QueryParameterDateValue | None | VariableType DEFAULT: None

enum_value

(Block) Dropdown parameter value. Consists of following attributes:

TYPE: QueryParameterEnumValue | None | VariableType DEFAULT: None

name

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

TYPE: str | VariableType

numeric_value

(Block) Numeric parameter value. Consists of following attributes:

TYPE: QueryParameterNumericValue | None | VariableType DEFAULT: None

query_backed_value

(Block) Query-based dropdown parameter value. Consists of following attributes:

TYPE: QueryParameterQueryBackedValue | None | VariableType DEFAULT: None

text_value

(Block) Text parameter value. Consists of following attributes:

TYPE: QueryParameterTextValue | None | VariableType DEFAULT: None

title

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

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.query.QueryParameterDateRangeValue ¤

Bases: BaseModel

PARAMETER DESCRIPTION
date_range_value

(Block) Manually specified date-time range value. Consists of the following attributes: * start (Required, String) - begin of the date range. * end (Required, String) - end of the date range

TYPE: QueryParameterDateRangeValueDateRangeValue | None | VariableType DEFAULT: None

dynamic_date_range_value

(String) Dynamic date-time range value based on current date-time. Possible values are TODAY, YESTERDAY, THIS_WEEK, THIS_MONTH, THIS_YEAR, LAST_WEEK, LAST_MONTH, LAST_YEAR, LAST_HOUR, LAST_8_HOURS, LAST_24_HOURS, LAST_7_DAYS, LAST_14_DAYS, LAST_30_DAYS, LAST_60_DAYS, LAST_90_DAYS, LAST_12_MONTHS

TYPE: str | None | VariableType DEFAULT: None

precision

Date-time precision to format the value into when the query is run. Possible values are DAY_PRECISION, MINUTE_PRECISION, SECOND_PRECISION. Defaults to DAY_PRECISION (YYYY-MM-DD)

TYPE: str | None | VariableType DEFAULT: None

start_day_of_week

Specify what day that starts the week

TYPE: int | None | VariableType DEFAULT: None

laktory.models.resources.databricks.query.QueryParameterDateRangeValueDateRangeValue ¤

Bases: BaseModel

PARAMETER DESCRIPTION
end

TYPE: str | VariableType

start

TYPE: str | VariableType

laktory.models.resources.databricks.query.QueryParameterDateValue ¤

Bases: BaseModel

PARAMETER DESCRIPTION
date_value

(String) Manually specified date-time value

TYPE: str | None | VariableType DEFAULT: None

dynamic_date_value

(String) Dynamic date-time value based on current date-time. Possible values are NOW, YESTERDAY

TYPE: str | None | VariableType DEFAULT: None

precision

Date-time precision to format the value into when the query is run. Possible values are DAY_PRECISION, MINUTE_PRECISION, SECOND_PRECISION. Defaults to DAY_PRECISION (YYYY-MM-DD)

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.query.QueryParameterEnumValue ¤

Bases: BaseModel

PARAMETER DESCRIPTION
enum_options

(String) List of valid query parameter values, newline delimited

TYPE: str | None | VariableType DEFAULT: None

multi_values_options

If specified, allows multiple values to be selected for this parameter. Consists of following attributes:

TYPE: QueryParameterEnumValueMultiValuesOptions | None | VariableType DEFAULT: None

values

(Array of strings) List of selected query parameter values

TYPE: list[str] | None | VariableType DEFAULT: None

laktory.models.resources.databricks.query.QueryParameterEnumValueMultiValuesOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
prefix

Character that prefixes each selected parameter value

TYPE: str | None | VariableType DEFAULT: None

separator

Character that separates each selected parameter value. Defaults to a comma

TYPE: str | None | VariableType DEFAULT: None

suffix

Character that suffixes each selected parameter value

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.query.QueryParameterNumericValue ¤

Bases: BaseModel

PARAMETER DESCRIPTION
value
  • actual numeric value

TYPE: int | VariableType

laktory.models.resources.databricks.query.QueryParameterQueryBackedValue ¤

Bases: BaseModel

PARAMETER DESCRIPTION
multi_values_options

If specified, allows multiple values to be selected for this parameter. Consists of following attributes:

TYPE: QueryParameterQueryBackedValueMultiValuesOptions | None | VariableType DEFAULT: None

query_id

ID of the query that provides the parameter values

TYPE: str | VariableType

values

(Array of strings) List of selected query parameter values

TYPE: list[str] | None | VariableType DEFAULT: None

laktory.models.resources.databricks.query.QueryParameterQueryBackedValueMultiValuesOptions ¤

Bases: BaseModel

PARAMETER DESCRIPTION
prefix

Character that prefixes each selected parameter value

TYPE: str | None | VariableType DEFAULT: None

separator

Character that separates each selected parameter value. Defaults to a comma

TYPE: str | None | VariableType DEFAULT: None

suffix

Character that suffixes each selected parameter value

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.query.QueryParameterTextValue ¤

Bases: BaseModel

PARAMETER DESCRIPTION
value
  • actual numeric value

TYPE: str | VariableType