sqlite3-ffi 0.1.0

data/lib/sqlite3/statement.rb

@@ -0,0 +1,190 @@
+require "sqlite3/errors"
+require "sqlite3/resultset"
+
+class String
+  def to_blob
+    SQLite3::Blob.new(self)
+  end
+end
+
+module SQLite3
+  # A statement represents a prepared-but-unexecuted SQL query. It will rarely
+  # (if ever) be instantiated directly by a client, and is most often obtained
+  # via the Database#prepare method.
+  class Statement
+    include Enumerable
+
+    # This is any text that followed the first valid SQL statement in the text
+    # with which the statement was initialized. If there was no trailing text,
+    # this will be the empty string.
+    attr_reader :remainder
+
+    # call-seq: SQLite3::Statement.new(db, sql)
+    #
+    # Create a new statement attached to the given Database instance, and which
+    # encapsulates the given SQL text. If the text contains more than one
+    # statement (i.e., separated by semicolons), then the #remainder property
+    # will be set to the trailing text.
+    def initialize(db, sql)
+      raise ArgumentError, "prepare called on a closed database" if db.closed?
+
+      sql = sql.encode(Encoding::UTF_8) if sql && sql.encoding != Encoding::UTF_8
+
+      @connection = db
+      @columns = nil
+      @types = nil
+      @remainder = prepare db, sql
+    end
+
+    # Binds the given variables to the corresponding placeholders in the SQL
+    # text.
+    #
+    # See Database#execute for a description of the valid placeholder
+    # syntaxes.
+    #
+    # Example:
+    #
+    #   stmt = db.prepare( "select * from table where a=? and b=?" )
+    #   stmt.bind_params( 15, "hello" )
+    #
+    # See also #execute, #bind_param, Statement#bind_param, and
+    # Statement#bind_params.
+    def bind_params(*bind_vars)
+      index = 1
+      bind_vars.flatten.each do |var|
+        if Hash === var
+          var.each { |key, val| bind_param key, val }
+        else
+          bind_param index, var
+          index += 1
+        end
+      end
+    end
+
+    # Execute the statement. This creates a new ResultSet object for the
+    # statement's virtual machine. If a block was given, the new ResultSet will
+    # be yielded to it; otherwise, the ResultSet will be returned.
+    #
+    # Any parameters will be bound to the statement using #bind_params.
+    #
+    # Example:
+    #
+    #   stmt = db.prepare( "select * from table" )
+    #   stmt.execute do |result|
+    #     ...
+    #   end
+    #
+    # See also #bind_params, #execute!.
+    def execute(*bind_vars)
+      reset! if active? || done?
+
+      bind_params(*bind_vars) unless bind_vars.empty?
+      results = @connection.build_result_set self
+
+      step if column_count == 0
+
+      yield results if block_given?
+      results
+    end
+
+    # Execute the statement. If no block was given, this returns an array of
+    # rows returned by executing the statement. Otherwise, each row will be
+    # yielded to the block.
+    #
+    # Any parameters will be bound to the statement using #bind_params.
+    #
+    # Example:
+    #
+    #   stmt = db.prepare( "select * from table" )
+    #   stmt.execute! do |row|
+    #     ...
+    #   end
+    #
+    # See also #bind_params, #execute.
+    def execute!(*bind_vars, &block)
+      execute(*bind_vars)
+      block ? each(&block) : to_a
+    end
+
+    # Returns true if the statement is currently active, meaning it has an
+    # open result set.
+    def active?
+      !done?
+    end
+
+    # Return an array of the column names for this statement. Note that this
+    # may execute the statement in order to obtain the metadata; this makes it
+    # a (potentially) expensive operation.
+    def columns
+      get_metadata unless @columns
+      @columns
+    end
+
+    def each
+      loop do
+        val = step
+        break self if done?
+        yield val
+      end
+    end
+
+    # Return an array of the data types for each column in this statement. Note
+    # that this may execute the statement in order to obtain the metadata; this
+    # makes it a (potentially) expensive operation.
+    def types
+      must_be_open!
+      get_metadata unless @types
+      @types
+    end
+
+    # Performs a sanity check to ensure that the statement is not
+    # closed. If it is, an exception is raised.
+    def must_be_open! # :nodoc:
+      if closed?
+        raise SQLite3::Exception, "cannot use a closed statement"
+      end
+    end
+
+    # Returns a Hash containing information about the statement.
+    # The contents of the hash are implementation specific and may change in
+    # the future without notice. The hash includes information about internal
+    # statistics about the statement such as:
+    #   - +fullscan_steps+: the number of times that SQLite has stepped forward
+    # in a table as part of a full table scan
+    #   - +sorts+: the number of sort operations that have occurred
+    #   - +autoindexes+: the number of rows inserted into transient indices
+    # that were created automatically in order to help joins run faster
+    #   - +vm_steps+: the number of virtual machine operations executed by the
+    # prepared statement
+    #   - +reprepares+: the number of times that the prepare statement has been
+    # automatically regenerated due to schema changes or changes to bound
+    # parameters that might affect the query plan
+    #   - +runs+: the number of times that the prepared statement has been run
+    #   - +filter_misses+: the number of times that the Bloom filter returned
+    # a find, and thus the join step had to be processed as normal
+    #   - +filter_hits+: the number of times that a join step was bypassed
+    # because a Bloom filter returned not-found
+    def stat key = nil
+      if key
+        stat_for(key)
+      else
+        stats_as_hash
+      end
+    end
+
+    private
+
+    # A convenience method for obtaining the metadata about the query. Note
+    # that this will actually execute the SQL, which means it can be a
+    # (potentially) expensive operation.
+    def get_metadata
+      @columns = Array.new(column_count) do |column|
+        column_name column
+      end
+      @types = Array.new(column_count) do |column|
+        val = column_decltype(column)
+        val&.downcase
+      end
+    end
+  end
+end

