Oracle Connection

The Oracle connection type provides connection to a Oracle database.

Configuring the Connection

Host (optional)

The host to connect to.

Schema (optional)

Specify the schema name to be used in the database.

Login (optional)

Specify the user name to connect.

Password (optional)

Specify the password to connect.

Extra (optional)

Specify the extra parameters (as json dictionary) that can be used in Oracle connection. The following parameters are supported:

  • encoding - The encoding to use for regular database strings. If not specified, the environment variable NLS_LANG is used. If the environment variable NLS_LANG is not set, ASCII is used.

  • nencoding - The encoding to use for national character set database strings. If not specified, the environment variable NLS_NCHAR is used. If the environment variable NLS_NCHAR is not used, the environment variable NLS_LANG is used instead, and if the environment variable NLS_LANG is not set, ASCII is used.

  • threaded - Whether or not Oracle should wrap accesses to connections with a mutex. Default value is False.

  • events - Whether or not to initialize Oracle in events mode.

  • mode - one of sysdba, sysasm, sysoper, sysbkp, sysdgd, syskmt or sysrac which are defined at the module level, Default mode is connecting.

  • purity - one of new, self, default. Specify the session acquired from the pool. configuration parameter.

  • dsn. Specify a Data Source Name (and ignore Host).

  • sid or service_name. Use to form DSN instead of Schema.

Connect using dsn, Host and sid, Host and service_name, or only Host (OracleHook.getconn Documentation).

For example:

Host = "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=dbhost.example.com)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=orclpdb1)))"

or

Host = "dbhost.example.com"
Schema = "orclpdb1"

or

Host = "dbhost.example.com"
Schema = "orcl"

More details on all Oracle connect parameters supported can be found in cx_Oracle documentation.

Information on creating an Oracle Connection through the web user interface can be found in Airflow’s Managing Connections Documentation.

Example “extras” field:

{
   "encoding": "UTF-8",
   "nencoding": "UTF-8",
   "threaded": false,
   "events": false,
   "mode": "sysdba",
   "purity": "new"
}

When specifying the connection as URI (in AIRFLOW_CONN_{CONN_ID} variable) you should specify it following the standard syntax of DB connections, where extras are passed as parameters of the URI (note that all components of the URI should be URL-encoded).

For example:

export AIRFLOW_CONN_ORACLE_DEFAULT='oracle://oracle_user:XXXXXXXXXXXX@1.1.1.1:1521?encoding=UTF-8&nencoding=UTF-8&threaded=False&events=False&mode=sysdba&purity=new'

Was this entry helpful?