activerecord-dsql-adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d5653142d403dfb1efc8e710f3f2e9cc72264bfdce1f0a21e0fb7f8d4ee316f
+  data.tar.gz: f66eb457cedb77489ec8c761e022af67f9d68cac59cf6eb4db7c12851868592e
+SHA512:
+  metadata.gz: 56ebe63d14994b848c165eb8a95844d51c182eca011578694a183883e36f3c6ef9ee75f5c8a982d056144baf5ab4264e016ed64d52dcee16b0654fa7022cc16e
+  data.tar.gz: 1a81f168feff53852f0cc6c192e744f70dca091155ebdef87a92901104940d58a8568150560562998675dc745a62178d11eec513e6cb7aa48846dbbd015b935c

data/README.md

@@ -0,0 +1,46 @@
+# Active Record Adapter for AWS Aurora DSQL
+
+The very beginnings of an Active Record connection adapter for Amazon's AWS Aurora DSQL database.
+
+https://docs.aws.amazon.com/aurora-dsql/latest/userguide/
+
+## Installation
+
+```
+bundle add activerecord-dsql-adapter
+```
+
+## Usage
+
+```
+# config/database.yml
+development:
+  adapter: dsql
+  host: abc123.dsql.us-east-1.on.aws
+```
+
+Credentials available in ENV or inside your `~/.aws/config` file will be used to generate an appropriate AWS signature as a password:
+
+https://docs.aws.amazon.com/aurora-dsql/latest/userguide/authentication-token-ruby.html
+
+```
+$ rails console
+Loading development environment (Rails 7.2.2)
+
+dsql-example(dev)> ActiveRecord::Base.connection.raw_connection
+#<PG::Connection:0x000000011dab5860 host=abc123.dsql.us-east-1.on.aws port=5432 user=admin>
+
+dsql-example(dev)> ActiveRecord::Base.connection.execute("SELECT 1")
+   (1844.8ms)  SELECT 1
+=> #<PG::Result:0x00000001238b39a8 status=PGRES_TUPLES_OK ntuples=1 nfields=1 cmd_tuples=1>
+```
+
+## Development
+
+After checking out the repo, run `script/setup` to install dependencies. You can also run `script/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sj26/activerecord-dsql-adapter.

data/lib/active_record/connection_adapters/dsql_adapter.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "aws-sdk-dsql"
+
+require "active_record"
+require "active_record/connection_adapters/postgresql_adapter"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class DSQLAdapter < PostgreSQLAdapter
+      ADAPTER_NAME = "DSQL"
+
+      class << self
+        def new_client(conn_params)
+          conn_params[:sslmode] ||= "require"
+          conn_params[:user] ||= "admin"
+          conn_params[:dbname] ||= "postgres"
+
+          conn_params[:password] ||= generate_password(conn_params)
+
+          super(conn_params)
+        end
+
+        private
+
+        def generate_password(conn_params)
+          endpoint = conn_params.fetch(:host)
+          region = ENV["AWS_REGION"] || ENV["AWS_DEFAULT_REGION"] || "us-east-1"
+
+          credentials = Aws::CredentialProviderChain.new.resolve
+
+          token_generator = Aws::DSQL::AuthTokenGenerator.new(credentials: credentials)
+
+          token_generator.generate_db_connect_admin_auth_token(endpoint: endpoint, region: region)
+        end
+      end
+
+      def configure_connection
+        # PostgreSQLAdapter sets a bunch of parameters here which DSQL doesn't support
+      end
+
+      # https://docs.aws.amazon.com/aurora-dsql/latest/userguide/working-with-postgresql-compatibility-unsupported-features.html
+
+      def supports_views?
+        false
+      end
+
+      def supports_materialized_views?
+        false
+      end
+
+      def supports_extensions?
+        false
+      end
+
+      def supports_index_sort_order?
+        false
+      end
+    end
+  end
+end

data/lib/activerecord-dsql-adapter.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_record/connection_adapters"
+
+ActiveRecord::ConnectionAdapters.register("dsql", "ActiveRecord::ConnectionAdapters::DSQLAdapter", "active_record/connection_adapters/dsql_adapter")

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-dsql-adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Cochran
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDKDCCAhCgAwIBAgIBAzANBgkqhkiG9w0BAQsFADA6MQ0wCwYDVQQDDARzajI2
+  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0y
+  NDA3MjIwNjA3MjdaFw0yNTA3MjIwNjA3MjdaMDoxDTALBgNVBAMMBHNqMjYxFDAS
+  BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
+  hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
+  xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
+  1xzcNRvFsn0aQoQ00k+sj+G83j3T5OOV5OZIlu8xAChMkQmiPd1NXc6uFv+Iacz7
+  kj+CMsI9YUFdNoU09QY0b+u+Rb6wDYdpyvN60YC30h0h1MeYbvYZJx/iZK4XY5zu
+  4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
+  KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
+  NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
+  m3ZsDWrNC80wDQYJKoZIhvcNAQELBQADggEBAKcQ+MfpXXDmqboG36O8mXhJZJ8+
+  zlUqM1QnoEG8XpH/29py4GzSgs6Sb+v/Z1SEArRDq0r1bKZuWiWxqEDnmSE94+pe
+  A0Ct6Pv/paEhQCoPkGQNa74cH4tzkVHIA7WSwRL8wOz5vo++YBKH5H36nNqtLV7s
+  kNJYsbeOL/w2icQ4b0w4KYgcs4bd6yrYdgcgsRd2sCYb2XFHjczYqw4iEwuUenNM
+  G8WXc9zUMVewWkEjS9s++xFNb/7f4dFNXCoE3pgHjzctt7gYcJVacprsg925LYHO
+  WsbnbEow7BPlYOZm3rDIsEYpWqxN0lR8BakO2ToJ5RAHXahFu4K4eJtAsLk=
+  -----END CERTIFICATE-----
+date: 2024-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dsql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- sj26@sj26.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/active_record/connection_adapters/dsql_adapter.rb
+- lib/activerecord-dsql-adapter.rb
+homepage: https://github.com/sj26/activerecord-dsql-adapter
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sj26/activerecord-dsql-adapter
+  source_code_uri: https://github.com/sj26/activerecord-dsql-adapter
+  changelog_uri: https://github.com/sj26/activerecord-dsql-adapter/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: ActiveRecord adapter for AWS Aurora DSQL (PostgreSQL)
+test_files: []