rpsExtractDataAzure

rpsExtractDataAzure(tableName:               String;
                    scriptFilePath:          String;
                    dataFilesPath:           String;
                    rdbDataFilesPath:        String;
                    rdbName:                 String;
                    loadHistoricalTables:    Boolean;
                    serverName:              String;
                    extractWorkers:          Integer;
                    azureDbName:             String;
                    optionalUserPrinciple:   String): Process;

The rpsExtractDataAzure method of the JadeDatabaseAdmin class starts the RPS Datapump application on the server node to extract data for all tables in a format appropriate for loading into an Azure SQL database from the client side using a bcp script.

This method returns the process of the asynchronous process that is generating the data extract scripts.

For details about using the rpsExtractDataAzure method to extract and load data, see "Extracting Data and Loading it into an Azure SQL Database", in Chapter 2 of the Synchronized Database Service (SDS) Administration Guide.

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 rpsExtractDataAzure method parameters are listed in the following table.

Parameter	Specifies…
tableName	The table name to extract or all tables (that is, if the value of the tableName parameter is null).
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.
loadHistoricalTables	If historical table data is to be loaded.
serverName	The name of the RDBMS server.
extractWorkers	The number of extract worker processes to run. This value must be greater than zero (0).
azureDbName	The name of the Azure SQL database. (This could be the same value as the rdbName parameter.)
optionalUserPrinciple	The name of the owner of the table or view into which to load the data. By default, the value is set to dbo. This parameter is optional.

2022.0.02 and higher