embulk-input-postgresql 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87724534f3076d4264cc4728fff2744c321c7982
-  data.tar.gz: 9914d0dfe4ef6d469de2da431e26b61c03c566e6
+  metadata.gz: edb5cbc6680e6fdd62506d5274f43ae0fa95e89d
+  data.tar.gz: a961032ae6f7add861fcd88760fc8bbe9f09fe05
 SHA512:
-  metadata.gz: 031259689b5a0f86e7a530f2ebdce24255b65d7da54b9e55cf56f2d9d4c65f62087bc6189cb887147db24f95c45d437e42e9923c5be607fd173b7af80c05ca5c
-  data.tar.gz: 607b8e8e01d553badbeb7a4b881db6997ea721b2242bb373454785957fb188bbcbe2d416d5579e4f7dbe932de0bd5dcea6ad54e9c2c7f3f32a88c48608fbb088
+  metadata.gz: ece1c87b6a0b05919ba2054cdcdb8a10f59c3b4e4d9b6c6a1fb689f3964bfae1f013d5d0e17d8a453f1c49f7fe6a80218bfdb0bc2c19fd976a388cc517fb62cf
+  data.tar.gz: b0a055403e5a383316f4a39caee43fa24fd70207aa24a950779dfe3f08182e2d95e86a635057cc561b890626fd5d099603120fad0ae5bd308b80f3754c3c2e0b

data/README.md

@@ -24,6 +24,7 @@ PostgreSQL input plugin for Embulk loads records from PostgreSQL.
 - **options**: extra JDBC properties (hash, default: {})
 - If you write SQL directly,
   - **query**: SQL to run (string)
+  - **use_raw_query_with_incremental**: If true, you can write optimized query using prepared statement by yourself. See [Use incremental loading with raw query](#use-incremental-loading-with-raw-query) for more detail (boolean, default: false)
 - If **query** is not set,
   - **table**: destination table name (string, required)
   - **select**: expression of select (e.g. `id, created_at`) (string, default: "*")
@@ -114,6 +115,38 @@ 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 (serial / bigserial) primary key. Currently, only strings and integers are supported as incremental_columns.
 
+### Use incremental loading with raw query
+
+**IMPORTANT**: This is an advanced feature and assume you have an enough knowledge about incremental loading using Embulk and this plugin
+
+Normally, you can't write your own query for incremental loading.
+`use_raw_query_with_incremental` option allow you to write raw query for incremental loading. It might be well optimized and faster than SQL statement which is automatically generated by plugin.
+
+Prepared statement starts with `:` is available instead of fixed value.
+`last_record` value is necessary when you use this option.
+Please use prepared statement that is well distinguishable in SQL statement. Using too simple prepared statement like `:a` might cause SQL parse failure.
+
+In the following example, prepared statement `:foo_id` will be replaced with value "1" which is specified in `last_record`.
+
+```yaml
+in:
+  type: postgresql
+  query:
+    SELECT
+      foo.id as foo_id, bar.name
+    FROM
+      foo LEFT JOIN bar ON foo.id = bar.id
+    WHERE
+      foo.hoge IS NOT NULL
+      AND foo.id > :foo_id
+    ORDER BY
+      foo.id ASC
+  use_raw_query_with_incremental: true
+  incremental_columns:
+    - foo_id
+  incremental: true
+  last_record: [1]
+```
 
 ## Example
 

data/src/test/java/org/embulk/input/postgresql/IncrementalTest.java

@@ -140,4 +140,68 @@ public class IncrementalTest
                 result2.getConfigDiff(),
                 is((ConfigDiff) loadYamlResource(embulk, "timestamptz/expected_2.diff")));
     }
+
+    @Test
+    public void simpleQueryWithPlaceholder() throws Exception
+    {
+        // setup first rows
+        execute(readResource("query/setup.sql"));
+
+        Path out1 = embulk.createTempFile("csv");
+        RunResult result1 = embulk.runInput(
+                baseConfig.merge(loadYamlResource(embulk, "query/config_1.yml")),
+                out1);
+        assertThat(
+                readSortedFile(out1),
+                is(readResource("query/expected_1.csv")));
+        assertThat(
+                result1.getConfigDiff(),
+                is((ConfigDiff) loadYamlResource(embulk, "query/expected_1.diff")));
+
+        // insert more rows
+        execute(readResource("query/insert_more.sql"));
+
+        Path out2 = embulk.createTempFile("csv");
+        RunResult result2 = embulk.runInput(
+                baseConfig.merge(loadYamlResource(embulk, "query/config_2.yml")),
+                out2);
+        assertThat(
+                readSortedFile(out2),
+                is(readResource("query/expected_2.csv")));
+        assertThat(
+                result2.getConfigDiff(),
+                is((ConfigDiff) loadYamlResource(embulk, "query/expected_2.diff")));
+    }
+
+    @Test
+    public void simpleQueryWithPlaceholderAndMultiColumns() throws Exception
+    {
+        // setup first rows
+        execute(readResource("query/setup.sql"));
+
+        Path out1 = embulk.createTempFile("csv");
+        RunResult result1 = embulk.runInput(
+                baseConfig.merge(loadYamlResource(embulk, "query/multi_columns_config_1.yml")),
+                out1);
+        assertThat(
+                readSortedFile(out1),
+                is(readResource("query/multi_columns_expected_1.csv")));
+        assertThat(
+                result1.getConfigDiff(),
+                is((ConfigDiff) loadYamlResource(embulk, "query/multi_columns_expected_1.diff")));
+
+        // insert more rows
+        execute(readResource("query/insert_more.sql"));
+
+        Path out2 = embulk.createTempFile("csv");
+        RunResult result2 = embulk.runInput(
+                baseConfig.merge(loadYamlResource(embulk, "query/multi_columns_config_2.yml")),
+                out2);
+        assertThat(
+                readSortedFile(out2),
+                is(readResource("query/multi_columns_expected_2.csv")));
+        assertThat(
+                result2.getConfigDiff(),
+                is((ConfigDiff) loadYamlResource(embulk, "query/multi_columns_expected_2.diff")));
+    }
 }

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/config_1.yml