data/lib/sqlite3/value.rb

@@ -0,0 +1,54 @@
+require "sqlite3/constants"
+
+module SQLite3
+  class Value
+    attr_reader :handle
+
+    def initialize(db, handle)
+      @driver = db.driver
+      @handle = handle
+    end
+
+    def null?
+      type == :null
+    end
+
+    def to_blob
+      @driver.value_blob(@handle)
+    end
+
+    def length(utf16 = false)
+      if utf16
+        @driver.value_bytes16(@handle)
+      else
+        @driver.value_bytes(@handle)
+      end
+    end
+
+    def to_f
+      @driver.value_double(@handle)
+    end
+
+    def to_i
+      @driver.value_int(@handle)
+    end
+
+    def to_int64
+      @driver.value_int64(@handle)
+    end
+
+    def to_s(utf16 = false)
+      @driver.value_text(@handle, utf16)
+    end
+
+    def type
+      case @driver.value_type(@handle)
+      when Constants::ColumnType::INTEGER then :int
+      when Constants::ColumnType::FLOAT then :float
+      when Constants::ColumnType::TEXT then :text
+      when Constants::ColumnType::BLOB then :blob
+      when Constants::ColumnType::NULL then :null
+      end
+    end
+  end
+end

data/lib/sqlite3/version.rb

@@ -0,0 +1,4 @@
+module SQLite3
+  # (String) the version of the sqlite3 gem, e.g. "2.1.1"
+  VERSION = "2.6.0"
+end

data/lib/sqlite3/version_info.rb

@@ -0,0 +1,17 @@
+module SQLite3
+  # a hash of descriptive metadata about the current version of the sqlite3 gem
+  VERSION_INFO = {
+    ruby: RUBY_DESCRIPTION,
+    gem: {
+      version: SQLite3::VERSION
+    },
+    sqlite: {
+      compiled: SQLite3::SQLITE_VERSION,
+      loaded: SQLite3::SQLITE_LOADED_VERSION,
+      packaged: SQLite3::SQLITE_PACKAGED_LIBRARIES,
+      precompiled: SQLite3::SQLITE_PRECOMPILED_LIBRARIES,
+      sqlcipher: SQLite3.sqlcipher?,
+      threadsafe: SQLite3.threadsafe?
+    }
+  }
+end

data/lib/sqlite3.rb

@@ -0,0 +1,19 @@
+# support multiple ruby version (fat binaries under windows)
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "sqlite3/#{$1}/sqlite3_native"
+rescue LoadError
+  require "sqlite3/sqlite3_native"
+end
+
+require "sqlite3/database"
+require "sqlite3/version"
+
+module SQLite3
+  # Was sqlite3 compiled with thread safety on?
+  def self.threadsafe?
+    threadsafe > 0
+  end
+end
+
+require "sqlite3/version_info"

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sqlite3-ffi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamis Buck
+- Luis Lavena
+- Aaron Patterson
+- Mike Dalessio
+- Andrew Kane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: andrew@ankane.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/sqlite3.rb
+- lib/sqlite3/constants.rb
+- lib/sqlite3/database.rb
+- lib/sqlite3/errors.rb
+- lib/sqlite3/ffi.rb
+- lib/sqlite3/ffi/aggregator.rb
+- lib/sqlite3/ffi/backup.rb
+- lib/sqlite3/ffi/c_api.rb
+- lib/sqlite3/ffi/core_ext.rb
+- lib/sqlite3/ffi/database.rb
+- lib/sqlite3/ffi/exception.rb
+- lib/sqlite3/ffi/functions.rb
+- lib/sqlite3/ffi/sqlite3.rb
+- lib/sqlite3/ffi/statement.rb
+- lib/sqlite3/ffi/utils.rb
+- lib/sqlite3/ffi/version.rb
+- lib/sqlite3/fork_safety.rb
+- lib/sqlite3/pragmas.rb
+- lib/sqlite3/resultset.rb
+- lib/sqlite3/sqlite3_native.rb
+- lib/sqlite3/statement.rb
+- lib/sqlite3/value.rb
+- lib/sqlite3/version.rb
+- lib/sqlite3/version_info.rb
+homepage: https://github.com/ankane/sqlite3-ffi
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message:
+rdoc_options: []
+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.5.16
+signing_key:
+specification_version: 4
+summary: A drop-in replacement for sqlite3 for JRuby
+test_files: []