-
Notifications
You must be signed in to change notification settings - Fork 14.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Apache Beam operators #12814
Merged
Merged
Add Apache Beam operators #12814
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
5f2bd80
Add Apache Beam operators
33f756e
Refactor common logic to Apache Beam and Dataflow
1da37cf
Fix backport wheels
b233f6e
Add howto guide
d3f8799
Update provider Readme
54749a1
Update airflow/providers/apache/beam/hooks/beam.py
1a4844e
Add changelog
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
<!-- | ||
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. | ||
--> | ||
|
||
|
||
# Package apache-airflow-backport-providers-apache-beam | ||
|
||
Release: | ||
|
||
**Table of contents** | ||
|
||
- [Backport package](#backport-package) | ||
- [Installation](#installation) | ||
- [PIP requirements](#pip-requirements) | ||
- [Cross provider package dependencies](#cross-provider-package-dependencies) | ||
- [Provider class summary](#provider-classes-summary) | ||
- [Operators](#operators) | ||
- [Moved operators](#moved-operators) | ||
- [Transfer operators](#transfer-operators) | ||
- [Moved transfer operators](#moved-transfer-operators) | ||
- [Hooks](#hooks) | ||
- [Moved hooks](#moved-hooks) | ||
- [Releases](#releases) | ||
- [Release](#release) | ||
|
||
## Backport package | ||
|
||
This is a backport providers package for `apache.beam` provider. All classes for this provider package | ||
are in `airflow.providers.apache.beam` python package. | ||
|
||
**Only Python 3.6+ is supported for this backport package.** | ||
|
||
While Airflow 1.10.* continues to support Python 2.7+ - you need to upgrade python to 3.6+ if you | ||
want to use this backport package. | ||
|
||
|
||
## Installation | ||
|
||
You can install this package on top of an existing airflow 1.10.* installation via | ||
`pip install apache-airflow-backport-providers-apache-beam` | ||
|
||
## Cross provider package dependencies | ||
|
||
Those are dependencies that might be needed in order to use all the features of the package. | ||
You need to install the specified backport providers package in order to use them. | ||
|
||
You can install such cross-provider dependencies when installing from PyPI. For example: | ||
|
||
```bash | ||
pip install apache-airflow-beckport-providers-apache-beam[google] | ||
``` | ||
|
||
| Dependent package | Extra | | ||
|:----------------------------------------------------------------------------------------------------------|:------------| | ||
| [apache-airflow-providers-apache-google](https://pypi.org/project/apache-airflow-providers-apache-google) | google | | ||
|
||
|
||
# Provider classes summary | ||
|
||
In Airflow 2.0, all operators, transfers, hooks, sensors, secrets for the `apache.beam` provider | ||
are in the `airflow.providers.apache.beam` package. You can read more about the naming conventions used | ||
in [Naming conventions for provider packages](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#naming-conventions-for-provider-packages) | ||
|
||
|
||
## Operators | ||
|
||
### New operators | ||
|
||
| New Airflow 2.0 operators: `airflow.providers.apache.beam` package | | ||
|:-----------------------------------------------------------------------------------------------------------------------------------------------| | ||
| [operators.beam.BeamRunJavaPipelineOperator](https://github.com/apache/airflow/blob/master/airflow/providers/apache/beam/operators/beam.py) | | ||
| [operators.beam.BeamRunPythonPipelineOperator](https://github.com/apache/airflow/blob/master/airflow/providers/apache/beam/operators/beam.py) | | ||
|
||
|
||
## Hooks | ||
|
||
### New hooks | ||
|
||
| New Airflow 2.0 hooks: `airflow.providers.apache.beam` package | | ||
|:-----------------------------------------------------------------------------------------------------------------| | ||
| [hooks.beam.BeamHook](https://github.com/apache/airflow/blob/master/airflow/providers/apache/beam/hooks/beam.py) | | ||
|
||
|
||
## Releases |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
.. 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. | ||
|
||
|
||
Changelog | ||
--------- | ||
|
||
1.0.0 | ||
..... | ||
|
||
Initial version of the provider. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
<!-- | ||
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. | ||
--> | ||
|
||
|
||
# Package apache-airflow-providers-apache-beam | ||
|
||
Release: 0.0.1 | ||
|
||
**Table of contents** | ||
|
||
- [Provider package](#provider-package) | ||
- [Installation](#installation) | ||
- [PIP requirements](#pip-requirements) | ||
- [Cross provider package dependencies](#cross-provider-package-dependencies) | ||
- [Provider class summary](#provider-classes-summary) | ||
- [Operators](#operators) | ||
- [Transfer operators](#transfer-operators) | ||
- [Hooks](#hooks) | ||
- [Releases](#releases) | ||
|
||
## Provider package | ||
|
||
This is a provider package for `apache.beam` provider. All classes for this provider package | ||
are in `airflow.providers.apache.beam` python package. | ||
|
||
## Installation | ||
|
||
NOTE! | ||
|
||
On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver | ||
does not yet work with Apache Airflow and might lead to errors in installation - depends on your choice | ||
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4 | ||
`pip install --upgrade pip==20.2.4` or, in case you use Pip 20.3, you need to add option | ||
`--use-deprecated legacy-resolver` to your pip install command. | ||
|
||
You can install this package on top of an existing airflow 2.* installation via | ||
`pip install apache-airflow-providers-apache-beam` | ||
|
||
## Cross provider package dependencies | ||
|
||
Those are dependencies that might be needed in order to use all the features of the package. | ||
You need to install the specified backport providers package in order to use them. | ||
|
||
You can install such cross-provider dependencies when installing from PyPI. For example: | ||
|
||
```bash | ||
pip install apache-airflow-providers-apache-beam[google] | ||
``` | ||
|
||
| Dependent package | Extra | | ||
|:--------------------------------------------------------------------------------------------|:------------| | ||
| [apache-airflow-providers-google](https://pypi.org/project/apache-airflow-providers-google) | google | | ||
|
||
|
||
# Provider classes summary | ||
|
||
In Airflow 2.0, all operators, transfers, hooks, sensors, secrets for the `apache.beam` provider | ||
are in the `airflow.providers.apache.beam` package. You can read more about the naming conventions used | ||
in [Naming conventions for provider packages](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#naming-conventions-for-provider-packages) | ||
|
||
|
||
## Operators | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we add info here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure. I improved Readme |
||
### New operators | ||
|
||
| New Airflow 2.0 operators: `airflow.providers.apache.beam` package | | ||
|:-----------------------------------------------------------------------------------------------------------------------------------------------| | ||
| [operators.beam.BeamRunJavaPipelineOperator](https://github.com/apache/airflow/blob/master/airflow/providers/apache/beam/operators/beam.py) | | ||
| [operators.beam.BeamRunPythonPipelineOperator](https://github.com/apache/airflow/blob/master/airflow/providers/apache/beam/operators/beam.py) | | ||
|
||
|
||
## Hooks | ||
|
||
### New hooks | ||
|
||
| New Airflow 2.0 hooks: `airflow.providers.apache.beam` package | | ||
|:-----------------------------------------------------------------------------------------------------------------| | ||
| [hooks.beam.BeamHook](https://github.com/apache/airflow/blob/master/airflow/providers/apache/beam/hooks/beam.py) | | ||
|
||
|
||
## Releases |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# | ||
# 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# | ||
# 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. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is more that could be added here related to hooks, and operators maybe?