duckdb 0.2.7.0 → 0.2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 309d9f5ae00645a93cd5bf8bd706f12391e1386336516d172e1963b963df5ab4
-  data.tar.gz: 8814748ae38a1b501d21b69f47b262124771ddc382dfcdbba3d7b3b88b3cb691
+  metadata.gz: a07cf98bca895ec39cc43754e6f69544e22c16cab023554daa632dc0be14d527
+  data.tar.gz: d2e96a7556e9ab139fb4b03f8306961d011c80ff9eb259bb8f29cdbd390ea757
 SHA512:
-  metadata.gz: 96d87f3dfa1e8366e98a0a93e1f6506508c885131eb4287ec2463eea8040fb1cc87436a10871cecb83b524d97173443d9b1c42330a5f311c210ffb921b64a7d9
-  data.tar.gz: fed84bbde6a9c6b696e9a52bf769810788b7b49d845ddca065cafcfc535540d62127d395524ca4fee86cfba9213c82fe74204063ea674d14498d7f82f0c34e33
+  metadata.gz: fc64b4021083e0837de1c22470b015be7337f2e43754771c36b4265f133542bb7161762fa51a46f2ec9f9ac992bf67bb45e7d8031206f4cd385f248bddcff14d
+  data.tar.gz: 131cb3b1ee245cb765b8b7081d8fb900634055cf6570e6220121991e275d53e7be44ac1c1274c64f4c8991cd3252823274fd887fa3b49a31c8dc9578dd4aade6

data/.github/workflows/test_on_macos.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        ruby: ['2.5.8', '2.6.7', '2.7.3', '3.0.1', 'head']
+        ruby: ['2.5.8', '2.6.8', '2.7.4', '3.0.2', 'head']
 
     steps:
     - uses: actions/checkout@v2

data/.github/workflows/test_on_ubuntu.yml

@@ -8,8 +8,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['2.5.8', '2.6.7', '2.7.3', '3.0.1', 'head']
-        duckdb: ['0.2.6', '0.2.7']
+        ruby: ['2.5.8', '2.6.8', '2.7.4', '3.0.2', 'head']
+        duckdb: ['0.2.8', '0.2.7']
 
     steps:
     - uses: actions/checkout@v2
@@ -19,14 +19,14 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
 
-    - name: duckdb 0.2.6 cache
-      id: duckdb-cache-v0_2_6
+    - name: duckdb 0.2.8 cache
+      id: duckdb-cache-v0_2_8
       uses: actions/cache@v1.1.0
       with:
-        path: duckdb-v0.2.6
-        key: ${{ runner.os }}-duckdb-v0_2_6_001
+        path: duckdb-v0.2.8
+        key: ${{ runner.os }}-duckdb-v0_2_8_001
         restore-keys: |
-          ${{ runner.os }}-duckdb-v0_2_6
+          ${{ runner.os }}-duckdb-v0_2_8
 
     - name: duckdb 0.2.7 cache
       id: duckdb-cache-v0_2_7
@@ -37,15 +37,15 @@ jobs:
         restore-keys: |
           ${{ runner.os }}-duckdb-v0_2_7
 
-    - name: Build duckdb 0.2.6
-      if: steps.duckdb-cache-v0_2_6.outputs.cache-hit != 'true'
+    - name: Build duckdb 0.2.8
+      if: steps.duckdb-cache-v0_2_8.outputs.cache-hit != 'true'
       run: |
