sequel-snowflake 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0b9a03ce3aedfe6db5faa8659e7eb8b13e2507df006ded3fd2e1a3acef9c85f
+  data.tar.gz: c03b76900ba58dc7cc0cf93d3412be9c0bead514c1dab540d289dfab34aa40cb
+SHA512:
+  metadata.gz: 1bc7b615f16bb2ec666c303aa4688f16f0b41be32406f273b85ddf1c93ac11e2fb759123659d35b4b842781d0d7d9e81b5a1db8541698d8bcdf20f4516c5dcd5
+  data.tar.gz: a53c7946e6775280163066b1dc97026d6444ab3ee79e12e70c951093155d7559347292a040299c76fda2b6a7856f38c0df0465ea059bbb9df3fe88e98df5efa5

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

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,40 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install unix-odbc
+      run: sudo apt-get install 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
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        SNOWFLAKE_CONN_STR: "${{secrets.SNOWFLAKE_CONN_STR}}"

data/.gitignore

@@ -0,0 +1,62 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# Ignore for macOS systems
+.DS_Store
+
+# Jetbrains IDEs
+.idea/

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--order random
+--require spec_helper.rb

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+### 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
+    * Booleans
+    * Dates
+* Support insertion of multiple rows using the `VALUES` syntax.
+* Support creating tables with `String` columns with maximum varchar size (16777216).

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel-snowflake.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Yesware, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# sequel-snowflake
+
+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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequel-snowflake'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sequel-snowflake
+
+You'll also need [unixODBC](http://www.unixodbc.org/) (if on Linux/macOS) and the appropriate
+[Snowflake ODBC driver](https://sfc-repo.snowflakecomputing.com/odbc/index.html) in order to use
+this adapter. Follow the Snowflake documentation on their ODBC Driver
+[here](https://docs.snowflake.com/en/user-guide/odbc.html) before proceeding.
+
+## Usage
+
+When establishing the connection, specify `:snowflake` as the adapter to use.
+
+```ruby
+DB = Sequel.connect(adapter: :snowflake,
+                    drvconnect: conn_str)
+```
+
+## Testing
+
+In order to run specs, you'll need a Snowflake account. A connection string should be
+provided as an environment variable `SNOWFLAKE_CONN_STR`. For example, on macOS,
+our connection string would resemble:
+
+```bash
+DRIVER=/opt/snowflake/snowflakeodbc/lib/universal/libSnowflake.dylib;
+SERVER=<account>.<region>.snowflakecomputing.com;
+DATABASE=<database>;
+WAREHOUSE=<warehouse>;
+SCHEMA=<schema>;
+UID=<user>;
+PWD=<password>;
+CLIENT_SESSION_KEEP_ALIVE=true;
+```
+
+The test will create a temporary table on the specified database to run tests on, and this will
+be taken down either via the `after(:each)` blocks or when the connection is closed.
+
+## GitHub Actions
+
+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
+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.
+
+* Ruby Gem (`gem-push.yml`): This builds and pushes this gem to RubyGems, acting only on successful
+pushes to the `main` branch. Note that this workflow requires a `RUBYGEMS_AUTH_TOKEN` secret to be set
+to authenticate with RubyGems.
+
+## Contributing
+
+1. Fork it ( https://github.com/Yesware/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :test    => :spec
+task :default => :spec
+
+desc 'All-in-one target for CI servers to run.'
+task :ci => ['spec']

data/lib/sequel-snowflake.rb

@@ -0,0 +1,7 @@
+require 'sequel-snowflake/version'
+require 'sequel/adapters/snowflake'
+
+# Register our Snowflake adapter to Sequel's map.
+# This allows us to specify the adapter on database connection:
+# DB = Sequel.connect(adapter: :snowflake, ...)
+Sequel::ADAPTER_MAP[:snowflake] = Sequel::Snowflake::Database

data/lib/sequel-snowflake/version.rb

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

data/lib/sequel/adapters/snowflake.rb

@@ -0,0 +1,81 @@
+require 'sequel'
+require 'sequel/adapters/odbc'
+
+# A lightweight adapter providing Snowflake support for the `sequel` gem.
+# The only difference between this and the Sequel-provided ODBC adapter is
+# how we interpret the response data, which is handled by the Dataset class.
+module Sequel
+  module Snowflake
+    class Database < Sequel::ODBC::Database
+      # Default varchar size is the maximum (https://docs.snowflake.com/en/sql-reference/data-types-text.html#varchar)
+      def default_string_column_size
+        16777216
+      end
+
+      def dataset_class_default
+        Sequel::Snowflake::Dataset
+      end
+      private :dataset_class_default
+    end
+
+    # A custom Sequel Dataset class crafted specifically to handle Snowflake results.
+    class Dataset < Sequel::ODBC::Dataset
+      def fetch_rows(sql)
+        execute(sql) do |s|
+          i = -1
+          cols = s.columns(true).map{|c| [output_identifier(c.name), c.type, c.scale, i+=1]}
+          columns = cols.map{|c| c[0]}
+          self.columns = columns
+          s.each do |row|
+            hash = {}
+            cols.each{|n,type,scale,j| hash[n] = convert_snowflake_value(row[j], type, scale)}
+            yield hash
+          end
+        end
+        self
+      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,
+      # to properly convert Integers and Doubles.
+      # Partially inspired by https://github.com/instacart/odbc_adapter.
+      #
+      # @param value The actual value to be converted
+      # @param column_type The type assigned to that value's column
+      # @param scale [Number] The number of digits to the right of the decimal point, if this is a SQL_DECIMAL value.
+      def convert_snowflake_value(value, column_type, scale)
+        return nil if value.nil? # Null values need no conversion.
+
+        case value
+        when ::ODBC::TimeStamp
+          db.to_application_timestamp(
+            [value.year, value.month, value.day, value.hour, value.minute, value.second, value.fraction]
+          )
+        when ::ODBC::Time
+          Sequel::SQLTime.create(value.hour, value.minute, value.second)
+        when ::ODBC::Date
+          Date.new(value.year, value.month, value.day)
+        else
+          if column_type == ::ODBC::SQL_BIT
+            value == 1
+          elsif column_type == ::ODBC::SQL_DECIMAL && scale.zero?
+            value.to_i
+          elsif column_type == ::ODBC::SQL_DECIMAL && !scale.zero?
+            value.to_f
+          else
+            # Ensure strings are in UTF-8: https://stackoverflow.com/q/65946886
+            value.is_a?(String) ? value.force_encoding('UTF-8') : value
+          end
+        end
+      end
+      private :convert_snowflake_value
+
+      # Snowflake can insert multiple rows using VALUES (https://stackoverflow.com/q/64578007)
+      def multi_insert_sql_strategy
+        :values
+      end
+      private :multi_insert_sql_strategy
+    end
+  end
+end

data/sequel-snowflake.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel-snowflake/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel-snowflake"
+  spec.version       = Sequel::Snowflake::VERSION
+  spec.authors       = ["Yesware, Inc"]
+  spec.email         = ["engineering@yesware.com"]
+  spec.summary       = %q{Sequel adapter for Snowflake}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/Yesware/sequel-snowflake"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  spec.add_runtime_dependency 'sequel'
+  spec.add_runtime_dependency 'ruby-odbc'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/sequel/adapters/snowflake_spec.rb

@@ -0,0 +1,71 @@
+require 'securerandom'
+
+describe Sequel::Snowflake::Dataset do
+  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']) }
+
+    before(:each) do
+      # Set timezone for parsing timestamps. This gives us a consistent timezone to test against below.
+      Sequel.default_timezone = :utc
+
+      db.create_table(test_table, :temp => true) do
+        Numeric :n
+        BigDecimal :d, size: [38, 5]
+        Float :f
+        DateTime :t
+        TrueClass :b
+        String :str
+        String :str2
+      end
+    end
+
+    after(:each) do
+      db.drop_table(test_table)
+    end
+
+    it 'converts Snowflake data types into equivalent Ruby types' do
+      db[test_table].insert(
+        { n: 17, d: 42.035, f: 1.2247, t: '2020-03-12 01:02:03.123456789', b: true, str: 'hi', str2: nil }
+      )
+
+      res = db[test_table].select(
+        :n, :d, :f, :t, :b,
+        Sequel.as(Sequel.function(:to_time, :t), :time),
+        Sequel.as(Sequel.function(:to_date, :t), :date),
+        :str, :str2
+      ).first
+
+      expect(res).to include(
+        n: 17,
+        d: a_value_within(0.0001).of(42.035),
+        f: a_value_within(0.00001).of(1.2247),
+        b: true,
+        str: 'hi',
+        str2: nil
+      )
+
+      expect(res[:t]).to be_a(Time)
+      expect(res[:t].iso8601).to eq('2020-03-12T01:02:03Z')
+
+      expect(res[:time]).to be_a(Time)
+      expect(res[:time].to_s).to eq('01:02:03')
+
+      expect(res[:date]).to be_a(Date)
+      expect(res[:date].to_s).to eq('2020-03-12')
+    end
+
+    it 'inserts multiple records successfully using the VALUE syntax' do
+      db[test_table].multi_insert(
+        [
+          { n: 17, d: 42.035, f: 1.2247, t: '2020-03-12 01:02:03.123456789', b: true, str: 'hi', str2: nil },
+          { n: 18, d: 837.5, f: 3.09, t: '2020-03-15 11:22:33.12345', b: false, str: 'beware the ides', str2: 'of march' }
+        ]
+      )
+
+      expect(db[test_table].count).to eq(2)
+      expect(db[test_table].select(:n).all).to eq([{ n: 17 }, { n: 18 }])
+    end
+  end
+end

data/spec/snowflake_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'sequel-snowflake'
+
+describe Sequel::Snowflake do
+  it "should have a VERSION constant" do
+    expect(subject.const_get('VERSION')).to_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec'
+end
+SimpleCov.minimum_coverage(100)
+
+require 'sequel-snowflake'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: sequel-snowflake
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Yesware, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  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'
+- !ruby/object:Gem::Dependency
+  name: ruby-odbc
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sequel adapter for Snowflake
+email:
+- engineering@yesware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sequel-snowflake.rb
+- lib/sequel-snowflake/version.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: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Sequel adapter for Snowflake
+test_files:
+- spec/sequel/adapters/snowflake_spec.rb
+- spec/snowflake_spec.rb
+- spec/spec_helper.rb