chdb-ruby 0.1.0.rc.2

data/lib/chdb/result_set.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ChDB
+  # The ResultSet object encapsulates the enumerability of a query's output.
+  # It is a simple cursor over the data that the query returns. It will
+  # very rarely (if ever) be instantiated directly. Instead, clients should
+  # obtain a ResultSet instance via Statement#execute.
+  class ResultSet
+    include Enumerable
+
+    # Create a new ResultSet attached to the given database, using the
+    # given sql text.
+    def initialize(db, stmt)
+      @db = db
+      @stmt = stmt
+    end
+
+    def eof?
+      @stmt.done?
+    end
+
+    def next
+      @stmt.step
+    end
+
+    def each
+      while (node = self.next)
+        yield node
+      end
+    end
+
+    # Provides an internal iterator over the rows of the result set where
+    # each row is yielded as a hash.
+    def each_hash
+      while (node = next_hash)
+        yield node
+      end
+    end
+
+    # Returns the names of the columns returned by this result set.
+    def columns
+      @stmt.columns
+    end
+
+    # Return the next row as a hash
+    def next_hash
+      row = @stmt.step
+      return nil unless row
+
+      @stmt.columns.zip(row).to_h
+    end
+  end
+
+  class HashResultSet < ResultSet # :nodoc:
+    alias next next_hash
+  end
+end

data/lib/chdb/sql_processor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ChDB
+  # This module provides functionality for processing SQL queries,
+  # including binding variables and escaping values.
+  module SQLProcessor
+    def process_sql
+      escaped_values = @bind_vars.map { |v| escape(v) }
+      sql = @sql.dup
+      sql.gsub(/(?<!\\)\?/) { escaped_values.shift or '?' }
+    end
+
+    def escape(value)
+      case value
+      when String then "'#{value.gsub("'", "''")}'"
+      when NilClass then 'NULL'
+      when TrueClass then '1'
+      when FalseClass then '0'
+      else value.to_s
+      end
+    end
+  end
+end

data/lib/chdb/statement.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'csv'
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "chdb/#{Regexp.last_match(1)}/chdb_native"
+rescue LoadError
+  require 'chdb/chdb_native'
+end
+require 'chdb/local_result'
+require 'chdb/result_set'
+require 'chdb/result_handler'
+require 'chdb/parameter_binding'
+require 'chdb/sql_processor'
+
+module ChDB
+  # Represents a prepared SQL statement in the ChDB database.
+  # This class provides methods for executing SQL statements, binding parameters,
+  # and iterating over the result set.
+  class Statement
+    include Enumerable
+    include ParameterBinding
+    include SQLProcessor
+    include ResultHandler
+
+    attr_reader :result, :columns, :parsed_data
+
+    def initialize(db, sql_str)
+      validate_inputs(db, sql_str)
+      @sql = encode_sql(sql_str)
+      @connection = db
+      @executed = false
+      @parsed = false
+      @row_idx = 0
+      @bind_vars = []
+      @parsed_data = []
+      @columns = []
+    end
+
+    def execute(*bind_vars)
+      reset! if @executed
+      @executed = true
+
+      bind_params(*bind_vars) unless bind_vars.empty?
+
+      @processed_sql = process_sql
+
+      results = @connection.build_result_set self
+      @result = @connection.conn.query(@processed_sql, 'CSVWithNames')
+      @result.output_format = 'CSVWithNames'
+
+      yield results if block_given?
+      results
+    end
+
+    def execute!(*bind_vars, &block)
+      execute(*bind_vars)
+      block ? each(&block) : to_a
+    end
+
+    def execute_with_format(*bind_vars, format)
+      reset! if @executed
+      @executed = true
+
+      bind_params(*bind_vars) unless bind_vars.empty?
+
+      @processed_sql = process_sql
+      @result = @connection.conn.query(@processed_sql, format)
+
+      yield @result.buf if block_given?
+      @result.buf
+    end
+
+    def reset!
+      @executed = false
+      @parsed = false
+      @row_idx = 0
+      @bind_vars.clear
+      @parsed_data.clear
+      @columns.clear
+      @results = nil
+    end
+
+    def step
+      parse
+      return nil if @row_idx >= @parsed_data.size
+
+      current_row = @parsed_data[@row_idx]
+      @row_idx += 1
+      current_row
+    end
+
+    def parse
+      return if @parsed
+
+      if @result&.buf.to_s.empty?
+        @columns = []
+        @parsed_data = []
+      else
+        @columns, @parsed_data = ResultHandler.parse_output(@result.buf)
+      end
+
+      @parsed = true
+      @results = nil
+    end
+
+    private
+
+    def validate_inputs(db, sql_str)
+      raise ArgumentError, 'SQL statement cannot be nil' if sql_str.nil?
+      raise ArgumentError, 'prepare called on a closed database' if db.nil? || db.closed?
+    end
+
+    def encode_sql(sql_str)
+      if sql_str.encoding == Encoding::UTF_8
+        sql_str.dup
+      else
+        sql_str.encode(Encoding::UTF_8)
+      end
+    end
+
+    # Returns true if the statement is currently active, meaning it has an
+    # open result set.
+    def active?
+      @executed && !done?
+    end
+
+    def each
+      loop do
+        val = step
+        break if val.nil?
+
+        yield val
+      end
+    end
+  end
+end