-        git clone -b v0.2.6 https://github.com/cwida/duckdb.git duckdb-tmp-v0.2.6
-        cd duckdb-tmp-v0.2.6 && make && cd ..
-        rm -rf duckdb-v0.2.6
-        mkdir -p duckdb-v0.2.6/build/release/src duckdb-v0.2.6/src
-        cp -rip duckdb-tmp-v0.2.6/build/release/src/*.so duckdb-v0.2.6/build/release/src
-        cp -rip duckdb-tmp-v0.2.6/src/include duckdb-v0.2.6/src/
+        git clone -b v0.2.8 https://github.com/cwida/duckdb.git duckdb-tmp-v0.2.8
+        cd duckdb-tmp-v0.2.8 && make && cd ..
+        rm -rf duckdb-v0.2.8
+        mkdir -p duckdb-v0.2.8/build/release/src duckdb-v0.2.8/src
+        cp -rip duckdb-tmp-v0.2.8/build/release/src/*.so duckdb-v0.2.8/build/release/src
+        cp -rip duckdb-tmp-v0.2.8/src/include duckdb-v0.2.8/src/
 
     - name: Build duckdb 0.2.7
       if: steps.duckdb-cache-v0_2_7.outputs.cache-hit != 'true'

data/.travis.yml

@@ -2,17 +2,17 @@ language: ruby
 cache:
   bundler: true
   directories:
-    - ${HOME}/duckdb-v0.2.7
+    - ${HOME}/duckdb-v0.2.8
 before_install:
   - yes | gem update --system
-  - if [[ ! -d ${HOME}/duckdb-v0.2.7/build ]]; then cd ${HOME} && git clone -b v0.2.7 https://github.com/cwida/duckdb.git duckdb-v0.2.7 && cd duckdb-v0.2.7 && make && cd ${TRAVIS_BUILD_DIR}; fi
+  - if [[ ! -d ${HOME}/duckdb-v0.2.8/build ]]; then cd ${HOME} && git clone -b v0.2.8 https://github.com/cwida/duckdb.git duckdb-v0.2.8 && cd duckdb-v0.2.8 && make && cd ${TRAVIS_BUILD_DIR}; fi
 
 env:
-  - DUCKDB_VERSION=0.2.7
+  - DUCKDB_VERSION=0.2.8
 rvm:
   - 2.5.8
-  - 2.6.7
-  - 2.7.3
-  - 3.0.1
+  - 2.6.8
+  - 2.7.4
+  - 3.0.2
   - ruby-head
 script: bundle exec rake -- --with-duckdb-include=${HOME}/duckdb-v${DUCKDB_VERSION}/src/include --with-duckdb-lib=${HOME}/duckdb-v${DUCKDB_VERSION}/build/release/src/

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # ChangeLog
 
+- DuckDB::Database.open accepts 2-nd argument as DuckDB::Config object.
+- add DuckDB::Config
+- bump duckdb to 0.2.8 in CI
+- bump Ruby to 2.6.8, 2.7.4, 3.0.2 in CI
+
 # 0.2.7.0
 
 - call duckdb_free after calling duckdb_value_blob, duckdb_value_varchar.

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    duckdb (0.2.7.0)
+    duckdb (0.2.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     minitest (5.14.4)
-    rake (13.0.3)
+    rake (13.0.6)
     rake-compiler (1.1.1)
       rake
 
@@ -22,4 +22,4 @@ DEPENDENCIES
   rake-compiler
 
 BUNDLED WITH
-   2.2.17
+   2.2.25

data/README.md

@@ -149,3 +149,21 @@ end
 # prepare    0.230457   0.000000   0.230457 (  0.230460 )
 # append     0.012666   0.000000   0.012666 (  0.012670 )
 ```
+
+### Configuration
+
+Config class provides Ruby interface of [DuckDB configuration](https://duckdb.org/docs/api/c/config).
+
+```
+require 'duckdb'
+config = DuckDB::Config.new
+config['default_order'] = 'DESC'
+db = DuckDB::Database.open(nil, config)
+con = db.connect
+con.query('CREATE TABLE numbers (number INTEGER)')
+con.query('INSERT INTO numbers VALUES (2), (1), (4), (3)')
+
+# number is ordered by descending.
+r = con.query('SELECT number FROM numbers ORDER BY number')
+r.first.first # => 4
+```

data/ext/duckdb/config.c

@@ -0,0 +1,80 @@
+#include "ruby-duckdb.h"
+
+#ifdef HAVE_DUCKDB_CREATE_CONFIG
+
+VALUE cDuckDBConfig;
+
+static void deallocate(void *);
+static VALUE allocate(VALUE klass);
+static VALUE config_s_size(VALUE klass);
+static VALUE config_s_get_config_flag(VALUE self, VALUE value);
+static VALUE config_initialize(VALUE self);
+static VALUE config_set_config(VALUE self, VALUE key, VALUE value);
+
+static void deallocate(void * ctx)
+{
+    rubyDuckDBConfig *p = (rubyDuckDBConfig *)ctx;
+
+    duckdb_destroy_config(&(p->config));
+    xfree(p);
+}
+
+static VALUE allocate(VALUE klass)
+{
+    rubyDuckDBConfig *ctx = xcalloc((size_t)1, sizeof(rubyDuckDBConfig));
+    return Data_Wrap_Struct(klass, NULL, deallocate, ctx);
+}
+
+static VALUE config_initialize(VALUE self) {
+    rubyDuckDBConfig *ctx;
+
+    Data_Get_Struct(self, rubyDuckDBConfig, ctx);
+
+    if (duckdb_create_config(&(ctx->config)) == DuckDBError) {
+        rb_raise(eDuckDBError, "failed to create config");
+    }
+    return self;
+}
+
+static VALUE config_s_size(VALUE self) {
+    return INT2NUM(duckdb_config_count());
+}
+
+static VALUE config_s_get_config_flag(VALUE klass, VALUE value) {
+    const char *pkey;
+    const char *pdesc;
+
+    size_t i = NUM2INT(value);
+
+    if (duckdb_get_config_flag(i, &pkey, &pdesc) == DuckDBError) {
+        rb_raise(eDuckDBError, "failed to get config information of index %ld", i);
+    }
+
+    return rb_ary_new3(2, rb_str_new2(pkey), rb_str_new2(pdesc));
+}
+
+static VALUE config_set_config(VALUE self, VALUE key, VALUE value) {
+    const char *pkey = StringValuePtr(key);
+    const char *pval = StringValuePtr(value);
+
+    rubyDuckDBConfig *ctx;
+    Data_Get_Struct(self, rubyDuckDBConfig, ctx);
+
+    if (duckdb_set_config(ctx->config, pkey, pval) == DuckDBError) {
+        rb_raise(eDuckDBError, "failed to set config %s => %s", pkey, pval);
+    }
+    return self;
+}
+
+void init_duckdb_config(void) {
+    cDuckDBConfig = rb_define_class_under(mDuckDB, "Config", rb_cObject);
+    rb_define_alloc_func(cDuckDBConfig, allocate);
+    rb_define_singleton_method(cDuckDBConfig, "size", config_s_size, 0);
+    rb_define_singleton_method(cDuckDBConfig, "get_config_flag", config_s_get_config_flag, 1);
+
+    rb_define_method(cDuckDBConfig, "initialize", config_initialize, 0);
+    rb_define_method(cDuckDBConfig, "set_config", config_set_config, 2);
+}
+
+#endif
+

data/ext/duckdb/config.h

@@ -0,0 +1,18 @@
+#ifndef RUBY_DUCKDB_CONFIG_H
+#define RUBY_DUCKDB_CONFIG_H
+
+#ifdef HAVE_DUCKDB_CREATE_CONFIG
+
+struct _rubyDuckDBConfig {
+    duckdb_config config;
+};
+
+typedef struct _rubyDuckDBConfig rubyDuckDBConfig;
+
+void init_duckdb_config(void);
+
+#endif
+
+#endif
+
+

data/ext/duckdb/database.c

@@ -2,6 +2,12 @@
 
 VALUE cDuckDBDatabase;
 
+static void close_database(rubyDuckDB *p);
+static void deallocate(void * ctx);
+static VALUE allocate(VALUE klass);
+static VALUE duckdb_database_s_open(int argc, VALUE *argv, VALUE cDuckDBDatabase);
+static VALUE duckdb_database_s_open_ext(int argc, VALUE *argv, VALUE cDuckDBDatabase);
+
 static void close_database(rubyDuckDB *p)
 {
     duckdb_close(&(p->db));
@@ -25,6 +31,7 @@ static VALUE duckdb_database_s_open(int argc, VALUE *argv, VALUE cDuckDBDatabase
 {
     rubyDuckDB *ctx;
     VALUE obj;
+
     char *pfile = NULL;
     VALUE file = Qnil;
 
@@ -36,13 +43,49 @@ static VALUE duckdb_database_s_open(int argc, VALUE *argv, VALUE cDuckDBDatabase
 
     obj = allocate(cDuckDBDatabase);
     Data_Get_Struct(obj, rubyDuckDB, ctx);
-    if (duckdb_open(pfile, &(ctx->db)) == DuckDBError)
-    {
+    if (duckdb_open(pfile, &(ctx->db)) == DuckDBError) {
         rb_raise(eDuckDBError, "Failed to open database"); /* FIXME */
     }
     return obj;
 }
 
