airflow.providers.cloudant.hooks.cloudant

Hook for Cloudant.

Module Contents

Classes

CloudantHook

Interact with Cloudant. This class is a thin wrapper around the cloudant python library.
class airflow.providers.cloudant.hooks.cloudant.CloudantHook(cloudant_conn_id=default_conn_name)[source]

Bases: airflow.hooks.base.BaseHook

Interact with Cloudant. This class is a thin wrapper around the cloudant python library.

See also

the latest documentation here.

Parameters

cloudant_conn_id (str) – The connection id to authenticate and get a session object from cloudant.

conn_name_attr = 'cloudant_conn_id'[source]
default_conn_name = 'cloudant_default'[source]
conn_type = 'cloudant'[source]
hook_name = 'Cloudant'[source]
classmethod get_ui_field_behaviour()[source]

Return custom field behaviour.

get_conn()[source]

Open a connection to the cloudant service and close it automatically if used as context manager.

Note

In the connection form: - ‘host’ equals the ‘Account’ (optional) - ‘login’ equals the ‘Username (or API Key)’ (required) - ‘password’ equals the ‘Password’ (required)

Returns

an authorized cloudant session context manager object.

Return type

cloudant.cloudant

Was this entry helpful?