sequel-snowflake 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0b9a03ce3aedfe6db5faa8659e7eb8b13e2507df006ded3fd2e1a3acef9c85f
-  data.tar.gz: c03b76900ba58dc7cc0cf93d3412be9c0bead514c1dab540d289dfab34aa40cb
+  metadata.gz: 772b801f7ed529ccadccd14d02fad21713a6e62d1d23a6b531647a4a876d5238
+  data.tar.gz: 9b92e7bceb1899f346d117299e733b4773bf65b3b17140968b286ac262026a1e
 SHA512:
-  metadata.gz: 1bc7b615f16bb2ec666c303aa4688f16f0b41be32406f273b85ddf1c93ac11e2fb759123659d35b4b842781d0d7d9e81b5a1db8541698d8bcdf20f4516c5dcd5
-  data.tar.gz: a53c7946e6775280163066b1dc97026d6444ab3ee79e12e70c951093155d7559347292a040299c76fda2b6a7856f38c0df0465ea059bbb9df3fe88e98df5efa5
+  metadata.gz: bd4c7cdf415e197569747c1181056312b3f4389049b3de254ebd407c1e8d882e3cac9f6fe7a5351e6e1330d57abb89e2805fac4a51112049863af189660e7025
+  data.tar.gz: 9d21e394346317988787eadf729d14a0a7caab19fddf639b9b1c9e9227766025c246e15f55b5e44ea9f4b34cc49eac387696ca3835d327a7e69ba34f34e539fa

data/.github/workflows/gem-push.yml

@@ -14,10 +14,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby 3.1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 3.1
 
     - name: Publish to RubyGems
       run: |

data/.github/workflows/ruby.yml

@@ -19,16 +19,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v2
-    - name: Install unix-odbc
-      run: sudo apt-get install unixodbc
+    - name: Update package lists
+      run: sudo apt-get update
+    - name: Install unixodbc-dev, odbcinst, and unixodbc
+      run: sudo apt-get -y install unixodbc-dev odbcinst unixodbc
     - name: Install Snowflake ODBC driver
       run: curl ${SNOWFLAKE_DRIVER_URL} -o snowflake_driver.deb && sudo dpkg -i snowflake_driver.deb
       env:
-        SNOWFLAKE_DRIVER_URL: https://sfc-repo.snowflakecomputing.com/odbc/linux/latest/snowflake-odbc-2.23.2.x86_64.deb
+        SNOWFLAKE_DRIVER_URL: https://sfc-repo.snowflakecomputing.com/odbc/linux/3.1.1/snowflake-odbc-3.1.1.x86_64.deb
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/CHANGELOG.md

@@ -1,11 +1,21 @@
-### 2.0.0 / 2021-06-16
+# Changelog
+All notable changes to this project will be documented in this file.
 
-* Change LICENSE to MIT (open source).
-* This gem is now tested against Rubies 2.6, 2.7, and 3.0.
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## 2.2.0 / 2023-10-17
+* Add support for `MERGE` (credit: @benalavi)
+* Add requirement for `sequel` v5.58.0 or newer (to support the new MERGE methods).
 
+## 2.1.0 / 2022-06-17
+* Add support for `EXPLAIN`.
 
-### 1.0.0 / 2021-04-22 [Initial Release]
+## 2.0.0 / 2021-06-16
+* Change LICENSE to MIT (open source).
+* This gem is now tested against Rubies 2.6, 2.7, and 3.0.
 
+## 1.0.0 / 2021-04-22 [Initial Release]
 * Handle parsing Snowflake values for the following types:
     * Numeric data types
     * String data types

data/README.md