+#ifdef HAVE_DUCKDB_OPEN_EXT
+static VALUE duckdb_database_s_open_ext(int argc, VALUE *argv, VALUE cDuckDBDatabase)
+{
+    rubyDuckDB *ctx;
+    VALUE obj;
+    rubyDuckDBConfig *ctx_config;
+    char *perror;
+
+    char *pfile = NULL;
+    VALUE file = Qnil;
+    VALUE config = Qnil;
+
+    rb_scan_args(argc, argv, "02", &file, &config);
+
+    if (!NIL_P(file)) {
+        pfile = StringValuePtr(file);
+    }
+
+    obj = allocate(cDuckDBDatabase);
+    Data_Get_Struct(obj, rubyDuckDB, ctx);
+    if (!NIL_P(config)) {
+        if (!rb_obj_is_kind_of(config, cDuckDBConfig)) {
+            rb_raise(rb_eTypeError, "The second argument must be DuckDB::Config object.");
+        }
+        Data_Get_Struct(config, rubyDuckDBConfig, ctx_config);
+        if (duckdb_open_ext(pfile, &(ctx->db), ctx_config->config, &perror) == DuckDBError) {
+            rb_raise(eDuckDBError, "Failed to open database %s", perror);
+        }
+    } else {
+        if (duckdb_open(pfile, &(ctx->db)) == DuckDBError) {
+            rb_raise(eDuckDBError, "Failed to open database"); /* FIXME */
+        }
+    }
+    return obj;
+}
+#endif /* HAVE_DUCKDB_OPEN_EXT */
+
 static VALUE duckdb_database_connect(VALUE self)
 {
     return create_connection(self);
@@ -67,6 +110,9 @@ void init_duckdb_database(void)
     cDuckDBDatabase = rb_define_class_under(mDuckDB, "Database", rb_cObject);
     rb_define_alloc_func(cDuckDBDatabase, allocate);
     rb_define_singleton_method(cDuckDBDatabase, "_open", duckdb_database_s_open, -1);
+#ifdef HAVE_DUCKDB_OPEN_EXT
+    rb_define_singleton_method(cDuckDBDatabase, "_open_ext", duckdb_database_s_open_ext, -1);
+#endif
     rb_define_private_method(cDuckDBDatabase, "_connect", duckdb_database_connect, 0);
     rb_define_method(cDuckDBDatabase, "close", duckdb_database_close, 0);
 }

