Skip to content

Commit

Permalink
fix(schedule-query): getUISchema function called in SchemaForm compon…
Browse files Browse the repository at this point in the history 
…ent (#20256)

* Revert "Superset - Release and Improvements (12-05-2022)"

* merging conflic changes

* Revert "Revert "Superset - Release and Improvements (12-05-2022)""

This reverts commit 6d18661.

* fixed breaking changes

* sync with master

* fixed breaking flows

* fixed getUISchema function call

* added default placeholder and updated docs

* fixed format and comments

* changed flag to configuration

* fix: indentation of SCHEDULED_QUERIES dict

* fix: changed intendation for SCHEDULED_QUERIES

* fix: updated docs for SCHEDULED_QUERIES

* fix: replaced button to menu item for SCHEDULED_QUERIES

* fix: updated docs for SCHEDULED_QUERIES

* fix: trailing whitespace
  • Loading branch information
@RahulRaj97
RahulRaj97 committed Jul 5, 2022
1 parent 59491f5 commit 4137fe0
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 75 deletions.
145 changes: 71 additions & 74 deletions docs/docs/installation/alerts-reports.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -391,94 +391,91 @@ You can optionally allow your users to schedule queries directly in SQL Lab. Thi
extra metadata to saved queries, which are then picked up by an external scheduled (like
[Apache Airflow](https://airflow.apache.org/)).

To allow scheduled queries, add the following to your configuration file:
To allow scheduled queries, add the following to `SCHEDULED_QUERIES` in your configuration file:

```python
FEATURE_FLAGS = {
# Configuration for scheduling queries from SQL Lab. This information is
# collected when the user clicks "Schedule query", and saved into the `extra`
# field of saved queries.
SCHEDULED_QUERIES = {
# This information is collected when the user clicks "Schedule query",
# and saved into the `extra` field of saved queries.
# See: https://github.com/mozilla-services/react-jsonschema-form
'SCHEDULED_QUERIES': {
'JSONSCHEMA': {
'title': 'Schedule',
'description': (
'In order to schedule a query, you need to specify when it '
'should start running, when it should stop running, and how '
'often it should run. You can also optionally specify '
'dependencies that should be met before the query is '
'executed. Please read the documentation for best practices '
'and more information on how to specify dependencies.'
),
'type': 'object',
'properties': {
'output_table': {
'type': 'string',
'title': 'Output table name',
},
'start_date': {
'type': 'string',
'title': 'Start date',
# date-time is parsed using the chrono library, see
# https://www.npmjs.com/package/chrono-node#usage
'format': 'date-time',
'default': 'tomorrow at 9am',
},
'end_date': {
'type': 'string',
'title': 'End date',
# date-time is parsed using the chrono library, see
# https://www.npmjs.com/package/chrono-node#usage
'format': 'date-time',
'default': '9am in 30 days',
},
'schedule_interval': {
'type': 'string',
'title': 'Schedule interval',
},
'dependencies': {
'type': 'array',
'title': 'Dependencies',
'items': {
'type': 'string',
},
},
'JSONSCHEMA': {
'title': 'Schedule',
'description': (
'In order to schedule a query, you need to specify when it '
'should start running, when it should stop running, and how '
'often it should run. You can also optionally specify '
'dependencies that should be met before the query is '
'executed. Please read the documentation for best practices '
'and more information on how to specify dependencies.'
),
'type': 'object',
'properties': {
'output_table': {
'type': 'string',
'title': 'Output table name',
},
'start_date': {
'type': 'string',
'title': 'Start date',
# date-time is parsed using the chrono library, see
# https://www.npmjs.com/package/chrono-node#usage
'format': 'date-time',
'default': 'tomorrow at 9am',
},
'end_date': {
'type': 'string',
'title': 'End date',
# date-time is parsed using the chrono library, see
# https://www.npmjs.com/package/chrono-node#usage
'format': 'date-time',
'default': '9am in 30 days',
},
},
'UISCHEMA': {
'schedule_interval': {
'ui:placeholder': '@daily, @weekly, etc.',
'type': 'string',
'title': 'Schedule interval',
},
'dependencies': {
'ui:help': (
'Check the documentation for the correct format when '
'defining dependencies.'
),
'type': 'array',
'title': 'Dependencies',
'items': {
'type': 'string',
},
},
},
'VALIDATION': [
# ensure that start_date <= end_date
{
'name': 'less_equal',
'arguments': ['start_date', 'end_date'],
'message': 'End date cannot be before start date',
# this is where the error message is shown
'container': 'end_date',
},
],
# link to the scheduler; this example links to an Airflow pipeline
# that uses the query id and the output table as its name
'linkback': (
'https://airflow.example.com/admin/airflow/tree?'
'dag_id=query_${id}_${extra_json.schedule_info.output_table}'
),
},
'UISCHEMA': {
'schedule_interval': {
'ui:placeholder': '@daily, @weekly, etc.',
},
'dependencies': {
'ui:help': (
'Check the documentation for the correct format when '
'defining dependencies.'
),
},
},
'VALIDATION': [
# ensure that start_date <= end_date
{
'name': 'less_equal',
'arguments': ['start_date', 'end_date'],
'message': 'End date cannot be before start date',
# this is where the error message is shown
'container': 'end_date',
},
],
# link to the scheduler; this example links to an Airflow pipeline
# that uses the query id and the output table as its name
'linkback': (
'https://airflow.example.com/admin/airflow/tree?'
'dag_id=query_${id}_${extra_json.schedule_info.output_table}'
),
}
```

This feature flag is based on
This configuration is based on
[react-jsonschema-form](https://github.com/mozilla-services/react-jsonschema-form) and will add a
button called “Schedule Query” to SQL Lab. When the button is clicked, a modal will show up where
menu item called “Schedule” to SQL Lab. When the menu item is clicked, a modal will show up where
the user can add the metadata required for scheduling the query.

This information can then be retrieved from the endpoint `/savedqueryviewapi/api/read` and used to
Expand Down
2 changes: 1 addition & 1 deletion superset-frontend/src/SqlLab/components/ScheduleQueryButton/index.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ const ScheduleQueryButton: FunctionComponent<ScheduleQueryButtonProps> = ({
<StyledJsonSchema>
<SchemaForm
schema={getJSONSchema()}
uiSchema={getUISchema}
uiSchema={getUISchema()}
onSubmit={onScheduleSubmit}
validate={getValidator()}
>
Expand Down
3 changes: 3 additions & 0 deletions superset/config.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,9 @@ def _try_json_readsha(filepath: str, length: int) -> Optional[str]:
ENABLE_PROXY_FIX = False
PROXY_FIX_CONFIG = {"x_for": 1, "x_proto": 1, "x_host": 1, "x_port": 1, "x_prefix": 1}

# Configuration for scheduling queries from SQL Lab.
SCHEDULED_QUERIES: Dict[str, Any] = {}

# ------------------------------
# GLOBALS FOR APP Builder
# ------------------------------
Expand Down

0 comments on commit 4137fe0

Please sign in to comment.