Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Introduction 

A plugin that can efficiently export data from Oracle to be used as a source in Hydrator.  Oracle includes command line tools to export data  that can be utilized to perform this task.  

 

Use-case
A Hydrator User would like to incorporate oracle data into a pipeline using a source plugin that does not require a JDBC connection to perform the export from Oracle.

User Stories

  • As a Hydrator User I want to export data from Oracle to be used in my hydrator Pipeline.
  • As a Hydrator User I want a Oracle Export plugin that exports data efficiently using existing existing Oracle tools. 
  • As a Hydrator User I want the export data capability of the Oracle plugin to be based on a sql query that I issue.  
  • User should be able to specify credentials.
  • Passwords should not be viewable in plain text from inside pipeline viewer or hydrator studio.  
  • User should be able to specify Oracle Instance
  • User should be able to specify location of EXP Utility.   
  • User should be able to specify type of output.
  • User should be able to specify location of output files.  
  • User should know of connectivity errors, or malformed queries/output identifier.   

Example

Example for how the plugin should work

Implementation Tips

Design 

Design:

{
    "name": "OracleExportAction",
      "plugin": {
        "name": "OracleExportAction",
        "type": "action",
        "label": "OracleExportAction",
        "artifact": {
          "name": "core-plugins",
          "version": "1.4.0-SNAPSHOT",
          "scope": "SYSTEM"
      },
      "properties": {
          "oracleServerHostname": "example.com",
          "oracleServerPort": "22",
          "serverUsername": "oracle",
          "serverPassword": "oracle@123",
          "dbUsername": "system",
          "dbPassword": "cask",
          "oracleHome": "/u01/app/oracle/product/11.2.0/xe",
          "oracleSID": "cask",
          "paramFilePath": "/parameters/param.par"
      }
      }
}
oracleServerHostname:Host name of the remote DB machine where the data dump command is to be executed
oracleServerPort:Port of the remote DB machine to connect to. Defaults to 22
serverUsername:User name used to connect to remote DB host
serverPassword:Password used to connect to remote DB host
dbUsername:User name to connect to oracle DB
dbPassword:Password to connect to oracle DB
oracleHome:Path of the ORACLE_HOME
oracleSID:Oracle SID
paramFilePath:
 Full path of the PARAM file.Param file should contain the required parameters to run data dump command. e.g If you want to export the data from test table using filter for name column" +
"DIRECTORY = test_dir(This should be already configured and should have required access)\n" +
"DUMPFILE = table.dmp(dump file name)\n" +
"LOGFILE = table_lg.log\n" +
"TABLES = test(tables on which data export needs to be done)\n" +
"QUERY = test:\"WHERE name = 'cask'\"

 

 

 

 

Table of Contents

Checklist

  • User stories documented 
  • User stories reviewed 
  • Design documented 
  • Design reviewed 
  • Feature merged 
  • Examples and guides 
  • Integration tests 
  • Documentation for feature 
  • Short video demonstrating the feature

 

  • No labels