data/ext/duckdb/duckdb.c

@@ -24,4 +24,10 @@ Init_duckdb_native(void)
     init_duckdb_appender();
 
 #endif /* HAVE_DUCKDB_APPENDER_CREATE */
+
+#ifdef HAVE_DUCKDB_CREATE_CONFIG
+
+    init_duckdb_config();
+
+#endif /* HAVE_DUCKDB_CREATE_CONFIG */
 }

data/ext/duckdb/extconf.rb

@@ -6,5 +6,7 @@ if have_library('duckdb')
   have_func('duckdb_bind_blob', 'duckdb.h')
   have_func('duckdb_appender_create', 'duckdb.h')
   have_func('duckdb_free', 'duckdb.h')
+  have_func('duckdb_create_config', 'duckdb.h')
+  have_func('duckdb_open_ext', 'duckdb.h')
   create_makefile('duckdb/duckdb_native')
 end

data/ext/duckdb/ruby-duckdb.h

@@ -21,6 +21,12 @@
 
 #endif /* HAVE_DUCKDB_APPENDER_CREATE */
 
+#ifdef HAVE_DUCKDB_CREATE_CONFIG
+
+#include "./config.h"
+
+#endif /* HAVE_DUCKDB_CREATE_CONFIG */
+
 extern VALUE mDuckDB;
 extern VALUE cDuckDBDatabase;
 extern VALUE cDuckDBConnection;
@@ -31,6 +37,12 @@ extern VALUE cDuckDBBlob;
 
 #endif /* HAVE_DUCKDB_VALUE_BLOB */
 
+#ifdef HAVE_DUCKDB_CREATE_CONFIG
+
+extern VALUE cDuckDBConfig;
+
+#endif /* HAVE_DUCKDB_CREATE_CONFIG */
+
 extern VALUE eDuckDBError;
 
 #endif

data/lib/duckdb/appender.rb

@@ -12,9 +12,9 @@ module DuckDB
     #   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
+      RANGE_INT16 = -32_768..32_767
+      RANGE_INT32 = -2_147_483_648..2_147_483_647
+      RANGE_INT64 = -9_223_372_036_854_775_808..9_223_372_036_854_775_807
 
       def append_hugeint(value)
         case value

