embulk-output-kintone 0.4.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c677006a4f3dfdbec29c97e039045874614b3e99
-  data.tar.gz: 9c1fff33d958a4ee8be940da64cc7e10af04eb92
+  metadata.gz: 38d9d369925e0cab9fa558716b9a939be4b1387e
+  data.tar.gz: f4ae4a741548a48b042e1c4b79bf7e533ded0d31
 SHA512:
-  metadata.gz: d6e53840dad2b56c75e7422a769f0ae2eb8b24ce6034cc269255952e22442c77164c3bdac78a08f28086e5318df2318f99ad924d1bd85af8966ae83e5d57d627
-  data.tar.gz: 641e40a2986787204ef8e0feec1b916a2d4d0b5c0cc1d5e9d0137f38eaf8ed43b3b5b0b2f19f3304ee8736668b049d0a115836a62d8d3cd6efa20fe61ecc3be5
+  metadata.gz: 06d103f7c4036dd458f62955bee9b2b82aa2bb2719cb59f18a2a762bab5c892025b4dd7fb0b41647e0e9cf66e012916f60de1a48c1a6d41414af0447d8affb06
+  data.tar.gz: ee848b7cfb53cc27c731724d32b6d5ffa9fe3336742fc1bbf24bd2b49d07f6f99439b478a0342051810ef94597471caded0f81caaf3aaff78203ce0ff20485d6

data/README.md

@@ -8,21 +8,34 @@ kintone output plugin for Embulk stores app records from kintone.
 
 ## Configuration
 
-- **domain**: kintone domain(FQDN) e.g. devfoo.cybozu.com (string, required)
+- **domain**: kintone domain (FQDN) e.g. devfoo.cybozu.com (string, required)
 - **username**: kintone username (string, optional)
 - **password**: kintone password (string, optional)
 - **token**: kintone app token. Username and password or token must be configured. If all of them are provided, this plugin uses username and password (string, optional)
 - **app_id**: kintone app id (integer, required)
-- **basic_auth_username**:  kintone basic auth username Please see kintone basic auth [here](https://jp.cybozu.help/general/en/admin/list_security/list_ip_basic/basic_auth.html) (string, optional)
-- **basic_auth_password**:  kintone basic auth password (string, optional)
+- **basic_auth_username**: kintone basic auth username Please see kintone basic auth [here](https://jp.cybozu.help/general/en/admin/list_security/list_ip_basic/basic_auth.html) (string, optional)
+- **basic_auth_password**: kintone basic auth password (string, optional)
 - **guest_space_id**: kintone app belongs to guest space, guest space id is required. (integer, optional)
 - **mode**: kintone mode (string, required)
-- **update_key**: column name to set update key (string, required if mode is update or upsert)
+- **update_key**: Column name to set update key (string, required if mode is update or upsert)
+- **reduce_key**: Key column name to reduce expanded SUBTABLE (string, optional)
+- **sort_columns**: List of columns for sorting input records (array of objects, optional)
+    - **name**: Column name (string, required)
+    - **order**: Sort order (string `asc` or `desc`, required)
+- **max_sort_tmp_files**: Maximum number of temporary files for sorting input records (integer, default is `1024`)
+- **max_sort_memory**: Maximum memory usage for sorting input records (bytes in long, default is the estimated available memory, which is the approximate value of the JVM's current free memory)
+- **prefer_nulls**: Whether to set fields to null instead of default value of type when column is null (boolean, default is `false`)
+- **ignore_nulls**: Whether to completely ignore fields when column is null (boolean, default is `false`)
 - **column_options** advanced: a key-value pairs where key is a column name and value is options for the column.
     - **field_code**: field code (string, required)
-    - **type**: field type (string, required)
+    - **type**: field type (string, required). See [this page](https://cybozu.dev/ja/kintone/docs/overview/field-types/#field-type-update) for list of available types. However, following types are not yet supported
+        - `USER_SELECT`, `ORGANIZATION_SELECT`, `GROUP_SELECT`, `FILE`
     - **timezone**: timezone to convert into `date` (string, default is `UTC`)
     - **val_sep**: Used to specify multiple checkbox values (string, default is `,`)
+    - **sort_columns**: List of columns for sorting rows in SUBTABLE. Available only if type is `SUBTABLE` (array of objects, optional)
+        - **name**: Column name (string, required)
+        - **order**: Sort order (string `asc` or `desc`, required)
+- **chunk_size**: Maximum number of records to request at once (integer, default is `100`)
 
 ## Example
 
@@ -43,6 +56,51 @@ out:
     date_time: {field_code: "datetime", type: "DATETIME"}
 ```
 
+### For reduce expanded SUBTABLE
+
+```yaml
+out:
+  ...
+  reduce_key: id
+  column_options:
+    id: {field_code: "id", type: "NUMBER"}
+    ...
+    table: {field_code: "table", type: "SUBTABLE", sort_columns: [{name: number, order: asc}, {name: text, order: desc}]}
+    table.number: {field_code: "number_in_table", type: "NUMBER"}
+    table.text: {field_code: "text_in_table", type: "SINGLE_LINE_TEXT"}
+```
+
+#### KINTONE
+
+| Form                      | Field Code      |
+| ------------------------- | --------------- |
+| Table's own               | table           |
+| NUMBER In Table           | number_in_table |
+| SINGLE_LINE_TEXT In Table | text_in_table   |
+
+#### INPUT CSV
+
+```csv
+id,table.number,table.text
+1,0,test0
+1,1,test1
+2,0,test0
+```
+
+#### RESULT
+
+ID:1
+
+| NUMBER        | SINGLE_LINE_TEXT |
+| ------------- | ---------------- |
+| 0             | test0            |
+| 1             | test1            |
+
+ID:2
+
+| NUMBER        | SINGLE_LINE_TEXT |
+| ------------- | ---------------- |
+| 0             | test0            |
 
 ## Build
 

data/build.gradle

@@ -28,6 +28,7 @@ targetCompatibility = 1.8
 
 dependencies {
     compileOnly "org.embulk:embulk-core:0.9.23"
+    implementation "com.google.code.externalsortinginjava:externalsortinginjava:0.6.2"
     implementation project(path: ":shadow-kintone-java-client", configuration: "shadow")
 
     testImplementation "junit:junit:4.+"

data/src/main/java/org/embulk/output/kintone/KintoneColumnOption.java

@@ -1,6 +1,6 @@
 package org.embulk.output.kintone;
 
-import java.util.Optional;
+import java.util.List;
 import org.embulk.config.Config;
 import org.embulk.config.ConfigDefault;
 import org.embulk.config.Task;
@@ -14,9 +14,13 @@ public interface KintoneColumnOption extends Task {
 
   @Config("timezone")
   @ConfigDefault("\"UTC\"")
-  Optional<String> getTimezone();
+  String getTimezone();
 
   @Config("val_sep")
   @ConfigDefault("\",\"")
   String getValueSeparator();
+
+  @Config("sort_columns")
+  @ConfigDefault("[]")
+  List<KintoneSortColumn> getSortColumns();
 }