|
| 1 | +<!-- |
| 2 | + Licensed to the Apache Software Foundation (ASF) under one |
| 3 | + or more contributor license agreements. See the NOTICE file |
| 4 | + distributed with this work for additional information |
| 5 | + regarding copyright ownership. The ASF licenses this file |
| 6 | + to you under the Apache License, Version 2.0 (the |
| 7 | + "License"); you may not use this file except in compliance |
| 8 | + with the License. You may obtain a copy of the License at |
| 9 | +
|
| 10 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +
|
| 12 | + Unless required by applicable law or agreed to in writing, |
| 13 | + software distributed under the License is distributed on an |
| 14 | + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + KIND, either express or implied. See the License for the |
| 16 | + specific language governing permissions and limitations |
| 17 | + under the License. |
| 18 | + --> |
| 19 | + |
| 20 | + |
| 21 | +# Package apache-airflow-providers-apache-beam |
| 22 | + |
| 23 | +Release: 0.0.1 |
| 24 | + |
| 25 | +**Table of contents** |
| 26 | + |
| 27 | +- [Provider package](#provider-package) |
| 28 | +- [Installation](#installation) |
| 29 | +- [PIP requirements](#pip-requirements) |
| 30 | +- [Cross provider package dependencies](#cross-provider-package-dependencies) |
| 31 | +- [Provider class summary](#provider-classes-summary) |
| 32 | + - [Operators](#operators) |
| 33 | + - [Transfer operators](#transfer-operators) |
| 34 | + - [Hooks](#hooks) |
| 35 | +- [Releases](#releases) |
| 36 | + |
| 37 | +## Provider package |
| 38 | + |
| 39 | +This is a provider package for `apache.beam` provider. All classes for this provider package |
| 40 | +are in `airflow.providers.apache.beam` python package. |
| 41 | + |
| 42 | +## Installation |
| 43 | + |
| 44 | +NOTE! |
| 45 | + |
| 46 | +On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver |
| 47 | +does not yet work with Apache Airflow and might lead to errors in installation - depends on your choice |
| 48 | +of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4 |
| 49 | +`pip install --upgrade pip==20.2.4` or, in case you use Pip 20.3, you need to add option |
| 50 | +`--use-deprecated legacy-resolver` to your pip install command. |
| 51 | + |
| 52 | +You can install this package on top of an existing airflow 2.* installation via |
| 53 | +`pip install apache-airflow-providers-apache-beam` |
| 54 | + |
| 55 | +## Cross provider package dependencies |
| 56 | + |
| 57 | +Those are dependencies that might be needed in order to use all the features of the package. |
| 58 | +You need to install the specified backport providers package in order to use them. |
| 59 | + |
| 60 | +You can install such cross-provider dependencies when installing from PyPI. For example: |
| 61 | + |
| 62 | +```bash |
| 63 | +pip install apache-airflow-providers-apache-beam[google] |
| 64 | +``` |
| 65 | + |
| 66 | +| Dependent package | Extra | |
| 67 | +|:--------------------------------------------------------------------------------------------|:------------| |
| 68 | +| [apache-airflow-providers-google](https://pypi.org/project/apache-airflow-providers-google) | google | |
| 69 | + |
| 70 | + |
| 71 | +# Provider classes summary |
| 72 | + |
| 73 | +In Airflow 2.0, all operators, transfers, hooks, sensors, secrets for the `apache.beam` provider |
| 74 | +are in the `airflow.providers.apache.beam` package. You can read more about the naming conventions used |
| 75 | +in [Naming conventions for provider packages](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#naming-conventions-for-provider-packages) |
| 76 | + |
| 77 | + |
| 78 | +## Operators |
| 79 | + |
| 80 | +### New operators |
| 81 | + |
| 82 | +| New Airflow 2.0 operators: `airflow.providers.apache.beam` package | |
| 83 | +|:-----------------------------------------------------------------------------------------------------------------------------------------------| |
| 84 | +| [operators.beam.BeamRunJavaPipelineOperator](https://github.com/apache/airflow/blob/master/airflow/providers/apache/beam/operators/beam.py) | |
| 85 | +| [operators.beam.BeamRunPythonPipelineOperator](https://github.com/apache/airflow/blob/master/airflow/providers/apache/beam/operators/beam.py) | |
| 86 | + |
| 87 | + |
| 88 | +## Hooks |
| 89 | + |
| 90 | +### New hooks |
| 91 | + |
| 92 | +| New Airflow 2.0 hooks: `airflow.providers.apache.beam` package | |
| 93 | +|:-----------------------------------------------------------------------------------------------------------------| |
| 94 | +| [hooks.beam.BeamHook](https://github.com/apache/airflow/blob/master/airflow/providers/apache/beam/hooks/beam.py) | |
| 95 | + |
| 96 | + |
| 97 | +## Releases |
0 commit comments