data/lib/duckdb/config.rb

@@ -0,0 +1,65 @@
+module DuckDB
+  if defined?(DuckDB::Config)
+    # The DuckDB::Config encapsulates DuckDB Configuration.
+    #
+    #   require 'duckdb'
+    #   config = DuckDB::Config.new
+    #   config['default_order'] = 'DESC'
+    #   db = DuckDB::Database.open(nil, config)
+    #   con = db.connect
+    #   con.query('CREATE TABLE numbers (number INTEGER)')
+    #   con.query('INSERT INTO numbers VALUES (2), (1), (4), (3)')
+    #
+    #   # number is ordered by descending.
+    #   r = con.query('SELECT number FROM numbers ORDER BY number)
+    #   r.first.first # => 4
+    class Config
+      class << self
+        #
+        # returns available configuration name and the description.
+        # The return value is array object. The first element is the configuration
+        # name. The second is the description.
+        #
+        #   key, desc = DuckDB::Config.key_description(0)
+        #   key # => "access_mode"
+        #   desc # => "Access mode of the database ([AUTOMATIC], READ_ONLY or READ_WRITE)"
+        #
+        alias key_description get_config_flag
+
+        #
+        # returns the Hash object of all available configuration names and
+        # the descriptions.
+        #
+        # configs = DuckDB::Config.key_descriptions
+        # configs['default_order'] # => "The order type used when none is specified ([ASC] or DESC)"
+        #
+        def key_descriptions
+          return @key_descriptions if @key_descriptions
+
+          n = size
+          @key_descriptions = (0...n).each_with_object({}) do |i, hash|
+            key, description = key_description(i)
+            hash[key] = description
+          end
+        end
+      end
+
+      #
+      # set configuration value
+      #
+      #   config = DuckDB::Config.new
+      #   # config.set_config('default_order', 'DESC')
+      #   config['default_order'] = 'DESC'
+      #
+      #   db = DuckDB::Database.open(nil, config)
+      #   con = db.connect
+      #   con.query('CREATE TABLE numbers (number INTEGER)')
+      #   con.query('INSERT INTO numbers VALUES (2), (1), (4), (3)')
+      #
+      #   # numbers are ordered by descending.
+      #   r = con.query('SELECT number FROM numbers ORDER BY number)
+      #   r.first.first # => 4
+      alias []= set_config
+    end
+  end
+end

data/lib/duckdb/database.rb

@@ -21,6 +21,7 @@ module DuckDB
   #
   class Database
     private_class_method :_open
+    private_class_method :_open_ext if defined?(DuckDB::Config)
 
     class << self
       ##
@@ -38,8 +39,8 @@ module DuckDB
       #     con.query('CREATE TABLE users (id INTEGER, name VARCHAR(30))')
       #   end
       #
-      def open(*args)
-        db = _open(*args)
+      def open(dbpath = nil, config = nil)
+        db = _db_open(dbpath, config)
         return db unless block_given?
 
         begin
@@ -48,6 +49,18 @@ module DuckDB
           db.close
         end
       end
+
+      private
+
+      def _db_open(dbpath, config)
+        if defined?(DuckDB::Config) && config
+          _open_ext(dbpath, config)
+        elsif config
+          _open(dbpath, config)
+        else
+          _open(dbpath)
+        end
+      end
     end
 
     ##

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.7.0'.freeze
+  VERSION = '0.2.8.0'.freeze
 end

data/lib/duckdb.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duckdb
 version: !ruby/object:Gem::Version
-  version: 0.2.7.0
+  version: 0.2.8.0
 platform: ruby
 authors:
 - Masaki Suketa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-19 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,6 +93,8 @@ files:
 - ext/duckdb/appender.h
 - ext/duckdb/blob.c
 - ext/duckdb/blob.h
+- ext/duckdb/config.c
+- ext/duckdb/config.h
 - ext/duckdb/connection.c
 - ext/duckdb/connection.h
 - ext/duckdb/database.c
@@ -108,6 +110,7 @@ files:
 - ext/duckdb/ruby-duckdb.h
 - lib/duckdb.rb
 - lib/duckdb/appender.rb
+- lib/duckdb/config.rb
 - lib/duckdb/connection.rb
 - lib/duckdb/database.rb
 - lib/duckdb/prepared_statement.rb
@@ -135,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: This module is Ruby binding for DuckDB database engine.