dwh 0.1.0

data/docs/guides/usage.md

@@ -0,0 +1,378 @@
+<!--
+# @title Advanced Usage
+-->
+# Advanced Usage Guide
+
+This guide covers advanced features and usage patterns for DWH, including function translation, streaming, connection pooling, and performance optimization.
+
+## SQL Function Translation
+
+DWH provides automatic translation of common SQL functions to database-specific syntax. This allows you to write database-agnostic code while leveraging native optimizations.
+
+### Date Functions
+
+#### Date Truncation
+
+```ruby
+# Truncate dates to different periods
+adapter.truncate_date('week', 'created_at')
+# PostgreSQL: DATE_TRUNC('week', created_at)
+# SQL Server: DATETRUNC(week, created_at)
+# MySQL: DATE_FORMAT(created_at, '%Y-%m-%d') - complex logic
+
+adapter.truncate_date('month', 'order_date')
+adapter.truncate_date('year', 'signup_date')
+```
+
+#### Date Literals
+
+```ruby
+# Create database-specific date literals
+adapter.date_literal('2025-01-01')
+# PostgreSQL: '2025-01-01'::DATE
+# SQL Server: '2025-01-01'
+# MySQL: '2025-01-01'
+
+adapter.date_time_literal('2025-01-01 10:30:00')
+# PostgreSQL: '2025-01-01 10:30:00'::TIMESTAMP
+# SQL Server: '2025-01-01 10:30:00'
+```
+
+#### Date Arithmetic
+
+```ruby
+# Add/subtract time periods
+adapter.date_add('created_at', 30, 'day')
+# PostgreSQL: (created_at + '30 day'::interval)
+# SQL Server: DATEADD(day, 30, created_at)
+# MySQL: TIMESTAMPADD(day, 30, created_at)
+
+adapter.date_diff('end_date', 'start_date', 'day')
+# Calculate difference between dates in specified units
+```
+
+#### Date Extraction
+
+```ruby
+# Extract date parts
+adapter.extract_year('created_at')
+# PostgreSQL: extract(year from created_at)
+# SQL Server: DATEPART(year, created_at)
+
+adapter.extract_month('created_at')
+adapter.extract_day_of_week('created_at')
+adapter.extract_quarter('created_at')
+```
+
+### String Functions
+
+```ruby
+# String manipulation
+adapter.trim('column_name')        # Remove whitespace
+adapter.upper_case('column_name')  # Convert to uppercase
+adapter.lower_case('column_name')  # Convert to lowercase
+
+# Quoting and literals
+adapter.quote('column_name')       # Database-specific column quoting
+adapter.string_literal('value')    # Database-specific string literals
+```
+
+### Null Handling
+
+```ruby
+# Null value handling
+adapter.if_null('column1', "'default'")
+# PostgreSQL: COALESCE(column1, 'default')
+# SQL Server: ISNULL(column1, 'default')
+
+adapter.null_if('column1', "'empty'")
+# Returns NULL if column1 equals 'empty'
+
+adapter.null_if_zero('numeric_column')
+# Returns NULL if numeric_column equals 0
+```
+
+### Array Functions
+
+Available for databases that support array operations (PostgreSQL, Druid):
+
+```ruby
+# Check if array contains any values from a list
+adapter.array_in_list('tags', "'tech', 'science'")
+# PostgreSQL: tags && ARRAY['tech', 'science']
+# Druid: MV_OVERLAP(tags, ARRAY['tech', 'science'])
+
+# Check if array excludes all values from a list
+adapter.array_exclude_list('categories', "'spam', 'test'")
+
+# Unnest/explode array for joins
+adapter.array_unnest_join('tags', 'tag_alias')
+# PostgreSQL: CROSS JOIN UNNEST(tags) AS tag_alias
+# Druid: CROSS JOIN UNNEST(MV_TO_ARRAY(tags)) tag_alias
+```
+
+### Type Casting
+
+```ruby
+# Database-specific type casting
+adapter.cast('column_name', 'INTEGER')
+# PostgreSQL: column_name::INTEGER
+# SQL Server: CAST(column_name AS INTEGER)
+# MySQL: CAST(column_name AS SIGNED)
+```
+
+## Streaming and Large Result Sets
+
+### Basic Streaming
+
+```ruby
+# Stream results directly to a file
+File.open('large_export.csv', 'w') do |file|
+  adapter.execute_stream("SELECT * FROM large_table", file)
+end
+
+# Stream with custom processing
+adapter.stream("SELECT * FROM large_table") do |chunk|
+  # Process each chunk as it arrives
+  process_data_chunk(chunk)
+end
+```
+
+### Streaming with Statistics
+
+```ruby
+# Create streaming stats collector
+stats = DWH::StreamingStats.new(10_000)  # Keep 10k rows in memory for preview
+
+# Stream with stats tracking
+File.open('export.csv', 'w') do |file|
+  exec_thread = adapter.execute_stream("SELECT * FROM large_table", file, stats: stats)
+  
+  # Monitor progress in another thread
+  Thread.new do
+    loop do
+      puts "Processed: #{stats.total_rows} rows"
+      puts "Preview size: #{stats.data.size} rows"
+      puts "Max row size: #{stats.max_row_size} bytes"
+      sleep(5)
+      break unless exec_thread.alive? 
+    end
+  end
+end
+
+# Access collected statistics
+puts "Final count: #{stats.total_rows}"
+puts "Sample data: #{stats.data.first(5)}"
+```
+
+### Memory Management
+
+```ruby
+# Configure streaming stats memory usage
+stats = DWH::StreamingStats.new(50_000)  # Keep more data for larger previews
+
+# Reset stats for reuse
+stats.reset
+
+# Manual memory management
+stats.add_row(['col1', 'col2', 'col3'])
+current_data = stats.data  # Thread-safe access
+```
+
+## Connection Pooling
+
+### Creating Connection Pools
+
+```ruby
+# Create a named connection pool
+pool = DWH.pool('analytics_pool', :postgres, {
+  host: 'localhost',
+  database: 'analytics',
+  username: 'analyst',
+  password: 'password'
+}, size: 10, timeout: 5)
+
+# Multiple pools for different databases
+etl_pool = DWH.pool('etl_pool', :postgres, etl_config, size: 5)
+reporting_pool = DWH.pool('reporting_pool', :mysql, reporting_config, size: 15)
+```
+
+### Using Connection Pools
+
+```ruby
+# Basic pool usage
+pool.with do |connection|
+  results = connection.execute("SELECT COUNT(*) FROM users")
+  metadata = connection.metadata('orders')
+end
+
+# Nested pool operations
+pool.with do |conn1|
+  users = conn1.execute("SELECT id FROM users LIMIT 100")
+  
+  pool.with do |conn2|  # Gets different connection from pool
+    orders = conn2.execute("SELECT * FROM orders WHERE user_id IN (?)", 
+                          users.map(&:first))
+  end
+end
+```
+
+### Pool Management
+
+```ruby
+# Check pool status
+puts "Pool size: #{pool.size}"
+puts "Available connections: #{pool.available}"
+puts "Active connections: #{pool.in_use}"
+
+# Graceful shutdown
+DWH.shutdown('analytics_pool')
+
+# Shutdown all pools
+DWH.shutdown_all
+```
+
+## Database Capabilities Detection
+
+### Checking Capabilities
+
+```ruby
+# Check what features are supported
+if adapter.supports_window_functions?
+  query = "SELECT name, ROW_NUMBER() OVER (ORDER BY created_at) FROM users"
+  results = adapter.execute(query)
+end
+```
+
+### Available Capability Checks
+
+- `supports_table_join?` - Basic JOIN support
+- `supports_full_join?` - FULL OUTER JOIN support
+- `supports_cross_join?` - CROSS JOIN support
+- `supports_sub_queries?` - Subquery support
+- `supports_common_table_expressions?` - CTE support
+- `supports_temp_tables?` - Temporary table support
+- `supports_window_functions?` - Window function support
+- `supports_array_functions?` - Array operation support
+
+## Performance Optimization
+
+### Query Timeouts
+
+```ruby
+# Set query timeouts per adapter
+postgres = DWH.create(:postgres, {
+  host: 'localhost',
+  database: 'mydb',
+  username: 'user',
+  query_timeout: 1800  # 30 minutes
+})
+
+# For long-running analytical queries
+druid = DWH.create(:druid, {
+  host: 'localhost',
+  port: 8080,
+  protocol: 'http',
+  query_timeout: 3600  # 1 hour
+})
+```
+
+### Result Format Optimization
+
+```ruby
+# Choose appropriate result format for your use case
+arrays = adapter.execute(sql, format: :array)    # Fastest, least memory
+objects = adapter.execute(sql, format: :object)  # Hash access, more memory
+csv = adapter.execute(sql, format: :csv)         # String format
+native = adapter.execute(sql, format: :native)   # Database's native format
+```
+
+### Streaming for Large Results
+
+```ruby
+# Use streaming for large result sets
+def export_large_table(adapter, table_name, output_file)
+  query = "SELECT * FROM #{table_name}"
+  
+  File.open(output_file, 'w') do |file|
+    adapter.execute_stream(query, file)
+  end
+end
+
+# Chunk processing for memory efficiency
+def process_large_dataset(adapter, query)
+  adapter.stream(query) do |chunk|
+    # Process each chunk immediately
+    # Avoids loading entire result set into memory
+    chunk.each { |row| process_row(row) }
+  end
+end
+```
+
+## Error Handling and Debugging
+
+### Comprehensive Error Handling
+
+```ruby
+begin
+  results = adapter.execute("SELECT * FROM table")
+rescue DWH::ExecutionError => e
+  # Query execution failed
+  puts "Query failed: #{e.message}"
+  puts "SQL: #{e.sql}" if e.respond_to?(:sql)
+rescue DWH::ConnectionError => e
+  # Connection issues
+  puts "Connection failed: #{e.message}"
+  # Implement retry logic
+rescue DWH::ConfigError => e
+  # Configuration problems
+  puts "Configuration error: #{e.message}"
+rescue DWH::UnsupportedCapability => e
+  # Attempted unsupported operation
+  puts "Feature not supported: #{e.message}"
+end
+```
+
+## Custom Settings and Overrides
+
+### Runtime Settings Modification
+
+```ruby
+# Create adapter with custom settings
+adapter = DWH.create(:postgres, {
+  host: 'localhost',
+  database: 'mydb',
+  username: 'user',
+  settings: {
+    quote: '`@exp`',  # Use backticks instead of double quotes
+    supports_window_functions: false,  # Force disable window functions
+    temp_table_type: 'cte'  # Prefer CTEs over subqueries
+  }
+})
+
+# Modify settings at runtime
+adapter.alter_settings({
+  supports_full_join: false,  # Disable FULL JOINs
+  final_pass_measure_join_type: 'inner'  # Use INNER JOINs
+})
+
+# Reset to original settings
+adapter.reset_settings
+```
+
+### Custom Function Mappings
+
+```ruby
+# Override specific function translations
+adapter = DWH.create(:postgres, {
+  host: 'localhost',
+  database: 'mydb',
+  username: 'user',
+  settings: {
+    truncate_date: "DATE_TRUNC('@unit', @exp)",  # Custom date truncation
+    cast: "@exp::@type",  # PostgreSQL-style casting
+    null_if: "CASE WHEN @exp = @target THEN NULL ELSE @exp END"  # Custom NULLIF
+  }
+})
+```
+

