rb_snowflake_client 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41fc128164ffef226da74985180b136ecfbce6314cb3041e131653765c9e486f
-  data.tar.gz: b86fe4295d3ad395682214e116a0a4bf1e25213d7815ee52dffbe302d5c87e4a
+  metadata.gz: 7c61238d7915a65cc04b0219e1fd8dc016cc645d8b62819264e2476cd22bdace
+  data.tar.gz: b23ace47b825ed4650a12c1fe51b88a72ee51e9e6451e8421c99efbad14ccd1f
 SHA512:
-  metadata.gz: 89ad4c5b56f58acbd1440b8f0a3fb55c2a4aaa259bbea1ee8823078f95c00acfd4edf6a19e3ad03ebe539516de1988dda49b59560ccdbe43209ecdc579c0b147
-  data.tar.gz: 2fb149655ba64aa0b45a38b65fa21f8a14889c522de6bb0bc5cd43d3905306f03f46f28ac3c51a6b8cabbf0564221958bf9f06a670c40e83fcd6229b44dbe8cf
+  metadata.gz: 9c6616faa6d200731c4783e2ae0390022b9a90086e05e9c8b19527e74b65c59912155240f036f660c83c24b50fa30242a14a79f4b4c6b464cdc2d51a396725cf
+  data.tar.gz: 3dfeceb361c57f2f40eb3e3adc626abd0832ee977ef8ed86cdd089ae4f1eae95013c8441085aa3c9e74b19f8f367f7259adc75a477ecc34dcffeddbc65853158

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rb_snowflake_client (1.0.5)
+    rb_snowflake_client (1.1.0)
       concurrent-ruby (>= 1.2)
       connection_pool (>= 2.4)
       dotenv (>= 2.8)
@@ -12,38 +12,41 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
     coderay (1.1.3)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.3.1)
     connection_pool (2.4.1)
