airflow/providers/common/io/provider.yaml

# 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-name: apache-airflow-providers-common-io
name: Common IO
description: |
  ``Common IO Provider``

state: ready
source-date-epoch: 1715384419
# note that those versions are maintained by release manager - do not update them manually
versions:
  - 1.3.1
  - 1.3.0
  - 1.2.0
  - 1.1.0
  - 1.0.1
  - 1.0.0

dependencies:
  - apache-airflow>=2.8.0

integrations:
  - integration-name: Common IO
    external-doc-url: https://filesystem-spec.readthedocs.io/en/latest/index.html
    how-to-guide:
      - /docs/apache-airflow-providers-common-io/operators.rst
    tags: [software]

operators:
  - integration-name: Common IO
    python-modules:
      - airflow.providers.common.io.operators.file_transfer

xcom:
  - airflow.providers.common.io.xcom.backend

config:
  common.io:
    description: Common IO configuration section
    options:
      xcom_objectstorage_path:
        description: |
          Path to a location on object storage where XComs can be stored in url format.
        version_added: 1.3.0
        type: string
        example: "s3://conn_id@bucket/path"
        default: ""
      xcom_objectstorage_threshold:
        description: |
          Threshold in bytes for storing XComs in object storage. -1 means always store in the
          database. 0 means always store in object storage. Any positive number means
          it will be stored in object storage if the size of the value is greater than the threshold.
        version_added: 1.3.0
        type: integer
        example: "1000000"
        default: "-1"
      xcom_objectstorage_compression:
        description: |
          Compression algorithm to use when storing XComs in object storage. Supported algorithms
          are a.o.: snappy, zip, gzip, bz2, and lzma. If not specified, no compression will be used.
          Note that the compression algorithm must be available in the Python installation (e.g.
          python-snappy for snappy). Zip, gz, bz2 are available by default.
        version_added: 1.3.0
        type: string
        example: "gz"
        default: ""