rpsExtractDataAll

rpsExtractDataAll(executionLocation:       Integer;
                  scriptFilePath:          String;
                  dataFilesPath:           String;
                  rdbDataFilesPath:        String;
                  rdbName:                 String;
                  extractHistoricalTables: Boolean;
                  serverName:              String;
                  extractWorkers:          Integer;
                  extractOrder:            Integer;
                  extractFirst:            String;
                  userDataPumpSchema:      String;
                  userDataPumpApp:         String): Process;

The rpsExtractDataAll method of the JadeDatabaseAdmin class starts the user-defined RPS Datapump application specified by the userDataPumpApp and userDataPumpSchema parameters on the server node to extract data for all tables.

You can execute this method on an RPS node only, not on the primary node. Running an RPS extract on an SDS node causes tracking to be stopped during the extract.

The rpsExtractDataAll method parameters are listed in the following table.

Parameter Specifies the …
executionLocation The location that will be used for loading the extracted data. Permitted values can be specified using the RelationalView class Load_ServerExecute (0) and Load_ClientExecute (1) constants.
scriptFilePath The output directory for the script files.
dataFilesPath The output directory for the data files.
rdbDataFilesPath The path of the data files directory from the perspective of the RDBMS database.
rdbname The name of the RDBMS database.
extractHistoricalTables If historical table data is to be extracted.
serverName The name of the RDBMS server.
extractWorkers The number of extract worker processes to run.
extractOrder

The order in which the tables are to be extracted; possible values specified by the following JadeDatabaseAdmin class constants.

Class Constant Value Order of Output Tables
ExtractOrderDefault 0 No order specified
ExtractOrderClassInstances 1 Number of instances of the class from highest to lowest (note that determining the number of instances may delay the start of extraction)
ExtractOrderSelectedFirst 2 As specified in extractFirst parameter, then in default order
extractFirst The names of the tables to be extracted first, if any, delimited by semicolons.
userDataPumpSchema The name of the schema for the user-defined data pump application. If null, the default data pump application is used.
userDataPumpApp The name of the user-defined data pump application. If executed on the primary, the user-defined data pump may not be used. The user-defined data pump may be used in an RPS or SDS node. The value of the user-defined Datapump application (or <default>) is written out to the DataPumpApplication parameter in the [JadeRps] section of the JADE initialization file.

The method returns the process of the application that extracts the table data. You can register to receive notifications for events occurring for the process that carries out the data extraction in the following table.

Process Class Constant Value
RPS_EXTRACT_FAILED_EVENT 202
RPS_EXTRACT_FINISHED_EVENT 203

Calls to this method can raise the following exception.

 

VERSION 2018.0.01  |  Copyright © 2018  Jade Software Corporation Limited.  All rights reserved.