duckdb 0.2.6.0 → 0.2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e1030a16d014daaab4b84c0c15cde0d023fcb0fb761bee97056127f3530533
-  data.tar.gz: 2010828495199a8959b2246c0de6262de273387daaa3b3b9a8ebbca6e2fda47c
+  metadata.gz: 1e40641b43de4613a5417e6f06fb50e23277394f4ba54aadc524afa319e15dbb
+  data.tar.gz: a5c578bb6fd9dee33ca0ab5af5d853e623fefec7fc9b74a43b4d6432cdec6fb5
 SHA512:
-  metadata.gz: da434b1e0f179cf6392beb998be0eba637cd782a74a4ea4474752b1c900afe1cbf43a5816cb7ff37c8b6e34226a0a2bcc4e4e89e54c28697e5ec39695775f31f
-  data.tar.gz: be2f05c2b472db0e548da9acd69aebd41ff0685fdcf925970af36d489882539a88fb51c49a791edd1e4f34daf9aac16311e15ce6771e9f504b987e1d29e1aa93
+  metadata.gz: 2db7f176dc767856e43a2f8e4991c0bd6229f4174e2c1e91595436f36320f4f2b2eb1db52186644641b0ed45e38798a2bf76688e398abe27d4c3b81eda780939
+  data.tar.gz: 0343b460f0f62393ecd6e550ce468fa28c0098ce236a87968ad2bc8eb2f4764e87448c7df80f328e39b1f07da1acef6e5a931dfafe91af222dc201ef41812f36

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # ChangeLog
 
