documentation-gsoc/Synchronization_User_Manual.htm

   1 <html>
   2
   3 <head>
   4 <meta http-equiv=Content-Type content="text/html; charset=windows-1252">
   5 <meta name=Generator content="Microsoft Word 11 (filtered)">
   6 <title>  ‘Synchronize’ feature in  </title>
   7 <style>
   8 <!--
   9  /* Font Definitions */
  10  @font-face
  11         {font-family:Tahoma;
  12         panose-1:2 11 6 4 3 5 4 4 2 4;}
  13 @font-face
  14         {font-family:Cambria;
  15         panose-1:2 4 5 3 5 4 6 3 2 4;}
  16 @font-face
  17         {font-family:Calibri;
  18         panose-1:2 15 5 2 2 2 4 3 2 4;}
  19  /* Style Definitions */
  20  p.MsoNormal, li.MsoNormal, div.MsoNormal
  21         {margin-top:0in;
  22         margin-right:0in;
  23         margin-bottom:10.0pt;
  24         margin-left:0in;
  25         line-height:115%;
  26         font-size:11.0pt;
  27         font-family:Calibri;}
  28 h1
  29         {margin-top:24.0pt;
  30         margin-right:0in;
  31         margin-bottom:0in;
  32         margin-left:0in;
  33         margin-bottom:.0001pt;
  34         line-height:115%;
  35         page-break-after:avoid;
  36         font-size:14.0pt;
  37         font-family:Cambria;
  38         color:#365F91;}
  39 h2
  40         {margin-top:10.0pt;
  41         margin-right:0in;
  42         margin-bottom:0in;
  43         margin-left:0in;
  44         margin-bottom:.0001pt;
  45         line-height:115%;
  46         page-break-after:avoid;
  47         font-size:13.0pt;
  48         font-family:Cambria;
  49         color:#4F81BD;}
  50 h3
  51         {margin-right:0in;
  52         margin-left:0in;
  53         font-size:13.5pt;
  54         font-family:"Times New Roman";}
  55 strong
  56         {font-family:"Times New Roman";}
  57 p.MsoAcetate, li.MsoAcetate, div.MsoAcetate
  58         {margin:0in;
  59         margin-bottom:.0001pt;
  60         font-size:8.0pt;
  61         font-family:Tahoma;}
  62 span.Heading3Char
  63         {font-family:"Times New Roman";
  64         font-weight:bold;}
  65 span.BalloonTextChar
  66         {font-family:Tahoma;}
  67 span.Heading1Char
  68         {font-family:Cambria;
  69         color:#365F91;
  70         font-weight:bold;}
  71 p.NoSpacing, li.NoSpacing, div.NoSpacing
  72         {margin:0in;
  73         margin-bottom:.0001pt;
  74         font-size:11.0pt;
  75         font-family:Calibri;}
  76 span.IntenseEmphasis
  77         {font-family:"Times New Roman";
  78         color:#4F81BD;
  79         font-weight:bold;
  80         font-style:italic;}
  81 span.Heading2Char
  82         {font-family:Cambria;
  83         color:#4F81BD;
  84         font-weight:bold;}
  85 @page Section1
  86         {size:8.5in 11.0in;
  87         margin:1.0in 1.0in 1.0in 1.0in;}
  88 div.Section1
  89         {page:Section1;}
  90 -->
  91 </style>
  92
  93 </head>
  94
  95 <body lang=EN-US>
  96
  97 <div class=Section1>
  98
  99 <p class=MsoNormal><b><span style='font-size:13.0pt;line-height:115%;
 100 font-family:Cambria;color:#4F81BD'><img width=22 height=21 id="Picture 45"
 101 src="Synchronization_User_Manual_files/image001.jpg"
 102 alt=""></span></b><span
 103 class=Heading2Char><span style='font-size:13.0pt;line-height:115%'> ‘Synchronize’</span></span>
 104 feature in <img width=134 height=23 id="Picture 44"
 105 src="Synchronization_User_Manual_files/image002.gif"
 106 alt=""></p>
 107
 108 This feature is helpful for developers who need to replicate their databases’ structure as well as data.
 109 Moreover, this feature not only helps replication but also facilitates the user to keep his/her database in sync with another database. Other than the full database, certain tables of the databases can also be synchronized.
 110
 111 <h3><span class=IntenseEmphasis><span style='font-size:12.0pt;font-weight:normal;
 112 font-style:normal'><strong>How to Synchronize:</strong></span></span></h3>
 113 The synchronize tab is visible upfront in the right pane, the last link on the top of the home page.
 114
 115 <p class=MsoNormal><img width=682 height=421 id="Picture 1"
 116 src="Synchronization_User_Manual_files/image003.gif"></p>
 117
 118 <p class=MsoNormal>Press on the Synchronize tab and a form will be displayed.</p>
 119
 120 <p class=MsoNormal><img width=666 height=398 id="Picture 46"
 121 src="Synchronization_User_Manual_files/image004.jpg"></p>
 122 <p class=MsoNormal> <span
 123 class=Heading2Char><span style='font-size:13.0pt;line-height:115%'>Db Authentication Form?</span></span></p>
 124 <p class=MsoNormal> You need to fill in the host name of the server, the
 125 username and password of an user account already there in MySQL. Port is by default populated with 3306 (MySQL default port). Then the name of the
 126 database should be mentioned at the end.All the information other than the port needs to be filled  explicitly for the source as well as target servers.</p>
 127
 128 <p class=MsoNormal>A filled form is displayed underneath:</p>
 129
 130 <p class=MsoNormal><img width=653 height=394 id="Picture 7"
 131 src="Synchronization_User_Manual_files/image005.jpg"><span
 132 class=Heading2Char><span style='font-size:13.0pt;line-height:115%'> </span></span></p>
 133 <p class=MsoNormal><span
 134 class=Heading2Char><span style='font-size:13.0pt;line-height:115%'>Invalid entries
 135   during DB Authentication:</span></span></p>
 136 <p class=MsoNormal>The user will not be allowed to by pass this page if any of
 137 the values like Host name, Username and Database name remain unfilled and the
 138 user presses ‘Go’ button. An alert  would occur as follows, not allowing the user to
 139 move to the next page. On the other hand, the password field can remain empty.
 140 </p>
 141
 142 <p class=MsoNormal><img width=640 height=384 id="Picture 10"
 143 src="Synchronization_User_Manual_files/image006.jpg"></p>
 144
 145 <p class=MsoNormal>If any wrong information is provided by the user like wrong
 146 password, username or hostname then the connection is not established with the
 147 corresponding database and an error message is seen as follows.</p>
 148
 149 <p class=MsoNormal><img width=653 height=394 id="Picture 13"
 150 src="Synchronization_User_Manual_files/image007.jpg"></p>
 151
 152 <p class=MsoNormal>If the user enters a database name that does not exist, then
 153 even an error message occurs as follows and the user needs to re-enter all the
 154 information.</p>
 155
 156 <p class=MsoNormal><img width=653 height=391 id="Picture 16"
 157 src="Synchronization_User_Manual_files/image008.jpg"></p>
 158
 159 <p class=MsoNormal></p>
 160
 161 <h2>After  passing DB Authentication:</h2>
 162
 163 <p class=MsoNormal>After successfully by passing authentication phase, the source and
 164 target database table names will be displayed. It will be a tabular
 165 representation like this.</p>
 166
 167 <p class=MsoNormal><img width=614 height=368 id="Picture 19"
 168 src="Synchronization_User_Manual_files/image009.jpg"></p>
 169
 170 <h2>Left Column:”Source Database”</h2>
 171
 172 <p class=MsoNormal>On the left, are listed the source database table names.
 173 Some of the names have a ‘+’ plus sign preceding them. This shows that these
 174 tables are only present in source database and they need to be added to the
 175 target database in order to synchronize the target database.While those table name that are not preceded by a ‘+’ sign
 176 are also present in target database.</p>
 177
 178 <h2> Middle Column:”Difference”</h2>
 179 The column in the middle shows the difference between the source and target corresponding tables.The difference is depicted by the red and green buttons.
 180
 181 <p class=MsoNormal><img width=35 height=35 id="Picture 26"
 182 src="Synchronization_User_Manual_files/image010.gif"
 183 alt="">The
 184 presence of this button against any source table name shows that there is a
 185 structure difference between the corresponding source and the target tables. If
 186 at the same time, the source table name is preceded by a ‘+’plus, then the
 187 presence of this button shows that the table needs to be created in target
 188 database.  </p>
 189
 190 <p class=MsoNormal><img width=35 height=35 id="Picture 24"
 191 src="Synchronization_User_Manual_files/image011.jpg"
 192 alt=""> The
 193 presence of this button against any source table name shows that there is a
 194 data difference between the corresponding source and target table. If at the
 195 same time, the source table name is preceded by a ‘+’plus, then the presence of
 196 this button shows that the table needs to be created and populated in target
 197 database.  </p>
 198
 199 <p class=MsoNormal>&nbsp;</p>
 200
 201 <p class=MsoNormal><img width=33 height=31 id="Picture 27"
 202 src="Synchronization_User_Manual_files/image012.jpg"
 203 alt=""> After
 204 clicking the red button with S printed on, it turns to grey showing that the structure difference
 205 of that particular table has been selected by the user.</p>
 206
 207 <p class=MsoNormal><img width=33 height=31 id="Picture 25"
 208 src="Synchronization_User_Manual_files/image013.jpg"
 209 alt=""> After
 210 clicking the red button with a D printed on, it turns to grey showing that the data difference of
 211 that particular table has been selected by the user.</p>
 212
 213 <h2>Right Column: “Target Database”</h2>
 214
 215 <p class=MsoNormal>On the right, are listed the target database table names.
 216 There are few table names that have “(not present)” appended after their names.
 217 This means that these tables are to be created in target database in order to
 218 synchronize target database with source database. Some tables’ names have a ‘-’
 219 minus sign preceding them. This shows that these tables are only present in
 220 target database and they will remain unchanged in the target database. </p>
 221
 222 <p class=MsoNormal>While those table names that are not preceded by any sign,
 223 or do not have “(not present)” appended after them are already synchronized.</p>
 224
 225 <p class=MsoNormal><img width=678 height=408 id="Picture 28"
 226 src="Synchronization_User_Manual_files/image014.jpg"></p>
 227
 228 <h2>Detailed Difference Table:</h2>
 229
 230 <p class=MsoNormal> The above view shows that for those tables whose structure
 231 or data differences have been selected (depicted by grey buttons <img width=18
 232 height=17 src="Synchronization_User_Manual_files/image015.jpg"
 233 alt=""> or
 234 <img width=17 height=16 src="Synchronization_User_Manual_files/image016.jpg"
 235 alt="">),
 236 there exists a description in the second table underneath the table showing
 237 source and target database table names.  The description becomes visible only
 238 when a red or green button against any table is pressed.</p>
 239
 240 <h2>Table:</h2>
 241
 242 <p class=MsoNormal>Displays the <b>Table Name</b> column only to show the name
 243 of the table.</p>
 244
 245 <h2>Structure Difference:</h2>
 246
 247 <p class=MsoNormal> It elaborates the difference in structure like</p>
 248
 249 <p class=MsoNormal><b>Create Table: </b>When the table needs to be created in
 250 the target database, then only a <img width=16 height=16 id="Picture 31"
 251 src="Synchronization_User_Manual_files/image017.gif"
 252 alt=""> tick is
 253 seen in the create table column of the description table.  </p>
 254
 255 <p class=MsoNormal><b>Add Column(s):</b>  Shows the number of columns to be
 256 added.</p>
 257
 258 <p class=MsoNormal><b>Remove Column(s):</b> Shows the number of columns to be
 259 removed.</p>
 260
 261 <p class=MsoNormal><b>Alter Column(s):  </b>Shows the number of columns to be
 262 altered.</p>
 263
 264 <p class=MsoNormal><b>Apply Index(s): </b> Shows the number of indexes to be
 265 applied.</p>
 266
 267 <p class=MsoNormal><b>Remove Index(s):</b>  Shows the number of indexes to be
 268 removed.</p>
 269
 270 <h2>Data Difference:</h2>
 271
 272 <p class=MsoNormal>It elaborates the difference in data like </p>
 273
 274 <p class=MsoNormal><b>Update Row(s):</b> Shows the number of rows to be
 275 updated.</p>
 276
 277 <p class=MsoNormal><b>Insert Row(s): </b>Shows the number of rows to be
 278 inserted. </p>
 279
 280 <p class=MsoNormal>When the selected buttons (depicted by grey buttons <img
 281 width=18 height=17 src="Synchronization_User_Manual_files/image015.jpg"
 282 alt=""> or<img
 283 width=17 height=16 src="Synchronization_User%20Manual_files/image016.jpg"
 284 alt="">)
 285 are pressed again, the buttons become deselected (depicted by colored buttons <img
 286 width=23 height=23 src="Synchronization_User_Manual_files/image019.jpg"
 287 alt=""> or<img
 288 width=23 height=23 src="Synchronization_User_Manual_files/image020.jpg"
 289 alt="">) and the
 290 description from the second table regarding those table has been removed.</p>
 291
 292 <h2><span style='font-weight:normal'><img width=666 height=416 id="Picture 41"
 293 src="Synchronization_User_Manual_files/image021.jpg"></span></h2>
 294
 295 <h2>Check Box in Footer:</h2>
 296
 297 <p class=MsoNormal>A checkbox is also visible in the above view. It has a “<b>Would
 298 you like to delete all the previous rows from the target tables?</b>”</p>
 299
 300 <p class=MsoNormal>By checking this check box, the user assures the deletion of
 301 any previous rows residing in the target tables that are to be synchronized.
 302 This means that before any value gets inserted or updated in the target tables,
 303 any previously residing rows will be deleted.</p>
 304
 305 <h2>Apply Selected Changes Button in Footer: </h2>
 306
 307 <p class=MsoNormal>The “Apply Selected Changes” button, as it is clear from the
 308 name, applies only selected tables’ changes i.e. it allows user to synchronize
 309 selective tables between the source and the target databases.</p>
 310
 311 <p class=MsoNormal>After pressing “Apply Selected Changes” button, the view
 312 becomes  </p>
 313
 314 <p class=MsoNormal><img width=666 height=401 id="Picture 35"
 315 src="Synchronization_User_Manual_files/image022.jpg"></p>
 316
 317 <p class=MsoNormal>The ”course” table in the above view, now only shows data
 318 difference depicted by<img width=23 height=23
 319 src="Synchronization_User_Manual_files/image020.jpg"
 320 alt="">. This
 321 shows that the previously selected structure difference in that table has been
 322 applied in target database table “course” because we pressed the “Apply
 323 Selected Changes” button after selection. </p>
 324
 325 <p class=MsoNormal>“Apply Selected Changes” button allows the user to synchronize
 326 tables’ data and structure according to his/her requirement or desire.</p>
 327
 328 <p class=MsoNormal>Whenever “Apply Selected Changes” button is pressed and the
 329 page is reloaded, the checkbox becomes unchecked. This means that the user gets
 330 a choice to delete the previous rows of a certain set of tables and not from
 331 all the tables. </p>
 332
 333 <h2>Synchronize databases button in Footer:</h2>
 334
 335 <p class=MsoNormal>“Synchronize databases” button in the footer completely
 336 synchronizes the target database with the source database irrespective of which
 337 tables are selected for which type of synchronization.</p>
 338
 339 <p class=MsoNormal> “Synchronize databases” button if pressed after “Apply
 340 Selected Changes” button has been pressed once or twice or several times, will
 341 apply all the remaining changes that have not been selected earlier.</p>
 342
 343 <p class=MsoNormal>The view after “Synchronize databases” button has been
 344 pressed look like this:</p>
 345
 346 <p class=MsoNormal><img width=666 height=399 id="Picture 49"
 347 src="Synchronization_User_Manual_files/image023.jpg"></p>
 348
 349 <p class=MsoNormal>The lower half of the page displays the list of queries that
 350 have been executed in order to synchronize the databases while the upper half
 351 displays the source and target database table names.</p>
 352
 353 </div>
 354
 355 </body>
 356
 357 </html>