Oracle¶

Oracle data sources and sinks are in the database category of I/O connectors.

Tool documentation¶

Oracle Database documentation

Connector type values¶

The "type": value to use in the source or sink JSON files.

Connector type	Value
Data Source	DKDataSource_Oracle
Data Sink	DKDataSink_Oracle

Connection properties¶

The properties to use when connecting to an Oracle instance from Automation.

Field	Scope	Type	Required?	Description
`database`	source/sink	string	yes	Oracle database name.
`hostname`	source/sink	string	yes	Oracle host name.
`password`	source/sink	string	yes	Oracle password.
`port`	source/sink	string/number	yes	Oracle port.
`username`	source/sink	string	yes	Oracle username.

Connections¶

See Connection Properties for more details on connection configurations.

Defined in kitchen-level variables¶

oracleConfig in kitchen overrides

{
    "oracleConfig": {
        "username": "#{vault://oracle/username}",
        "password": "#{vault://oracle/password}",
        "hostname": "#{vault://oracle/hostname}",
        "database": "#{vault://oracle/database}",
        "port": "#{vault://oracle/port}"
    }
}

The Connection tab in a Node Editor¶

(Screenshot of the Connection tab)

Expanded connection syntax¶

For a data source¶

oracle_datasource.json

{
    "name": "oracle_datasource",
    "type": "DKDataSource_Oracle",
    "config": {
        "username": "{{oracleConfig.username}}",
        "password": "{{oracleConfig.password}}",
        "hostname": "{{oracleConfig.hostname}}",
        "database": "{{oracleConfig.database}}",
        "port": "{{oracleConfig.port}}"
    },
    "keys": {},
    "tests": {}
}

For a data sink¶

oracle_datasink.json

{
    "name": "oracle_datasink",
    "type": "DKDataSink_Oracle",
    "config": {
        "username": "{{oracleConfig.username}}",
        "password": "{{oracleConfig.password}}",
        "hostname": "{{oracleConfig.hostname}}",
        "database": "{{oracleConfig.database}}",
        "port": "{{oracleConfig.port}}"
    },
    "keys": {},
    "tests": {}
}

Condensed connection syntax¶

Note

Note: Do not use quotes for your condensed connection configuration variables.

For a data source¶

oracle_datasource.json

{
    "type": "DKDataSource_Oracle",
    "name": "oracle_datasource.json",
    "config-ref": "oracleConfig",
    "keys": {},
    "tests": {}
}

For a data sink¶

oracle_datasink.json

{
    "type": "DKDataSink_Oracle",
    "name": "oracle_datasink.json",
    "config-ref": "oracleConfig",
    "keys": {},
    "tests": {}
}

Other configuration properties¶

See the following topics for common properties and runtime variables:

Additional Oracle step (key) properties¶

Field	Type	Required?	Description
`ignore-errors`	Boolean	no	Supported for data sources only. Defaults to false

File encoding requirements¶

Files used with data sources and data sinks must be encoded in UTF-8 in order to avoid non-Unicode characters causing problems with sinking data to database tables and errors when running related tests

For CSV and other delimited files, use Save as in the program and select the proper encoding, or consider using a text editor with encoding options.