embulk-input-sqlserver 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5a1730a2670e28e2dda5ba09c2e9709ff9a84a3
+  data.tar.gz: dc4ce4f5a11f96f0f78abe0a0fa17a38305a6e64
+SHA512:
+  metadata.gz: 50c65fc5f5e5a37efc03480c953ee266cb5816d7d90ba0fa60923271baef2791d234db0ec9966f18aac8bda9adb896c954acee3f179eb4e1e885149608e218aa
+  data.tar.gz: 8466efeb12ebd8fa0356fbf622a7d6d07092bf7030bc5f00ae605d8cc689f304346316bbf84f1ef888f058e718d6f7317b224eff0eff6d3fdc7a8dc053e64679

data/README.md

@@ -0,0 +1,102 @@
+# SQL Server input plugins for Embulk
+
+SQL Server input plugins for Embulk loads records from SQL Server.
+
+## Overview
+
+* **Plugin type**: input
+* **Resume supported**: yes
+
+## Configuration
+
+- **driver_path**: path to the jar file of the SQL Server JDBC driver (string)
+- **host**: database host name (string, required if url is not set)
+- **port**: database port number (integer, default: 1433)
+- **integratedSecutiry**: whether to use integrated authentication or not. The `sqljdbc_auth.dll` must be located on Java library path if using integrated authentication. : (boolean, default: false)
+```
+rem C:\drivers\sqljdbc_auth.dll
+embulk "-J-Djava.library.path=C:\drivers" run input-sqlserver.yml
+```
+- **user**: database login user name (string, required if not using integrated authentication)
+- **password**: database login password (string, default: "")
+- **instance**: destination instance name (string, default: use the default instance)
+- **database**: destination database name (string, default: use the default database)
+- **url**: URL of the JDBC connection (string, optional)
+- 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: "*")
+  - **where**: WHERE condition to filter the rows (string, default: no-condition)
+- **fetch_rows**: number of rows to fetch one time (used for java.sql.Statement#setFetchSize) (integer, default: 10000)
+- **options**: extra JDBC properties (hash, default: {})
+- **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`.
+  (string, default: depends on the sql type of the column. Available values options are: `long`, `double`, `float`, `decimal`, `boolean`, `string`, `date`, `time`, `timestamp`)
+  - **type**: Column values are converted to this embulk type.
+  Available values options are: `boolean`, `long`, `double`, `string`, `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)
+
+## Example
+
+```yaml
+in:
+  type: sqlserver
+  driver_path: C:\drivers\sqljdbc41.jar
+  host: localhost
+  user: myuser
+  password: ""
+  instance: MSSQLSERVER
+  database: my_database
+  table: my_table
+  select: "col1, col2, col3"
+  where: "col4 != 'a'"
+```
+
+If you need a complex SQL,
+
+```yaml
+in:
+  type: sqlserver
+  driver_path: C:\drivers\sqljdbc41.jar
+  host: localhost
+  user: myuser
+  password: ""
+  instance: MSSQLSERVER
+  database: my_database
+  query: |
+    SELECT t1.id, t1.name, t2.id AS t2_id, t2.name AS t2_name
+    FROM table1 AS t1
+    LEFT JOIN table2 AS t2
+      ON t1.id = t2.t1_id
+```
+
+Advanced configuration:
+
+```yaml
+in:
+  type: sqlserver
+  driver_path: C:\drivers\sqljdbc41.jar
+  host: localhost
+  user: myuser
+  password: ""
+  instance: MSSQLSERVER
+  database: my_database
+  table: "my_table"
+  select: "col1, col2, col3"
+  where: "col4 != 'a'"
+  column_options:
+    col1: {type: long}
+    col3: {type: string, timestamp_format: "%Y/%m/%d", timezone: "+0900"}
+
+```
+
+## Build
+
+```
+$ ./gradlew gem
+```

data/build.gradle

@@ -0,0 +1,5 @@
+dependencies {
+    compile project(':embulk-input-jdbc')
+
+    testCompile project(':embulk-input-jdbc').sourceSets.test.output
+}

data/lib/embulk/input/sqlserver.rb

@@ -0,0 +1,3 @@
+Embulk::JavaPlugin.register_input(
+  :sqlserver, "org.embulk.input.SQLServerInputPlugin",
+  File.expand_path('../../../../classpath', __FILE__))

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

