activerecord-materialize-adapter 0.2.0

data/lib/active_record/tasks/materialize_database_tasks.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "tempfile"
+require "active_record"
+
+module ActiveRecord
+  module Tasks # :nodoc:
+    class MaterializeDatabaseTasks # :nodoc:
+      ON_ERROR_STOP_1 = "ON_ERROR_STOP=1"
+      SQL_COMMENT_BEGIN = "--"
+
+      delegate :connection, :establish_connection, :clear_active_connections!,
+        to: ActiveRecord::Base
+
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def create(master_established = false)
+        establish_master_connection unless master_established
+        connection.create_database configuration["database"], configuration
+        establish_connection configuration
+      rescue ActiveRecord::StatementInvalid => error
+        if error.cause.is_a?(PG::DuplicateDatabase)
+          raise DatabaseAlreadyExists
+        else
+          raise
+        end
+      end
+
+      def drop
+        establish_master_connection
+        connection.drop_database configuration["database"]
+      end
+
+      def collation
+        connection.collation
+      end
+
+      def purge
+        clear_active_connections!
+        drop
+        create true
+      end
+
+      def structure_dump(filename, extra_flags)
+        set_psql_env
+
+        search_path = \
+          case ActiveRecord::Base.dump_schemas
+          when :schema_search_path
+            configuration["schema_search_path"]
+          when :all
+            nil
+          when String
+            ActiveRecord::Base.dump_schemas
+          end
+
+        args = ["-s", "-x", "-O", "-f", filename]
+        args.concat(Array(extra_flags)) if extra_flags
+        unless search_path.blank?
+          args += search_path.split(",").map do |part|
+            "--schema=#{part.strip}"
+          end
+        end
+
+        ignore_tables = ActiveRecord::SchemaDumper.ignore_tables
+        if ignore_tables.any?
+          args += ignore_tables.flat_map { |table| ["-T", table] }
+        end
+
+        args << configuration["database"]
+        run_cmd("pg_dump", args, "dumping")
+        remove_sql_header_comments(filename)
+        File.open(filename, "a") { |f| f << "SET search_path TO #{connection.schema_search_path};\n\n" }
+      end
+
+      def structure_load(filename, extra_flags)
+        set_psql_env
+        args = ["-v", ON_ERROR_STOP_1, "-q", "-X", "-f", filename]
+        args.concat(Array(extra_flags)) if extra_flags
+        args << configuration["database"]
+        run_cmd("psql", args, "loading")
+      end
+
+      private
+        attr_reader :configuration
+
+        def establish_master_connection
+          establish_connection configuration.merge(
+            "database"           => "materialize"
+          )
+        end
+
+        def set_psql_env
+          ENV["PGHOST"]     = configuration["host"]          if configuration["host"]
+          ENV["PGPORT"]     = configuration["port"].to_s     if configuration["port"]
+          ENV["PGPASSWORD"] = configuration["password"].to_s if configuration["password"]
+          ENV["PGUSER"]     = configuration["username"].to_s if configuration["username"]
+        end
+
+        def run_cmd(cmd, args, action)
+          fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
+        end
+
+        def run_cmd_error(cmd, args, action)
+          msg = +"failed to execute:\n"
+          msg << "#{cmd} #{args.join(' ')}\n\n"
+          msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
+          msg
+        end
+
+        def remove_sql_header_comments(filename)
+          removing_comments = true
+          tempfile = Tempfile.open("uncommented_structure.sql")
+          begin
+            File.foreach(filename) do |line|
+              unless removing_comments && (line.start_with?(SQL_COMMENT_BEGIN) || line.blank?)
+                tempfile << line
+                removing_comments = false
+              end
+            end
+          ensure
+            tempfile.close
+          end
+          FileUtils.cp(tempfile.path, filename)
+        end
+    end
+  end
+end

data/lib/activerecord-materialize-adapter.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'active_record/connection_adapters/materialize_adapter.rb'

data/lib/materialize/errors/database_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Materialize
+  module Errors
+
+    # Base class for all Materialize errors
+    class DatabaseError < StandardError
+    end
+  end
+end

data/lib/materialize/errors/incomplete_input.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'materialize/errors/database_error'
+
+module Materialize
+  module Errors
+    class IncompleteInput < DatabaseError
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-materialize-adapter
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Henry Tseng
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.7
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.7
+- !ruby/object:Gem::Dependency
+  name: retriable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: Materialize is a streaming database for real-time applications. Materialize
+  accepts input data from a variety of streaming sources (e.g. Kafka) and files (e.g.
+  CSVs), and lets you query them using SQL.
+email: henry@heycanvas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/active_record/connection_adapters/materialize/column.rb
+- lib/active_record/connection_adapters/materialize/database_statements.rb
+- lib/active_record/connection_adapters/materialize/explain_pretty_printer.rb
+- lib/active_record/connection_adapters/materialize/oid.rb
+- lib/active_record/connection_adapters/materialize/oid/array.rb
+- lib/active_record/connection_adapters/materialize/oid/bit.rb
+- lib/active_record/connection_adapters/materialize/oid/bit_varying.rb
+- lib/active_record/connection_adapters/materialize/oid/bytea.rb
+- lib/active_record/connection_adapters/materialize/oid/cidr.rb
+- lib/active_record/connection_adapters/materialize/oid/date.rb
+- lib/active_record/connection_adapters/materialize/oid/date_time.rb
+- lib/active_record/connection_adapters/materialize/oid/decimal.rb
+- lib/active_record/connection_adapters/materialize/oid/enum.rb
+- lib/active_record/connection_adapters/materialize/oid/hstore.rb
+- lib/active_record/connection_adapters/materialize/oid/inet.rb
+- lib/active_record/connection_adapters/materialize/oid/jsonb.rb
+- lib/active_record/connection_adapters/materialize/oid/legacy_point.rb
+- lib/active_record/connection_adapters/materialize/oid/money.rb
+- lib/active_record/connection_adapters/materialize/oid/oid.rb
+- lib/active_record/connection_adapters/materialize/oid/point.rb
+- lib/active_record/connection_adapters/materialize/oid/range.rb
+- lib/active_record/connection_adapters/materialize/oid/specialized_string.rb
+- lib/active_record/connection_adapters/materialize/oid/type_map_initializer.rb
+- lib/active_record/connection_adapters/materialize/oid/uuid.rb
+- lib/active_record/connection_adapters/materialize/oid/vector.rb
+- lib/active_record/connection_adapters/materialize/oid/xml.rb
+- lib/active_record/connection_adapters/materialize/quoting.rb
+- lib/active_record/connection_adapters/materialize/referential_integrity.rb
+- lib/active_record/connection_adapters/materialize/schema_creation.rb
+- lib/active_record/connection_adapters/materialize/schema_definitions.rb
+- lib/active_record/connection_adapters/materialize/schema_dumper.rb
+- lib/active_record/connection_adapters/materialize/schema_statements.rb
+- lib/active_record/connection_adapters/materialize/type_metadata.rb
+- lib/active_record/connection_adapters/materialize/utils.rb
+- lib/active_record/connection_adapters/materialize/version.rb
+- lib/active_record/connection_adapters/materialize_adapter.rb
+- lib/active_record/tasks/materialize_database_tasks.rb
+- lib/activerecord-materialize-adapter.rb
+- lib/materialize/errors/database_error.rb
+- lib/materialize/errors/incomplete_input.rb
+homepage: https://rubygems.org/gems/activerecord-materialize-adapter
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/henrytseng/activerecord-materialize-adapter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Database adapter for materialize.io database.
+test_files: []