id stringlengths 15 25 | source stringclasses 1
value | chunk_index int64 0 393k | token_count int32 449 512 | content stringlengths 203 7.95k |
|---|---|---|---|---|
combine_chunk_900 | combine.txt | 900 | 512 | tasks on machines
that are not part of your main data center, e.g. edge servers. This also allows to
deploy only reduced dependencies on the edge worker.
Here are a few imperative requirements for your workers:
- ``airflow`` needs to be installed, and the Airflow CLI needs to be in the path. This includes
the Task... |
combine_chunk_901 | combine.txt | 901 | 512 | It is disabled intentionally to not expose
API endpoint by default. This is the endpoint the worker connects to.
In a future release a dedicated API server can be started.
- ``api_url``: Must be set to the URL which exposes the api endpoint as it is reachable from the
worker. Typically this looks like ``... |
combine_chunk_902 | combine.txt | 902 | 512 | _team` for setup details
and :doc:`apache-airflow:security/workload` (section "No team-level isolation in
Execution API") for the security boundary.
.. code-block:: bash
airflow edge worker
2026-07-09T12:28:32.954316Z [info ] Starting worker with API endpoint http://localhost:8080/edge_worker/v1/rpcapi
... |
combine_chunk_903 | combine.txt | 903 | 512 | stop the worker.
If you want to monitor the remote activity and worker, use the UI plugin which
is included in the provider package and install it on the api-server / webserver and use the
"Admin" - "Edge Worker Hosts" and "Edge Worker Jobs" pages.
(Note: The plugin is not available on Airflow 3.0 UI, it is only in 3... |
combine_chunk_904 | combine.txt | 904 | 512 | edge status
This will show the status of the local worker instance as JSON and the tasks running on it.
The status and maintenance comments will also be shown in the web UI
in the "Admin" - "Edge Worker" page.
The local worker instance can be started to fetch new tasks via the command
.. code-block:: bash
air... |
combine_chunk_905 | combine.txt | 905 | 512 | them.
This information is stored in the database and can be used to monitor the workers and their tasks as well as is displayed
in the web UI.
Basic information that is provided by the workers includes:
- Time of being first online
- Time of last heartbeat
- Airflow version
- Edge provider version
- Python version
-... |
combine_chunk_906 | combine.txt | 906 | 512 | 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 compl... |
combine_chunk_907 | combine.txt | 907 | 512 | dependencies
--------------------------------------------
Those are dependencies that might be needed in order to use all the features of the package.
You need to install the specified providers in order to use them.
You can install such cross-provider dependencies when installing from PyPI. For example:
.. code-bl... |
combine_chunk_908 | combine.txt | 908 | 512 | 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.apac... |
combine_chunk_909 | combine.txt | 909 | 512 | -airflow-providers-informatica``.
For the minimum Airflow version supported, see ``Requirements`` below.
Requirements
------------
The minimum Apache Airflow version supported by this provider distribution is ``3.0.0``.
========================================== ==================
PIP package ... |
combine_chunk_910 | combine.txt | 910 | 512 | airflow.apache.org/docs/apache-airflow-providers-common-sql>`_ ``common.sql``
============================================================================================================ ==============
Optional dependencies
---------------------
These extras install optional third-party libraries that enable additi... |
combine_chunk_911 | combine.txt | 911 | 512 | 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 t... |
combine_chunk_912 | combine.txt | 912 | 512 | 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 app... |
combine_chunk_913 | combine.txt | 913 | 512 | ook`` to extract lineage information from Informatica EDC and convert it to Airflow-compatible asset definitions. It is typically used internally by the provider's plugin and listeners.
**Initialization Example:**
.. code-block:: python
from airflow.providers.informatica.extractors.informatica import InformaticaL... |
combine_chunk_914 | combine.txt | 914 | 512 | 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.apac... |
combine_chunk_915 | combine.txt | 915 | 512 | A semicolon-separated list of fully-qualified Python class names. Operators whose
class matches an entry in this list are excluded entirely from lineage processing —
both automatic and manual inlets/outlets are ignored.
Example:
.. code-block:: ini
[informatica]
disabled_for_operators = airflow.providers.st... |
combine_chunk_916 | combine.txt | 916 | 512 | airflow/providers/informatica/docs/guides/usage.rst
.. 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 t... |
combine_chunk_917 | combine.txt | 917 | 512 | .disable_informatica_lineage` and :func:`~airflow.providers.informatica.lineage.enable_informatica_lineage`.
- **Operator Exclusion**: Exclude entire operator classes via ``disabled_for_operators`` in ``airflow.cfg``.
- **Optional Fail-fast Validation**: For tasks that must enforce lineage integrity, use ``pre_execute=... |
combine_chunk_918 | combine.txt | 918 | 512 | provider parses the SQL, finds ``sales`` as the source and ``summary`` as the target,
resolves both against the Informatica catalog, and creates the lineage link on task success.
The SQL dialect is inferred automatically from the connection ID string (e.g., a connection
ID containing ``postgres`` maps to the PostgreS... |
combine_chunk_919 | combine.txt | 919 | 512 | do not block task
execution. To fail the task before ``execute()`` when lineage resolution fails, set
``pre_execute=validate_informatica_lineage``:
.. code-block:: python
from airflow.providers.informatica.lineage.validation import validate_informatica_lineage
task = PythonOperator(
task_id="transform... |
combine_chunk_920 | combine.txt | 920 | 512 | 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 ... |
combine_chunk_921 | combine.txt | 921 | 512 |
``pip install apache-airflow-providers-pinecone``
The package supports the following python versions: 3.11,3.12,3.13,3.14
Requirements
------------
========================================== ==================
PIP package Version required
========================================== ... |
combine_chunk_922 | combine.txt | 922 | 512 | hidden:
:maxdepth: 1
:caption: System tests
System Tests <_api/tests/system/pinecone/index>
.. THE REMAINDER OF THE FILE IS AUTOMATICALLY GENERATED. IT WILL BE OVERWRITTEN AT RELEASE TIME!
.. toctree::
:hidden:
:maxdepth: 1
:caption: Commits
Detailed list of commits <commits>
apache-a... |
combine_chunk_923 | combine.txt | 923 | 512 | /airflow/providers/apache_airflow_providers_pinecone-2.5.1-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_pinecone-2.5.1-py3-none-any.whl.sha512>`__)
<|file|>airflow/providers/pinecone/docs/operators/pinecone.rst
.. Licensed to the Apache Software Foundation... |
combine_chunk_924 | combine.txt | 924 | 512 | to
interact with Pinecone APIs to create a Pod based Index.
Using the Operator
^^^^^^^^^^^^^^^^^^
The ``CreatePodIndexOperator`` requires the index details as well as the pod configuration details. ``api_key``, ``environment`` can be
passed via arguments to the operator or via the connection.
An example using the o... |
combine_chunk_925 | combine.txt | 925 | 512 | THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!
.. IF YOU WANT TO MODIFY THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
`PROVIDER_COMMITS_TEMPLATE.rst.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY
.. THE REMAINDER OF THE FILE IS AUTOMATICALLY GENERATED. IT WILL BE OVERWRITTEN!
Pa... |
combine_chunk_926 | combine.txt | 926 | 512 | 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.
.. _howto/connection:pinecone:
Pinecone Connection
===================
Th... |
combine_chunk_927 | combine.txt | 927 | 512 | _ versioning policy. Depending on
the scope of the change, Provider will get ''MAJOR'' version upgrade when there are
breaking changes, ``MINOR`` version upgrade when there are new features or ``PATCHLEVEL`` version upgrade
when there are only bug fixes (including security bugfixes) - and this is the only version that ... |
combine_chunk_928 | combine.txt | 928 | 512 | ord`` python package.
You can find package information and changelog for the provider
in the `documentation <https://airflow.apache.org/docs/apache-airflow-providers-discord/3.12.5/>`_.
Installation
------------
You can install this package on top of an existing Airflow installation (see ``Requirements`` below
for t... |
combine_chunk_929 | combine.txt | 929 | 512 | hidden:
:maxdepth: 1
:caption: References
Python API <_api/airflow/providers/discord/index>
PyPI Repository <https://pypi.org/project/apache-airflow-providers-discord/>
Installing from sources <installing-providers-from-sources>
.. THE REMAINDER OF THE FILE IS AUTOMATICALLY GENERATED. IT WILL BE O... |
combine_chunk_930 | combine.txt | 930 | 512 | l>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_discord-3.12.5-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_discord-3.12.5-py3-none-any.whl.sha512>`__)
<|file|>airflow/providers/discord/docs/commits.rst
.. Licensed to t... |
combine_chunk_931 | combine.txt | 931 | 512 | . 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. Se... |
combine_chunk_932 | combine.txt | 932 | 512 | {{ ti.task_id }} failed",
embed=Embed(
title="Hello ~~people~~ world :wave: The task {{ ti.task_id }} failed",
description="You can use [links](https://discord.com) or emojis :smile: 😎\n```\nAnd also code blocks\n```",
color=4... |
combine_chunk_933 | combine.txt | 933 | 512 | 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" ... |
combine_chunk_934 | combine.txt | 934 | 512 | under the License.
.. include:: /../../../devel-common/src/sphinx_exts/includes/security.rst
<|file|>airflow/providers/dingding/README.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional inform... |
combine_chunk_935 | combine.txt | 935 | 512 | .10.1``
``apache-airflow-providers-http``
========================================== ==================
The changelog for the provider package can be found in the
`changelog <https://airflow.apache.org/docs/apache-airflow-providers-dingding/3.10.1/changelog.html>`_.
<|file|>airflow/providers/dingding/docs/index.rst
... |
combine_chunk_936 | combine.txt | 936 | 512 | WRITTEN AT RELEASE TIME!
.. toctree::
:hidden:
:maxdepth: 1
:caption: Commits
Detailed list of commits <commits>
apache-airflow-providers-dingding package
------------------------------------------------------
`DingTalk <https://www.dingtalk.com/>`__
Release: 3.10.1
Provider package
-----------... |
combine_chunk_937 | combine.txt | 937 | 512 | -py3-none-any.whl.sha512>`__)
<|file|>airflow/providers/dingding/docs/commits.rst
.. 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 licens... |
combine_chunk_938 | combine.txt | 938 | 512 | 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.
.. include:: /../../../devel-common/src/sphinx_exts/includes/installing-providers-from-sources.rst
<|file|>airflow/provid... |
combine_chunk_939 | combine.txt | 939 | 512 | at_all`` to remind specific users when you send message,
``at_mobiles`` will be ignored When ``at_all`` is set to ``True``:
.. exampleinclude:: /../../dingding/tests/system/dingding/example_dingding.py
:language: python
:dedent: 4
:start-after: [START howto_operator_dingding_remind_users]
:end-before: ... |
combine_chunk_940 | combine.txt | 940 | 512 | 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 Lice... |
combine_chunk_941 | combine.txt | 941 | 512 | can find package information and changelog for the provider
in the `documentation <https://airflow.apache.org/docs/apache-airflow-providers-clickhousedb/1.0.1/>`_.
Installation
------------
You can install this package on top of an existing Airflow installation (see ``Requirements`` below
for the minimum Airflow ver... |
combine_chunk_942 | combine.txt | 942 | 512 | /index>
.. toctree::
:hidden:
:maxdepth: 1
:caption: References
Python API <_api/airflow/providers/clickhousedb/index>
.. toctree::
:hidden:
:maxdepth: 1
:caption: System tests
System Tests <_api/tests/system/clickhouse/index>
.. toctree::
:hidden:
:maxdepth: 1
:caption:... |
combine_chunk_943 | combine.txt | 943 | 512 | flow/providers/apache_airflow_providers_clickhousedb-1.0.1.tar.gz>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_clickhousedb-1.0.1.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_clickhousedb-1.0.1.tar.gz.sha512>`__)
* `The apache-airf... |
combine_chunk_944 | combine.txt | 944 | 512 | — the generic ``SQLExecuteQueryOperator`` handles DDL, DML, and analytical queries.
Using the Operator
^^^^^^^^^^^^^^^^^^
Set the ``conn_id`` argument to the ID of a
:ref:`ClickHouse connection <howto/connection:clickhouse>`.
.. list-table:: ClickHouse Airflow Connection Metadata
:widths: 25 25
:header-rows: ... |
combine_chunk_945 | combine.txt | 945 | 512 | 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 ... |
combine_chunk_946 | combine.txt | 946 | 512 | ``.
For high-level changelog, see :doc:`package information including changelog <index>`.
.. airflow-providers-commits::
<|file|>airflow/providers/clickhousedb/docs/installing-providers-from-sources.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the... |
combine_chunk_947 | combine.txt | 947 | 512 | __ library
which provides a DB-API 2.0 compliant interface.
Authenticating to ClickHouse
-----------------------------
Authenticate using a username and password. For ClickHouse Cloud and self-hosted clusters
with TLS enabled, set ``secure=True`` in the **Extra** field, and make sure to use the relevant port.
Defau... |
combine_chunk_948 | combine.txt | 948 | 512 | json
{
"max_execution_time": 300,
"max_memory_usage": 10000000000,
"max_threads": 8,
"readonly": 1
}
Settings set here act as **defaults** — any ``session_settings`` passed to the
:class:`~airflow.providers.clickhousedb.hooks.cli... |
combine_chunk_949 | combine.txt | 949 | 512 | KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
.. include:: /../../../devel-common/src/sphinx_exts/includes/security.rst
<|file|>airflow/providers/AGENTS.md
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.o... |
combine_chunk_950 | combine.txt | 950 | 512 | ments/` workflow is used only by
`airflow-core/`, `chart/`, and `dev/mypy/`. (`airflow-ctl/` follows the same "no newsfragments,
direct edit" pattern as providers — see `dev/README_RELEASE_AIRFLOWCTL.md`.)
When a provider change needs a user-visible note (typically a breaking change or important behavior
change that w... |
combine_chunk_951 | combine.txt | 951 | 512 | files.
- A kwarg that sets a proxy, endpoint URL, or hostname — attacker
redirects traffic to an MITM endpoint and harvests credentials or
tokens for *other* systems.
- A kwarg that toggles TLS verification, signing, or auth — attacker
silently downgrades security.
- A kwarg that controls subprocess execution, ... |
combine_chunk_952 | combine.txt | 952 | 512 | "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, WITHO... |
combine_chunk_953 | combine.txt | 953 | 512 | found in the
`changelog <https://airflow.apache.org/docs/apache-airflow-providers-salesforce/5.15.1/changelog.html>`_.
<|file|>airflow/providers/salesforce/docs/index.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed wi... |
combine_chunk_954 | combine.txt | 954 | 512 | : 1
:caption: Commits
Detailed list of commits <commits>
apache-airflow-providers-salesforce package
------------------------------------------------------
`Salesforce <https://www.salesforce.com/>`__
Release: 5.15.1
Provider package
----------------
This package is for the ``salesforce`` provider.
All ... |
combine_chunk_955 | combine.txt | 955 | 512 | _airflow_providers_salesforce-5.15.1-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_salesforce-5.15.1-py3-none-any.whl.sha512>`__)
<|file|>airflow/providers/salesforce/docs/operators/salesforce_apex_rest.rst
.. Licensed to the Apache Software Foundation (ASF... |
combine_chunk_956 | combine.txt | 956 | 512 | 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.a... |
combine_chunk_957 | combine.txt | 957 | 512 | /salesforce/example_bulk.py
:language: python
:dedent: 4
:start-after: [START howto_salesforce_bulk_update_operation]
:end-before: [END howto_salesforce_bulk_update_operation]
You can use this operator to access Bulk Upsert API:
.. exampleinclude:: /../../salesforce/tests/system/salesforce/example_bul... |
combine_chunk_958 | combine.txt | 958 | 512 | force``.
For high-level changelog, see :doc:`package information including changelog <index>`.
.. airflow-providers-commits::
<|file|>airflow/providers/salesforce/docs/installing-providers-from-sources.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See ... |
combine_chunk_959 | combine.txt | 959 | 512 | .
Use for Password authentication or IP Filtering.
Password (optional)
Specify the password associated with the account.
Use for Password authentication or IP Filtering.
Security Token (optional)
Specify the Salesforce security token for the username.
Use for Password authentication.
Consumer ... |
combine_chunk_960 | combine.txt | 960 | 512 | FLOW_CONN_SALESFORCE_DEFAULT='http://your_username:your_password@https%3A%2F%2Fyour_host.lightning.force.com?security_token=your_token'
<|file|>airflow/providers/salesforce/docs/security.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
... |
combine_chunk_961 | combine.txt | 961 | 512 | 0.0``
Alibaba Cloud integration (including `Alibaba Cloud <https://www.alibabacloud.com/>`__).
Provider package
----------------
This is a provider package for ``alibaba`` provider. All classes for this provider package
are in ``airflow.providers.alibaba`` python package.
You can find package information and chan... |
combine_chunk_962 | combine.txt | 962 | 512 | 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.
``apache-airflow-providers-alibaba``
====... |
combine_chunk_963 | combine.txt | 963 | 512 | ========== ========================================
PIP package Version required
========================================== ========================================
``apache-airflow`` ``>=2.11.0``
``apache-airflow-providers-common-compat`` ``>=1.13.0``
``aliba... |
combine_chunk_964 | combine.txt | 964 | 512 | 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 WARR... |
combine_chunk_965 | combine.txt | 965 | 512 | OSSCreateBucketOperator`` and ``OSSDeleteBucketOperator`` to create a
new OSS bucket with a given bucket name then delete it.
Defining tasks
""""""""""""""
In the following code we create a new bucket and then delete the bucket.
.. exampleinclude:: /../../alibaba/tests/system/alibaba/example_oss_bucket.py
:langu... |
combine_chunk_966 | combine.txt | 966 | 512 | /providers/alibaba/docs/commits.rst
.. 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 Licens... |
combine_chunk_967 | combine.txt | 967 | 512 | or implied. See the License for the
specific language governing permissions and limitations
under the License.
.. include:: /../../../devel-common/src/sphinx_exts/includes/installing-providers-from-sources.rst
<|file|>airflow/providers/alibaba/docs/connections/alibaba.rst
.. Licensed to the Apache Software... |
combine_chunk_968 | combine.txt | 968 | 512 |
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.... |
combine_chunk_969 | combine.txt | 969 | 512 | _base_log_folder = oss://my-bucket/path/to/logs
remote_log_conn_id = oss_default
In the above example, Airflow will try to use ``OSSHook('oss_default')``.
<|file|>airflow/providers/alibaba/docs/security.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. ... |
combine_chunk_970 | combine.txt | 970 | 512 | : ``5.7.1``
`Tableau <https://www.tableau.com/>`__
Provider package
----------------
This is a provider package for ``tableau`` provider. All classes for this provider package
are in ``airflow.providers.tableau`` python package.
You can find package information and changelog for the provider
in the `documentation... |
combine_chunk_971 | combine.txt | 971 | 512 | >
Changelog <changelog>
Security <security>
.. toctree::
:hidden:
:maxdepth: 1
:caption: References
Connection Types <connections/tableau>
Operators <operators>
Python API <_api/airflow/providers/tableau/index>
.. toctree::
:hidden:
:maxdepth: 1
:caption: System tests
... |
combine_chunk_972 | combine.txt | 972 | 512 | .org/airflow/providers/apache_airflow_providers_tableau-5.7.1.tar.gz>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_tableau-5.7.1.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_tableau-5.7.1.tar.gz.sha512>`__)
* `The apache-airflow-pro... |
combine_chunk_973 | combine.txt | 973 | 512 | for versions provider package: ``tableau``.
For high-level changelog, see :doc:`package information including changelog <index>`.
.. airflow-providers-commits::
<|file|>airflow/providers/tableau/docs/installing-providers-from-sources.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more cont... |
combine_chunk_974 | combine.txt | 974 | 512 | -python/docs/api-ref#tableauauth-class>`_
i.e. add a ``password`` and ``login`` to the Airflow connection.
2. Use a `Token Authentication
<https://tableau.github.io/server-client-python/docs/api-ref#personalaccesstokenauth-class>`_
i.e. add a ``token_name`` and ``personal_access_token`` to the Airflow connecti... |
combine_chunk_975 | combine.txt | 975 | 512 | for both token and password Authentication.
* ``token_name``: The personal access token name.
This is used with token authentication.
* ``personal_access_token``: The personal access token value.
This is used with token authentication.
* ``verify``: Either a boolean, in which case it controls w... |
combine_chunk_976 | combine.txt | 976 | 512 |
| **resource**: The name of the resource to use. **str**
| **method**: The name of the resource's method to execute. **str**
| **find**: The reference of resource that will receive the action. **str**
| **match_with**: The resource field name to be matched with find parameter. **str** - Default: **id**
| **site_id**:... |
combine_chunk_977 | combine.txt | 977 | 512 | - ``remove``
* - **workbooks**
- ``delete``, ``refresh``
An example usage of the TableauOperator is as follows:
.. exampleinclude:: /../../tableau/tests/system/tableau/example_tableau.py
:language: python
:start-after: [START howto_operator_tableau]
:end-before: [END howto_operator_tableau]
... |
combine_chunk_978 | combine.txt | 978 | 512 | external tools. A short delay in its handler exercises background invocation and polling.
The app uses the server's default in-process Runtime Store. Run it on one app instance; the test does not cover persistence or recovery across app restarts.
## Deploy the app
From the Airflow checkout, upload this directory an... |
combine_chunk_979 | combine.txt | 979 | 512 | the deployment.
## Clean up
Stop app compute after the test:
```bash
databricks apps stop airflow-system-test-agent --profile YOUR_PROFILE
```
Delete the app when it is no longer needed with `databricks apps delete airflow-system-test-agent --profile YOUR_PROFILE`.
<|file|>airflow/providers/databricks/README.rst
... |
combine_chunk_980 | combine.txt | 980 | 512 | required
========================================== ==================================================================
``apache-airflow`` ``>=2.11.0``
``apache-airflow-providers-common-compat`` ``>=1.23.0``
``apache-airflow-providers-common-sql`` ``>=1.32.0``
``requests`` ... |
combine_chunk_981 | combine.txt | 981 | 512 | Optional dependencies
----------------------
================== ================================================================================================================================================================
Extra Dependencies
================== ========================================... |
combine_chunk_982 | combine.txt | 982 | 512 | ::
:hidden:
:maxdepth: 1
:caption: Basics
Home <self>
Changelog <changelog>
Security <security>
.. toctree::
:hidden:
:maxdepth: 1
:caption: Guides
Connection types <connections/databricks>
Operators <operators/index>
Toolsets <toolsets/index>
Plugins <plugins/inde... |
combine_chunk_983 | combine.txt | 983 | 512 | ``>=1.32.0``
``requests`` ``>=2.32.0,<3``
``tenacity`` ``>=8.3.0``
``databricks-sql-connector`` ``>=4.4.0``
``aiohttp`` ``>=3.14.0,<4``
``mergedeep`` ``>=1.3.4``
``pandas`` ... |
combine_chunk_984 | combine.txt | 984 | 512 | ro]
================== ================================================================================================================================================================
Extra Dependencies
================== ================================================================================... |
combine_chunk_985 | combine.txt | 985 | 512 | .whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_databricks-7.24.0-py3-none-any.whl.sha512>`__)
<|file|>airflow/providers/databricks/docs/operators/index.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the... |
combine_chunk_986 | combine.txt | 986 | 512 | https://docs.databricks.com/dev-tools/api/latest/repos.html#operation/delete-repo>`_ API endpoint.
Using the Operator
^^^^^^^^^^^^^^^^^^
To use this operator you need to provide either ``repo_path`` or ``repo_id``.
.. list-table::
:widths: 15 25
:header-rows: 1
* - Parameter
- Input
* - repo_path:... |
combine_chunk_987 | combine.txt | 987 | 512 | limitations
under the License.
DatabricksReposUpdateOperator
=============================
Use the :class:`~airflow.providers.databricks.operators.DatabricksReposUpdateOperator` to update code in an existing
`Databricks Repos <https://docs.databricks.com/repos/index.html>`_ to a given Git branch or tag
via `ap... |
combine_chunk_988 | combine.txt | 988 | 512 | .. 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"); y... |
combine_chunk_989 | combine.txt | 989 | 512 | _limit: integer
- amount of times retry if the Databricks backend is unreachable.
* - databricks_retry_delay: decimal
- minimum wait in seconds between retryable attempts (exponential backoff by default).
Examples
--------
Create a Databricks Repo
^^^^^^^^^^^^^^^^^^^^^^^^
An example usage of the Databri... |
combine_chunk_990 | combine.txt | 990 | 512 | ✅ ✅
Retry from beginning ✅ ✅
Retry single task ✅ ✅
Task groups within Workflows ✅... |
combine_chunk_991 | combine.txt | 991 | 512 | ://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 ... |
combine_chunk_992 | combine.txt | 992 | 512 | params as Databricks job parameters
----------------------------------------------------------
The Databricks ``api/2.2/jobs/create`` endpoint accepts a top-level ``parameters`` field
that defines `job-level parameters
<https://docs.databricks.com/api/workspace/jobs/create#parameters>`_ — a list of objects
with a ``n... |
combine_chunk_993 | combine.txt | 993 | 512 | /tests/system/databricks/example_databricks.py
:language: python
:start-after: [START howto_operator_databricks_jobs_create_named]
:end-before: [END howto_operator_databricks_jobs_create_named]
Pairing with DatabricksRunNowOperator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can use the ``job_id`` that is r... |
combine_chunk_994 | combine.txt | 994 | 512 |
:language: python
:start-after: [START howto_operator_databricks_task_notebook]
:end-before: [END howto_operator_databricks_task_notebook]
Running a SQL query in Databricks using DatabricksTaskOperator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. exampleinclude:: /../../databricks/tes... |
combine_chunk_995 | combine.txt | 995 | 512 | in the run continue independently.
<|file|>airflow/providers/databricks/docs/operators/sql.rst
.. 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. T... |
combine_chunk_996 | combine.txt | 996 | 512 | -before: [END howto_operator_databricks_sql_select]
Selecting data into a file
^^^^^^^^^^^^^^^^^^^^^^^^^^
An example usage of the DatabricksSqlOperator to select data from a table and store in a file is as follows:
.. exampleinclude:: /../../databricks/tests/system/databricks/example_databricks_sql.py
:language:... |
combine_chunk_997 | combine.txt | 997 | 512 | _id="sensor_with_tags",
sql_warehouse_name="my_warehouse",
sql="SELECT 1 FROM my_table WHERE status = 'ready'",
query_tags={"team": "data-eng", "env": "prod"}, # merged with Airflow context tags
include_airflow_query_tags=True, # adds dag_id, task_id, run_id, try_number, map_index
... |
combine_chunk_998 | combine.txt | 998 | 512 | range or limit of values, such as partition_name >= partition_value). `Databricks comparison operators <https://docs.databricks.com/sql/language-manual/sql-ref-null-semantics.html#comparison-operators>`_ are supported.
* One of ``sql_warehouse_name`` (name of Databricks SQL warehouse to use) or ``http_path`` (HTTP ... |
combine_chunk_999 | combine.txt | 999 | 512 | .com/dev-tools/api/latest/jobs.html#operation/JobsRunNow>`_ API endpoint.
Using the Operator
^^^^^^^^^^^^^^^^^^
There are two ways to instantiate this operator. In the first way, you can take the JSON payload that you typically use
to call the ``api/2.2/jobs/run-now`` endpoint and pass it directly to our ``Databrick... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.