Oracle output plugins for Embulk

Oracle output plugins for Embulk loads records to Oracle.

Overview

  • Plugin type: output
  • Load all or nothing: depnds on the mode. see bellow.
  • Resume supported: depnds on the mode. see bellow.

Configuration

  • driver_path: path to the jar file of the Oracle JDBC driver (string)
  • host: database host name (string, required if url is not set or insert_method is "oci")
  • port: database port number (integer, default: 1521)
  • user: database login user name (string, required)
  • password: database login password (string, default: "")
  • database: destination database name (string, required if url is not set or insert_method is "oci")
  • url: URL of the JDBC connection (string, optional)
  • table: destination table name (string, required)
  • options: extra connection properties (hash, default: {})
  • mode: "insert", "insert_direct", "truncate_insert", or "replace". See bellow. (string, required)
  • insert_method: see below
  • batch_size: size of a single batch insert (integer, default: 16777216)
  • default_timezone: If input column type (embulk type) is timestamp and destination column type is string or nstring, this plugin needs to format the timestamp into a string. This default_timezone option is used to control the timezone. You can overwrite timezone for each columns using column_options option. (string, default: UTC)
  • column_options: advanced: a key-value pairs where key is a column name and value is options for the column.
    • type: type of a column when this plugin creates new tables (e.g. VARCHAR(255), INTEGER NOT NULL UNIQUE). This used when this plugin creates intermediate tables (insert, truncate_insert and merge modes), when it creates the target table (insert_direct and replace modes), and when it creates nonexistent target table automatically. (string, default: depends on input column type. BIGINT if input column type is long, BOOLEAN if boolean, DOUBLE PRECISION if double, CLOB if string, TIMESTAMP if timestamp)
    • value_type: This plugin converts input column type (embulk type) into a database type to build a INSERT statement. This value_type option controls the type of the value in a INSERT statement. (string, default: depends on input column type. Available values options are: byte, short, int, long, double, float, boolean, string, nstring, date, time, timestamp, decimal, null, pass)
    • timestamp_format: If input column type (embulk type) is timestamp and value_type is string or nstring, this plugin needs to format the timestamp value into a string. This timestamp_format option is used to control the format of the timestamp. (string, default: %Y-%m-%d %H:%M:%S.%6N)
    • timezone: If input column type (embulk type) is timestamp and value_type is string or nstring, this plugin needs to format the timestamp value into a string. And if the input column type is timestamp and value_type is date, this plugin needs to consider timezone. In those cases, this timezone option is used to control the timezone. (string, value of default_timezone option is used by default)

Modes

  • insert:
    • Behavior: This mode writes rows to some intermediate tables first. If all those tasks run correctly, runs INSERT INTO <target_table> SELECT * FROM <intermediate_table_1> UNION ALL SELECT * FROM <intermediate_table_2> UNION ALL ... query.
    • Transactional: Yes. This mode successfully writes all rows, or fails with writing zero rows.
    • Resumable: Yes.
  • insert_direct:
    • Behavior: This mode inserts rows to the target table directly.
    • Transactional: No. If fails, the target table could have some rows inserted.
    • Resumable: No.
  • truncate_insert:
    • Behavior: Same with insert mode excepting that it truncates the target table right before the last INSERT ... query.
    • Transactional: Yes.
    • Resumable: Yes.
  • replace:
    • Behavior: Same with insert mode excepting that it truncates the target table right before the last INSERT ... query.
    • Transactional: Yes.
    • Resumable: No.

Insert modes

insert_method supports three options.

"normal" means normal insert (default). It requires Oracle JDBC driver.

"direct" means direct path insert. It is faster than 'normal. It requires Oracle JDBC driver too, but the version 12 driver doesn't work (the version 11 driver works).

"oci" means direct path insert using OCI(Oracle Call Interface). It is fastest. It requires both Oracle JDBC driver and Oracle Instant Client (version 12.1.0.2.0). You must set the library loading path to the OCI library.

If you use "oci", platform dependent library written in cpp is required. Windows(x64) library and Linux(x64) are bundled, but others are not bundled. You should build by yourself and set the library loading path to it.

Example

out:
  type: oracle
  driver_path: /opt/oracle/ojdbc6.jar
  host: localhost
  user: root
  password: ""
  database: my_database
  table: my_table
  mode: insert
  insert_method: direct

Advanced configuration:

out:
  type: oracle
  driver_path: /opt/oracle/ojdbc6.jar
  host: localhost
  user: root
  password: ""
  database: my_database
  table: my_table
  options: {LoginTimeout: 20000}
  mode: insert_direct
  insert_method: direct
  column_options:
    my_col_1: {type: 'VARCHAR(255)'}
    my_col_3: {type: 'INT NOT NULL'}
    my_col_4: {value_type: string, timestamp_format: `%Y-%m-%d %H:%M:%S %z`, timezone: '-0700'}
    my_col_5: {type: 'DECIMAL(18,9)', value_type: pass}

Build

$ ./gradlew gem

Build environment for native library

For Windows (x64)

(1) Install JDK.

(2) Install Microsoft Visual Studio (only 2010 is tested).

(3) Install Oracle Instant Client SDK 11.1.0.6.0 for Microsoft Windows (x64).

(4) Set environment variables.

  • JAVA_HOME
  • OCI_SDK_PATH ("sdk" directory of Oracle Instant Client)

(5) Open src/main/cpp/win/embulk-output-oracle.sln by Visual Studio and build.

For Windows command line, the following are needed in addition to (1) - (4).

(6) Set environment variables.

  • MSVC_PATH (ex. C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC)
  • MSSDK_PATH (ex. C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A)

(7) Execute src/main/cpp/win/build.bat .

For Linux (x64) (only Ubuntu Server 14.04 is tested)

(1) Install JDK.

(2) Install gcc and g++ .

(3) Install Oracle Instant Client Basic and SDK 11.1.0.6.0 for Linux (x64).

(4) Create symbolic links of OCI libraries.

ln -s libocci.so.11.1 libocci.so
ln -s libclntsh.so.11.1 libclntsh.so

(5) Set environment variables.

  • JAVA_HOME
  • OCI_PATH (the directory of Oracle Instant Client Basic and the parent of the "sdk" directory)

(6) Execute src/main/cpp/linux/build.sh .