@@ -0,0 +1,14 @@
+last_record: [0]
+incremental: true
+incremental_columns: [num]
+use_raw_query_with_incremental: true
+query: |
+  SELECT
+    num,note
+  FROM
+    query_load
+  WHERE
+    num IS NOT NULL
+    AND num > :num
+  ORDER BY
+    num ASC

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/config_2.yml

@@ -0,0 +1,14 @@
+last_record: [4]
+incremental: true
+incremental_columns: [num]
+use_raw_query_with_incremental: true
+query: |
+  SELECT
+    num,note
+  FROM
+    query_load
+  WHERE
+    num IS NOT NULL
+    AND num > :num
+  ORDER BY
+    num ASC

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/expected_1.csv

@@ -0,0 +1,4 @@
+1,first
+2,first
+3,first
+4,first

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/expected_1.diff

@@ -0,0 +1,3 @@
+in:
+  last_record: [4]
+out: {}

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/expected_2.csv

@@ -0,0 +1,2 @@
+5,more_load
+9,more_load

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/expected_2.diff

@@ -0,0 +1,3 @@
+in:
+  last_record: [9]
+out: {}

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/insert_more.sql

@@ -0,0 +1,6 @@
+
+insert into query_load (num, num2, note) values
+(0, 100, 'more_skip'),
+(4, 104, 'more_skip'),
+(9, 109, 'more_load'),
+(5, 105, 'more_load');

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_config_1.yml

@@ -0,0 +1,16 @@
+last_record: [0,0]
+incremental: true
+incremental_columns: [num,num2]
+use_raw_query_with_incremental: true
+query: |
+  SELECT
+    *
+  FROM
+    query_load
+  WHERE
+    num IS NOT NULL
+    AND num > :num
+    OR (num = :num AND num2 > :num2)
+  ORDER BY
+    num ASC,
+    num2 ASC

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_config_2.yml

@@ -0,0 +1,16 @@
+last_record: [4,104]
+incremental: true
+incremental_columns: [num,num2]
+use_raw_query_with_incremental: true
+query: |
+  SELECT
+    *
+  FROM
+    query_load
+  WHERE
+    num IS NOT NULL
+    AND num > :num
+    OR (num = :num AND num2 > :num2)
+  ORDER BY
+    num ASC,
+    num2 ASC

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_expected_1.csv

@@ -0,0 +1,4 @@
+1,101,first
+2,102,first
+3,103,first
+4,104,first

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_expected_1.diff

@@ -0,0 +1,3 @@
+in:
+  last_record: [4,104]
+out: {}

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_expected_2.csv

@@ -0,0 +1,2 @@
+5,105,more_load
+9,109,more_load

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_expected_2.diff

@@ -0,0 +1,3 @@
+in:
+  last_record: [9,109]
+out: {}

data/src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/setup.sql

@@ -0,0 +1,13 @@
+drop table if exists query_load;
+
+create table query_load (
+    num int not null,
+    num2 int not null,
+    note text
+);
+
+insert into query_load (num, num2, note) values
+(3, 103, 'first'),
+(4, 104, 'first'),
+(2, 102, 'first'),
+(1, 101, 'first');

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: embulk-input-postgresql
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2018-08-10 00:00:00.000000000 Z
 dependencies: []
 description: Selects records from a table.
 email:
@@ -19,8 +19,8 @@ extra_rdoc_files: []
 files:
 - README.md
 - build.gradle
-- classpath/embulk-input-jdbc-0.9.2.jar
-- classpath/embulk-input-postgresql-0.9.2.jar
+- classpath/embulk-input-jdbc-0.9.3.jar
+- classpath/embulk-input-postgresql-0.9.3.jar
 - default_jdbc_driver/postgresql-9.4-1205-jdbc41.jar
 - lib/embulk/input/postgresql.rb
 - src/main/java/org/embulk/input/PostgreSQLInputPlugin.java
@@ -51,6 +51,20 @@ files:
 - src/test/resources/org/embulk/input/postgresql/test/expect/incremental/int/expected_2.diff
 - src/test/resources/org/embulk/input/postgresql/test/expect/incremental/int/insert_more.sql
 - src/test/resources/org/embulk/input/postgresql/test/expect/incremental/int/setup.sql
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/config_1.yml
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/config_2.yml
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/expected_1.csv
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/expected_1.diff
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/expected_2.csv
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/expected_2.diff
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/insert_more.sql
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_config_1.yml
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_config_2.yml
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_expected_1.csv
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_expected_1.diff
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_expected_2.csv
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/multi_columns_expected_2.diff
+- src/test/resources/org/embulk/input/postgresql/test/expect/incremental/query/setup.sql
 - src/test/resources/org/embulk/input/postgresql/test/expect/incremental/timestamp/config_1.yml
 - src/test/resources/org/embulk/input/postgresql/test/expect/incremental/timestamp/config_2.yml
 - src/test/resources/org/embulk/input/postgresql/test/expect/incremental/timestamp/expected_1.csv