embulk-input-redshift 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08e6e18498c2526a2931f5535a555f747d4bbf0e
-  data.tar.gz: 142340e8d88ac8780107dbdf6ec16020cd4d91aa
+  metadata.gz: 3dcd3503c3056643c3e889768ae5a54adfd37db5
+  data.tar.gz: 8cfd88e81e904dee60a8dcd2f9c95dec4a299e84
 SHA512:
-  metadata.gz: dcc6d6e8db32b1d28779e48cf0aca9b07d8c0de1477a1cf52f1db913acd30cd7b9392457e6d180b3a2736fe49d764cf8c37d6856c153947b443458a1a0422059
-  data.tar.gz: c0d64afefba4d4883cb62d81f79a3546e525f7e0eac7cac6bfe20d522c59c817c7b18e47bdb5fee8eb9030b4522cf81ffa2f00b0f13ed2d9281beae0d319595c
+  metadata.gz: 7466fc607e1d42fc6bd7fc4221ebeef47796681683ff4c573db65443bc6d2b9a8ff0d6eea4fd3e100e973faa88acb0d763c1a57da617c74303d421eb1bdb1ac4
+  data.tar.gz: 7394c561b93a2eda161b8eddba85c20f212f836a03b2acc7d148ed148f77c0c6dd961b2cd1f690807e4ed493eabff17edf2537b39d80edf449fa94c33736b0fa

data/README.md

@@ -19,14 +19,18 @@ Redshift input plugins for Embulk loads records from Redshift.
 - **fetch_rows**: number of rows to fetch one time (used for java.sql.Statement#setFetchSize) (integer, default: 10000)
 - **connect_timeout**: timeout for establishment of a database connection. (integer (seconds), default: 300)
 - **socket_timeout**: timeout for socket read operations. 0 means no timeout. (integer (seconds), default: 1800)
+- **ssl**: enables SSL. data will be encrypted but CA or certification will not be verified (boolean, default: false)
 - **options**: extra JDBC properties (hash, default: {})
 - If you write SQL directly,
   - **query**: SQL to run (string)
 - If **query** is not set,
   - **table**: destination table name (string, required)
-  - **select**: comma-separated list of columns to select (string, default: "*")
+  - **select**: expression of select (e.g. `id, created_at`) (string, default: "*")
   - **where**: WHERE condition to filter the rows (string, default: no-condition)
-  - **order_by**: name of the column that rows are sorted by (string, default: not sorted)
+  - **order_by**: expression of ORDER BY to sort rows (e.g. `created_at DESC, id ASC`) (string, default: not sorted)
+- **incremental**: if true, enables incremental loading. See next section for details (boolean, default: false)
+- **incremental_columns**: column names for incremental loading (array of strings, default: use primary keys)
+- **last_record**: values of the last record for incremental loading (array of objects, default: load all records)
 - **default_timezone**: If the sql type of a column is `date`/`time`/`datetime` and the embulk type is `string`, column values are formatted int this default_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.
   - **value_type**: embulk get values from database as this value_type. Typically, the value_type determines `getXXX` method of `java.sql.PreparedStatement`.
@@ -39,6 +43,43 @@ Redshift input plugins for Embulk loads records from Redshift.
 (string, value of default_timezone option is used by default)
 - **after_select**: if set, this SQL will be executed after the SELECT query in the same transaction.
 
+
+### Incremental loading
+
+Incremental loading uses monotonically increasing unique columns (such as auto-increment (IDENTITY) column) to load records inserted (or updated) after last execution.
+
+First, if `incremental: true` is set, this plugin loads all records with additional ORDER BY. For example, if `incremental_columns: [updated_at, id]` option is set, query will be as following:
+
+```
+SELECT * FROM (
+  ...original query is here...
+)
+ORDER BY updated_at, id
+```
+
+When bulk data loading finishes successfully, it outputs `last_record: ` paramater as config-diff so that next execution uses it.
+
+At the next execution, when `last_record: ` is also set, this plugin generates additional WHERE conditions to load records larger than the last record. For example, if `last_record: ["2017-01-01 00:32:12", 5291]` is set,
+
+```
+SELECT * FROM (
+  ...original query is here...
+)
+WHERE created_at > '2017-01-01 00:32:12' OR (created_at = '2017-01-01 00:32:12' AND id > 5291)
+ORDER BY updated_at, id
+```
+
+Then, it updates `last_record: ` so that next execution uses the updated last_record.
+
+**IMPORTANT**: If you set `incremental_columns: ` option, make sure that there is an index on the columns to avoid full table scan. For this example, following index should be created:
+
+```
+CREATE INDEX embulk_incremental_loading_index ON table (updated_at, id);
+```
+
+Recommended usage is to leave `incremental_columns` unset and let this plugin automatically finds an auto-increment (IDENTITY) primary key. Currently, only strings and integers are supported as incremental_columns.
+
+
 ## Example
 
 ```yaml
@@ -51,6 +92,16 @@ in:
   table: my_table
   select: "col1, col2, col3"
   where: "col4 != 'a'"
+  order_by: "col1 DESC"
+```
+
+This configuration will generate following SQL:
+
+```
+SELECT col1, col2, col3
+FROM "my_table"
+WHERE col4 != 'a'
+ORDER BY col1 DESC
 ```
 
 If you need a complex SQL,

data/src/main/java/org/embulk/input/RedshiftInputPlugin.java

@@ -39,6 +39,10 @@ public class RedshiftInputPlugin
         @Config("schema")
         @ConfigDefault("\"public\"")
         public String getSchema();
+
+        @Config("ssl")
+        @ConfigDefault("false")
+        public boolean getSsl();
     }
 
     @Override
