embulk 0.7.11-java → 0.8.0-java

data/embulk-core/src/main/java/org/embulk/spi/type/Types.java

@@ -11,4 +11,6 @@ public class Types
     public static final StringType STRING = StringType.STRING;
 
     public static final TimestampType TIMESTAMP = TimestampType.TIMESTAMP;
+
+    public static final JsonType JSON = JsonType.JSON;
 }

data/embulk-core/src/main/java/org/embulk/spi/util/DynamicColumnSetterFactory.java

@@ -8,11 +8,13 @@ import org.embulk.spi.type.LongType;
 import org.embulk.spi.type.DoubleType;
 import org.embulk.spi.type.StringType;
 import org.embulk.spi.type.TimestampType;
+import org.embulk.spi.type.JsonType;
 import org.embulk.spi.util.dynamic.BooleanColumnSetter;
 import org.embulk.spi.util.dynamic.LongColumnSetter;
 import org.embulk.spi.util.dynamic.DoubleColumnSetter;
 import org.embulk.spi.util.dynamic.StringColumnSetter;
 import org.embulk.spi.util.dynamic.TimestampColumnSetter;
+import org.embulk.spi.util.dynamic.JsonColumnSetter;
 import org.embulk.spi.util.dynamic.DefaultValueSetter;
 import org.embulk.spi.util.dynamic.NullDefaultValueSetter;
 import org.embulk.spi.time.TimestampFormatter;
@@ -58,6 +60,10 @@ public class DynamicColumnSetterFactory
             TimestampParser parser = new TimestampParser(task.getJRuby(),
                     getTimestampFormat(column).getFormat(), getTimeZone(column));
             return new TimestampColumnSetter(pageBuilder, column, defaultValue, parser);
+        } else if (type instanceof JsonType) {
+            TimestampFormatter formatter = new TimestampFormatter(task.getJRuby(),
+                    getTimestampFormat(column).getFormat(), getTimeZone(column));
+            return new JsonColumnSetter(pageBuilder, column, defaultValue, formatter);
         }
         throw new ConfigException("Unknown column type: "+type);
     }

data/embulk-core/src/main/java/org/embulk/spi/util/PagePrinter.java

@@ -98,5 +98,10 @@ public class PagePrinter
         {
             string = timestampFormatters[column.getIndex()].format(reader.getTimestamp(column));
         }
+
+        public void jsonColumn(Column column)
+        {
+            string = reader.getJson(column).toString();
+        }
     }
 }

data/embulk-core/src/main/java/org/embulk/spi/util/Pages.java

@@ -107,6 +107,16 @@ public class Pages
                 visit(column, record.getTimestamp(column));
             }
         }
+
+        @Override
+        public void jsonColumn(Column column)
+        {
+            if (record.isNull(column)) {
+                visit(column, null);
+            } else {
+                visit(column, record.getJson(column));
+            }
+        }
     }
 
     public static Object getObject(PageReader record, Column column)

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/AbstractDynamicColumnSetter.java

@@ -12,6 +12,7 @@ import org.embulk.spi.PageBuilder;
 import org.embulk.spi.Column;
 import org.embulk.spi.util.DynamicColumnSetter;
 import org.embulk.spi.time.Timestamp;
+import org.msgpack.value.Value;
 
 public abstract class AbstractDynamicColumnSetter
         implements DynamicColumnSetter
@@ -40,6 +41,8 @@ public abstract class AbstractDynamicColumnSetter
 
     public abstract void set(Timestamp value);
 
+    public abstract void set(Value value);
+
     public void setRubyObject(IRubyObject rubyObject)
     {
         if (rubyObject == null || rubyObject instanceof RubyNil) {

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/BooleanColumnSetter.java

@@ -4,6 +4,7 @@ import com.google.common.collect.ImmutableSet;
 import org.embulk.spi.Column;
 import org.embulk.spi.PageBuilder;
 import org.embulk.spi.time.Timestamp;
+import org.msgpack.value.Value;
 
 public class BooleanColumnSetter
         extends AbstractDynamicColumnSetter
@@ -61,4 +62,10 @@ public class BooleanColumnSetter
     {
         defaultValue.setBoolean(pageBuilder, column);
     }
+
+    @Override
+    public void set(Value v)
+    {
+        pageBuilder.setJson(column, v);
+    }
 }

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/DefaultValueSetter.java

@@ -15,4 +15,6 @@ public interface DefaultValueSetter
     void setString(PageBuilder pageBuilder, Column c);
 
     void setTimestamp(PageBuilder pageBuilder, Column c);
+
+    void setJson(PageBuilder pageBuilder, Column c);
 }

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/DoubleColumnSetter.java

