Extracts metadata (and data if specified) of a database into a script.

Syntax

 function ibec_ExtractMetadata(Connection : variant; ScriptFile :string;
                               Options : string; CallbackProc : variant): string;

Description

This function extracts metadata/data of a specified database into a script.

Note: In Firebird mixed case table names that are unquoted are stored in uppercase; in queries these object names are case insensitive. You need to use the table name as it is stored in the metadata tables for this function. This means: UPPERCASE for unquoted object names or the exact casing of quoted object names.

ibec_ExtractMetadata also supports the OctetsAsHex option which allows the extraction of CHAR(n) CHARACTER SET OCTETS values in hexadecimal format.

Firebird 3.0

You should specify packages in the Options string:

 PACKAGES=ALL;

or

 PACKAGES=PACKAGE_1,PACKAGE_2,...;

or

 PACKAGES=NONE;

The list of stored functions to be extracted should be specified in the Options string:

 FUNCTIONS=ALL;

or

 FUNCTIONS=FUNCTION_1,FUNCTION_2,...;

or

 FUNCTIONS=NONE;

The ExtractDDLPrivileges option allows extraction of privileges on data definition language statements such as CREATE/ALTER/DROP (Firebird 3).

The UseUpdateOrInsert option allows extraction of data as UPDATE OR INSERT statements instead of INSERT.

Parameters

Examples of usage

1. Extracting domain definitions in VCS-files:

   execute ibeblock
   as
   begin
      cbb = 'execute ibeblock (LogLine variant)
        as
        begin
          ibec_progress(LogLine);
        end';

      db = ibec_GetDefaultConnection();
 ibec_ExtractMetadata(db, 'E:\Domains\', 'Domains=ALL; Tables=NONE; Views=NONE;
 Triggers=NONE; Procedures=NONE; Generators=NONE;
 Exceptions=NONE; UDFs=NONE; Roles=NONE;
  VCSFiles', cbb);
    end;

2. Complete metadata extract:

   execute ibeblock
   as
   begin
      cbb = 'execute ibeblock (LogLine variant)
        as
        begin
          ibec_progress(LogLine);
        end';

   db = ibec_GetDefaultConnection();
 ibec_ExtractMetadata(db, 'E:\meta.sql', 'GenerateCreate; ExtractPrivileges; ExtractDescriptions',
 cbb);
   end;

3. Extracting data from specified tables:

   execute ibeblock
   as
   begin
      cbb = 'execute ibeblock (LogLine variant)
        as
        begin
          ibec_progress(LogLine);
        end';

      db = ibec_GetDefaultConnection();
 ibec_ExtractMetadata(db, 'E:\data.sql', 'Domains=NONE; Tables=NONE; Views=NONE; Triggers=NONE; 

 Procedures=NONE; Generators=NONE;
 Exceptions=NONE; UDFs=NONE; Roles=NONE;DataTables=IBE$$TEST_DATA, MY_TABLE;
 ExtractBLOBs;UseReinsert; CommitAfter=1000', cbb);
    end;

4. Using the IncludeCharset parameter:

 ibec_ExtractMetadata(db, 'E:\meta.sql', 'GenerateCreate;IncludeCharset;ExtractPrivileges; ExtractDescriptions',cbb);

5. Using a number of parameters:

 ibec_ExtractMetadata(MyDB, 'D:\MyDB.sql', 'ServerVersion=FB21; AddKeyword=FIRST,SECOND,KEY; 
 RemoveKeyword=START,TIME; ...', cbb);

See also:
Extract Metadata
Extract metadata using IBEBlock
Specifying WHERE clauses in ibec_ExtractMetadata
ibec_CompareMetadata
Using Extract metadata to repair databases

back to top of page
<< ibec_CompareMetadata | IBEBlock | Specifying WHERE clauses in ibec_ExtractMetadata >>