@@ -0,0 +1,145 @@
+package org.embulk.input;
+
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.sql.SQLException;
+import java.util.Properties;
+
+import org.embulk.config.Config;
+import org.embulk.config.ConfigDefault;
+import org.embulk.input.jdbc.AbstractJdbcInputPlugin;
+import org.embulk.input.jdbc.JdbcInputConnection;
+import org.embulk.input.sqlserver.SQLServerInputConnection;
+
+import com.google.common.base.Optional;
+
+public class SQLServerInputPlugin
+    extends AbstractJdbcInputPlugin
+{
+    public interface SQLServerPluginTask
+        extends PluginTask
+    {
+        @Config("driver_path")
+        @ConfigDefault("null")
+        public Optional<String> getDriverPath();
+
+        @Config("host")
+        @ConfigDefault("null")
+        public Optional<String> getHost();
+
+        @Config("port")
+        @ConfigDefault("1433")
+        public int getPort();
+
+        @Config("instance")
+        @ConfigDefault("null")
+        public Optional<String> getInstance();
+
+        @Config("database")
+        @ConfigDefault("null")
+        public Optional<String> getDatabase();
+
+        @Config("integratedSecurity")
+        @ConfigDefault("null")
+        public Optional<Boolean> getIntegratedSecurity();
+
+        @Config("url")
+        @ConfigDefault("null")
+        public Optional<String> getUrl();
+
+        @Config("user")
+        @ConfigDefault("null")
+        public Optional<String> getUser();
+
+        @Config("password")
+        @ConfigDefault("\"\"")
+        public Optional<String> getPassword();
+
+        @Config("schema")
+        @ConfigDefault("null")
+        public Optional<String> getSchema();
+    }
+
+    @Override
+    protected Class<? extends PluginTask> getTaskClass()
+    {
+        return SQLServerPluginTask.class;
+    }
+
+    @Override
+    protected JdbcInputConnection newConnection(PluginTask task) throws SQLException
+    {
+        SQLServerPluginTask sqlServerTask = (SQLServerPluginTask) task;
+
+        String url;
+        if (sqlServerTask.getUrl().isPresent()) {
+            if (sqlServerTask.getHost().isPresent()
+                    || sqlServerTask.getInstance().isPresent()
+                    || sqlServerTask.getDatabase().isPresent()
+                    || sqlServerTask.getIntegratedSecurity().isPresent()) {
+                throw new IllegalArgumentException("'host', 'port', 'instance', 'database' and 'integratedSecurity' parameters are invalid if 'url' parameter is set.");
+            }
+            url = sqlServerTask.getUrl().get();
+        } else {
+            if (!sqlServerTask.getHost().isPresent()) {
+                throw new IllegalArgumentException("Field 'host' is not set.");
+            }
+            if (!sqlServerTask.getDatabase().isPresent()) {
+                throw new IllegalArgumentException("Field 'database' is not set.");
+            }
+            StringBuilder urlBuilder = new StringBuilder();
+            if (sqlServerTask.getInstance().isPresent()) {
+                urlBuilder.append(String.format("jdbc:sqlserver://%s\\%s:%d",
+                        sqlServerTask.getHost().get(), sqlServerTask.getInstance().get(), sqlServerTask.getPort()));
+            } else {
+                urlBuilder.append(String.format("jdbc:sqlserver://%s:%d",
+                        sqlServerTask.getHost().get(), sqlServerTask.getPort()));
+            }
+            if (sqlServerTask.getDatabase().isPresent()) {
+                urlBuilder.append(";databaseName=" + sqlServerTask.getDatabase().get());
+            }
+            if (sqlServerTask.getIntegratedSecurity().isPresent() && sqlServerTask.getIntegratedSecurity().get()) {
+                urlBuilder.append(";integratedSecurity=" + sqlServerTask.getIntegratedSecurity().get());
+            } else {
+                if (!sqlServerTask.getUser().isPresent()) {
+                    throw new IllegalArgumentException("Field 'user' is not set.");
+                }
+                if (!sqlServerTask.getPassword().isPresent()) {
+                    throw new IllegalArgumentException("Field 'password' is not set.");
+                }
+            }
+            url = urlBuilder.toString();
+        }
+
+        Properties props = new Properties();
+        if (sqlServerTask.getUser().isPresent()) {
+            props.setProperty("user", sqlServerTask.getUser().get());
+        }
+        if (sqlServerTask.getPassword().isPresent()) {
+            props.setProperty("password", sqlServerTask.getPassword().get());
+        }
+        props.putAll(sqlServerTask.getOptions());
+
+        if (sqlServerTask.getDriverPath().isPresent()) {
+            loadDriverJar(sqlServerTask.getDriverPath().get());
+        }
+
+        try {
+            Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
+        } catch (Exception ex) {
+            throw new RuntimeException(ex);
+        }
+
+        Connection con = DriverManager.getConnection(url, props);
+        try {
+            SQLServerInputConnection c = new SQLServerInputConnection(con, sqlServerTask.getSchema().orNull());
+            con = null;
+            return c;
+        } finally {
+            if (con != null) {
+                con.close();
+            }
+        }
+    }
+
+}

data/src/main/java/org/embulk/input/sqlserver/SQLServerInputConnection.java

@@ -0,0 +1,21 @@
+package org.embulk.input.sqlserver;
+
+import java.sql.Connection;
+import java.sql.SQLException;
+
+import org.embulk.input.jdbc.JdbcInputConnection;
+
+public class SQLServerInputConnection extends JdbcInputConnection {
+
+    public SQLServerInputConnection(Connection connection, String schemaName) throws SQLException
+    {
+        super(connection, schemaName);
+    }
+
+    @Override
+    protected void setSearchPath(String schema) throws SQLException
+    {
+        // NOP
+    }
+
+}

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: embulk-input-sqlserver
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Sadayuki Furuhashi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-07-07 00:00:00.000000000 Z
+dependencies: []
+description: Selects records from a table.
+email:
+- frsyuki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- build.gradle
+- lib/embulk/input/sqlserver.rb
+- src/main/java/org/embulk/input/SQLServerInputPlugin.java
+- src/main/java/org/embulk/input/sqlserver/SQLServerInputConnection.java
+- classpath/embulk-input-jdbc-0.6.0.jar
+- classpath/embulk-input-sqlserver-0.6.0.jar
+homepage: https://github.com/embulk/embulk-input-jdbc
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+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
+signing_key:
+specification_version: 4
+summary: JDBC input plugin for Embulk
+test_files: []