Changes between Version 18 and Version 19 of GSOC2012/DatabaseMigration/Userguildlines

Timestamp:

08/20/12 17:50:50 (13 years ago)

Author:

anubhav

Comment:

--

GSOC2012/DatabaseMigration/Userguildlines

@@ -1 +1 @@
 [[TOC]]
+== Comparison Script ==
+Before using the comparison script , the user of the script should have 2 eden apps , one the containing the old database schema from which the data is to migrated and one with the new database schema
+
+The apps_db_comparison script compares the db schema of 2 eden apps to tell the differences
+Just run the script with 3 necessary arguments in this order
+1.WEB2PY_PATH
+2.OLD_APP
+3.NEW_APP
+i.e python applications/eden/static/scripts/Database_migration/apps_db_comparison.py /home/web2py eden_old eden_new
+
+This script also has an test script that makes 2 new web2py with apps to compare
+Just run the test script to compare
+i.e python applications/eden/tests/dbmigration TestScript.py
+
+The detected changes are displayed , then using the changes displayed user could figure out the what kind of migration is needed , like if there is a field appeared in the new schema which has the same properties as the one disappeared from the old schema then the migration function for the renaming a field can be called . 
+
+Also the change in the properties of the fields are detected , the migration function for those can be called too . 
+
 == Migration Script ==
 All the functions that does the migration have been added to migration_scripts file . migration_scripts file internally calls the functions of migration_helping_methods file too perform the migration . Thus in order to do the migration one just needs to import migration_scripts and call the method corresponding to the migration he wants . Also the user who wishes to do the migration in the db doesn't have to know the internal functioning of migration_script , thus the functions or the methods declared in migration_helping_methods file doesn't concern him.
@@ -44 +62 @@
 === migrating_to_unique_field ===
 ==== Purpose of the migration====
-Adding values to a new field , or update an existing field through the mappings given through the mapping_funation
+Adding values to a new field and adding values according to the mappings given through the mapping_function
 
 ==== Method of Calling ====
@@ -51 +69 @@
 import mapping_function
 migration_scripts.migrating_to_unique_field( web2py_path, app ,field_to_update , changed_table , list_of_tables)
+}}}
+
+==== Description of arguments ====
+||= Argument =||= Description =||
+||web2py_path ||The path to the web2py congaing the Eden app  (i.e "/home/web2py")||
+||app ||The name of the eden application of whose database needs to be migrated (i.e "eden")||
+||field_to_update ||The name of the field to be updated according to the mapping||
+||changed_table ||The name of the original table in which the new unique field id added||
+||list_of_tables ||These contains the list of tables which the changed_tables references||
+
+
+=== update_field_by_mapping ===
+==== Purpose of the migration====
+ Update the the values of an existing field according to the mappings given through the mapping_function
+
+==== Method of Calling ====
+{{{#!python
+import migration_scripts
+import mapping_function
+migration_scripts.update_field_by_mapping( web2py_path, app ,field_to_update , changed_table ,mapping_function, list_of_tables)
 }}}
 
@@ -86 +124 @@
 ||old_table ||The name of the original table||
 
+== Tests for Migration ==
+The links for all of the migrations
+=== Migration script ===
+    https://github.com/anubhav929/Dbmigration-final-/blob/master/tests/dbmigration/test_migrations.py
+This script when run shows a menu with all the tests options , choose the migration that you want to test
+
 == Links for the scrips ==
 I have made it the database migration in the form of the library ,