data/docs/index.html

@@ -0,0 +1,210 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: README
+  
+    &mdash; Documentation by YARD 0.9.37
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "README";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index</a> &raquo; 
+    <span class="title">File: README</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><div id='filecontents'>
+<p><a href="https://github.com/stratasite/dwh/actions"><img src="https://github.com/stratasite/dwh/workflows/Ruby/badge.svg" alt="Ruby" /></a></p>
+
+<h1 id="dwh---data-warehouse-adapter-library">DWH - Data Warehouse Adapter Library</h1>
+
+<p>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 <code>date_trunc</code>, <code>date_add</code> etc.  The function tranlation is not comprehensive. But, it does provides good coverage for date handling, and some array handling as well.</p>
+
+<blockquote>
+  <p>[!NOTE]
+<strong>This is not an ORM</strong> 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.</p>
+</blockquote>
+
+<h2 id="why-do-we-need-another-database-abstraction-layer">Why do we need another database abstraction layer?</h2>
+
+<p>Libraries like <a href="https://github.com/jeremyevans/sequel">Sequel</a> 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.</p>
+
+<p>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 <a href="http://github.com/stratasite/dwh/blob/main/lib/dwh/adapters/druid.rb">Druid</a> implementation as an example. And <a href="https://github.com/stratasite/dwh/blob/main/lib/dwh/settings/druid.yml">here</a> is its corresponding YAML settings file.</p>
+
+<h2 id="features">Features</h2>
+
+<ul>
+  <li><strong>Unified Interface</strong>: Connect to multiple database types using the same API</li>
+  <li><strong>SQL Function Translation</strong>: Automatically translates common SQL functions to database-specific syntax</li>
+  <li><strong>Connection Pooling</strong>: Built-in connection pool management for high-performance applications</li>
+  <li><strong>Rich Metadata</strong>: Extract table schemas, column information, and statistics</li>
+</ul>
+
+<h2 id="supported-databases">Supported Databases</h2>
+
+<ul>
+  <li><strong>Snowflake</strong> - High performance cloud warehouse</li>
+  <li><strong>Trino</strong> (formerly Presto) - Distributed SQL query engine</li>
+  <li><strong>AWS Athena</strong> - AWS big data warehouse</li>
+  <li><strong>Apache Druid</strong> - Real-time analytics database</li>
+  <li><strong>DuckDB</strong> - In-process analytical database</li>
+  <li><strong>PostgreSQL</strong> - Full-featured RDBMS with advanced SQL support</li>
+  <li><strong>MySQL</strong> - Popular open-source database</li>
+  <li><strong>SQL Server</strong> - Microsoft’s enterprise database</li>
+</ul>
+
+<h2 id="integrations-coming-soon">Integrations Coming Soon</h2>
+
+<ul>
+  <li><strong>Redshift</strong> - AWS data warehouse platform</li>
+  <li><strong>ClickHouse</strong> - High performance analytical db</li>
+  <li><strong>Databricks</strong> - Big data compute engine</li>
+  <li><strong>MotherDuck</strong> - Hosted DuckDB service</li>
+</ul>
+
+<h2 id="quick-start">Quick Start</h2>
+
+<p>Install it yourself as:</p>
+
+<p><code>bash
+gem install dwh
+</code></p>
+
+<h3 id="connect-and-execute-a-basic-query">Connect and Execute a Basic Query</h3>
+
+<p>```ruby
+require ‘dwh’</p>
+
+<h1 id="connect-to-druid">Connect to Druid</h1>
+<p>druid = DWH.create(:druid, {
+  host: ‘localhost’,
+  port: 8080,
+  protocol: ‘http’
+})</p>
+
+<h1 id="basic-query-execution">basic query execution</h1>
+<p>results = druid.execute(“SELECT * FROM web_sales”, format: :csv)
+```</p>
+
+<h2 id="core-api">Core API</h2>
+
+<p>Standardized API across adapters:</p>
+
+<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>
+
+<h2 id="tutorials-and-guides">Tutorials and Guides</h2>
+
+<ul>
+  <li><a href="/docs/guides/getting-started.md">Getting Started</a></li>
+  <li><a href="/docs/guides/adapters.md">Adapter Configuration</a></li>
+  <li><a href="/docs/guides/creating-adapters.md">Creating an Adapter</a></li>
+  <li><a href="https://rubydoc.info/github/stratasite/dwh.git">API</a></li>
+</ul>
+
+<h2 id="testing">Testing</h2>
+
+<p>Certain databases have to be tested via docker. Those tests will try to launch docker compose services in <code>test/support/compose*.yml</code></p>
+
+<p>Run Unit Tests:</p>
+
+<p><code>bash
+bundle exec rake test:unit
+</code></p>
+
+<p>Run tests on RDBMS dbs:</p>
+
+<p><code>bash
+bundle exec rake test:system:rdbms 
+</code></p>
+
+<p>Run tests on  druid:</p>
+
+<p><code>bash
+bundle exec rake test:system:druid 
+</code></p>
+
+<h2 id="development">Development</h2>
+
+<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake test</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt.</p>
+
+<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>.</p>
+
+<h2 id="contributing">Contributing</h2>
+
+<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/stratasite/dwh">https://github.com/stratasite/dwh</a>.</p>
+
+<h2 id="license">License</h2>
+
+<p>This project is available as open source under the terms of the MIT License.</p>
+
+<h2 id="version">Version</h2>
+
+<p>Current version: 0.1.0</p>
+</div></div>
+
+      <div id="footer">
+  Generated on Fri Aug 22 08:31:21 2025 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.4.4).
+</div>
+
+    </div>
+  </body>
+</html>