-    diff-lcs (1.5.0)
-    dotenv (2.8.1)
-    jwt (2.7.1)
-    method_source (1.0.0)
-    oj (3.16.1)
-    parallel (1.23.0)
+    diff-lcs (1.5.1)
+    dotenv (3.1.2)
+    jwt (2.8.1)
+      base64
+    method_source (1.1.0)
+    oj (3.16.3)
+      bigdecimal (>= 3.0)
+    parallel (1.24.0)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rake (13.1.0)
+    rake (13.2.1)
     retryable (3.0.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
 
 PLATFORMS
-  arm64-darwin-21
   arm64-darwin-22
-  x86_64-linux
+  ruby
 
 DEPENDENCIES
   bundler
@@ -60,4 +63,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   2.4.19
+   2.5.4

data/README.md

@@ -4,11 +4,11 @@
 
 The available options for connecting from Ruby to Snowflake include:
 * ODBC - which works, but can be very slow, especially for a lot of data, which is probably why you're using Snowflake
-* The [ruby snowflake client][https://github.com/rinsed-org/ruby-snowflake-client] that wraps the go client. This is probably the fastest single threaded option, which we also created. However, that library takes the ruby GVL and so stops all other processing in your ruby process (threads).
+* The [ruby snowflake client](https://github.com/rinsed-org/ruby-snowflake-client) that wraps the go client. This is probably the fastest single threaded option, which we also created. However, that library takes the ruby GVL and so stops all other processing in your ruby process (threads).
 
 This library is implemented in ruby and while it leverages some libraries that have native extensions, doesn't currently include anything itself. Depending on network latency and the shape of the data this library can be faster or slower than the go wrapper. The big advantages are:
 * It uses about half the memory when you pull a full result set into memory
-* It does not hold onto the [ruby GVL][https://www.speedshop.co/2020/05/11/the-ruby-gvl-and-scaling.html] and so does not block other threads while waiting on IO like the go wrapper client.
+* It does not hold onto the [ruby GVL](https://www.speedshop.co/2020/05/11/the-ruby-gvl-and-scaling.html) and so does not block other threads while waiting on IO like the go wrapper client.
 * It will consume more resources for the same data, because it's using the HTTP v2 API and getting JSON back, there is just more work to as compared to the go or python clients that use Apache Arrow under the covers.
 
 # Usage
@@ -105,6 +105,24 @@ Clients are not warehouse specific, you can override the default warehouse per q
 client.query("SELECT * FROM BIGTABLE", warehouse: "FAST_WH")
 ```
 
+## Binding parameters
+
+Say we have `BIGTABLE` with a `data` column of a type `VARIANT`.
+
+```ruby
+json_string = '{"valid": "json"}'
+query = "insert into BIGTABLE(data) select parse_json(?)"
+bindings = {
+  "1": {
+    "type": "TEXT",
+    "value": json_string
+  }
+}
+client.query(query, bindings: bindings)
+```
+
+For additional information about binding parameters refer to snowflake documentation: https://docs.snowflake.com/en/developer-guide/sql-api/submitting-requests#using-bind-variables-in-a-statement
+
 # Configuration Options
 
 The client supports the following configuration options, each with their own getter/setter except connection pool options which must be set at construction. Additionally, all except logger can be configured with environment variables (see above, but the pattern is like: "SNOWFLAKE_HTTP_RETRIES". Configuration options can only be set on initialization through `new` or `from_env`.

data/lib/ruby_snowflake/client.rb

@@ -128,7 +128,7 @@ module RubySnowflake
       @_enable_polling_queries = false
     end
 
-    def query(query, warehouse: nil, streaming: false, database: nil)
+    def query(query, warehouse: nil, streaming: false, database: nil, schema: nil, bindings: nil)
       warehouse ||= @default_warehouse
       database ||= @default_database
 
@@ -136,8 +136,11 @@ module RubySnowflake
       response = nil
       connection_pool.with do |connection|
         request_body = {
-          "statement" => query, "warehouse" => warehouse&.upcase,
-          "database" =>  database&.upcase, "timeout" => @query_timeout
+          "warehouse" => warehouse&.upcase,
+          "schema" => schema&.upcase,
+          "database" =>  database&.upcase,  
+          "statement" => query,
+          "bindings" => bindings
         }
 
         response = request_with_auth_and_headers(
@@ -147,7 +150,7 @@ module RubySnowflake
           Oj.dump(request_body)
         )
       end
-      retreive_result_set(query_start_time, query, response, streaming)
+      retrieve_result_set(query_start_time, query, response, streaming)
     end
 
     alias fetch query
@@ -264,7 +267,7 @@ module RubySnowflake
         false
       end
 
-      def retreive_result_set(query_start_time, query, response, streaming)
+      def retrieve_result_set(query_start_time, query, response, streaming)
         json_body = Oj.load(response.body, OJ_OPTIONS)
         statement_handle = json_body["statementHandle"]
 
@@ -274,18 +277,18 @@ module RubySnowflake
         end
 
         num_threads = number_of_threads_to_use(json_body["resultSetMetaData"]["partitionInfo"].size)
-        retreive_proc = ->(index) { retreive_partition_data(statement_handle, index) }
+        retrieve_proc = ->(index) { retrieve_partition_data(statement_handle, index) }
 
         if streaming
-          StreamingResultStrategy.result(json_body, retreive_proc)
+          StreamingResultStrategy.result(json_body, retrieve_proc)
         elsif num_threads == 1
-          SingleThreadInMemoryStrategy.result(json_body, retreive_proc)
+          SingleThreadInMemoryStrategy.result(json_body, retrieve_proc)
         else
-          ThreadedInMemoryStrategy.result(json_body, retreive_proc, num_threads)
+          ThreadedInMemoryStrategy.result(json_body, retrieve_proc, num_threads)
         end
       end
 
-      def retreive_partition_data(statement_handle, partition_index)
+      def retrieve_partition_data(statement_handle, partition_index)
         partition_response = nil
         connection_pool.with do |connection|
           partition_response = request_with_auth_and_headers(

data/lib/ruby_snowflake/version.rb

@@ -1,3 +1,3 @@
 module RubySnowflake
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rb_snowflake_client
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Rinsed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-20 00:00:00.000000000 Z
+date: 2024-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby