activerecord8-redshift-adapter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa5caefae917701fe9b5f6b84c36d7f42d7c17fcd24ad6416345a66585f7b208
+  data.tar.gz: 4349e6d9fca32e14ee7fe6e042c607daead2207923b4c5c22e53bf65ca52947d
+SHA512:
+  metadata.gz: 531ce0f10c5ab65e7e6528b5de60923b9e36b1e558ef1c239076f40633529660c5dc98fc21691abdc0e360424b4af46f5ebae9952f6ea7be1601fe8f2166cec3
+  data.tar.gz: e4da7dfd607589a38de261d19e1198695ce91b0b4303c96fa85cdf78846bad3de4bb3f67c8268594bc3f398de35debfeae72752df375baacbc9087a4c8921d94

data/LICENSE

@@ -0,0 +1,55 @@
+-----------------------------------------------------------------------------------
+The MIT License (MIT)
+
+Copyright (c) 2026 Nicholas Guarino (ActiveRecord 8.1 compatibility updates)
+Copyright (c) 2004-2013 David Heinemeier Hansson (original code author)
+Copyright (c) 2013 Minero Aoki
+
+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.
+
+-----------------------------------------------------------------------------------
+Copyright (c) 2010-2013, Fiksu, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+ o Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+ o Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the
+   distribution.
+
+ o Fiksu, Inc. nor the names of its contributors may be used to
+   endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,168 @@
+activerecord8-redshift-adapter
+==============================
+
+[![Test](https://github.com/nguarino522/activerecord8-redshift-adapter/actions/workflows/test.yml/badge.svg)](https://github.com/nguarino522/activerecord8-redshift-adapter/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/activerecord8-redshift-adapter.svg)](https://rubygems.org/gems/activerecord8-redshift-adapter)
+[![License](https://img.shields.io/badge/license-MIT%20%26%20BSD--3--Clause-blue)](LICENSE)
+
+Amazon Redshift adapter for ActiveRecord 8.1 (Rails 8.1).
+
+Forked from [charitywater/activerecord-redshift-adapter](https://github.com/charitywater/activerecord-redshift-adapter) (which itself descends from the original [fiksu/activerecord-redshift-adapter](https://github.com/fiksu/activerecord-redshift-adapter)). The prior forks targeted Rails 8.0; this gem updates the adapter to work with the changes introduced in ActiveRecord 8.1. Thanks to all the prior authors.
+
+Installation
+------------
+
+Add to your Gemfile:
+
+```ruby
+gem 'activerecord8-redshift-adapter', '~> 1.0'
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+Or install it directly:
+
+```bash
+gem install activerecord8-redshift-adapter
+```
+
+Usage
+-----
+
+In `config/database.yml`:
+
+```yaml
+development:
+  adapter: redshift
+  host: host
+  port: port
+  database: db
+  username: user
+  password: password
+  encoding: utf8
+```
+
+Or via a connection URL:
+
+```ruby
+class SomeModel < ApplicationRecord
+  establish_connection('redshift://username:password@host/database')
+end
+```
+
+### Typical pattern: Redshift as a secondary read-only connection
+
+Most apps use Redshift alongside a primary OLTP database (Postgres, MySQL). With ActiveRecord multi-database support:
+
+```yaml
+production:
+  primary:
+    adapter: postgresql
+    database: app_production
+    # ...
+  warehouse:
+    adapter: redshift
+    host: my-cluster.xxxxxx.us-east-1.redshift.amazonaws.com
+    port: 5439
+    database: analytics
+    username: app_reader
+    password: <%= ENV["REDSHIFT_PASSWORD"] %>
+    replica: true
+```
+
+```ruby
+class AnalyticsRecord < ApplicationRecord
+  self.abstract_class = true
+  connects_to database: { reading: :warehouse }
+end
+
+class PageView < AnalyticsRecord
+  self.table_name = "page_views"
+end
+```
+
+Compatibility
+-------------
+
+- Ruby `>= 3.2` (tested on 3.2, 3.3, 3.4)
+- ActiveRecord `>= 8.1, < 9.0` (Rails 8.1)
+- `pg` `~> 1.0`
+
+For older Rails versions, use the matching gem in the same family:
+[`activerecord7-redshift-adapter`](https://rubygems.org/gems/activerecord7-redshift-adapter),
+[`activerecord6-redshift-adapter`](https://rubygems.org/gems/activerecord6-redshift-adapter),
+[`activerecord5-redshift-adapter`](https://rubygems.org/gems/activerecord5-redshift-adapter).
+For Rails 8.0, the upstream [`activerecord-redshift-adapter`](https://rubygems.org/gems/activerecord-redshift-adapter) `8.0.x` still works.
+
+Development
+-----------
+
+```bash
+bundle install
+gem build activerecord8-redshift-adapter.gemspec
+```
+
+To release a new version (maintainers), bump `s.version` in the gemspec, tag the commit, then:
+
+```bash
+gem push activerecord8-redshift-adapter-<version>.gem
+```
+
+Testing
+-------
+
+The test suite runs against a local **PostgreSQL** database (Redshift is wire-compatible with Postgres 8.0, so most adapter behavior can be exercised locally). For Redshift-specific behavior — `RETURNING`, identity columns, distribution keys, system catalogs — run the smoke script against a real cluster (see below).
+
+### Prerequisites
+
+- PostgreSQL running locally (any reasonably modern version)
+- A database the test user can connect to and create tables in
+
+```bash
+createdb redshift_adapter_test
+```
+
+### Running the suite
+
+```bash
+bundle install
+bundle exec rake test
+```
+
+Connection settings come from standard `PG*` environment variables, with sensible defaults:
+
+| Variable     | Default                 |
+| ------------ | ----------------------- |
+| `PGHOST`     | `localhost`             |
+| `PGPORT`     | `5432`                  |
+| `PGDATABASE` | `redshift_adapter_test` |
+| `PGUSER`     | `$USER`                 |
+| `PGPASSWORD` | _(unset)_               |
+
+Override any of them inline, e.g.:
+
+```bash
+PGUSER=postgres PGPASSWORD=secret bundle exec rake test
+```
+
+### Smoke-testing against real Redshift
+
+`test/smoke.rb` is a small ad-hoc script (not part of the rake task) that connects to a real Redshift cluster using the same env vars and exercises basic queries. Use it to validate the adapter against your actual cluster before deploying:
+
+```bash
+PGHOST=my-cluster.xxxxxx.us-east-1.redshift.amazonaws.com \
+PGPORT=5439 \
+PGDATABASE=analytics \
+PGUSER=myuser \
+PGPASSWORD=... \
+bundle exec ruby test/smoke.rb
+```
+
+License
+-------
+
+Dual-licensed under MIT (Rails-derived code) and BSD-3-Clause (Fiksu Redshift-specific portions). See [`LICENSE`](LICENSE) for full text.

data/lib/active_record/connection_adapters/redshift/array_parser.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Redshift
+      module ArrayParser # :nodoc:
+        DOUBLE_QUOTE = '"'
+        BACKSLASH = '\\'
+        COMMA = ','
+        BRACKET_OPEN = '{'
+        BRACKET_CLOSE = '}'
+
+        def parse_pg_array(string) # :nodoc:
+          local_index = 0
+          array = []
+          while local_index < string.length
+            case string[local_index]
+            when BRACKET_OPEN
+              local_index, array = parse_array_contents(array, string, local_index + 1)
+            when BRACKET_CLOSE
+              return array
+            end
+            local_index += 1
+          end
+
+          array
+        end
+
+        private
+
+        def parse_array_contents(array, string, index)
+          is_escaping  = false
+          is_quoted    = false
+          was_quoted   = false
+          current_item = ''
+
+          local_index = index
+          while local_index
+            token = string[local_index]
+            if is_escaping
+              current_item << token
+              is_escaping = false
+            elsif is_quoted
+              case token
+              when DOUBLE_QUOTE
+                is_quoted = false
+                was_quoted = true
+              when BACKSLASH
+                is_escaping = true
+              else
+                current_item << token
+              end
+            else
+              case token
+              when BACKSLASH
+                is_escaping = true
+              when COMMA
+                add_item_to_array(array, current_item, was_quoted)
+                current_item = ''
+                was_quoted = false
+              when DOUBLE_QUOTE
+                is_quoted = true
+              when BRACKET_OPEN
+                internal_items = []
+                local_index, internal_items = parse_array_contents(internal_items, string, local_index + 1)
+                array.push(internal_items)
+              when BRACKET_CLOSE
+                add_item_to_array(array, current_item, was_quoted)
+                return local_index, array
+              else
+                current_item << token
+              end
+            end
+
+            local_index += 1
+          end
+          [local_index, array]
+        end
+
+        def add_item_to_array(array, current_item, quoted)
+          return if !quoted && current_item.empty?
+
+          if !quoted && current_item == 'NULL'
+            array.push nil
+          else
+            array.push current_item
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/redshift/column.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    class RedshiftColumn < Column # :nodoc:
+      delegate :oid, :fmod, to: :sql_type_metadata
+
+      # Required for Rails 6.1, see https://github.com/rails/rails/pull/41756
+      mattr_reader :array, default: false
+      alias array? array
+
+      def initialize(name, cast_type, default, sql_type_metadata = nil, null = true, default_function = nil, **)
+        super
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/redshift/database_statements.rb

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Redshift
+      module DatabaseStatements
+        def explain(arel, binds = [])
+          sql = "EXPLAIN #{to_sql(arel, binds)}"
+          ExplainPrettyPrinter.new.pp(exec_query(sql, 'EXPLAIN', binds))
+        end
+
+        class ExplainPrettyPrinter # :nodoc:
+          # Pretty prints the result of a EXPLAIN in a way that resembles the output of the
+          # PostgreSQL shell:
+          #
+          #                                     QUERY PLAN
+          #   ------------------------------------------------------------------------------
+          #    Nested Loop Left Join  (cost=0.00..37.24 rows=8 width=0)
+          #      Join Filter: (posts.user_id = users.id)
+          #      ->  Index Scan using users_pkey on users  (cost=0.00..8.27 rows=1 width=4)
+          #            Index Cond: (id = 1)
+          #      ->  Seq Scan on posts  (cost=0.00..28.88 rows=8 width=4)
+          #            Filter: (posts.user_id = 1)
+          #   (6 rows)
+          #
+          def pp(result)
+            header = result.columns.first
+            lines  = result.rows.map(&:first)
+
+            # We add 2 because there's one char of padding at both sides, note
+            # the extra hyphens in the example above.
+            width = [header, *lines].map(&:length).max + 2
+
+            pp = []
+
+            pp << header.center(width).rstrip
+            pp << '-' * width
+
+            pp += lines.map { |line| " #{line}" }
+
+            nrows = result.rows.length
+            rows_label = nrows == 1 ? 'row' : 'rows'
+            pp << "(#{nrows} #{rows_label})"
+
+            "#{pp.join("\n")}\n"
+          end
+        end
+
+        def select_value(arel, name = nil, binds = [])
+          # In Rails 5.2, arel_from_relation replaced binds_from_relation,
+          # so we see which method exists to get the variables
+          #
+          # In Rails 6.0 to_sql_and_binds began only returning sql, with
+          # to_sql_and_binds serving as a replacement
+          if respond_to?(:arel_from_relation, true)
+            arel = arel_from_relation(arel)
+            sql, binds = to_sql_and_binds(arel, binds)
+          else
+            arel, binds = binds_from_relation arel, binds
+            sql = to_sql(arel, binds)
+          end
+          execute_and_clear(sql, name, binds) do |result|
+            result.getvalue(0, 0) if result.ntuples > 0 && result.nfields > 0
+          end
+        end
+
+        def select_values(arel, name = nil)
+          # In Rails 5.2, arel_from_relation replaced binds_from_relation,
+          # so we see which method exists to get the variables
+          #
+          # In Rails 6.0 to_sql_and_binds began only returning sql, with
+          # to_sql_and_binds serving as a replacement
+          if respond_to?(:arel_from_relation, true)
+            arel = arel_from_relation(arel)
+            sql, binds = to_sql_and_binds(arel, [])
+          else
+            arel, binds = binds_from_relation arel, []
+            sql = to_sql(arel, binds)
+          end
+
+          execute_and_clear(sql, name, binds) do |result|
+            if result.nfields > 0
+              result.column_values(0)
+            else
+              []
+            end
+          end
+        end
+
+        # Executes a SELECT query and returns an array of rows. Each row is an
+        # array of field values.
+        def select_rows(arel, name = nil, binds = [])
+          if respond_to?(:arel_from_relation, true)
+            arel = arel_from_relation(arel)
+            sql, binds = to_sql_and_binds(arel, [])
+          else
+            arel, binds = binds_from_relation arel, []
+            sql = to_sql(arel, binds)
+          end
+          execute_and_clear(sql, name, binds, &:values)
+        end
+
+        # The internal PostgreSQL identifier of the money data type.
+        MONEY_COLUMN_TYPE_OID = 790 # :nodoc:
+        # The internal PostgreSQL identifier of the BYTEA data type.
+        BYTEA_COLUMN_TYPE_OID = 17 # :nodoc:
+
+        # create a 2D array representing the result set
+        def result_as_array(res) # :nodoc:
+          # check if we have any binary column and if they need escaping
+          ftypes = Array.new(res.nfields) do |i|
+            [i, res.ftype(i)]
+          end
+
+          rows = res.values
+          return rows unless ftypes.any? do |_, x|
+            [BYTEA_COLUMN_TYPE_OID, MONEY_COLUMN_TYPE_OID].include?(x)
+          end
+
+          typehash = ftypes.group_by { |_, type| type }
+          binaries = typehash[BYTEA_COLUMN_TYPE_OID] || []
+          monies   = typehash[MONEY_COLUMN_TYPE_OID] || []
+
+          rows.each do |row|
+            # unescape string passed BYTEA field (OID == 17)
+            binaries.each do |index, _|
+              row[index] = unescape_bytea(row[index])
+            end
+
+            # If this is a money type column and there are any currency symbols,
+            # then strip them off. Indeed it would be prettier to do this in
+            # PostgreSQLColumn.string_to_decimal but would break form input
+            # fields that call value_before_type_cast.
+            monies.each do |index, _|
+              data = row[index]
+              # Because money output is formatted according to the locale, there are two
+              # cases to consider (note the decimal separators):
+              #  (1) $12,345,678.12
+              #  (2) $12.345.678,12
+              case data
+              when /^-?\D+[\d,]+\.\d{2}$/ # (1)
+                data.gsub!(/[^-\d.]/, '')
+              when /^-?\D+[\d.]+,\d{2}$/ # (2)
+                data.gsub!(/[^-\d,]/, '').sub!(/,/, '.')
+              end
+            end
+          end
+        end
+
+        # Queries the database and returns the results in an Array-like object
+        def query(sql, name = nil) # :nodoc:
+          log(sql, name) do
+            result_as_array @connection.async_exec(sql)
+          end
+        end
+
+        # Executes an SQL statement, returning a PG::Result object on success
+        # or raising a PG::Error exception otherwise.
+        def execute(sql, name = nil)
+          log(sql, name) do
+            @connection.async_exec(sql)
+          end
+        end
+
+        def exec_query(sql, name = 'SQL', binds = [], prepare: false)
+          execute_and_clear(sql, name, binds, prepare: prepare) do |result|
+            types = {}
+            fields = result.fields
+            fields.each_with_index do |fname, i|
+              ftype = result.ftype i
+              fmod  = result.fmod i
+              types[fname] = get_oid_type(ftype, fmod, fname)
+            end
+            ActiveRecord::Result.new(fields, result.values, types)
+          end
+        end
+
+        def exec_delete(sql, name = 'SQL', binds = [])
+          execute_and_clear(sql, name, binds, &:cmd_tuples)
+        end
+        alias exec_update exec_delete
+
+        def sql_for_insert(sql, pk, id_value, sequence_name, binds)
+          if pk.nil?
+            # Extract the table from the insert sql. Yuck.
+            table_ref = extract_table_ref_from_insert_sql(sql)
+            pk = primary_key(table_ref) if table_ref
+          end
+
+          sql = "#{sql} RETURNING #{quote_column_name(pk)}" if pk && use_insert_returning?
+
+          super
+        end
+
+        def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil, returning: nil)
+          val = exec_query(sql, name, binds)
+          if !use_insert_returning? && pk
+            unless sequence_name
+              table_ref = extract_table_ref_from_insert_sql(sql)
+              sequence_name = default_sequence_name(table_ref, pk)
+              return val unless sequence_name
+            end
+            last_insert_id_result(sequence_name)
+          else
+            val
+          end
+        end
+
+        def internal_exec_query(sql, name = "SQL", binds = [], prepare: false, async: false, allow_retry: false, materialize_transactions: true) # :nodoc:
+          execute_and_clear(sql, name, binds, prepare: prepare, async: async, allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |result|
+            types = {}
+            fields = result.fields
+            fields.each_with_index do |fname, i|
+              ftype = result.ftype i
+              fmod  = result.fmod i
+              types[fname] = types[i] = get_oid_type(ftype, fmod, fname)
+            end
+            build_result(columns: fields, rows: result.values, column_types: types)
+          end
+        end
+
+        # Begins a transaction.
+        def begin_db_transaction
+          execute 'BEGIN'
+        end
+
+        def begin_isolated_db_transaction(isolation)
+          begin_db_transaction
+          execute "SET TRANSACTION ISOLATION LEVEL #{transaction_isolation_levels.fetch(isolation)}"
+        end
+
+        # Commits a transaction.
+        def commit_db_transaction
+          execute 'COMMIT'
+        end
+
+        # Aborts a transaction.
+        def exec_rollback_db_transaction
+          execute 'ROLLBACK'
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/redshift/oid/date_time.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Redshift
+      module OID # :nodoc:
+        class DateTime < Type::DateTime # :nodoc:
+          def type_cast_for_database(value)
+            if has_precision? && value.acts_like?(:time) && value.year <= 0
+              bce_year = format('%04d', -value.year + 1)
+              "#{super.sub(/^-?\d+/, bce_year)} BC"
+            else
+              super
+            end
+          end
+
+          def cast_value(value)
+            if value.is_a?(::String)
+              case value
+              when 'infinity' then ::Float::INFINITY
+              when '-infinity' then -::Float::INFINITY
+              when / BC$/
+                astronomical_year = format('%04d', -value[/^\d+/].to_i + 1)
+                super(value.sub(/ BC$/, '').sub(/^\d+/, astronomical_year))
+              else
+                super
+              end
+            else
+              value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/redshift/oid/decimal.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Redshift
+      module OID # :nodoc:
+        class Decimal < Type::Decimal # :nodoc:
+          def infinity(**options)
+            BigDecimal('Infinity') * (options[:negative] ? -1 : 1)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/redshift/oid/json.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Redshift
+      module OID # :nodoc:
+        class Json < Type::Value # :nodoc:
+          include ActiveModel::Type::Helpers::Mutable
+
+          def type
+            :json
+          end
+
+          def type_cast_from_database(value)
+            if value.is_a?(::String)
+              begin
+                ::ActiveSupport::JSON.decode(value)
+              rescue StandardError
+                nil
+              end
+            else
+              super
+            end
+          end
+
+          def type_cast_for_database(value)
+            if value.is_a?(::Array) || value.is_a?(::Hash)
+              ::ActiveSupport::JSON.encode(value)
+            else
+              super
+            end
+          end
+
+          def accessor
+            ActiveRecord::Store::StringKeyedHashAccessor
+          end
+        end
+      end
+    end
+  end
+end