@@ -4,6 +4,7 @@ import java.math.RoundingMode;
 import org.embulk.spi.Column;
 import org.embulk.spi.PageBuilder;
 import org.embulk.spi.time.Timestamp;
+import org.msgpack.value.Value;
 
 public class DoubleColumnSetter
         extends AbstractDynamicColumnSetter
@@ -58,4 +59,10 @@ public class DoubleColumnSetter
         double frac = v.getNano() / 1000000000.0;
         pageBuilder.setDouble(column, sec + frac);
     }
+
+    @Override
+    public void set(Value v)
+    {
+        pageBuilder.setJson(column, v);
+    }
 }

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/JsonColumnSetter.java

@@ -0,0 +1,73 @@
+package org.embulk.spi.util.dynamic;
+
+import org.embulk.spi.Column;
+import org.embulk.spi.PageBuilder;
+import org.embulk.spi.time.Timestamp;
+import org.embulk.spi.time.TimestampFormatter;
+import org.embulk.spi.json.JsonParser;
+import org.embulk.spi.json.JsonParseException;
+import org.msgpack.value.Value;
+import org.msgpack.value.ValueFactory;
+
+public class JsonColumnSetter
+        extends AbstractDynamicColumnSetter
+{
+    private final TimestampFormatter timestampFormatter;
+    private final JsonParser jsonParser;
+
+    public JsonColumnSetter(PageBuilder pageBuilder, Column column,
+                            DefaultValueSetter defaultValue,
+                            TimestampFormatter timestampFormatter)
+    {
+        super(pageBuilder, column, defaultValue);
+        this.timestampFormatter = timestampFormatter;
+        this.jsonParser = new JsonParser();
+    }
+
+    @Override
+    public void setNull()
+    {
+        pageBuilder.setNull(column);
+    }
+
+    @Override
+    public void set(boolean v)
+    {
+        pageBuilder.setJson(column, ValueFactory.newBoolean(v));
+    }
+
+    @Override
+    public void set(long v)
+    {
+        pageBuilder.setJson(column, ValueFactory.newInteger(v));
+    }
+
+    @Override
+    public void set(double v)
+    {
+        pageBuilder.setJson(column, ValueFactory.newFloat(v));
+    }
+
+    @Override
+    public void set(String v)
+    {
+        try {
+            pageBuilder.setJson(column, jsonParser.parse(v));
+        }
+        catch (JsonParseException ex) {
+            defaultValue.setTimestamp(pageBuilder, column);
+        }
+    }
+
+    @Override
+    public void set(Timestamp v)
+    {
+        pageBuilder.setJson(column, ValueFactory.newString(timestampFormatter.format(v)));
+    }
+
+    @Override
+    public void set(Value v)
+    {
+        pageBuilder.setJson(column, v);
+    }
+}

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/LongColumnSetter.java

@@ -5,6 +5,7 @@ import com.google.common.math.DoubleMath;
 import org.embulk.spi.Column;
 import org.embulk.spi.PageBuilder;
 import org.embulk.spi.time.Timestamp;
+import org.msgpack.value.Value;
 
 public class LongColumnSetter
         extends AbstractDynamicColumnSetter
@@ -40,7 +41,8 @@ public class LongColumnSetter
         try {
             // TODO configurable rounding mode
             lv = DoubleMath.roundToLong(v, RoundingMode.HALF_UP);
-        } catch (ArithmeticException ex) {
+        }
+        catch (ArithmeticException ex) {
             // NaN / Infinite / -Infinite
             defaultValue.setLong(pageBuilder, column);
             return;
@@ -54,7 +56,8 @@ public class LongColumnSetter
         long lv;
         try {
             lv = Long.parseLong(v);
-        } catch (NumberFormatException e) {
+        }
+        catch (NumberFormatException e) {
             defaultValue.setLong(pageBuilder, column);
             return;
         }
@@ -66,4 +69,10 @@ public class LongColumnSetter
     {
         pageBuilder.setDouble(column, v.getEpochSecond());
     }
+
+    @Override
+    public void set(Value v)
+    {
+        pageBuilder.setJson(column, v);
+    }
 }

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/NullDefaultValueSetter.java

@@ -31,4 +31,9 @@ public class NullDefaultValueSetter
     {
         pageBuilder.setNull(c);
     }
+
+    public void setJson(PageBuilder pageBuilder, Column c)
+    {
+        pageBuilder.setNull(c);
+    }
 }

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/SkipColumnSetter.java

@@ -6,6 +6,7 @@ import org.embulk.spi.Column;
 import org.embulk.spi.time.Timestamp;
 import org.embulk.spi.time.TimestampParser;
 import org.embulk.spi.time.TimestampParseException;
+import org.msgpack.value.Value;
 
 public class SkipColumnSetter
         extends AbstractDynamicColumnSetter
@@ -46,6 +47,10 @@ public class SkipColumnSetter
     public void set(Timestamp v)
     { }
 
+    @Override
+    public void set(Value v)
+    { }
+
     @Override
     public void setRubyObject(IRubyObject rubyObject)
     { }

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/StringColumnSetter.java

@@ -4,6 +4,7 @@ import org.embulk.spi.PageBuilder;
 import org.embulk.spi.Column;
 import org.embulk.spi.time.Timestamp;
 import org.embulk.spi.time.TimestampFormatter;
+import org.msgpack.value.Value;
 
 public class StringColumnSetter
         extends AbstractDynamicColumnSetter
@@ -53,4 +54,10 @@ public class StringColumnSetter
     {
         pageBuilder.setString(column, timestampFormatter.format(v));
     }
+
+    @Override
+    public void set(Value v)
+    {
+        pageBuilder.setJson(column, v);
+    }
 }

data/embulk-core/src/main/java/org/embulk/spi/util/dynamic/TimestampColumnSetter.java

@@ -5,6 +5,7 @@ import org.embulk.spi.Column;
 import org.embulk.spi.time.Timestamp;
 import org.embulk.spi.time.TimestampParser;
 import org.embulk.spi.time.TimestampParseException;
+import org.msgpack.value.Value;
 
 public class TimestampColumnSetter
         extends AbstractDynamicColumnSetter
@@ -51,7 +52,8 @@ public class TimestampColumnSetter
     {
         try {
             pageBuilder.setTimestamp(column, timestampParser.parse(v));
-        } catch (TimestampParseException e) {
+        }
+        catch (TimestampParseException e) {
             defaultValue.setTimestamp(pageBuilder, column);
         }
     }
@@ -61,4 +63,10 @@ public class TimestampColumnSetter
     {
         pageBuilder.setTimestamp(column, v);
     }
+
+    @Override
+    public void set(Value v)
+    {
+        pageBuilder.setJson(column, v);
+    }
 }

data/embulk-core/src/test/java/org/embulk/spi/MockFormatterPlugin.java

@@ -92,6 +92,13 @@ public class MockFormatterPlugin implements FormatterPlugin
                             record.add(pageReader.getTimestamp(column));
                         }
                     }
+
+                    public void jsonColumn(Column column)
+                    {
+                        if (!pageReader.isNull(column)) {
+                            record.add(pageReader.getJson(column));
+                        }
+                    }
                 });
                 records.add(record);
             }

data/embulk-docs/src/built-in.rst

@@ -470,7 +470,44 @@ Example
     filters:
       ...
       - type: rename
-	columns:
-	  my_existing_column1: new_column1
-	  my_existing_column2: new_column2
+        columns:
+          my_existing_column1: new_column1
+          my_existing_column2: new_column2
+
+Local executor plugin
+------------------
+
+The ``local`` executor plugin runs tasks using local threads. This is the only built-in executor plugin.
+
+Options
+~~~~~~~~~~~~~~~~~~
+
++------------------+----------+----------------------------------------------------------------------+--------------------------------------+
+| name             | type     | description                                                          | required?                            |
++==================+==========+======================================================================+======================================+
+| max_threads      | integer  | Maximum number of threads to run concurrently.                       | 2x of available CPU cores by default |
++------------------+----------+----------------------------------------------------------------------+--------------------------------------+
+| min_output_tasks | integer  | Mimimum number of output tasks to enable page scattering.            | 1x of available CPU cores by default |
++------------------+----------+----------------------------------------------------------------------+--------------------------------------+
+
+
+The ``max_threads`` option controls maximum concurrency. Setting smaller number here is useful if too many threads make the destination or source storage overloaded. Setting larger number here is useful if CPU utilization is too low due to high latency.
+
+The ``min_output_tasks`` option enables "page scattering". The feature is enabled if number of input tasks is less than ``min_output_tasks``. It uses multiple filter & output threads for each input task so that one input task can use multiple threads. Setting larger number here is useful if embulk doesn't use multi-threading with enough concurrency due to too few number of input tasks. Setting 1 here disables page scattering completely.
+
+Example
+~~~~~~~~~~~~~~~~~~
+
+.. code-block:: yaml
+
+    exec:
+      max_threads: 8         # run at most 8 tasks concurrently
+      min_output_tasks: 1    # disable page scattering
+    in:
+      type: ...
+      ...
+    out:
+      type: ...
+      ...
+
 

data/embulk-docs/src/conf.py

@@ -53,9 +53,9 @@ copyright = u'2015, Embulk Project'
 # built documents.
 #
 # The short X.Y version.
-version = '0.7'
+version = '0.8'
 # The full version, including alpha/beta/rc tags.