+# 0.2.6.1
+
+- add DuckDB::PreparedStatement#bind_int8
+- DuckDB::Connection#appender accepts block.
+- add DuckDB::Appender#append_row.
+- support HUGEINT type.
+- add DuckDB::Appender#append.
+- rename PreparedStatement#bind_boolean to PreparedStatement#bind_bool.
+- add DuckDB::Connection#appender.
+
 # 0.2.6.0
 
 - change version policy

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    duckdb (0.2.6.0)
+    duckdb (0.2.6.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -68,7 +68,7 @@ end
 ### using BLOB column
 
 BLOB is available with DuckDB v0.2.5 or later.
-Use `DuckDB::Blob.new` or use sting#force_encoding(Encoding::ASCII_8BIT)
+Use `DuckDB::Blob.new` or use sting#force_encoding(Encoding::BINARY)
 
 ```
 require 'duckdb'
@@ -87,3 +87,69 @@ DuckDB::Database.open do |db|
   end
 end
 ```
+
+### Appender
+
+Appender class provides Ruby interface of [DuckDB Appender](https://duckdb.org/docs/data/appender)
+
+```
+require 'duckdb'
+require 'benchmark'
+
+def insert
+  DuckDB::Database.open do |db|
+    db.connect do |con|
+      con.query('CREATE TABLE users (id INTEGER, name VARCHAR(30))')
+      10000.times do
+        con.query("INSERT into users VALUES(1, 'Alice')")
+      end
+      # r = con.query('SELECT count(*) from users')
+      # p r.each.first
+    end
+  end
+end
+
+def prepare
+  DuckDB::Database.open do |db|
+    db.connect do |con|
+      con.query('CREATE TABLE users (id INTEGER, name VARCHAR(30))')
+      stmt = con.prepared_statement('INSERT INTO users VALUES($1, $2)')
+      10000.times do
+        stmt.bind(1, 1)
+        stmt.bind(2, 'Alice')
+        stmt.execute
+      end
+    end
+  end
+end
+
+def append
+  DuckDB::Database.open do |db|
+    db.connect do |con|
+      con.query('CREATE TABLE users (id INTEGER, name VARCHAR(30))')
+      appender = con.appender('users')
+      10000.times do
+        appender.begin_row
+        appender.append(1)
+        appender.append('Alice')
+        appender.end_row
+      end
+      appender.flush
+      # r = con.query('SELECT count(*) from users')
+      # p r.each.first
+    end
+  end
+end
+
+Benchmark.bm(8) do |x|
+  x.report('insert') { insert }
+  x.report('prepare') { prepare }
+  x.report('append') { append }
+end
+
+# =>
+#                user     system      total        real
+# insert     0.637439   0.000000   0.637439 (  0.637486 )
+# prepare    0.230457   0.000000   0.230457 (  0.230460 )
+# append     0.012666   0.000000   0.012666 (  0.012670 )
+```

data/ext/duckdb/appender.c

@@ -112,7 +112,7 @@ static VALUE appender_append_int8(VALUE self, VALUE val) {
 
 static VALUE appender_append_int16(VALUE self, VALUE val) {
     rubyDuckDBAppender *ctx;
-    int16_t i16val = NUM2INT(val);
+    int16_t i16val = (int16_t)NUM2INT(val);
 
     Data_Get_Struct(self, rubyDuckDBAppender, ctx);
 
@@ -136,7 +136,7 @@ static VALUE appender_append_int32(VALUE self, VALUE val) {
 
 static VALUE appender_append_int64(VALUE self, VALUE val) {
     rubyDuckDBAppender *ctx;
-    int64_t i64val = NUM2LL(val);
+    int64_t i64val = (int64_t)NUM2LL(val);
 
     Data_Get_Struct(self, rubyDuckDBAppender, ctx);
 
@@ -184,7 +184,7 @@ static VALUE appender_append_uint32(VALUE self, VALUE val) {
 
 static VALUE appender_append_uint64(VALUE self, VALUE val) {
     rubyDuckDBAppender *ctx;
-    uint64_t ui64val = (int64_t)NUM2ULL(val);
+    uint64_t ui64val = (uint64_t)NUM2ULL(val);
 
     Data_Get_Struct(self, rubyDuckDBAppender, ctx);
 

data/ext/duckdb/prepared_statement.c

@@ -70,7 +70,7 @@ static idx_t check_index(VALUE vidx)
     return idx;
 }
 
-static VALUE duckdb_prepared_statement_bind_boolean(VALUE self, VALUE vidx, VALUE val)
+static VALUE duckdb_prepared_statement_bind_bool(VALUE self, VALUE vidx, VALUE val)
 {
     rubyDuckDBPreparedStatement *ctx;
     idx_t idx = check_index(vidx);
@@ -86,6 +86,20 @@ static VALUE duckdb_prepared_statement_bind_boolean(VALUE self, VALUE vidx, VALU
     return self;
 }
 
+static VALUE duckdb_prepared_statement_bind_int8(VALUE self, VALUE vidx, VALUE val)
+{
+    rubyDuckDBPreparedStatement *ctx;
+    idx_t idx = check_index(vidx);
+    int8_t i8val = (int8_t)NUM2INT(val);
+
+    Data_Get_Struct(self, rubyDuckDBPreparedStatement, ctx);
+
+    if (duckdb_bind_int8(ctx->prepared_statement, idx, i8val) == DuckDBError) {
+        rb_raise(eDuckDBError, "fail to bind %llu parameter", (unsigned long long)idx);
+    }
+    return self;
+}
+
 static VALUE duckdb_prepared_statement_bind_int16(VALUE self, VALUE vidx, VALUE val)
 {
     rubyDuckDBPreparedStatement *ctx;
@@ -203,7 +217,8 @@ void init_duckdb_prepared_statement(void)
     rb_define_method(cDuckDBPreparedStatement, "initialize", duckdb_prepared_statement_initialize, 2);
     rb_define_method(cDuckDBPreparedStatement, "execute", duckdb_prepared_statement_execute, 0);
     rb_define_method(cDuckDBPreparedStatement, "nparams", duckdb_prepared_statement_nparams, 0);
-    rb_define_method(cDuckDBPreparedStatement, "bind_boolean", duckdb_prepared_statement_bind_boolean, 2);
+    rb_define_method(cDuckDBPreparedStatement, "bind_bool", duckdb_prepared_statement_bind_bool, 2);
+    rb_define_method(cDuckDBPreparedStatement, "bind_int8", duckdb_prepared_statement_bind_int8, 2);
     rb_define_method(cDuckDBPreparedStatement, "bind_int16", duckdb_prepared_statement_bind_int16, 2);
     rb_define_method(cDuckDBPreparedStatement, "bind_int32", duckdb_prepared_statement_bind_int32, 2);
     rb_define_method(cDuckDBPreparedStatement, "bind_int64", duckdb_prepared_statement_bind_int64, 2);

data/ext/duckdb/result.c

@@ -88,6 +88,9 @@ static VALUE to_ruby_obj(duckdb_result *result, idx_t col_idx, idx_t row_idx)
         p = duckdb_value_varchar(result, col_idx, row_idx);
         obj = rb_str_new2(p);
         free(p);
+        if (result->columns[col_idx].type == DUCKDB_TYPE_HUGEINT) {
+            obj = rb_funcall(obj, rb_intern("to_i"), 0);
+        }
     }
     return obj;
 }

data/lib/duckdb.rb

@@ -4,6 +4,7 @@ require 'duckdb/database'
 require 'duckdb/connection'
 require 'duckdb/result'
 require 'duckdb/prepared_statement'
+require 'duckdb/appender'
 
 # DuckDB provides Ruby interface of DuckDB.
 module DuckDB

data/lib/duckdb/appender.rb

@@ -0,0 +1,102 @@
+require 'date'
+
+module DuckDB
+  if defined?(DuckDB::Appender)
+    # The DuckDB::Appender encapsulates DuckDB Appender.
+    #
+    #   require 'duckdb'
+    #   db = DuckDB::Database.open
+    #   con = db.connect
+    #   con.query('CREATE TABLE users (id INTEGER, name VARCHAR)')
+    #   appender = con.appender('users')
+    #   appender.append_row(1, 'Alice')
+    #
+    class Appender
+      RANGE_INT16 = (-32_768..32_767).freeze
+      RANGE_INT32 = (-2_147_483_648..2_147_483_647).freeze
+      RANGE_INT64 = (-9_223_372_036_854_775_808..9_223_372_036_854_775_807).freeze
+
+      def append_hugeint(value)
+        case value
+        when Integer
+          append_varchar(value.to_s)
+        else
+          rb_raise(ArgumentError, "2nd argument `#{value}` must be Integer.")
+        end
+      end
+
+      #
+      # appends value.
+      #
+      #   require 'duckdb'
+      #   db = DuckDB::Database.open
+      #   con = db.connect
+      #   con.query('CREATE TABLE users (id INTEGER, name VARCHAR)')
+      #   appender = con.appender('users')
+      #   appender.begin_row
+      #   appender.append(1)
+      #   appender.append('Alice')
+      #   appender.end_row
+      #
+      def append(value)
+        case value
+        when NilClass
+          append_null
+        when Float
+          append_double(value)
+        when Integer
+          case value
+          when RANGE_INT16
+            append_int16(value)
+          when RANGE_INT32
+            append_int32(value)
+          when RANGE_INT64
+            append_int64(value)
+          else
+            append_hugeint(value)
+          end
+        when String
+          if defined?(DuckDB::Blob)
+            blob?(value) ? append_blob(value) : append_varchar(value)
+          else
+            append_varchar(value)
+          end
+        when TrueClass, FalseClass
+          append_bool(value)
+        when Time
+          append_varchar(value.strftime('%Y-%m-%d %H:%M:%S.%N'))
+        when Date
+          append_varchar(value.strftime('%Y-%m-%d'))
+        else
+          rb_raise(DuckDB::Error, "not supported type #{value} (value.class)")
+        end
+      end
+
+      #
+      # append a row.
+      #
+      #   appender.append_row(1, 'Alice')
+      #
+      # is same as:
+      #
+      #   appender.begin_row
+      #   appender.append(1)
+      #   appender.append('Alice')
+      #   appender.end_row
+      #
+      def append_row(*args)
+        begin_row
+        args.each do |arg|
+          append(arg)
+        end
+        end_row
+      end
+
+      private
+
+      def blob?(value)
+        value.instance_of?(DuckDB::Blob) || value.encoding == Encoding::BINARY
+      end
+    end
+  end
+end

data/lib/duckdb/connection.rb

@@ -52,6 +52,27 @@ module DuckDB
       PreparedStatement.new(self, str)
     end
 
+    #
+    # returns Appender object.
+    # The first argument is table name
+    #
+    def appender(table)
+      appender = create_appender(table)
+
+      return appender unless block_given?
+
+      yield appender
+      appender.flush
+      appender.close
+    end
+
+    private
+
+    def create_appender(table)
+      t1, t2 = table.split('.')
+      t2 ? Appender.new(self, t1, t2) : Appender.new(self, t2, t1)
+    end
+
     alias execute query
     alias open connect
     alias close disconnect

data/lib/duckdb/prepared_statement.rb

@@ -13,6 +13,19 @@ module DuckDB
   #   stmt.execute
   class PreparedStatement
 
+    RANGE_INT16 = -32768..32767
+    RANGE_INT32 = -2147483648..2147483647
+    RANGE_INT64 = -9223372036854775808..9223372036854775807
+
+    def bind_hugeint(i, value)
+      case value
+      when Integer
+        bind_varchar(i, value.to_s)
+      else
+        rb_raise(ArgumentError, "2nd argument `#{value}` must be Integer.")
+      end
+    end
+
     # binds i-th parameter with SQL prepared statement.
     # The first argument is index of parameter. The index of first parameter is
     # 1 not 0.
@@ -31,7 +44,12 @@ module DuckDB
       when Float
         bind_double(i, value)
       when Integer
-        bind_int64(i, value)
+        case value
+        when RANGE_INT64
+          bind_int64(i, value)
+        else
+          bind_varchar(i, value.to_s)
+        end
       when String
         if defined?(DuckDB::Blob)
           blob?(value) ? bind_blob(i, value) : bind_varchar(i, value)
@@ -39,7 +57,7 @@ module DuckDB
           bind_varchar(i, value)
         end
       when TrueClass, FalseClass
-        bind_boolean(i, value)
+        bind_bool(i, value)
       when Time
         bind_varchar(i, value.strftime('%Y-%m-%d %H:%M:%S.%N'))
       when Date

data/lib/duckdb/version.rb

@@ -1,5 +1,5 @@
 module DuckDB
   # The version string of ruby-duckdb.
   # Currently, ruby-duckdb is NOT semantic versioning.
-  VERSION = '0.2.6.0'.freeze
+  VERSION = '0.2.6.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duckdb
 version: !ruby/object:Gem::Version
-  version: 0.2.6.0
+  version: 0.2.6.1
 platform: ruby
 authors:
 - Masaki Suketa
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - ext/duckdb/result.h
 - ext/duckdb/ruby-duckdb.h
 - lib/duckdb.rb
+- lib/duckdb/appender.rb
 - lib/duckdb/connection.rb
 - lib/duckdb/database.rb
 - lib/duckdb/prepared_statement.rb
@@ -118,7 +119,7 @@ metadata:
   homepage_uri: https://github.com/suketa/ruby-duckdb
   source_code_uri: https://github.com/suketa/ruby-duckdb
   changelog_uri: https://github.com/suketa/ruby-duckdb/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: This module is Ruby binding for DuckDB database engine.
 test_files: []