duckdb 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7738df010c1fb1aab32b61077ff9409566cfaddecfef3b27aa6e7ee7a8651f2
-  data.tar.gz: 6357f43da56b7c4fbea72ec7b3c549f598f3a91b88c1c91ab5320a01606f3589
+  metadata.gz: 2948812978266d6ca2040d2071479f0484fe39719be860282e238b1e786a53e7
+  data.tar.gz: 3a3d10a5dd8e318b7a6274e6e32f0fc4850eeafada95673b42ed6c6121a36af5
 SHA512:
-  metadata.gz: e417badc1b301fdea9f3f4b27648e7e1c7d8e125a0a1323bb69e93a992467eca0a57a320b0bb14f7fda45bf8d9d3706b59eb586a71e3c9f77bd2ec18c88b8b3a
-  data.tar.gz: b1486d0d525fa93a8485504eac95015a07ac064a4dfb15bb0689aa7be4cb41edcf03436324e822bda26a8c3c6e8a9e2a690efcd49f7180f675777f75284df5e8
+  metadata.gz: f4bf27bf6c3e378650584e9226bd0c2e16a76a2d5e68c96451f5abafb4dfe6fbb4df705ceb754ac8df30ed36bc6fe67299f61861fa882ef11acac79dea1e80cf
+  data.tar.gz: 71f42787f8368ab322c5d8c9a9a74227117dbf0454601d9ac3ec407188497c34e437fd5de14bec2038d6f3df3233098b580a8e116f8590dedd8004b7ba934f5a

data/.github/workflows/test_on_macos.yml

@@ -15,8 +15,8 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        ruby: ['2.7.8', '3.0.6', '3.1.4', '3.2.2', '3.3.0-preview1', 'head']
-        duckdb: ['0.9.0', '0.8.1']
+        ruby: ['2.7.8', '3.0.6', '3.1.4', '3.2.2', '3.3.0-preview2', 'head']
+        duckdb: ['0.9.1', '0.8.1']
 
     steps:
     - uses: actions/checkout@v3

data/.github/workflows/test_on_ubuntu.yml

@@ -15,8 +15,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['2.7.8', '3.0.6', '3.1.4', '3.2.2', '3.3.0-preview1', 'head']
-        duckdb: ['0.9.0', '0.8.1']
+        ruby: ['2.7.8', '3.0.6', '3.1.4', '3.2.2', '3.3.0-preview2', 'head']
+        duckdb: ['0.9.1', '0.8.1']
 
     steps:
     - uses: actions/checkout@v3

data/.github/workflows/test_on_windows.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:
         ruby: ['2.7.8', '3.0.6', '3.1.4', '3.2.2', 'ucrt', 'mingw', 'mswin', 'head']
-        duckdb: ['0.9.0', '0.8.1']
+        duckdb: ['0.9.1', '0.8.1']
 
     steps:
     - uses: actions/checkout@v3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # ChangeLog
 
+# 0.9.1
+- add `DuckDB::PreparedStatement#parameter_name`.
+- bump duckdb to 0.9.1.
+
+# 0.9.0.1
+- add `DuckDB::PreparedStatement#bind_parameter_index`.
+- DuckDB::Connection#query accepts SQL with named bind parameters.
+
 # 0.9.0
 - bump duckdb to 0.9.0.
 

data/Dockerfile

@@ -1,7 +1,7 @@
 ARG RUBY_VERSION=3.2.2
 FROM ruby:${RUBY_VERSION}
 
-ARG DUCKDB_VERSION=0.9.0
+ARG DUCKDB_VERSION=0.9.1
 
 RUN apt update -qq && \
     apt install -y build-essential curl git wget

data/Gemfile.lock

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

data/README.md

