Module: ActiveRecordViews
- Defined in:
- lib/active_record_views.rb,
lib/active_record_views/railtie.rb,
lib/active_record_views/version.rb,
lib/active_record_views/extension.rb,
lib/active_record_views/checksum_cache.rb,
lib/active_record_views/registered_view.rb,
lib/active_record_views/database_cleaner/truncation_extension.rb
Defined Under Namespace
Modules: DatabaseCleaner, DatabaseTasks, Extension Classes: ChecksumCache, Railtie, RegisteredView
Constant Summary collapse
- VERSION =
'0.1.6'
Class Method Summary collapse
- .check_dependencies(connection, name, class_name, declared_class_names) ⇒ Object
- .create_view(base_connection, name, class_name, sql, options = {}) ⇒ Object
- .drop_all_views(base_connection) ⇒ Object
- .drop_unregistered_views! ⇒ Object
- .drop_view(base_connection, name) ⇒ Object
- .execute_create_view(connection, name, sql, options) ⇒ Object
- .execute_drop_view(connection, name) ⇒ Object
- .find_sql_file(name) ⇒ Object
- .get_view_dependants(connection, name) ⇒ Object
- .get_view_direct_dependencies(connection, name) ⇒ Object
- .init! ⇒ Object
- .materialized_view?(connection, name) ⇒ Boolean
- .parse_dependencies(dependencies) ⇒ Object
- .read_sql_file(model_class, sql_path) ⇒ Object
- .register_for_reload(model_class, sql_path) ⇒ Object
- .reload_stale_views! ⇒ Object
- .reset_materialized_views ⇒ Object
- .supports_concurrent_refresh?(connection) ⇒ Boolean
- .view_exists?(connection, name) ⇒ Boolean
- .without_dependants(connection, name) ⇒ Object
- .without_transaction(connection) ⇒ Object
Class Method Details
.check_dependencies(connection, name, class_name, declared_class_names) ⇒ Object
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/active_record_views.rb', line 114 def self.check_dependencies(connection, name, class_name, declared_class_names) actual_class_names = get_view_direct_dependencies(connection, name).sort missing_class_names = actual_class_names - declared_class_names extra_class_names = declared_class_names - actual_class_names if missing_class_names.present? example = "is_view dependencies: [#{actual_class_names.join(', ')}]" raise ArgumentError, <<-TEXT.squish #{missing_class_names.to_sentence} must be specified as #{missing_class_names.size > 1 ? 'dependencies' : 'a dependency'} of #{class_name}: `#{example}` TEXT end if extra_class_names.present? raise ArgumentError, <<-TEXT.squish #{extra_class_names.to_sentence} #{extra_class_names.size > 1 ? 'are' : 'is'} not #{extra_class_names.size > 1 ? 'dependencies' : 'a dependency'} of #{class_name} TEXT end end |
.create_view(base_connection, name, class_name, sql, options = {}) ⇒ Object
67 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 |
# File 'lib/active_record_views.rb', line 67 def self.create_view(base_connection, name, class_name, sql, = {}) = .dup .assert_valid_keys :dependencies, :materialized, :unique_columns [:dependencies] = parse_dependencies([:dependencies]) without_transaction base_connection do |connection| cache = ActiveRecordViews::ChecksumCache.new(connection) data = {class_name: class_name, checksum: Digest::SHA1.hexdigest(sql), options: } return if cache.get(name) == data drop_and_create = if [:materialized] true else raise ArgumentError, 'unique_columns option requires view to be materialized' if [:unique_columns] begin connection.transaction :requires_new => true do connection.execute "CREATE OR REPLACE VIEW #{connection.quote_table_name name} AS #{sql}" check_dependencies connection, name, class_name, [:dependencies] end false rescue ActiveRecord::StatementInvalid true end end if drop_and_create connection.transaction :requires_new => true do without_dependants connection, name do execute_drop_view connection, name execute_create_view connection, name, sql, check_dependencies connection, name, class_name, [:dependencies] end end end cache.set name, data end end |
.drop_all_views(base_connection) ⇒ Object
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/active_record_views.rb', line 151 def self.drop_all_views(base_connection) without_transaction base_connection do |connection| ActiveRecordViews::ChecksumCache.new(connection) names = Set.new connection.select_values('SELECT name FROM active_record_views;') func = lambda do |name| if view_exists?(connection, name) get_view_dependants(connection, name).each do |dependant_name, _, _, _| func.call(dependant_name) end drop_view connection, name end end names.each { |name| func.call(name) } end end |
.drop_unregistered_views! ⇒ Object
326 327 328 329 330 331 332 333 |
# File 'lib/active_record_views.rb', line 326 def self.drop_unregistered_views! connection = ActiveRecord::Base.connection ActiveRecordViews::ChecksumCache.new(connection) connection.select_rows('SELECT name, class_name FROM active_record_views') .reject { |name, class_name| Object.const_defined? class_name } .each { |name, class_name| ActiveRecordViews.drop_view connection, name } end |
.drop_view(base_connection, name) ⇒ Object
143 144 145 146 147 148 149 |
# File 'lib/active_record_views.rb', line 143 def self.drop_view(base_connection, name) without_transaction base_connection do |connection| cache = ActiveRecordViews::ChecksumCache.new(connection) execute_drop_view connection, name cache.set name, nil end end |
.execute_create_view(connection, name, sql, options) ⇒ Object
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/active_record_views.rb', line 169 def self.execute_create_view(connection, name, sql, ) .assert_valid_keys :dependencies, :materialized, :unique_columns sql = sql.sub(/;\s*\z/, '') if .fetch(:materialized, false) connection.execute "CREATE MATERIALIZED VIEW #{connection.quote_table_name name} AS #{sql} WITH NO DATA;" else connection.execute "CREATE VIEW #{connection.quote_table_name name} AS #{sql};" end if unique_columns = .fetch(:unique_columns, nil) connection.execute <<-SQL.squish CREATE UNIQUE INDEX #{connection.quote_table_name "#{name}_pkey"} ON #{connection.quote_table_name name}( #{unique_columns.map { |column_name| connection.quote_table_name(column_name) }.join(', ')} ); SQL end end |
.execute_drop_view(connection, name) ⇒ Object
189 190 191 192 193 194 195 |
# File 'lib/active_record_views.rb', line 189 def self.execute_drop_view(connection, name) if materialized_view?(connection, name) connection.execute "DROP MATERIALIZED VIEW IF EXISTS #{connection.quote_table_name name};" else connection.execute "DROP VIEW IF EXISTS #{connection.quote_table_name name};" end end |
.find_sql_file(name) ⇒ Object
23 24 25 26 27 28 29 30 31 |
# File 'lib/active_record_views.rb', line 23 def self.find_sql_file(name) self.sql_load_path.each do |dir| path = "#{dir}/#{name}.sql" return path if File.exist?(path) path = path + '.erb' return path if File.exist?(path) end raise "could not find #{name}.sql" end |
.get_view_dependants(connection, name) ⇒ Object
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/active_record_views.rb', line 240 def self.get_view_dependants(connection, name) connection.select_rows <<-SQL.squish WITH RECURSIVE dependants AS ( SELECT #{connection.quote name}::regclass::oid, 0 AS level UNION ALL SELECT DISTINCT(pg_rewrite.ev_class) AS oid, dependants.level + 1 AS level FROM pg_depend dep INNER JOIN pg_rewrite ON pg_rewrite.oid = dep.objid INNER JOIN dependants ON dependants.oid = dep.refobjid WHERE pg_rewrite.ev_class != dep.refobjid AND dep.deptype = 'n' ) SELECT oid::regclass::text AS name, MIN(class_name) AS class_name, pg_catalog.pg_get_viewdef(oid) AS definition, MIN(options::text) AS options_json FROM dependants INNER JOIN active_record_views ON active_record_views.name = oid::regclass::text WHERE level > 0 GROUP BY oid ORDER BY MAX(level) ; SQL end |
.get_view_direct_dependencies(connection, name) ⇒ Object
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/active_record_views.rb', line 221 def self.get_view_direct_dependencies(connection, name) connection.select_values <<-SQL.squish WITH dependencies AS ( SELECT DISTINCT refobjid::regclass::text AS name FROM pg_depend d INNER JOIN pg_rewrite r ON r.oid = d.objid WHERE refclassid = 'pg_class'::regclass AND classid = 'pg_rewrite'::regclass AND deptype = 'n' AND refobjid != r.ev_class AND r.ev_class = #{connection.quote name}::regclass::oid ) SELECT class_name FROM dependencies INNER JOIN active_record_views USING (name) SQL end |
.init! ⇒ Object
15 16 17 18 19 20 21 |
# File 'lib/active_record_views.rb', line 15 def self.init! require 'active_record_views/extension' ::ActiveRecord::Base.send :include, ActiveRecordViews::Extension require 'active_record_views/database_tasks' ::ActiveRecord::Tasks::DatabaseTasks.singleton_class.prepend ActiveRecordViews::DatabaseTasks require 'active_record_views/database_cleaner/truncation_extension' if defined? ::DatabaseCleaner end |
.materialized_view?(connection, name) ⇒ Boolean
209 210 211 212 213 214 215 |
# File 'lib/active_record_views.rb', line 209 def self.materialized_view?(connection, name) connection.select_value(<<-SQL.squish).present? SELECT 1 FROM pg_matviews WHERE schemaname = 'public' AND matviewname = #{connection.quote name}; SQL end |
.parse_dependencies(dependencies) ⇒ Object
106 107 108 109 110 111 112 |
# File 'lib/active_record_views.rb', line 106 def self.parse_dependencies(dependencies) dependencies = Array(dependencies) unless dependencies.all? { |dependency| dependency.is_a?(Class) && dependency < ActiveRecord::Base } raise ArgumentError, 'dependencies must be ActiveRecord classes' end dependencies.map(&:name).sort end |
.read_sql_file(model_class, sql_path) ⇒ Object
33 34 35 36 37 38 39 |
# File 'lib/active_record_views.rb', line 33 def self.read_sql_file(model_class, sql_path) if sql_path.end_with?('.erb') ERB.new(File.read(sql_path)).result(model_class.instance_eval { binding }) else File.read(sql_path) end end |
.register_for_reload(model_class, sql_path) ⇒ Object
311 312 313 |
# File 'lib/active_record_views.rb', line 311 def self.register_for_reload(model_class, sql_path) self.registered_views << RegisteredView.new(model_class, sql_path) end |
.reload_stale_views! ⇒ Object
315 316 317 318 319 320 321 322 323 324 |
# File 'lib/active_record_views.rb', line 315 def self.reload_stale_views! self.registered_views.each do |registered_view| if registered_view.stale? registered_view.reload! end if registered_view.dead? self.registered_views.delete registered_view end end end |
.reset_materialized_views ⇒ Object
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/active_record_views.rb', line 335 def self.reset_materialized_views connection = ActiveRecord::Base.connection ActiveRecordViews::ChecksumCache.new(connection) connection.transaction do materialized_views = connection.select_values(<<~SQL) SELECT name FROM active_record_views WHERE (options ->> 'materialized')::boolean AND refreshed_at IS NOT NULL SQL materialized_views.each do |view| connection.execute(<<~SQL) REFRESH MATERIALIZED VIEW #{view} WITH NO DATA; SQL end connection.execute(<<~SQL) UPDATE active_record_views SET refreshed_at = NULL; SQL end end |
.supports_concurrent_refresh?(connection) ⇒ Boolean
217 218 219 |
# File 'lib/active_record_views.rb', line 217 def self.supports_concurrent_refresh?(connection) connection.raw_connection.server_version >= 90400 end |
.view_exists?(connection, name) ⇒ Boolean
197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/active_record_views.rb', line 197 def self.view_exists?(connection, name) connection.select_value(<<-SQL.squish).present? SELECT 1 FROM information_schema.views WHERE table_schema = 'public' AND table_name = #{connection.quote name} UNION ALL SELECT 1 FROM pg_matviews WHERE schemaname = 'public' AND matviewname = #{connection.quote name}; SQL end |
.without_dependants(connection, name) ⇒ Object
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/active_record_views.rb', line 272 def self.without_dependants(connection, name) unless view_exists?(connection, name) yield return end dependants = get_view_dependants(connection, name) cache = ActiveRecordViews::ChecksumCache.new(connection) = {} dependants.reverse.each do |dependant_name, _, _, _| execute_drop_view connection, dependant_name [dependant_name] = cache.get(dependant_name) cache.set dependant_name, nil end yield dependants.each do |dependant_name, class_name, definition, | create_view_exception = begin connection.transaction :requires_new => true do = JSON.load().symbolize_keys execute_create_view connection, dependant_name, definition, cache.set dependant_name, [dependant_name] end nil rescue StandardError => e e end begin class_name.constantize rescue NameError => e raise unless e.missing_name?(class_name) raise create_view_exception unless create_view_exception.nil? end end end |
.without_transaction(connection) ⇒ Object
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/active_record_views.rb', line 41 def self.without_transaction(connection) states = Thread.current[:active_record_views_without_transaction] ||= {} begin if states[connection] yield states[connection] elsif connection.transaction_open? begin temp_connection = connection.pool.checkout states[temp_connection] = states[connection] = temp_connection yield temp_connection ensure connection.pool.checkin temp_connection if temp_connection states[temp_connection] = states[connection] = nil end else begin states[connection] = connection yield connection ensure states[connection] = nil end end end end |