Oracle Extractor Instructions

Here are the detailed instructions for extracting required information from Oracle database systems.

Downloading the extractor

The extOraSchema-8.jar archive contains the JRE 8 version and should work with JRE version 8 to 21.

The extractor requires ojdbc8.jar which is bundled with SQL Developer.

The “Determine JRE Version” section below gives more details of JRE versions and extractor versions, but in most cases extOraSchema-8.jar should work, and you may skip to “Your Encryption Key”.

Determine JRE Version

To ensure the correct version of the extractor is used, please check what version of the JRE you have installed. We recommend using the JRE that comes with SQL Developer.

Please use the following link to down the appropriate Extractor version.

JRE Version Extractor File Extractor Link
8 (1.8) extOrSchema-8.jar click to download
11 extOrSchema-11.jar click to download
17 extOrSchema-17.jar click to download
19 extOrSchema-19.jar click to download
21 extOrSchema-21.jar click to download

Extractor Java Compatibility matrix

All tested with ojdbc8.jar

JRE 8 JRE 11 JRE 17 JRE 19 JRE 21
extOraSchema-8.jar
extOraSchema-11.jar
extOraSchema-17.jar
extOraSchema-19.jar
extOraSchema-21.jar

Licenced Oracle customers may use the JRE supplied with SQL Developer.

Your Encryption Key

The extractor will use an encryption key to encrypt the extracted zip archive.

Demo or trial users will need to request the encryption key from their account manager.

Registered customers can generate keys via the portal.

Extractor Parameters

The extractors use the following positional command line parameters:

Parameter No. Description
1 IP address or hostname of the databases server
2 DB listener port on the database service
3 DB SID
4 Username to connect as. Must have SELECT_CATALOG_ROLE, or be able to select any view/table.
5 Password for the user
6 Name of schema to extract
7 Set to 'Y' to include SQL extract
8 For internal use. Always specify N
9 Name of output folder to extract objects scripts into
10 Encryption Key

Test Mode

If just the first 6 parameters are provided, the extractor runs in ‘test’ mode, where it will check if it can connect and run a basic query. This is useful for testing basic workings.

Running The Extractor

Decide Location of Output

Decide where the extractor will write its output files to (this folder tree will be zipped after extraction phase is complete).

Create a Run Script

Copy and paste the following into a run script, and amend the JAVA_HOME and IP_ADDR PORT SID USER PWD SCHEMA values as appropriate. Also amend the extOraSchema-8.jar to whatever was downloaded.

The following will run in test mode:

set JAVA_HOME=K:\Oracle\Development\sqldeveloper-21\jdk\jre
%JAVA_HOME%\bin\java -version
echo
echo
%JAVA_HOME%\bin\java -cp "extOraSchema-8.jar;K:\Oracle\Development\sqldeveloper-21\jdbc\lib\ojdbc8.jar" extOraSchema IP_ADDR PORT SID USER PWD SCHEMA

Run the script and check that it connects OK and produces output similar to :

Doxra Oracle Extractor v1.0.5
6 parameters provided - connection test mode only
getObjectCount:
54 objects of type INDEX
7 objects of type JOB
26 objects of type PACKAGE
24 objects of type PACKAGE BODY
30 objects of type SEQUENCE
38 objects of type TABLE
1 objects of type TRIGGER
180 Total Objects

Now create a 2nd script with all the parameters specified as follows, and amend the JAVA_HOME and IP_ADDR PORT SID USER PWD SCHEMA OUTDIR ENCKEY values as appropriate. Also amend the extOraSchema-8.jar to whatever was downloaded.

set JAVA_HOME=K:\Oracle\Development\sqldeveloper-21\jdk\jre%JAVA_HOME%\bin\java -version
echo
echo
%JAVA_HOME%\bin\java -cp ".\extOraSchema-8.jar;K:\Oracle\Development\sqldeveloper-21\jdbc\lib\ojdbc8.jar" extOraSchema IP_ADDR PORT SID USER PWD SCHEMA Y N OUTDIR ENCKEY

Run this second script. Depending on the number of tables this make take a while to run, but it will post updates to the console to show progress.

Output

The specified output folder will have a sub-folder structure created with scripts files created, as well as a object map JSON file.

Once the extraction is complete, the folder is zipped.

This zip file will be called doxra_ora_DBNAME_SCHEMA.zip

The resulting zip file will then be encrypted using the key provided, resulting in a file called doxra_ora_DBNAME_SCHEMA.enc

Registered customers will be able to upload this encrypted file via the portal web app.

Demo users should request an upload portal link from their account manager.