@@ -3,7 +3,7 @@
 An adapter to connect to Snowflake databases using [Sequel](http://sequel.jeremyevans.net/).
 This provides proper types for returned values, as opposed to the ODBC adapter.
 
-[![Ruby](https://github.com/Yesware/sequel-snowflake/actions/workflows/ruby.yml/badge.svg)](https://github.com/Yesware/sequel-snowflake/actions/workflows/ruby.yml)
+[![Ruby](https://github.com/vendasta/sequel-snowflake/actions/workflows/ruby.yml/badge.svg)](https://github.com/vendasta/sequel-snowflake/actions/workflows/ruby.yml)
 
 ## Installation
 
@@ -57,7 +57,7 @@ be taken down either via the `after(:each)` blocks or when the connection is clo
 
 We have two workflows included in this project:
 
-* Ruby (`ruby.yml`): This runs the specs for this gem against Ruby 2.6, 2.7, and 3.0. Note
+* Ruby (`ruby.yml`): This runs the specs for this gem against Ruby 3.0 and 3.1. Note
 that this requires the secret `SNOWFLAKE_CONN_STR` to be set (see above for example connection string),
 as we need to connect to Snowflake to run tests. These specs will be run for every pull request,
 and is run after every commit to those branches.
@@ -68,7 +68,7 @@ to authenticate with RubyGems.
 
 ## Contributing
 
-1. Fork it ( https://github.com/Yesware/sequel-snowflake/fork )
+1. Fork it ( https://github.com/vendasta/sequel-snowflake/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/sequel/adapters/shared/snowflake.rb

@@ -0,0 +1,32 @@
+module Sequel
+  module Snowflake
+    Sequel::Database.set_shared_adapter_scheme(:snowflake, self)
+
+    module DatasetMethods
+      # Return an array of strings specifying a query explanation for a SELECT of the
+      # current dataset.
+      # The options (symbolized, in lowercase) are:
+      #   JSON: JSON output is easier to store in a table and query.
+      #   TABULAR (default): tabular output is generally more human-readable than JSON output.
+      #   TEXT: formatted text output is generally more human-readable than JSON output.
+      def explain(opts=OPTS)
+        # Load the PrettyTable class, needed for explain output
+        Sequel.extension(:_pretty_table) unless defined?(Sequel::PrettyTable)
+
+        explain_with_format = if opts[:tabular]
+          "EXPLAIN USING TABULAR"
+        elsif opts[:json]
+          "EXPLAIN USING JSON"
+        elsif opts[:text]
+          "EXPLAIN USING TEXT"
+        else
+          "EXPLAIN"
+        end
+
+        ds = db.send(:metadata_dataset).clone(:sql=>"#{explain_with_format} #{select_sql}")
+        rows = ds.all
+        Sequel::PrettyTable.string(rows, ds.columns)
+      end
+    end
+  end
+end

data/lib/sequel/adapters/snowflake.rb

@@ -1,5 +1,6 @@
 require 'sequel'
 require 'sequel/adapters/odbc'
+require_relative 'shared/snowflake'
 
 # A lightweight adapter providing Snowflake support for the `sequel` gem.
 # The only difference between this and the Sequel-provided ODBC adapter is
@@ -20,6 +21,8 @@ module Sequel
 
     # A custom Sequel Dataset class crafted specifically to handle Snowflake results.
     class Dataset < Sequel::ODBC::Dataset
+      include Sequel::Snowflake::DatasetMethods
+
       def fetch_rows(sql)
         execute(sql) do |s|
           i = -1
@@ -35,6 +38,13 @@ module Sequel
         self
       end
 
+      # Whether the MERGE statement is supported:
+      # https://github.com/jeremyevans/sequel/blob/master/lib/sequel/dataset/features.rb#L129
+      # Snowflake reference: https://docs.snowflake.com/en/sql-reference/sql/merge
+      def supports_merge?
+        true
+      end
+
       # This is similar to the ODBC adapter's Dataset#convert_odbc_value, except for some special casing
       # around Snowflake numerics, which come in through ODBC as Strings instead of Numbers.
       # In those cases, we need to examine the column type as well as the scale,

data/lib/sequel-snowflake/version.rb

@@ -1,6 +1,6 @@
 module Sequel
   module Snowflake
     # sequel-snowflake version
-    VERSION = "2.0.0"
+    VERSION = "2.2.0"
   end
 end

data/sequel-snowflake.gemspec

@@ -8,9 +8,10 @@ Gem::Specification.new do |spec|
   spec.version       = Sequel::Snowflake::VERSION
   spec.authors       = ["Yesware, Inc"]
   spec.email         = ["engineering@yesware.com"]
+  spec.license       = "MIT"
   spec.summary       = %q{Sequel adapter for Snowflake}
   spec.description   = spec.summary
-  spec.homepage      = "https://github.com/Yesware/sequel-snowflake"
+  spec.homepage      = "https://github.com/vendasta/sequel-snowflake"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -18,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
 
-  spec.add_runtime_dependency 'sequel'
+  spec.add_runtime_dependency 'sequel', '>= 5.58.0'
   spec.add_runtime_dependency 'ruby-odbc'
 
   spec.add_development_dependency 'rake'

data/spec/sequel/adapters/snowflake_spec.rb

@@ -1,10 +1,11 @@
 require 'securerandom'
 
 describe Sequel::Snowflake::Dataset do
+  let(:db) { Sequel.connect(adapter: :snowflake, drvconnect: ENV['SNOWFLAKE_CONN_STR']) }
+
   describe 'Converting Snowflake data types' do
     # Create a test table with a reasonably-random suffix
-    let!(:test_table) { "SEQUEL_SNOWFLAKE_SPECS_#{SecureRandom.hex(10)}".to_sym }
-    let!(:db) { Sequel.connect(adapter: :snowflake, drvconnect: ENV['SNOWFLAKE_CONN_STR']) }
+    let(:test_table) { "SEQUEL_SNOWFLAKE_SPECS_#{SecureRandom.hex(10)}".to_sym }
 
     before(:each) do
       # Set timezone for parsing timestamps. This gives us a consistent timezone to test against below.
@@ -68,4 +69,72 @@ describe Sequel::Snowflake::Dataset do
       expect(db[test_table].select(:n).all).to eq([{ n: 17 }, { n: 18 }])
     end
   end
+
+  describe 'MERGE feature' do
+    let(:target_table) { "SEQUEL_SNOWFLAKE_SPECS_#{SecureRandom.hex(10)}".to_sym }
+    let(:source_table) { "SEQUEL_SNOWFLAKE_SPECS_#{SecureRandom.hex(10)}".to_sym }
+
+    before(:each) do
+      db.create_table(target_table, :temp => true) do
+        String :str
+        String :str2
+        String :str3
+      end
+
+      db.create_table(source_table, :temp => true) do
+        String :from
+        String :to
+        String :whomst
+      end
+
+      db[target_table].insert({ str: 'foo', str2: 'foo', str3: 'phoo' })
+      db[target_table].insert({ str: 'baz', str2: 'foo', str3: 'buzz' })
+      db[source_table].insert({ from: 'foo', to: 'bar', whomst: 'me' })
+    end
+
+    after(:each) do
+      db.drop_table(target_table)
+      db.drop_table(source_table)
+    end
+
+    it 'can use MERGE' do
+      db[target_table].merge_using(source_table, str: :from).merge_update(str2: :to).merge
+
+      expect(db[target_table].select_all.all).to match_array([
+        { str: 'foo', str2: 'bar', str3: 'phoo' },
+        { str: 'baz', str2: 'foo', str3: 'buzz' }
+      ])
+    end
+  end
+
+  describe '#explain' do
+    # Create a test table with a reasonably-random suffix
+    let(:test_table) { "SEQUEL_SNOWFLAKE_SPECS_#{SecureRandom.hex(10)}".to_sym }
+
+    before(:each) do
+      db.create_table(test_table, :temp => true) do
+        Numeric :id
+        String :name
+        String :email
+        String :title
+      end
+
+      db[test_table].insert(
+        { id: 1, name: 'John Null', email: 'j.null@example.com', title: 'Software Tester' }
+      )
+    end
+
+    after(:each) do
+      db.drop_table(test_table)
+    end
+
+    it "should have explain output" do
+      query = db.fetch("SELECT * FROM #{test_table} WHERE ID=1;")
+
+      expect(query.explain).to be_a_kind_of(String)
+      expect(query.explain(:tabular=>true)).to be_a_kind_of(String)
+      expect(query.explain(:json=>true)).to be_a_kind_of(String)
+      expect(query.explain(:text=>true)).to be_a_kind_of(String)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-snowflake
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Yesware, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.58.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.58.0
 - !ruby/object:Gem::Dependency
   name: ruby-odbc
   requirement: !ruby/object:Gem::Requirement
@@ -98,13 +98,15 @@ files:
 - Rakefile
 - lib/sequel-snowflake.rb
 - lib/sequel-snowflake/version.rb
+- lib/sequel/adapters/shared/snowflake.rb
 - lib/sequel/adapters/snowflake.rb
 - sequel-snowflake.gemspec
 - spec/sequel/adapters/snowflake_spec.rb
 - spec/snowflake_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/Yesware/sequel-snowflake
-licenses: []
+homepage: https://github.com/vendasta/sequel-snowflake
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Sequel adapter for Snowflake