dwh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3971b0c0d4f6964a2f6d1ce8d04038f3f79e09036cd8ab19a2c5dd866d5411ca
+  data.tar.gz: 567185f3ec75fa9b606538031076f8215e376257a421159f6139dfc951e43e30
+SHA512:
+  metadata.gz: 75c38e6b03b9d6759cc43d363924b6cbffa91bfd2af30e327d864371c5c77143071d909f8b805d44fb59de679ad23ed1be0294a99906ef435b5effb18a381e33
+  data.tar.gz: e8e5ac7103954e9c644a0fbfc819b66ef673bbd4a85dd9a8a96a6b4cacb86dd50b73e37aeb1cba4bd049a190d42a3f78f7024235b8b0c4fd4c44a0f931f581fb

data/.rubocop.yml

@@ -0,0 +1,36 @@
+Layout/LineLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+  
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 10
+
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/dwh/adapters/**/*.rb'
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-03
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Strata Business Intelligence
+
+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,130 @@
+
+[![Ruby](https://github.com/stratasite/dwh/workflows/Ruby/badge.svg)](https://github.com/stratasite/dwh/actions)
+
+# DWH - Data Warehouse Adapter Library
+
+A light weight library to connect, introspect, and query popular databases over a unified interface.  This gem is intended for analtyical workloads.  The library also provides database specific translations for common functions like `date_trunc`, `date_add` etc.  The function tranlation is not comprehensive. But, it does provides good coverage for date handling, and some array handling as well.
+
+> [!NOTE]
+> **This is not an ORM** nor will it cast types to ruby unless the underlying client does it out of the box.  The goal here is to create an Architecture where new databases can be onboarded quickly.
+
+## Why do we need another database abstraction layer?
+
+Libraries like [Sequel](https://github.com/jeremyevans/sequel) are amazing and comprehensive.  However, its broad coverage also makes it more laborious to add new databases.  Especially, ones with only HTTP endpoints for Ruby.  We seem to be having an explosion of databases recently and a light weight interface will allow us to integrate faster.
+
+The adapter only has 5 core methods (6 including the connection method).  A YAML settings controls how it interacts with a particular db.  It is relatively fast to add a new db. See the [Druid](http://github.com/stratasite/dwh/blob/main/lib/dwh/adapters/druid.rb) implementation as an example. And [here](https://github.com/stratasite/dwh/blob/main/lib/dwh/settings/druid.yml) is its corresponding YAML settings file.
+
+## Features
+
+- **Unified Interface**: Connect to multiple database types using the same API
+- **SQL Function Translation**: Automatically translates common SQL functions to database-specific syntax
+- **Connection Pooling**: Built-in connection pool management for high-performance applications
+- **Rich Metadata**: Extract table schemas, column information, and statistics
+
+## Supported Databases
+
+- **Snowflake** - High performance cloud warehouse
+- **Trino** (formerly Presto) - Distributed SQL query engine
+- **AWS Athena** - AWS big data warehouse
+- **Apache Druid** - Real-time analytics database
+- **DuckDB** - In-process analytical database
+- **PostgreSQL** - Full-featured RDBMS with advanced SQL support
+- **MySQL** - Popular open-source database
+- **SQL Server** - Microsoft's enterprise database
+
+## Integrations Coming Soon
+
+- **Redshift** - AWS data warehouse platform
+- **ClickHouse** - High performance analytical db
+- **Databricks** - Big data compute engine
+- **MotherDuck** - Hosted DuckDB service
+
+## Quick Start
+
+Install it yourself as:
+
+```bash
+gem install dwh
+```
+
+### Connect and Execute a Basic Query
+
+```ruby
+require 'dwh'
+
+# Connect to Druid
+druid = DWH.create(:druid, {
+  host: 'localhost',
+  port: 8080,
+  protocol: 'http'
+})
+
+# basic query execution
+results = druid.execute("SELECT * FROM web_sales", format: :csv)
+```
+
+## Core API
+
+Standardized API across adapters:
+
+<dl>
+  <dt>connection</dt>
+  <dd>Creates a reusuable connection based on config hash passed in</dd>
+  <dt>tables(schema: nil, catalog: nil)</dt>
+  <dd> returns a list of tables from the default connection or from the specified schema and catalog </dd>
+  <dt> metadata(table_name, schema: nil, catalog: nil) </dt>
+  <dd> provides metadata about a table </dd>
+  <dt>stats(table_name, date_column: nil) </dt>
+  <dd> provides table row count and date range </dd>
+  <dt> execute(sql, format: :array, retries: 0) </dt>
+  <dd> runs a query and returns in given format </dd>
+  <dt> execute_stream(sql, io, stats: nil) </dt>
+  <dd> runs a query and streams it as csv into the given io </dd>
+</dl>
+
+## Tutorials and Guides
+
+- [Getting Started](/docs/guides/getting-started.md)
+- [Adapter Configuration](/docs/guides/adapters.md)
+- [Creating an Adapter](/docs/guides/creating-adapters.md)
+- [API](https://rubydoc.info/github/stratasite/dwh.git)
+
+## Testing
+
+Certain databases have to be tested via docker. Those tests will try to launch docker compose services in `test/support/compose*.yml`
+
+Run Unit Tests:
+
+```bash
+bundle exec rake test:unit
+```
+
+Run tests on RDBMS dbs:
+
+```bash
+bundle exec rake test:system:rdbms 
+```
+
+Run tests on  druid:
+
+```bash
+bundle exec rake test:system:druid 
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/stratasite/dwh>.
+
+## License
+
+This project is available as open source under the terms of the MIT License.
+
+## Version
+
+Current version: 0.1.0

data/Rakefile

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+require 'yard'
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = ['lib/**/*.rb']
+
+  # Output directory
+  t.options = [
+    '--output-dir', 'docs',
+    '--markup', 'markdown',
+    '--markup-provider', 'kramdown',
+    '--charset', 'utf-8',
+    '--verbose', '--debug',
+    '--files', 'docs/guides/*.md'
+  ]
+end
+
+namespace :test do
+  Minitest::TestTask.create :unit do |t|
+    t.test_globs = ['test/unit/**/*_test.rb']
+  end
+
+  namespace :system do
+    Minitest::TestTask.create :rdbms do |t|
+      t.test_globs = ['test/system/rdbms_*_test.rb']
+    end
+
+    Minitest::TestTask.create :druid do |t|
+      t.test_globs = ['test/system/druid_test.rb']
+    end
+
+    Minitest::TestTask.create :cloud do |t|
+      t.test_globs = ['test/system/cloud_test.rb']
+    end
+  end
+end
+
+# task test: %i[test:unit]
+# task test_all: %i[test:unit test:system:all]