dbx-api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09cd7a1984478b2761fbe0dca4b69acd123d664c96ea7333997143fe4389aa3b'
-  data.tar.gz: 5e1093ab32b19c13eff195869d12dc159459f4418f3bc260df241e737cd5f78f
+  metadata.gz: c868f357a1e4f6659b248d71be4567ddce7b4e2b0099a094b3cf473c5100b5ff
+  data.tar.gz: ec6d7f7a72ce00d9a21396f506f7b7a8f7795f072c5d7541a5b96d1710bc2b5a
 SHA512:
-  metadata.gz: 407516bedbe4fa69d01ad765804aa2593966faebfa966eadac4ed08da44fb41fc7ea055b2be781194e762916784c4cb1d0bb0d4c44b9b3ad8ed23273415277f2
-  data.tar.gz: 569cdbc0465214559dd397e27d143cf3e56fbc96e1f1447c45bd18ba472ef444ec712cf16ae69837b6380de54135c3e42dd1af775f22221954b149c70f249a5c
+  metadata.gz: 354a655157aad1118192f0d01d93db0844d861e6277cb53af0befe1f1d8e3318bfec296d512b7c6ac07650fb1ea7ff26e8a4235a61e4d3457e9395ea65e59fd6
+  data.tar.gz: 3c9ae8e759f56d5f8d3e0c38f2cfbbdee4b237dc36ca6436924ad60b7384957e9f7e4a1f7239873234f96e87af21b00a08f6de1ad629ec5b013c2fbe1e6d2241

data/CHANGELOG.md

@@ -11,4 +11,7 @@
 - `DatabricksGateway::run_sql` now returns an object of type `DatabricksSQLResponse`
   - results can be accessed by `DatabricksSQLResponse::results`
   - query success can be accessed by `DatabricksSQLResponse::success?`
-- Added optional `sleep_timer` parameter to `DatabricksGateway`. This is the number of seconds to wait between checking the status of a query. Defaults to 5 seconds.
+- Added optional `sleep_timer` parameter to `DatabricksGateway`. This is the number of seconds to wait between checking the status of a query. Defaults to 5 seconds.
+
+## [0.2.1]
+- Added option to `DatabricksSQLResponse::results` to return symbolized keys

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dbx-api (0.2.0)
+    dbx-api (0.2.1)
       dotenv (~> 2.0)
 
 GEM

data/README.md

@@ -80,11 +80,30 @@ return res.results if res.success?
 puts "query failed: #{res.error_message}"
 ```
 
+The result of `DatabrucksSQLResponse.results` is always a an array of hashes with string keys. You can map over this array using whatever ruby code you like. For example:
+```ruby
+sql_response = sql_runnner.run_sql(my_query)
+
+# count the number of results
+sql_response.results.length
+```
+
+If you would prefer a symbolized hash, you can use the `symbolize_keys` option when calling `results`:
+```ruby
+sql_response.results(symbolize_keys: true)
+```
+
 Since `run_sql` returns an instance of `DatabricksSQLResponse`, you can also chain methods together:
 ```ruby
 sql_runner.run_sql("SELECT 1").results
 ```
 
+The `run_sql` method hanldes slow queries by pinging databricks at set time intervals (default 5 seconds) until the query either fails or succeeds. The default sleep_timer can be set to any desired time interval at initialization:
+```ruby
+# changing the default sleep timer to 1 second
+sql_runner = DatabricksGateway.new(sleep_timer: 1)
+```
+
 ## Development
 - After checking out the repo, run `bin/setup` to install dependencies. 
 - Set up your `.env` file as described above. 
@@ -93,4 +112,4 @@ sql_runner.run_sql("SELECT 1").results
 ## Build
 - Run `gem build dbx.gemspec ` to build the gem.
 - Run `gem push dbx-api-0.2.0.gem` to push the gem to rubygems.org
-  - Requires logging in to rubygems.org first via `gem login`
+  - Requires logging in to rubygems.org first via `gem login`

data/lib/dbx/databricks/sql_response.rb

@@ -97,15 +97,16 @@ class DatabricksSQLResponse
     body.dig("result", "data_array") || body["data_array"] || []
   end
 
-  # Return the results of the query as an array of hashes.
+  # Return the results of the query as an array of hashes with string keys.
   # @return [Array<Hash>]
-  def results
+  def results(symbolize_keys: false)
     return [] if failed?
 
     data_array.map do |row|
       hash = {}
       columns.each do |column|
-        hash[column["name"]] = row[column["position"]]
+        key = symbolize_keys ? column["name"].to_sym : column["name"]
+        hash[key] = row[column["position"]]
       end
       hash
     end

data/lib/dbx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dbx
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbx-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - cmmille
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -56,6 +56,7 @@ metadata:
   homepage_uri: https://github.com/pdxmolab/dbx-gem
   source_code_uri: https://github.com/pdxmolab/dbx-gem
   changelog_uri: https://github.com/pdxmolab/dbx-gem/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: