BeginBackup(String) Method

In This Topic

Syntax
Remarks
Example
Requirements
See Also

Starts an asynchronous invocation of a Backup(String) method.

Syntax

Visual Basic
C#

public IAsyncResult BeginBackup( 
   string fileName
)

'Declaration
 
Public Overloads Function BeginBackup( _
   ByVal fileName As String _
) As IAsyncResult

Parameters

fileName: The name of the file to write the script to.

Return Value

An System.IAsyncResult interface that represents the asynchronous operation started by calling this method.

Remarks

BeginBackup(String) method enables you to perform a backup operation without having current thread blocked. In other words, your program can continue execution while the backup runs in background so you do not have to wait for it.

To start the backup operation, you have to call BeginBackup(String) method, which in turn invokes appropriate actions in another thread. Return value of this method must be assigned to an System.IAsyncResult object. After executing this method, the program flow continues.

When you are ready to finish the backup operation, call EndBackup. If at the moment you call this function the backup has not yet been finished, application stops and waits till the function returns.

Example

This sample demonstrates performing async backup and restore operations.

csharp

public void DumpIt(PgSqlConnection conn)
{
        conn.Open();
        PgSqlDump pgSqlDump = new PgSqlDump();
        pgSqlDump.Connection = conn;
        pgSqlDump.Schema = "public";
        pgSqlDump.Tables = "dept;emp";
        pgSqlDump.IncludeDrop = true;
        IAsyncResult Result = pgSqlDump.BeginBackup("d:\\dump.dmp");
        while (!Result.IsCompleted)
        {
                Console.Write(".");
                //Perform here any operation you need
        }
        pgSqlDump.EndBackup(Result);
        Console.WriteLine("Dumped.");
        conn.Close();
}

public void UnDumpIt(PgSqlConnection conn)
{
        conn.Open();
        PgSqlDump pgSqlDump = new PgSqlDump();
        pgSqlDump.Connection = conn;
        IAsyncResult Result = pgSqlDump.BeginRestore("d:\\dump.dmp");
        while (!Result.IsCompleted)
        {
                Console.Write(".");
                //Perform here any operation you need
        }
        pgSqlDump.EndRestore(Result);
        Console.WriteLine("Restored.");
        conn.Close();
}

Visual Basic

Public Sub DumpIt(conn As PgSqlConnection)
        conn.Open()
        Dim pgSqlDump As New PgSqlDump()
        pgSqlDump.Connection = conn
        pgSqlDump.Schema = "public"
        pgSqlDump.Tables = "dept;emp"
        pgSqlDump.IncludeDrop = True
        Dim Result As IAsyncResult = pgSqlDump.BeginBackup("d:\dump.dmp")
        While Not Result.IsCompleted
                'Perform here any operation you need
                Console.Write(".")
        End While
        pgSqlDump.EndBackup(Result)
        Console.WriteLine("Dumped.")
        conn.Close()
End Sub

Public Sub UnDumpIt(conn As PgSqlConnection)
        conn.Open()
        Dim pgSqlDump As New PgSqlDump()
        pgSqlDump.Connection = conn
        Dim Result As IAsyncResult = pgSqlDump.BeginRestore("d:\dump.dmp")
        While Not Result.IsCompleted
                'Perform here any operation you need
                Console.Write(".")
        End While
        pgSqlDump.EndRestore(Result)
        Console.WriteLine("Restored.")
        conn.Close()
End Sub

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DbDump Class
DbDump Members
Overload List

Send Feedback