athena-utils 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90313673159e89c11d9e5a349cf25ba6f36c8a1b2e0842aede4077b4bd4591e2
-  data.tar.gz: cc06774cad38266f57b842dbd75c05f82b2a39502c4c4918653f1a8becd8e8f0
+  metadata.gz: a6cfc30203a5a7011e98d08203bb667a82635fef01f429aea57816ed26e2f162
+  data.tar.gz: 8f54fbfdaa0decb20edadf57a01ff93507d42ec97c7ca033811be22d03339e22
 SHA512:
-  metadata.gz: a9d081001c9d3df09e9c168eaf1b9ae3b9efef68304de3f7bee46f58faac5ba661cdcab389a1c41930c92673f6bce55f1b123e39fbc258789c62ffbfd7607ab9
-  data.tar.gz: c95477b1c4a8f13c6e3ad9433c0ebe123b56b4446799c70bf7c345c1e4a447742ca246dba2a6a015711e576a7018d679dc5b19145df5b2b178860ce2ab1054fa
+  metadata.gz: eb94223f2bc84ae9363c64ba9fadfa24b4afa6003c41b498979b1b0673dbf0f97d330b7ce4d8c55abefe29718ce9191aba35229d4c9feb6515f2cd391605a55a
+  data.tar.gz: eecb9e9020be2969c47ed309d41c1a001e1910fd6bba0bc7956855507b1d4aa73497fdcd9964f7e7ea3d9ba9fdf85391519c7b6be5884842178d3d68a8a8f630

data/README.md

@@ -1,3 +1,76 @@
 # AWS Athena Utils
 
-A simple query wrapper around Aws::Athena::Client.
+Purpose of this utility is to execute Athena queries and wait for results.
+
+## Usage
+
+Install the gem:
+
+```
+gem install 'athena-utils'
+```
+
+Create an Athena client and wait for results.
+
+```
+require 'athena-utils'
+
+athena_database = 'test_db'
+athena_workspace = 'primary'
+athena_client = AthenaUtils::AthenaClient.new(athena_database, athena_workspace)
+
+results = athena_client.query("SELECT * FROM users WHERE created_at >= Date('2022-01-01')")
+results.first
+# => {"id"=>"8", "name"=>"Foo", "email"=>"foo@example.com", "created_at"=>"2022-02-01"}
+```
+
+Execute multiple queries and wait for results.
+
+```
+require 'athena-utils'
+
+athena_database = 'test_db'
+athena_workspace = 'primary'
+athena_client = AthenaUtils::AthenaClient.new(athena_database, athena_workspace)
+
+# contains table_name => query_execution_id
+query_executions = {}
+query_executions['users'] = athena_client.query_async("SELECT * FROM users WHERE created_at >= Date('2022-01-01')")
+query_executions['groups'] = athena_client.query_async("SELECT * FROM groups WHERE created_at >= Date('2022-01-01')")
+query_executions['activities'] = athena_client.query_async("SELECT * FROM activities WHERE created_at >= Date('2022-01-01')")
+
+# given an array of query_execution_id(s)
+# waits for each query to successfully complete
+# and returns the results of each in a hash
+# key is the query_execution_id and the value is the results
+results = athena_client.wait(query_executions.values)
+
+users_results = results[query_executions['users']]
+groups_results = results[query_executions['groups']]
+activities_results = results[query_executions['activities']]
+
+users_results.first
+# => {"id"=>"8", "name"=>"Foo", "email"=>"foo@example.com", "created_at"=>"2022-02-01"}
+```
+
+## AthenaUtils::AthenaQueryResults
+
+Streams the results of the query.  Avoids loading the results into memory.
+
+The class implements the Enumerable module.  For easy of use the _each_ method returns each row in a hash where the header names are the keys.
+
+How to access the rows as an array
+
+```
+# given the above query logic
+headers = users_results.csv.shift
+
+while(row = users_results.csv.shift)
+  id = row[0]
+  name = row[1]
+  emai = row[2]
+  created_at = row[3]
+
+  # do something
+end
+```

data/athena-utils.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'athena-utils'
-  s.version     = '0.2.0'
+  s.version     = '0.2.1'
   s.licenses    = ['MIT']
   s.summary     = 'Athena Utils'
   s.description = 'Tools for querying AWS Athena'

data/bin/athena

@@ -11,17 +11,17 @@ options = {
   console: false
 }
 OptionParser.new do |opts|
-  opts.banner = "Usage: athena [options]"
+  opts.banner = 'Usage: athena [options]'
 
-  opts.on("-d", "--database DATABASE", "Athena DB") do |v|
+  opts.on('-d', '--database DATABASE', 'Athena DB') do |v|
     options[:database] = v
   end
 
-  opts.on("-w WORK_GROUP", "Athena Work Group, default: primary") do |v|
+  opts.on('-w', '--work-group WORK_GROUP', 'Athena Work Group, default: primary') do |v|
     options[:work_group] = v
   end
 
-  opts.on("-e", "--execute QUERY", "Execute SQL Query") do |v|
+  opts.on('-e', '--execute QUERY', 'Execute SQL Query') do |v|
     options[:query] = v
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: athena-utils
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Doug Youch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-athena