README.md in embulk-input-mysql-0.9.3 vs README.md in embulk-input-mysql-0.10.0

- old
+ new

@@ -5,10 +5,14 @@ ## Overview * **Plugin type**: input * **Resume supported**: yes +**[WARNING!]** + +- The default embulk type for MySQL JSON type will be changed from `string` to `json`. + ## Configuration - **driver_path**: path to the jar file of the MySQL JDBC driver. If not set, the bundled JDBC driver (MySQL Connector/J 5.1.44) will be used (string). NOTE: embulk-input-mysql 0.9.0 upgraded the bundled MySQL Connector/J version from 5.1.34 to 5.1.44 . And set useLegacyDatetimeCode=false by default in order to get correct datetime value when the server timezone and the client timezone are different. Set useLegacyDatetimeCode=true if you need to get datetime value same as older embulk-input-mysql. - **host**: database host name (string, required) - **port**: database port number (integer, 3306) @@ -39,19 +43,22 @@ - **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`) - **use_legacy_datetime_code**: recommended not to set the property (boolean, default: false). If true, embulk-output-mysql will get wrong datetime values when the server timezone and the client server timezone are different as older embulk-output-mysql did. -- **column_options**: advanced: a key-value pairs where key is a column name and value is options for the column. +- **default_column_options**: advanced: column_options for each JDBC type as default. key-value pairs where key is a JDBC type (e.g. 'DATE', 'BIGINT') and value is same as column_options's value. +- **column_options**: advanced: 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`. (string, default: depends on the sql type of the column. Available values options are: `long`, `double`, `float`, `decimal`, `boolean`, `string`, `json`, `date`, `time`, `timestamp`) - **type**: Column values are converted to this embulk type. Available values options are: `boolean`, `long`, `double`, `string`, `json`, `timestamp`). By default, the embulk type is determined according to the sql type of the column (or value_type if specified). - **timestamp_format**: If the sql type of the column is `date`/`time`/`datetime` and the embulk type is `string`, column values are formatted by this timestamp_format. And if the embulk type is `timestamp`, this timestamp_format may be used in the output plugin. For example, stdout plugin use the timestamp_format, but *csv formatter plugin doesn't use*. (string, default : `%Y-%m-%d` for `date`, `%H:%M:%S` for `time`, `%Y-%m-%d %H:%M:%S` for `timestamp`) - **timezone**: If the sql type of the column is `date`/`time`/`datetime` and the embulk type is `string`, column values are formatted in this timezone. (string, value of default_timezone option is used by default) +- **before_setup**: if set, this SQL will be executed before setup. You can prepare table for input by this option. +- **before_select**: if set, this SQL will be executed before the SELECT query in the same transaction. - **after_select**: if set, this SQL will be executed after the SELECT query in the same transaction. ## Incremental loading @@ -84,11 +91,11 @@ ``` 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 primary key. Currently, only strings and integers are supported as incremental_columns. +Recommended usage is to leave `incremental_columns` unset and let this plugin automatically finds an AUTO_INCREMENT primary key. Currently, only strings, integers, DATETIME and TIMESTAMP are supported as incremental_columns. ## Trouble shooting - If you get an exception 'The server time zone value XXX is unrecognized ...', please set proper time zone to the MySQL server or set `true` to the `use_legacy_datetime_code` property. @@ -176,9 +183,12 @@ password: "" database: my_database table: "my_table" select: "col1, col2, col3" where: "col4 != 'a'" + default_column_options: + TIMESTAMP: { type: string, timestamp_format: "%Y/%m/%d %H:%M:%S", timezone: "+0900"} + BIGINT: { type: string } column_options: col1: {type: long} col3: {type: string, timestamp_format: "%Y/%m/%d", timezone: "+0900"} after_select: "update my_table set col5 = '1' where col4 != 'a'"