FireDAC.Phys.IB.TFDIBSDump

From RAD Studio API Documentation
Jump to: navigation, search

FireDAC.Phys.IBBase.TFDIBServiceFireDAC.Phys.TFDPhysDriverServiceFireDAC.Stan.Intf.TFDComponentSystem.Classes.TComponentSystem.Classes.TPersistentSystem.TObjectTFDIBSDump

Delphi

TFDIBSDump = class (TFDIBService)

C++

class PASCALIMPLEMENTATION TFDIBSDump : public Firedac::Phys::Ibbase::TFDIBService

Properties

Type Visibility Source Unit Parent
class public
FireDAC.Phys.IB.pas
FireDAC.Phys.IB.hpp
FireDAC.Phys.IB FireDAC.Phys.IB

Description

The class implementing an online database dump service for Interbase.

Use the TFDIBSDump component to add an online Interbase-only database dump capability to an application. This is a programmatic method to invoke the gbak -d tool as a thread in the DB server process.

To configure the connection to the database server, you must fill the following properties: DriverLink, Host, Protocol, UserName and Password.

To produce a DB online dump, an application should:

  • Specify the Database - a primary database file that is to be backed up.
  • Specify the BackupFiles - the names of the files into which the database is to be backed up.
  • Call the Dump method.

Other properties and methods are optional.

The paths of the backup files are relative to the server. Because TFDIBSDump executes backup on the DB server host, the DB Service Manager writes backup files on the server host. The DB Service Manager also creates files in the context of the server.

To restore a backup created by TFDIBSDump, use the TFDIBRestore component. The TFDFBNBackup component can be used for a Firebird incremental backup.

Example

ADIBSDump1.DriverLink := ADPhysIBDriverLink1;

ADIBSDump1.UserName := 'sysdba';
ADIBSDump1.Password := 'masterkey';
ADIBSDump1.Host := 'db_srv_host';
ADIBSDump1.Protocol := ipTCPIP;

ADIBSDump1.Database := 'e:\ib\addemo.gdb';
ADIBSDump1.BackupFiles.Clear;
ADIBSDump1.BackupFiles.Add('e:\ib\addemo.backup');

ADIBSDump1.Dump;

See Also