data/lib/chdb/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ChDB
+  # (String) the version of the chdb gem, e.g. "0.1.0"
+  VERSION = '0.1.0.rc.2'
+end

data/lib/chdb/version_info.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ChDB
+  # a hash of descriptive metadata about the current version of the chdb gem
+  VERSION_INFO = {
+    ruby: RUBY_DESCRIPTION,
+    gem: {
+      version: ChDB::VERSION
+    }
+  }.freeze
+end

data/lib/chdb.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ChDB
+  def self.lib_file_path
+    @lib_file_path ||= File.expand_path(__FILE__)
+  end
+end
+
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "chdb/#{Regexp.last_match(1)}/chdb_native"
+rescue LoadError
+  require 'chdb/chdb_native'
+end
+
+require 'chdb/database'
+require 'chdb/version'
+require 'chdb/version_info'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: chdb-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc.2
+platform: ruby
+authors:
+- Xiaozhe Yu
+- Auxten Wang
+bindir: bin
+cert_chain: []
+date: 2025-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: |
+  Ruby library to interface with the chDB database engine (https://clickhouse.com/docs/chdb). Precompiled
+  binaries are available for common platforms for recent versions of Ruby.
+executables: []
+extensions:
+- ext/chdb/extconf.rb
+extra_rdoc_files: []
+files:
+- INSTALLATION.md
+- LICENSE
+- README.md
+- dependencies.yml
+- ext/chdb/chdb.c
+- ext/chdb/chdb_handle.c
+- ext/chdb/chdb_handle.h
+- ext/chdb/connection.c
+- ext/chdb/connection.h
+- ext/chdb/constants.h
+- ext/chdb/exception.c
+- ext/chdb/exception.h
+- ext/chdb/extconf.rb
+- ext/chdb/local_result.c
+- ext/chdb/local_result.h
+- lib/chdb.rb
+- lib/chdb/constants.rb
+- lib/chdb/data_path.rb
+- lib/chdb/database.rb
+- lib/chdb/errors.rb
+- lib/chdb/local_result.rb
+- lib/chdb/parameter_binding.rb
+- lib/chdb/result_handler.rb
+- lib/chdb/result_set.rb
+- lib/chdb/sql_processor.rb
+- lib/chdb/statement.rb
+- lib/chdb/version.rb
+- lib/chdb/version_info.rb
+homepage: https://github.com/chdb-io/chdb-ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/chdb-io/chdb-ruby
+  bug_tracker_uri: https://github.com/chdb-io/chdb-ruby/issues
+  changelog_uri: https://github.com/chdb-io/chdb-ruby/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/chdb-io/chdb-ruby
+  rubygems_mfa_required: 'true'
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Ruby library to interface with the chDB database engine (https://clickhouse.com/docs/chdb).
+test_files: []