-release = '0.7'
+release = '0.8'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

data/embulk-docs/src/release.rst

@@ -4,7 +4,7 @@ Release Notes
 .. toctree::
     :maxdepth: 1
 
-    release/release-0.7.11
+    release/release-0.8.0
     release/release-0.7.10
     release/release-0.7.9
     release/release-0.7.8

data/embulk-docs/src/release/release-0.8.0.rst

@@ -0,0 +1,68 @@
+Release 0.8.0
+==================================
+
+General Changes
+------------------
+
+* Added JSON type support.
+
+  * A column with ``json`` type can represent nested values such as maps or arrays. This is useful when both input and output support dynamically-typed values.
+
+  * **IMPORTANT**: If input plugin uses JSON type but output plugin is compiled with an old embulk (< 0.8.0), a bulk load transaction fails with a confusing error message. To avoid this issue, please run ``embulk migrate /path/to/embulk-plugin-directory`` to upgrade plugin code, and use the latest plugin. This problem doesn't happen if input plugin doesn't use json type.
+
+  * Filter plugins to process JSON types are not ready yet. Expected plugins are for example, flatten a json column into statically-typed columns with guess plugin, extracting a value from a json column using an expression (such as JSONPath) and set it to another column, or building a json column by copying values from other columns.
+
+* Local executor plugin (the default executor) runs multiple tasks even if there is only 1 input task. This improves performance a lot especially if input is a single huge file.
+
+  * Its mechanism is that the executor creates 2, 3, 4, or more number of output tasks for each input task. Page chunks from a input task is scattered to output tasks. All of the tasks run in parallel using threads. This feature is called "page scattering".
+
+  * Added ``min_output_tasks`` option at ``exec:`` section. Default is 1x of available CPU cores. Page scattering is enabled if number of input tasks is less than this ``min_output_tasks`` option. Setting larger number here is useful if embulk doesn't use multi-threading with enough concurrency due to too few number of input tasks.
+
+  * Added ``max_threads`` option at ``exec:`` section. Default is 2x of availalbe CPU cores. This option controls maximum concurrency. Setting smaller number here is useful if too many threads make the destination or source storage overloaded. Setting larger number here is useful if CPU utilization is too low due to high latency.
+
+  * The results of output transaction will be deterministic. There're no randomness that depends on timing. However, task assignment changes if ``min_output_tasks`` changes. If you need deterministic results regardless of machines that may have different number of CPU cores, please add ``min_output_tasks`` option to ``exec:`` section. Setting 1 there will disable page scattering completely.
+
+* Upraded JRuby version to 9.0.4.0.
+
+* YAML configuration parser uses stricter rules when it converts type of a non-quoted strings.
+
+  * Strings starting with 0 such as 019 or 0819 will be a string instead of float.
+
+  * Strings looks like a timestamp such as 2015-01-01 will be a string instead of UNIX timestamp.
+
+  * On, Off, Yes, and No (case-insensitive) will be a string instead of boolean. Only true, True, false, False are recognized as a boolean.
+
+Java Plugin API
+------------------
+
+* Added ``org.embulk.spi.json.JsonParser`` class to parse a String into an internal representation of a JSON value (org.msgpack.value.Value). Usage of this class is similar to TimestampParser.
+
+* Added ``jsonColumn`` method to ``org.embulk.spi.ColumnVisitor``. At an input plugin or parser plugin, please implement this method using above JsonParser class and ``PageBuilder#stJson`` method. At an output plugin or formatter plugin, you can use ``org.msgpack.value.Value#toJson`` method to convert it to a JSON string.
+
+* Upgraded gradle version to 2.10. ``embulk migrate`` upgrades gradle version of your plugins.
+
+* ``embulk new`` and ``embulk migrate`` adds checkstyle configuration for Java plugins. ``./gradlew checkstyle`` checks code styles.
+
+
+Run Plugin API
+------------------
+
+* ``PageBuilder#add`` accepts a nested object (Hash or Array) when the column type is json.
+
+  * Internally, the value is serialized using MessagePack and passed to Java components through JRuby interface.
+
+* ``page.each`` method will give an nested object (Hash or Array) if the column type is json.
+
+
+Built-in plugins
+------------------
+
+* ``parser-cvs`` and ``guess-csv`` plugins support JSON type. JSON type will be automatically guessed.
+
+* ``formatter-csv`` supports JSON type. JSON column is serialized into a string using JSON format (``Value#toJson()``).
+
+* ``formatter-stdout`` supports JSON type. JSON column is serialized into a string using string representation of Value (``Value#toString()``). This is slightly different from JSON but can represent some superset of json such as non-string keys of objects.
+
+Release Date
+------------------
+2016-01-13