Skip to content

Instantly share code, notes, and snippets.

@fpopic
Last active May 19, 2021 19:44
Show Gist options
  • Save fpopic/35807489d9c36c7ea8bc4de6f966b5fc to your computer and use it in GitHub Desktop.
Save fpopic/35807489d9c36c7ea8bc4de6f966b5fc to your computer and use it in GitHub Desktop.
import logging
from airflow.hooks.postgres_hook import PostgresHook
from airflow.models import BaseOperator
from airflow.utils.decorators import apply_defaults
class SelectPostgresOperator(BaseOperator):
"""
Executes sql code in a specific Postgres database
and returns table result as a pandas dataframe
:param postgres_conn_id: reference to a specific postgres database
:type postgres_conn_id: string
:param sql: the sql code to be executed
:type sql: Can receive a str representing a sql statement,
a list of str (sql statements), or reference to a template file.
Template reference are recognized by str ending in '.sql'
"""
template_fields = ('sql',)
template_ext = ('.sql',)
ui_color = '#ededed'
@apply_defaults
def __init__(
self, sql,
postgres_conn_id='select_postgres_default', autocommit=False,
parameters=None,
*args, **kwargs):
super(SelectPostgresOperator, self).__init__(*args, **kwargs)
self.sql = sql
self.postgres_conn_id = postgres_conn_id
self.hook = PostgresHook(postgres_conn_id=self.postgres_conn_id)
self.autocommit = autocommit
self.parameters = parameters
def execute(self, context):
logging.info("Executing: " + str(self.sql))
df = self.hook.get_pandas_df(self.sql, parameters=self.parameters)
logging.info("Result count: {0}".format(len(df)))
return df
@maryampashmi
Copy link

@fpopic is this code finally worked for you? Have you updated the correct version? I have exactly the same issue..

@maryampashmi
Copy link

I am using airflow 2.0.2, and this is my modification, is this ok?

#
# 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.
from typing import Iterable, Mapping, Optional, Union

from airflow.models import BaseOperator
from airflow.providers.postgres.hooks.postgres import PostgresHook
from airflow.utils.decorators import apply_defaults



class PostgresOperator(BaseOperator):
    """
    Executes sql code in a specific Postgres database

    :param sql: the sql code to be executed. (templated)
    :type sql: Can receive a str representing a sql statement,
        a list of str (sql statements), or reference to a template file.
        Template reference are recognized by str ending in '.sql'
    :param postgres_conn_id: The :ref:`postgres conn id <howto/connection:postgres>`
        reference to a specific postgres database.
    :type postgres_conn_id: str
    :param autocommit: if True, each command is automatically committed.
        (default value: False)
    :type autocommit: bool
    :param parameters: (optional) the parameters to render the SQL query with.
    :type parameters: dict or iterable
    :param database: name of database which overwrite defined one in connection
    :type database: str
    """


    template_fields = ('sql',)


    template_fields_renderers = {'sql': 'sql'}


    template_ext = ('.sql',)


    ui_color = '#ededed'


    @apply_defaults
    def __init__(
        self,
        *,
        sql: str,
        postgres_conn_id: str = 'postgres_default',
        autocommit: bool = False,
        parameters: Optional[Union[Mapping, Iterable]] = None,
        database: Optional[str] = None,
        **kwargs,
    ) -> None:
        super().__init__(**kwargs)
        self.sql = sql
        self.postgres_conn_id = postgres_conn_id
        self.autocommit = autocommit
        self.parameters = parameters
        self.database = database
        self.hook = None


    def execute(self, context):
        self.log.info('Executing: %s', self.sql)
        self.hook = PostgresHook(postgres_conn_id=self.postgres_conn_id, schema=self.database)
        run = self.hook.run(self.sql, self.autocommit, parameters=self.parameters)
        for output in self.hook.conn.notices:
            self.log.info(output)

        return run

@fpopic
Copy link
Author

fpopic commented May 19, 2021

@fpopic is this code finally worked for you? Have you updated the correct version? I have exactly the same issue..

I think it did. You can see in revisions https://gist.github.com/fpopic/35807489d9c36c7ea8bc4de6f966b5fc/revisions that I swapped 32 and 34 lines. :) Didn't use for a while so don't know what's the state today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment