MySqlDump Class

Serves to store a database or its parts as a script and to restore database from the generated script.

For a list of all members of this type, see MySqlDump members.

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         Devart.Data.MySql.MySqlDump

Syntax

[Visual Basic]
Public Class MySqlDump 
   Inherits Component
   Implements IComponent, IDisposable

[C#]
public class MySqlDump : Component, IComponent, IDisposable

Remarks

MySqlDump by its behaviour is similar to mysqldump program.

Use Tables property to specify a list of tables to be stored. If Tables property is an empty string all tables will be included into the dump text. To generate a script call Backup method. Result script can be viewed in DumpText. To run it on a database, use Restore method.

When generating scripts, all operations are executed within database that Database property of associated MySqlConnection object references to. When restoring tables using the generated script, the property Database is used only if IncludeDatabase has been set to false in the moment of script generation.

If the Unicode is true, MySqlDump uses UTF8, otherwise it uses default encoding.

Note: This class is available with dotConnect for MySQL Professional edition only.

Example

The following example creates a MySqlDump component and executes backup of the specified tables using Backup method. After execution of backup operation the result is saved at d:\tmp\mysqldump.dmp file. The second routine executes the generated script using Restore method.

[C#]

public void DumpIt(MySqlConnection myConnection) 
{ 
  myConnection.Open(); 
  MySqlDump mySqlDump = new MySqlDump(); 
  mySqlDump.Connection = myConnection; 
  myConnection.Database = "Test"; 
  mySqlDump.IncludeDrop = true; 
  mySqlDump.GenerateHeader = true; 
  mySqlDump.Tables = "Dept;Emp"; 
  mySqlDump.Backup(); 
  StreamWriter stream = new StreamWriter("d:\\tmp\\mysqldump.dmp"); 
  stream.WriteLine(mySqlDump.DumpText); 
  stream.Close(); 
  Console.WriteLine("Dumped."); 
  myConnection.Close(); 
} 
 
public void UnDumpIt(MySqlConnection myConnection) 
{ 
  myConnection.Open(); 
  MySqlDump mySqlDump = new MySqlDump(); 
  mySqlDump.Connection = myConnection; 
  myConnection.Database = "Test"; 
  StreamReader stream = new StreamReader("d:\\tmp\\mysqldump.dmp"); 
  mySqlDump.DumpText = stream.ReadToEnd(); 
  stream.Close(); 
  mySqlDump.Restore(); 
  Console.WriteLine("Restored."); 
  myConnection.Close(); 
}

[Visual Basic]

Public Sub DumpIt(ByVal myConnection As MySqlConnection)
   myConnection.Open()
   Dim mySqlDump As MySqlDump = New MySqlDump
   mySqlDump.Connection = myConnection
   myConnection.Database = "Test"
   mySqlDump.IncludeDrop = True
   mySqlDump.GenerateHeader = True
   mySqlDump.Tables = "Emp;Dept"
   mySqlDump.Backup()
   Dim stream As StreamWriter = New StreamWriter("d:\tmp\mysqldump.dmp")
   stream.WriteLine(mySqlDump.DumpText)
   stream.Close()
   Console.WriteLine("Dumped.")
   myConnection.Close()
 End Sub
 
Public Sub UnDumpIt(ByVal myConnection As MySqlConnection)
   myConnection.Open()
   Dim mySqlDump As MySqlDump = New MySqlDump
   mySqlDump.Connection = myConnection
   myConnection.Database = "Test"
   Dim stream As StreamReader = New StreamReader("d:\tmp\mysqldump.dmp")
   mySqlDump.DumpText = stream.ReadToEnd()
   stream.Close()
   mySqlDump.Restore()
   Console.WriteLine("Restored.")
   myConnection.Close()
 End Sub

See Also

Language