Back to Airflow

Provider package

providers/ibm/mq/README.rst

3.3.0b14.2 KB
Original Source

.. 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.

.. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!

.. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FILE, YOU SHOULD MODIFY THE TEMPLATE PROVIDER_README_TEMPLATE.rst.jinja2 IN the dev/breeze/src/airflow_breeze/templates DIRECTORY

Package apache-airflow-providers-ibm-mq

Release: 0.1.0

IBM MQ <https://www.ibm.com/products/mq/>__

Provider package

This is a provider package for ibm.mq provider. All classes for this provider package are in airflow.providers.ibm.mq python package.

You can find package information and changelog for the provider in the documentation <https://airflow.apache.org/docs/apache-airflow-providers-ibm-mq/0.1.0/>_.

Installation

You can install this package on top of an existing Airflow 2 installation (see Requirements below for the minimum Airflow version supported) via

pip install apache-airflow-providers-ibm-mq

This installs only the provider package. To use the IBM MQ operators at runtime you also need the ibmmq dependency, which can be installed via the provider extra:

pip install apache-airflow-providers-ibm-mq[ibmmq]

The ibmmq extra installs the Python wrapper for the IBM MQ client that is required by the provider hooks and operators.

Note that the ibmmq <https://github.com/ibm-messaging/mq-mqi-python/>_ Python package requires the native IBM MQ Redistributable Client <https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=overview-redistributable-mq-clients>_ libraries to be installed on the system.

Refer to the IBM MQ documentation for installation instructions for your platform.

The package supports the following python versions: 3.10,3.11,3.12,3.13

Requirements

========================================== ====================================== PIP package Version required ========================================== ====================================== apache-airflow >=2.11.0 apache-airflow-providers-common-compat >=1.12.0 asgiref >=2.3.0; python_version < "3.14" asgiref >=3.11.1; python_version >= "3.14" ========================================== ======================================

======================================================================================================================== ==================== Dependent package Extra ======================================================================================================================== ==================== apache-airflow-providers-common-compat <https://airflow.apache.org/docs/apache-airflow-providers-common-compat>_ common.compat apache-airflow-providers-common-messaging <https://airflow.apache.org/docs/apache-airflow-providers-common-messaging>_ common.messaging ======================================================================================================================== ====================

Optional dependencies

========== ================ Extra Dependencies ========== ================ ibmmq ibmmq>=2.0.4 ========== ================

The changelog for the provider package can be found in the changelog <https://airflow.apache.org/docs/apache-airflow-providers-ibm-mq/0.1.0/changelog.html>_.