sequel-snowflake 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0b9a03ce3aedfe6db5faa8659e7eb8b13e2507df006ded3fd2e1a3acef9c85f
-  data.tar.gz: c03b76900ba58dc7cc0cf93d3412be9c0bead514c1dab540d289dfab34aa40cb
+  metadata.gz: eba6e3849823d647dca41ee39a327c8c2e832bfc4f45ceb33d184ae06ed834c4
+  data.tar.gz: b04b7c352deb704dc3b08dda547fd6b52e0cecdb6fe52cc1f2abce3f4c4b8c3a
 SHA512:
-  metadata.gz: 1bc7b615f16bb2ec666c303aa4688f16f0b41be32406f273b85ddf1c93ac11e2fb759123659d35b4b842781d0d7d9e81b5a1db8541698d8bcdf20f4516c5dcd5
-  data.tar.gz: a53c7946e6775280163066b1dc97026d6444ab3ee79e12e70c951093155d7559347292a040299c76fda2b6a7856f38c0df0465ea059bbb9df3fe88e98df5efa5
+  metadata.gz: f682678759afd025e0ca7a7fc87c1dcdf5aaeb4c39b31519453d4064e2a168e43488a8dad341020b189a5dd65b191e22a9df51654f7b3d0b5a869a8b08abf94f
+  data.tar.gz: 2b83a1c9bbea68cb0ae13497f1bb8b15d7ad767ab8b0a83f26c12b3ec753b70081a1d7c56bc89b78e9da8cbc5812bbb51df5ee09321071ff6698aa2f4b9adeb0

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,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v2
@@ -28,7 +28,7 @@ jobs:
     - 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/2.25.2/snowflake-odbc-2.25.2.x86_64.deb
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/CHANGELOG.md

@@ -1,11 +1,17 @@
-### 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.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/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

data/lib/sequel-snowflake/version.rb

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

data/sequel-snowflake.gemspec

@@ -8,6 +8,7 @@ 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"

data/spec/sequel/adapters/snowflake_spec.rb

@@ -68,4 +68,36 @@ describe Sequel::Snowflake::Dataset do
       expect(db[test_table].select(:n).all).to eq([{ n: 17 }, { n: 18 }])
     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 }
+    let!(:db) { Sequel.connect(adapter: :snowflake, drvconnect: ENV['SNOWFLAKE_CONN_STR']) }
+
+    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.1.0
 platform: ruby
 authors:
 - Yesware, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -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: []
+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.7
 signing_key: 
 specification_version: 4
 summary: Sequel adapter for Snowflake