@@ -94,6 +94,17 @@ DuckDB::Database.open do |db|
 end
 ```
 
+### using bind variables
+
+You can use bind variables.
+
+```ruby
+con.query('SELECT * FROM users WHERE name = ? AND email = ?', 'Alice', 'alice@example.com')
+# or
+con.query('SELECT * FROM users WHERE name = $name AND email = $email', name: 'Alice', email: 'alice@example.com')
+```
+
+
 ### using BLOB column
 
 BLOB is available with DuckDB v0.2.5 or later.

data/ext/duckdb/extconf.rb

@@ -31,4 +31,6 @@ have_func('duckdb_string_is_inlined', 'duckdb.h')
 # check duckdb >= 0.9.0
 have_func('duckdb_bind_parameter_index', 'duckdb.h')
 
+have_func('duckdb_parameter_name', 'duckdb.h')
+
 create_makefile('duckdb/duckdb_native')

data/ext/duckdb/prepared_statement.c

@@ -9,6 +9,14 @@ static VALUE duckdb_prepared_statement_initialize(VALUE self, VALUE con, VALUE q
 static VALUE duckdb_prepared_statement_nparams(VALUE self);
 static VALUE duckdb_prepared_statement_execute(VALUE self);
 static idx_t check_index(VALUE vidx);
+
+#ifdef HAVE_DUCKDB_H_GE_V090
+static VALUE duckdb_prepared_statement_bind_parameter_index(VALUE self, VALUE name);
+#ifdef HAVE_DUCKDB_PARAMETER_NAME
+static VALUE duckdb_prepared_statement_parameter_name(VALUE self, VALUE vidx);
+#endif
+#endif
+
 static VALUE duckdb_prepared_statement_bind_bool(VALUE self, VALUE vidx, VALUE val);
 static VALUE duckdb_prepared_statement_bind_int8(VALUE self, VALUE vidx, VALUE val);
 static VALUE duckdb_prepared_statement_bind_int16(VALUE self, VALUE vidx, VALUE val);
@@ -93,6 +101,39 @@ static idx_t check_index(VALUE vidx) {
     return idx;
 }
 
+#ifdef HAVE_DUCKDB_H_GE_V090
+static VALUE duckdb_prepared_statement_bind_parameter_index(VALUE self, VALUE name) {
+    rubyDuckDBPreparedStatement *ctx;
+    idx_t idx;
+
+    TypedData_Get_Struct(self, rubyDuckDBPreparedStatement, &prepared_statement_data_type, ctx);
+
+    if (duckdb_bind_parameter_index(ctx->prepared_statement, &idx, StringValuePtr(name)) == DuckDBError) {;
+        rb_raise(rb_eArgError, "parameter '%s' not found", StringValuePtr(name));
+    }
+    return ULL2NUM(idx);
+}
+
+#ifdef HAVE_DUCKDB_PARAMETER_NAME
+static VALUE duckdb_prepared_statement_parameter_name(VALUE self, VALUE vidx) {
+    rubyDuckDBPreparedStatement *ctx;
+    VALUE vname;
+    const char *name;
+    idx_t idx = check_index(vidx);
+
+    TypedData_Get_Struct(self, rubyDuckDBPreparedStatement, &prepared_statement_data_type, ctx);
+
+    name = duckdb_parameter_name(ctx->prepared_statement, idx);
+    if (name == NULL) {
+        rb_raise(eDuckDBError, "fail to get name of %llu parameter", (unsigned long long)idx);
+    }
+    vname = rb_str_new2(name);
+    duckdb_free((void *)name);
+    return vname;
+}
+#endif /* HAVE_DUCKDB_PARAMETER_NAME */
+#endif /* HAVE_DUCKDB_H_GE_V090 */
+
 static VALUE duckdb_prepared_statement_bind_bool(VALUE self, VALUE vidx, VALUE val) {
     rubyDuckDBPreparedStatement *ctx;
     idx_t idx = check_index(vidx);
@@ -308,6 +349,14 @@ 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);
+
+#ifdef HAVE_DUCKDB_H_GE_V090
+    rb_define_method(cDuckDBPreparedStatement, "bind_parameter_index", duckdb_prepared_statement_bind_parameter_index, 1);
+#ifdef HAVE_DUCKDB_PARAMETER_NAME
+    rb_define_method(cDuckDBPreparedStatement, "parameter_name", duckdb_prepared_statement_parameter_name, 1);
+#endif
+#endif
+
     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);

data/lib/duckdb/connection.rb

@@ -12,7 +12,6 @@ module DuckDB
     # executes sql with args.
     # The first argument sql must be SQL string.
     # The rest arguments are parameters of SQL string.
-    # The parameters must be '?' in SQL statement.
     #
     #   require 'duckdb'
     #   db = DuckDB::Database.open('duckdb_file')
@@ -21,12 +20,20 @@ module DuckDB
     #   sql = 'SELECT * FROM users WHERE name = ? AND email = ?'
     #   dave = con.query(sql, 'Dave', 'dave@example.com')
     #
-    def query(sql, *args)
-      return query_sql(sql) if args.empty?
+    #   # or You can use named parameter.
+    #
+    #   sql = 'SELECT * FROM users WHERE name = $name AND email = $email'
+    #   dave = con.query(sql, name: 'Dave', email: 'dave@example.com')
+    #
+    def query(sql, *args, **hash)
+      return query_sql(sql) if args.empty? && hash.empty?
 
       stmt = PreparedStatement.new(self, sql)
-      args.each_with_index do |arg, i|
-        stmt.bind(i + 1, arg)
+      args.each.with_index(1) do |arg, i|
+        stmt.bind(i, arg)
+      end
+      hash.each do |key, value|
+        stmt.bind(key, value)
       end
       stmt.execute
     end

data/lib/duckdb/prepared_statement.rb

@@ -1,6 +1,6 @@
 require 'date'
 require 'bigdecimal'
-require_relative './converter'
+require_relative 'converter'
 
 module DuckDB
   # The DuckDB::PreparedStatement encapsulates connection with DuckDB prepared
@@ -167,35 +167,55 @@ module DuckDB
     #   sql ='SELECT name, email FROM users WHERE email = ?'
     #   stmt = PreparedStatement.new(con, sql)
     #   stmt.bind(1, 'email@example.com')
-    def bind(i, value)
+    def bind(index, value)
+      case index
+      when Integer
+        bind_with_index(index, value)
+      when String
+        bind_with_name(index, value)
+      when Symbol
+        bind_with_name(index.to_s, value)
+      else
+        raise(ArgumentError, "1st argument `#{index}` must be Integer or String or Symbol.")
+      end
+    end
+
+    private
+
+    def bind_with_index(index, value)
       case value
       when NilClass
