Class: Knj::Db::Revision
Overview
This class takes a database-schema from a hash and runs it against the database. It then checks that the database matches the given schema.
Examples
db = Knj::Db.new(:type => “sqlite3”, :path => “test_db.sqlite3”) schema =
"tables" => {
"User" => {
"columns" => [
{"name" => "id", "type" => "int", "autoincr" => true, "primarykey" => true,
=> "name", "type" => "varchar",
=> "lastname", "type" => "varchar"
],
"indexes" => [
"name",
=> "lastname", "columns" => ["lastname"]
],
"on_create_after" => proc{|d|
d["db"].insert("User", {"name" => "John", "lastname" => "Doe"})
}
}
}
}
rev = Knj::Db::Revision.new rev.init_db(“db” => db, “schema” => schema)
Instance Method Summary collapse
-
#init_db(args) ⇒ Object
This initializes a database-structure and content based on a schema-hash.
-
#initialize(args = {}) ⇒ Revision
constructor
A new instance of Revision.
Constructor Details
#initialize(args = {}) ⇒ Revision
Returns a new instance of Revision.
27 28 29 |
# File 'lib/knj/knjdb/revision.rb', line 27 def initialize(args = {}) @args = args end |
Instance Method Details
#init_db(args) ⇒ Object
This initializes a database-structure and content based on a schema-hash.
Examples
dbrev = Knj::Db::Revision.new dbrev.init_db(“db” => db_obj, “schema” => schema_hash)
35 36 37 38 39 40 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 66 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 105 106 107 108 109 110 111 112 113 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 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 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 271 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 |
# File 'lib/knj/knjdb/revision.rb', line 35 def init_db(args) schema = args["schema"] db = args["db"] #Check for normal bugs and raise apropiate error. raise "'schema' argument was not a Hash: '#{schema.class.name}'." if !schema.is_a?(Hash) raise "':return_keys' is not 'symbols' - Knjdbrevision will not work without it." if db.opts[:return_keys] != "symbols" raise "No tables given." if !schema.has_key?("tables") #Cache tables to avoid constant reloading. if !args.key?("tables_cache") or args["tables_cache"] print "Caching tables-list.\n" if args["debug"] tables = db.tables.list else print "Skipping tables-cache.\n" if args["debug"] end schema["tables"].each do |table_name, table_data| begin begin table_obj = db.tables[table_name] #Cache indexes- and column-objects to avoid constant reloading. cols = table_obj.columns indexes = table_obj.indexes if table_data["columns"] first_col = true table_data["columns"].each do |col_data| begin col_obj = table_obj.column(col_data["name"]) col_str = "#{table_name}.#{col_obj.name}" type = col_data["type"].to_s dochange = false if !first_col and !col_data["after"] #Try to find out the previous column - if so we can set "after" which makes the column being created in the right order as defined. if !col_data.has_key?("after") prev_no = table_data["columns"].index(col_data) if prev_no != nil and prev_no != 0 prev_no = prev_no - 1 prev_col_data = table_data["columns"][prev_no] col_data["after"] = prev_col_data["name"] end end actual_after = nil set_next = false cols.each do |col_name, col_iter| if col_iter.name == col_obj.name break else actual_after = col_iter.name end end if actual_after != col_data["after"] print "Changing '#{col_str}' after from '#{actual_after}' to '#{col_data["after"]}'.\n" if args["debug"] dochange = true end end #BUGFIX: When using SQLite3 the primary-column or a autoincr-column may never change type from int... This will break it! if db.opts[:type] == "sqlite3" and col_obj.type.to_s == "int" and (col_data["primarykey"] or col_data["autoincr"]) and db.int_types.index(col_data["type"].to_s) type = "int" end if type and col_obj.type.to_s != type print "Type mismatch on #{col_str}: #{col_data["type"]}, #{col_obj.type}\n" if args["debug"] dochange = true end if col_data.has_key?("primarykey") and col_obj.primarykey? != col_data["primarykey"] print "Primary-key mismatch for #{col_str}: #{col_data["primarykey"]}, #{col_obj.primarykey?}\n" if args["debug"] dochange = true end if col_data.has_key?("autoincr") and col_obj.autoincr? != col_data["autoincr"] print "Auto-increment mismatch for #{col_str}: #{col_data["autoincr"]}, #{col_obj.autoincr?}\n" if args["debug"] dochange = true end if col_data.has_key?("maxlength") and col_obj.maxlength.to_s != col_data["maxlength"].to_s print "Maxlength mismatch on #{col_str}: #{col_data["maxlength"]}, #{col_obj.maxlength}\n" if args["debug"] dochange = true end if col_data.has_key?("null") and col_obj.null?.to_s != col_data["null"].to_s print "Null mismatch on #{col_str}: #{col_data["null"]}, #{col_obj.null?}\n" if args["debug"] dochange = true end if col_data.has_key?("default") and col_obj.default.to_s != col_data["default"].to_s print "Default mismatch on #{col_str}: #{col_data["default"]}, #{col_obj.default}\n" if args["debug"] dochange = true end if col_data.has_key?("comment") and col_obj.respond_to?(:comment) and col_obj.comment.to_s != col_data["comment"].to_s print "Comment mismatch on #{col_str}: #{col_data["comment"]}, #{col_obj.comment}\n" if args["debug"] dochange = true end if col_data.is_a?(Hash) and col_data["on_before_alter"] callback_data = col_data["on_before_alter"].call("db" => db, "table" => table_obj, "col" => col_obj, "col_data" => col_data) if callback_data and callback_data["action"] if callback_data["action"] == "retry" raise Knj::Errors::Retry end end end if dochange col_obj.change(col_data) #Change has been made - update cache. cols = table_obj.columns end first_col = false rescue Errno::ENOENT => e print "Column not found: #{table_obj.name}.#{col_data["name"]}.\n" if args["debug"] if col_data.has_key?("renames") raise "'renames' was not an array for column '#{table_obj.name}.#{col_data["name"]}'." if !col_data["renames"].is_a?(Array) rename_found = false col_data["renames"].each do |col_name| begin col_rename = table_obj.column(col_name) rescue Errno::ENOENT => e next end print "Rename #{table_obj.name}.#{col_name} to #{table_obj.name}.#{col_data["name"]}\n" if args["debug"] if col_data.is_a?(Hash) and col_data["on_before_rename"] col_data["on_before_rename"].call("db" => db, "table" => table_obj, "col" => col_rename, "col_data" => col_data) end col_rename.change(col_data) #Change has been made - update cache. cols = table_obj.columns if col_data.is_a?(Hash) and col_data["on_after_rename"] col_data["on_after_rename"].call("db" => db, "table" => table_obj, "col" => col_rename, "col_data" => col_data) end rename_found = true break end retry if rename_found end oncreated = col_data["on_created"] col_data.delete("on_created") if col_data["oncreated"] col_obj = table_obj.create_columns([col_data]) #Change has been made - update cache. cols = table_obj.columns oncreated.call("db" => db, "table" => table_obj) if oncreated end end end if table_data["columns_remove"] table_data["columns_remove"].each do |column_name, column_data| begin col_obj = table_obj.column(column_name) rescue Errno::ENOENT => e next end column_data["callback"].call if column_data.is_a?(Hash) and column_data["callback"] col_obj.drop end end if table_data["indexes"] table_data["indexes"].each do |index_data| if index_data.is_a?(String) index_data = {"name" => index_data, "columns" => [index_data]} end begin index_obj = table_obj.index(index_data["name"]) rewrite_index = false rewrite_index = true if index_data.key?("unique") and index_data["unique"] != index_obj.unique? if rewrite_index index_obj.drop table_obj.create_indexes([index_data]) end rescue Errno::ENOENT => e table_obj.create_indexes([index_data]) end end end if table_data["indexes_remove"] table_data["indexes_remove"].each do |index_name, index_data| begin index_obj = table_obj.index(index_name) rescue Errno::ENOENT => e next end if index_data.is_a?(Hash) and index_data["callback"] index_data["callback"].call if index_data["callback"] end index_obj.drop end end rows_init("db" => db, "table" => table_obj, "rows" => table_data["rows"]) if table_data and table_data["rows"] rescue Errno::ENOENT => e if table_data.key?("renames") table_data["renames"].each do |table_name_rename| begin table_rename = db.tables[table_name_rename.to_sym] table_rename.rename(table_name) raise Knj::Errors::Retry rescue Errno::ENOENT next end end end if !table_data.key?("columns") print "Notice: Skipping creation of '#{table_name}' because no columns were given in hash.\n" next end if table_data["on_create"] table_data["on_create"].call("db" => db, "table_name" => table_name, "table_data" => table_data) end db.tables.create(table_name, table_data) table_obj = db.tables[table_name.to_sym] if table_data["on_create_after"] table_data["on_create_after"].call("db" => db, "table_name" => table_name, "table_data" => table_data) end rows_init("db" => db, "table" => table_obj, "rows" => table_data["rows"]) if table_data["rows"] end rescue Knj::Errors::Retry retry end end if schema["tables_remove"] schema["tables_remove"].each do |table_name, table_data| begin table_obj = db.tables[table_name.to_sym] table_data["callback"].call("db" => db, "table" => table_obj) if table_data.is_a?(Hash) and table_data["callback"] table_obj.drop rescue Errno::ENOENT => e next end end end #Free cache. tables.clear if tables tables = nil end |