activerecord-spanner-adapter 0.3.0 → 1.0.0

data/lib/arel/visitors/spanner.rb

@@ -0,0 +1,111 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+module Arel # :nodoc: all
+  module Visitors
+    class StalenessHint
+      attr_reader :value
+
+      def initialize value
+        @value = value
+      end
+    end
+
+    class StatementHint
+      attr_reader :value
+
+      def initialize value
+        @value = value
+      end
+    end
+
+    class Spanner < Arel::Visitors::ToSql
+      def compile node, collector = Arel::Collectors::SQLString.new
+        collector.class.module_eval { attr_accessor :hints }
+        collector.class.module_eval { attr_accessor :table_hints }
+        collector.class.module_eval { attr_accessor :join_hints }
+        collector.hints = {}
+        collector.table_hints = {}
+        collector.join_hints = {}
+        sql, binds = accept(node, collector).value
+        sql = collector.hints[:statement_hint].value + sql if collector.hints[:statement_hint]
+        binds << collector.hints[:staleness] if collector.hints[:staleness]
+        [sql, binds]
+      end
+
+      private
+
+      BIND_BLOCK = proc { |i| "@p#{i}" }
+      private_constant :BIND_BLOCK
+
+      def bind_block
+        BIND_BLOCK
+      end
+
+      def visit_table_hint v, collector
+        value = v.delete_prefix("table_hint:").strip
+        # TODO: This does not support FORCE_INDEX hints that reference an index that contains '@{' in the name.
+        start_of_hint_index = value.rindex "@{"
+        table_name = value[0, start_of_hint_index]
+        table_hint = value[start_of_hint_index, value.length]
+        collector.table_hints[table_name] = table_hint if table_name && table_hint
+      end
+
+      def visit_statement_hint v, collector
+        collector.hints[:statement_hint] = \
+          StatementHint.new v.delete_prefix("statement_hint:")
+      end
+
+      # rubocop:disable Naming/MethodName
+      def visit_Arel_Nodes_OptimizerHints o, collector
+        o.expr.each do |v|
+          visit_table_hint v, collector if v.start_with? "table_hint:"
+          visit_statement_hint v, collector if v.start_with? "statement_hint:"
+          if v.start_with? "max_staleness:"
+            collector.hints[:staleness] = \
+              StalenessHint.new max_staleness: v.delete_prefix("max_staleness:").to_f
+            next
+          end
+          if v.start_with? "exact_staleness:"
+            collector.hints[:staleness] = \
+              StalenessHint.new exact_staleness: v.delete_prefix("exact_staleness:").to_f
+            next
+          end
+          if v.start_with? "min_read_timestamp:"
+            time = Time.xmlschema v.delete_prefix("min_read_timestamp:")
+            collector.hints[:staleness] = \
+              StalenessHint.new min_read_timestamp: time
+            next
+          end
+          next unless v.start_with? "read_timestamp:"
+          time = Time.xmlschema v.delete_prefix("read_timestamp:")
+          collector.hints[:staleness] = \
+            StalenessHint.new read_timestamp: time
+        end
+        collector
+      end
+
+      def visit_Arel_Table o, collector
+        return super unless collector.table_hints[o.name]
+        if o.table_alias
+          collector << quote_table_name(o.name) << collector.table_hints[o.name] \
+                    << " " << quote_table_name(o.table_alias)
+        else
+          collector << quote_table_name(o.name) << collector.table_hints[o.name]
+        end
+      end
+
+      def visit_Arel_Nodes_BindParam o, collector
+        # Do not generate a query parameter if the value should be set to the PENDING_COMMIT_TIMESTAMP(), as that is
+        # not supported as a parameter value by Cloud Spanner.
+        return collector << "PENDING_COMMIT_TIMESTAMP()" \
+          if o.value.type.is_a?(ActiveRecord::Type::Spanner::Time) && o.value.value == :commit_timestamp
+        collector.add_bind(o.value, &bind_block)
+      end
+      # rubocop:enable Naming/MethodName
+    end
+  end
+end

data/lib/spanner_client_ext.rb

@@ -0,0 +1,107 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+
+module Google
+  module Cloud
+    module Spanner
+      class Project
+        def create_session instance_id, database_id, labels: nil
+          ensure_service!
+
+          grpc = @service.create_session(
+            Admin::Database::V1::DatabaseAdmin::Paths.database_path(
+              project: project, instance: instance_id, database: database_id
+            ),
+            labels: labels
+          )
+          Session.from_grpc grpc, @service
+        end
+      end
+
+      class Session
+        def commit_transaction transaction, mutations = []
+          ensure_service!
+
+          resp = service.commit(
+            path,
+            mutations,
+            transaction_id: transaction.transaction_id
+          )
+          @last_updated_at = Time.now
+          Convert.timestamp_to_time resp.commit_timestamp
+        end
+
+        # Create a single-use transaction selector.
+        def self.single_use_transaction opts
+          return nil if opts.nil? || opts.empty?
+
+          exact_timestamp = Convert.time_to_timestamp opts[:read_timestamp]
+          exact_staleness = Convert.number_to_duration opts[:exact_staleness]
+          min_read_timestamp = Convert.time_to_timestamp opts[:min_read_timestamp]
+          max_staleness = Convert.number_to_duration opts[:max_staleness]
+
+          V1::TransactionSelector.new(single_use:
+            V1::TransactionOptions.new(read_only:
+              V1::TransactionOptions::ReadOnly.new({
+                strong: opts[:strong],
+                read_timestamp: exact_timestamp,
+                exact_staleness: exact_staleness,
+                min_read_timestamp: min_read_timestamp,
+                max_staleness: max_staleness,
+                return_read_timestamp: true
+              }.delete_if { |_, v| v.nil? })))
+        end
+
+        def create_snapshot strong: nil,
+                            timestamp: nil, read_timestamp: nil,
+                            staleness: nil, exact_staleness: nil
+          validate_snapshot_args! strong: strong, timestamp: timestamp,
+                                  read_timestamp: read_timestamp,
+                                  staleness: staleness,
+                                  exact_staleness: exact_staleness
+          ensure_service!
+
+          snp_grpc = service.create_snapshot \
+            path, timestamp: (timestamp || read_timestamp),
+            staleness: (staleness || exact_staleness)
+          Snapshot.from_grpc snp_grpc, self
+        end
+
+        def create_pdml
+          ensure_service!
+          pdml_grpc = service.create_pdml path
+          Transaction.from_grpc pdml_grpc, self
+        end
+
+        private
+
+        ##
+        # Check for valid snapshot arguments
+        def validate_snapshot_args! strong: nil,
+                                    timestamp: nil, read_timestamp: nil,
+                                    staleness: nil, exact_staleness: nil
+          valid_args_count = [
+            strong, timestamp, read_timestamp, staleness, exact_staleness
+          ].compact.count
+          return true if valid_args_count <= 1
+          raise ArgumentError,
+                "Can only provide one of the following arguments: " \
+                "(strong, timestamp, read_timestamp, staleness, " \
+                "exact_staleness)"
+        end
+      end
+
+      class Results
+        attr_reader :metadata
+      end
+
+      class Transaction
+        attr_accessor :seqno, :commit
+      end
+    end
+  end
+end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}