Module: Upkeep::ActiveRecordQuery

Defined in:
lib/upkeep/active_record_query.rb

Defined Under Namespace

Modules: Schema Classes: OpaqueRelationError, Result

Class Method Summary collapse

Class Method Details

.analyze(relation) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/upkeep/active_record_query.rb', line 68

def analyze(relation)
  sql = relation.to_sql
  dialect = dialect_for(relation.klass.connection)
  statement = SQLGlot.parse(sql, dialect: dialect)
  schema = Schema.for(relation.klass.connection, statement)
  mapping_schema = SQLGlot::MappingSchema.new(schema, dialect: dialect)
  qualified_statement = SQLGlot.qualify_columns(statement, mapping_schema)
  dependency_statement = SQLDependencyAnalysis.preserve_wildcard_projections(
    statement,
    qualified_statement
  )
  dependency = SQLDependencyAnalysis.analyze(
    dependency_statement,
    schema: schema,
    scope: SQLGlot.build_scope(dependency_statement)
  )

  Result.new(
    primary_table: relation.klass.table_name,
    table_columns: with_primary_key(
      dependency.table_columns,
      relation.klass.table_name,
      relation.klass.primary_key
    ),
    coverage: :columns,
    sql: sql,
    primary_key: relation.klass.primary_key,
    appendable: dependency.appendable?,
    limit_value: dependency.limit_value,
    predicates: dependency.predicates
  )
rescue ActiveRecord::StatementInvalid,
  SQLGlot::Error,
  SQLDependencyAnalysis::UnsupportedError,
  KeyError => error
  raise OpaqueRelationError.new(
    relation,
    reasons: [
      "#{error.class}: #{error.message}",
      "dialect: #{safe_dialect(relation)}",
      "SQLGlot: #{SQLGlot.version}"
    ]
  )
end

.analyze_for_write(relation) ⇒ Object 



113
114
115
116
117
 
# File 'lib/upkeep/active_record_query.rb', line 113

def analyze_for_write(relation)
  analyze(relation)
rescue OpaqueRelationError
  table_only_result(relation)
end

.dialect_for(connection) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/upkeep/active_record_query.rb', line 119

def dialect_for(connection)
  adapter = connection.adapter_name.to_s.downcase

  case adapter
  when /postgres/
    :postgres
  when /mysql|trilogy/
    :mysql
  when /sqlite/
    :sqlite
  when /sqlserver/
    :tsql
  when /oracle/
    :oracle
  else
    raise SQLDependencyAnalysis::UnsupportedError,
      "unsupported Active Record adapter: #{connection.adapter_name}"
  end
end