-        bind_null(i)
+        bind_null(index)
       when Float
-        bind_double(i, value)
+        bind_double(index, value)
       when Integer
         case value
         when RANGE_INT64
-          bind_int64(i, value)
+          bind_int64(index, value)
         else
-          bind_varchar(i, value.to_s)
+          bind_varchar(index, value.to_s)
         end
       when String
-        blob?(value) ? bind_blob(i, value) : bind_varchar(i, value)
+        blob?(value) ? bind_blob(index, value) : bind_varchar(index, value)
       when TrueClass, FalseClass
-        bind_bool(i, value)
+        bind_bool(index, value)
       when Time
-        bind_varchar(i, value.strftime('%Y-%m-%d %H:%M:%S.%N'))
+        bind_varchar(index, value.strftime('%Y-%m-%d %H:%M:%S.%N'))
       when Date
-        bind_varchar(i, value.strftime('%Y-%m-%d'))
+        bind_varchar(index, value.strftime('%Y-%m-%d'))
       when BigDecimal
-        bind_varchar(i, value.to_s('F'))
+        bind_varchar(index, value.to_s('F'))
       else
         raise(DuckDB::Error, "not supported type `#{value}` (#{value.class})")
       end
     end
 
-    private
+    def bind_with_name(name, value)
+      raise DuckDB::Error, 'not supported binding with name' unless respond_to?(:bind_parameter_index)
+
+      i = bind_parameter_index(name)
+      bind_with_index(i, value)
+    end
 
     def blob?(value)
       value.instance_of?(DuckDB::Blob) || value.encoding == Encoding::BINARY

data/lib/duckdb/version.rb

@@ -3,5 +3,5 @@
 module DuckDB
   # The version string of ruby-duckdb.
   # Currently, ruby-duckdb is NOT semantic versioning.
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duckdb
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Masaki Suketa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2023-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler