airflow.providers.postgres.hooks.postgres

Module Contents

airflow.providers.postgres.hooks.postgres.CursorType[source]
class airflow.providers.postgres.hooks.postgres.PostgresHook(*args, **kwargs)[source]

Bases: airflow.hooks.dbapi.DbApiHook

Interact with Postgres.

You can specify ssl parameters in the extra field of your connection as {"sslmode": "require", "sslcert": "/path/to/cert.pem", etc}. Also you can choose cursor as {"cursor": "dictcursor"}. Refer to the psycopg2.extras for more details.

Note: For Redshift, use keepalives_idle in the extra connection parameters and set it to less than 300 seconds.

Note: For AWS IAM authentication, use iam in the extra connection parameters and set it to true. Leave the password field empty. This will use the “aws_default” connection to get the temporary token unless you override in extras. extras example: {"iam":true, "aws_conn_id":"my_aws_conn"} For Redshift, also use redshift in the extra connection parameters and set it to true. The cluster-identifier is extracted from the beginning of the host field, so is optional. It can however be overridden in the extra field. extras example: {"iam":true, "redshift":true, "cluster-identifier": "my_cluster_id"}

Parameters

postgres_conn_id (str) – The postgres conn id reference to a specific postgres database.

conn_name_attr = postgres_conn_id[source]
default_conn_name = postgres_default[source]
conn_type = postgres[source]
hook_name = Postgres[source]
supports_autocommit = True[source]
get_conn(self)[source]

Establishes a connection to a postgres database.

copy_expert(self, sql: str, filename: str)[source]

Executes SQL using psycopg2 copy_expert method. Necessary to execute COPY command without access to a superuser.

Note: if this method is called with a “COPY FROM” statement and the specified input file does not exist, it creates an empty file and no data is loaded, but the operation succeeds. So if users want to be aware when the input file does not exist, they have to check its existence by themselves.

bulk_load(self, table: str, tmp_file: str)[source]

Loads a tab-delimited file into a database table

bulk_dump(self, table: str, tmp_file: str)[source]

Dumps a database table into a tab-delimited file

get_iam_token(self, conn: Connection)[source]

Uses AWSHook to retrieve a temporary password to connect to Postgres or Redshift. Port is required. If none is provided, default is used for each service

get_table_primary_key(self, table: str, schema: Optional[str] = 'public')[source]

Helper method that returns the table primary key

Parameters
  • table (str) – Name of the target table

  • table – Name of the target schema, public by default

Returns

Primary key columns list

Return type

List[str]

Was this entry helpful?