psql2rabbitmq 1.0.4

Asynchronous PostgreSQL data read and publish to RabbitMQ library

psql2rabbitmq

psql2rabbitmq is a library that asynchronously forwards postgresql data to the RabbitMQ message queue in the requested template. Using the library, the parametrically given query is run, and the data obtained is converted into the format specified as a template and forwarded to the message queue.

Installation

You can install this library easily with pip. pip install psql2rabbitmq

Usage

As a library

import os
import asyncio
from psql2rabbitmq import perform_task

if __name__ == '__main__':
    logger = logging.getLogger("psql2rabbitmq")
    logger.setLevel(os.environ.get('LOG_LEVEL', "DEBUG"))
    handler = logging.StreamHandler()
    handler.setFormatter(
        logging.Formatter(
            os.environ.get('LOG_FORMAT', "%(asctime)s [%(levelname)s] %(name)s: %(message)s")
        )
    )
    logger.addHandler(handler)

    config = {
      "mq_host": os.environ.get('MQ_HOST'),
	    "mq_port": int(os.environ.get('MQ_PORT', '5672')), 
	    "mq_vhost": os.environ.get('MQ_VHOST'),
	    "mq_user": os.environ.get('MQ_USER'),
	    "mq_pass": os.environ.get('MQ_PASS'),
	    "mq_exchange": os.environ.get('MQ_EXCHANGE', 'psql2rabbitmq'),
      "mq_routing_key": os.environ.get('MQ_ROUTING_KEY', 'psql2rabbitmq'),
	    "db_host": os.environ.get('DB_HOST'),
	    "db_port": int(os.environ.get('DB_PORT', '5432')),
	    "db_user": os.environ.get('DB_USER'),
	    "db_pass": os.environ.get('DB_PASS'),
	    "db_database": os.environ.get('DB_DATABASE'),
      "sql_file_path": os.environ.get('SQL_FILE_PATH'),
      "data_template_file_path": os.environ.get('DATA_TEMPLATE_FILE_PATH'),
      "consumer_pool_size": os.environ.get('CONSUMER_POOL_SIZE'),
      "sql_fetch_size": os.environ.get('SQL_FETCH_SIZE') 
    }

    sql_file_path = """/usr/home/your_sql_file"""
    data_template_file_path = """/usr/home/your_data_template_file""" 
    loop = asyncio.get_event_loop()
    try:
      loop.run_until_complete(
        perform_task(
          loop=loop,
          consumer_pool_size=10,
          sql_file_path=sql_file_path,
          config=config,
          consumer_pool_size=10, 
          sql_fetch_size=1000
        )
      )
    finally:
      loop.close()

This library uses aio_pika, aiopg, jinja2 and psycopg2 packages.

Standalone

You can also call this library as standalone job command. Just set required environment variables and run psql2rabbitmq. This usecase perfectly fits when you need run it on cronjobs or kubernetes jobs.

Required environment variables:

• MQ_HOST
• MQ_PORT (optional)
• MQ_VHOST
• MQ_USER
• MQ_PASS
• MQ_EXCHANGE
• MQ_ROUTING_KEY
• DB_HOST
• DB_PORT (optional)
• DB_USER
• DB_PASS
• DB_DATABASE
• SQL_FILE_PATH (File path contain sql query. Ex: /usr/home/your_sql_file)
• DATA_TEMPLATE_FILE_PATH (File path contain reqested data template. Ex: /usr/home/your_data_template_file)
• CONSUMER_POOL_SIZE (optional, default value: 10)
• SQL_FETCH_SIZE (optional, default value: 1000)
• LOG_LEVEL (Logging level. See: Python logging module docs)

Example Kubernetes job: You can see it to kube.yaml