@@ -65,16 +69,13 @@ public class RedshiftInputPlugin
         // Socket options TCP_KEEPCNT, TCP_KEEPIDLE, and TCP_KEEPINTVL are not configurable.
         props.setProperty("tcpKeepAlive", "true");
 
-        // TODO
-        //switch t.getSssl() {
-        //when "disable":
-        //    break;
-        //when "enable":
-        //    props.setProperty("sslfactory", "org.postgresql.ssl.NonValidatingFactory");  // disable server-side validation
-        //when "verify":
-        //    props.setProperty("ssl", "true");
-        //    break;
-        //}
+        if (t.getSsl()) {
+            // TODO add ssl_verify (boolean) option to allow users to verify certification.
+            //      see embulk-input-ftp for SSL implementation.
+            props.setProperty("ssl", "true");
+            props.setProperty("sslfactory", "org.postgresql.ssl.NonValidatingFactory");  // disable server-side validation
+        }
+        // setting ssl=false enables SSL. See org.postgresql.core.v3.openConnectionImpl.
 
         props.putAll(t.getOptions());
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: embulk-input-redshift
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies: []
 description: Selects records from a table.
 email:
@@ -19,12 +19,12 @@ extra_rdoc_files: []
 files:
 - README.md
 - build.gradle
+- classpath/embulk-input-jdbc-0.7.3.jar
+- classpath/embulk-input-postgresql-0.7.3.jar
+- classpath/embulk-input-redshift-0.7.3.jar
+- classpath/postgresql-9.4-1205-jdbc41.jar
 - lib/embulk/input/redshift.rb
 - src/main/java/org/embulk/input/RedshiftInputPlugin.java
-- classpath/embulk-input-jdbc-0.7.2.jar
-- classpath/embulk-input-postgresql-0.7.2.jar
-- classpath/embulk-input-redshift-0.7.2.jar
-- classpath/postgresql-9.4-1205-jdbc41.jar
 homepage: https://github.com/embulk/embulk-input-jdbc
 licenses:
 - Apache 2.0
@@ -35,17 +35,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: JDBC input plugin for Embulk