ambika-garg opened a new pull request, #39243:
URL: https://github.com/apache/airflow/pull/39243
# Apache Airflow Provider for Power BI.
## Operators
### PowerBIDatasetRefreshOperator
The operator triggers the Power BI dataset refresh and pushes the details of
refresh in Xcom. It can accept the following parameters:
* `dataset_id`: The dataset Id.
* `group_id`: The workspace Id.
* `wait_for_termination`: (Default value: True) Wait until the pre-existing
or current triggered refresh completes before exiting.
* `force_refresh`: When enabled, it will force refresh the dataset again,
after pre-existing ongoing refresh request is terminated.
* `timeout`: Time in seconds to wait for a dataset to reach a terminal
status for non-asynchronous waits. Used only if ``wait_for_termination`` is
True.
* `check_interval`: Number of seconds to wait before rechecking the refresh
status.
## Hooks
### PowerBI Hook
A hook to interact with Power BI.
* `powerbi_conn_id`: Airflow Connection ID that contains the connection
information for the Power BI account used for authentication.
## Features
* #### Xcom Integration: The Power BI Dataset refresh operator enriches the
Xcom with essential fields for downstream tasks:
1. `powerbi_dataset_refresh_id`: Request Id of the Dataset Refresh.
2. `powerbi_dataset_refresh_status`: Refresh Status.
* `Unknown`: Refresh state is unknown or a refresh is in progress.
* `Completed`: Refresh successfully completed.
* `Failed`: Refresh failed (details in `powerbi_dataset_refresh_error`).
* `Disabled`: Refresh is disabled by a selective refresh.
3. `powerbi_dataset_refresh_end_time`: The end date and time of the refresh
(may be None if a refresh is in progress)
4. `powerbi_dataset_refresh_error`: Failure error code in JSON format (None
if no error)
* #### External Monitoring link: The operator conveniently provides a
redirect link to the Power BI UI for monitoring refreshes.
## Sample DAG to use the plugin.
Check out the sample DAG code below:
```python
from datetime import datetime
from airflow import DAG
from airflow.operators.bash import BashOperator
from operators.powerbi_refresh_dataset_operator import
PowerBIDatasetRefreshOperator
with DAG(
dag_id='refresh_dataset_powerbi',
schedule_interval=None,
start_date=datetime(2023, 8, 7),
catchup=False,
concurrency=20,
tags=['powerbi', 'dataset', 'refresh']
) as dag:
refresh_in_given_workspace = PowerBIDatasetRefreshOperator(
task_id="refresh_in_given_workspace",
dataset_id="<dataset_id",
group_id="workspace_id",
force_refresh = False,
wait_for_termination = False
)
refresh_in_given_workspace
```
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
