OraDump Export API exposes its interface through collection of classes, each one of them is responsible for migrating Oracle dump file into certain data format.
OraDump2Access - this class is used to export Oracle dump files into MS Access databases. It implements the following COM interface:
__interface IOraDump2Access : IDispatch
{
// open source dump file and do first pass of reading
[id(1), helpstring("method open")] HRESULT open(BSTR ora_dump);
// the main conversion cycle
[id(2), helpstring("method convert")] HRESULT convert(BSTR database);
// get the progress of 1st reading the dump file (in percents 1..100)
[id(3), helpstring("method get_open_progress")] HRESULT get_open_progress([out,retval] LONG* progress);
// get the progress of conversion (in percents 1..100)
[id(4), helpstring("method get_conversion_progress")]
HRESULT get_conversion_progress([out,retval] LONG* progress);
// get total number of tables in the opened dump file
[id(5),helpstring("method get_tables_count")] HRESULT get_tables_count([out,retval] LONG *pVal);
// get name of table by ordinal position in the tables list
[id(6),helpstring("method get_table_name_by_index")]
HRESULT get_table_name_by_index([in] LONG nIdx, [out,retval] BSTR *pVal );
// add individual table to convert
[id(7),helpstring("method add_table_to_convert")] HRESULT add_table_to_convert([in] BSTR table_name);
// return true if dump file is valid and false otherwise
[id(8),helpstring("method is_dump_file_valid")] HRESULT is_dump_file_valid([out,retval] LONG *pVal);
// set up logfile to write conversion traces
[id(9), helpstring("method set_logfile")] HRESULT set_logfile([in] BSTR file_name);
// specify file to load list of tables to convert (one table name per line)
[id(10), helpstring("method set_tabfile")] HRESULT set_tabfile([in] BSTR file_name);
// get/set how to process existing database (0 - overwrite
// the entire database, 1 - overwrite existing tables only,
// 2 - skip existing tables, 3 - merge
[propget, id(11), helpstring("property mode")] HRESULT mode([out, retval] LONG* pVal);
[propput, id(11), helpstring("property mode")] HRESULT mode([in] LONG newVal);
// get/set format of the destination MS Access file (0/1):
// 0 - MS Access 97 and older, 1 - MS Access 2000 and higher
[propget, id(12), helpstring("property format")] HRESULT format([out, retval] LONG* pVal);
[propput, id(12), helpstring("property format")] HRESULT format([in] LONG newVal);
// get/set 'Convert table definitions only' property
[propget, id(13), helpstring("property tabdef_only")] HRESULT tabdef_only([out, retval] LONG* pVal);
[propput, id(13), helpstring("property tabdef_only")] HRESULT tabdef_only([in] LONG newVal);
};
OraDump2CSV - this class is used to export Oracle dump files into CSV format (each table becomes CSV file). It implements the following COM interface:
__interface IOraDump2CSV : IDispatch
{
// open source dump file and do first pass of reading
[id(1), helpstring("method open")] HRESULT open([in] BSTR ora_dump);
// the main conversion cycle
[id(2), helpstring("method convert")] HRESULT convert([in] BSTR database);
// get the progress of 1st reading the dump file (in percents 1..100)
[id(3), helpstring("method get_open_progress")]
HRESULT get_open_progress([out,retval] LONG* progress);
// get the progress of conversion (in percents 1..100)
[id(4), helpstring("method get_conversion_progress")]
HRESULT get_conversion_progress([out,retval] LONG* progress);
// get total number of tables in the opened dump file
[id(5),helpstring("method get_tables_count")] HRESULT get_tables_count([out,retval] LONG *pVal);
// get name of table by ordinal position in the tables list
[id(6),helpstring("method get_table_name_by_index")] HRESULT
get_table_name_by_index([in] LONG nIdx, [out,retval] BSTR *pVal );
// add individual table to convert
[id(7),helpstring("method add_table_to_convert")] HRESULT add_table_to_convert([in] BSTR table_name);
// return true if dump file is valid and false otherwise
[id(8),helpstring("method is_dump_file_valid")] HRESULT is_dump_file_valid([out,retval] LONG *pVal);
// set up logfile to write conversion traces
[id(9), helpstring("method set_logfile")] HRESULT set_logfile([in] BSTR file_name);
// specify file to load list of tables to convert (one table name per line)
[id(10), helpstring("method set_tabfile")] HRESULT set_tabfile([in] BSTR file_name);
// get/set delimiter used for the destination CSV file (0/1/2):
// 0 - tab, 1 - semicolon, 2 - comma
[propget, id(11), helpstring("property delimiter")] HRESULT delimiter([out, retval] LONG* pVal);
[propput, id(11), helpstring("property delimiter")] HRESULT delimiter([in] LONG newVal);
// get/set how to process existing database (0 - overwrite
// the entire database, 1 - overwrite existing tables only,
// 2 - skip existing tables, 3 - merge
[propget, id(12), helpstring("property mode")] HRESULT mode([out, retval] LONG* pVal);
[propput, id(12), helpstring("property mode")] HRESULT mode([in] LONG newVal);
// get/set 'Convert table definitions only' property
[propget, id(13), helpstring("property tabdef_only")] HRESULT tabdef_only([out, retval] LONG* pVal);
[propput, id(13), helpstring("property tabdef_only")] HRESULT tabdef_only([in] LONG newVal);
};
OraDump2Excel - this class is used to export Oracle dump files into MS Excel format. It implements the following COM interface:
__interface IOraDump2Excel : IDispatch
{
// open source dump file and do first pass of reading
[id(1), helpstring("method open")] HRESULT open(BSTR ora_dump);
// the main conversion cycle
[id(2), helpstring("method convert")] HRESULT convert(BSTR database);
// get the progress of 1st reading the dump file (in percents 1..100)
[id(3), helpstring("method get_open_progress")] HRESULT get_open_progress([out,retval] LONG* progress);
// get the progress of conversion (in percents 1..100)
[id(4), helpstring("method get_conversion_progress")]
HRESULT get_conversion_progress([out,retval] LONG* progress);
// get total number of tables in the opened dump file
[id(5),helpstring("method get_tables_count")] HRESULT get_tables_count([out,retval] LONG *pVal);
// get name of table by ordinal position in the tables list
[id(6),helpstring("method get_table_name_by_index")]
HRESULT get_table_name_by_index([in] LONG nIdx, [out,retval] BSTR *pVal );
// add individual table to convert
[id(7),helpstring("method add_table_to_convert")] HRESULT add_table_to_convert([in] BSTR table_name);
// return true if dump file is valid and false otherwise
[id(8),helpstring("method is_dump_file_valid")] HRESULT is_dump_file_valid([out,retval] LONG *pVal);
// set up logfile to write conversion traces
[id(9), helpstring("method set_logfile")] HRESULT set_logfile([in] BSTR file_name);
// specify file to load list of tables to convert (one table name per line)
[id(10), helpstring("method set_tabfile")] HRESULT set_tabfile([in] BSTR file_name);
// get/set format of the destination MS Excel spreadsheet ()
// 0 - MS Excel 7.0 and older, 1 - MS Excel 2000 and higher
[propget, id(11), helpstring("property format")] HRESULT format([out, retval] LONG* pVal);
[propput, id(11), helpstring("property format")] HRESULT format([in] LONG newVal);
// get/set how to process existing database (0 - overwrite
// the entire database, 1 - overwrite existing tables only,
// 2 - skip existing tables, 3 - merge
[propget, id(12), helpstring("property mode")] HRESULT mode([out, retval] LONG* pVal);
[propput, id(12), helpstring("property mode")] HRESULT mode([in] LONG newVal);
// get/set splitting data into multiple xls files (if necessary):
// true - splitting is allowed, false - splitting is not allowed
[propget, id(13), helpstring("property split_mult_xls")] HRESULT split_mult_xls([out, retval] BYTE* pVal);
[propput, id(13), helpstring("property split_mult_xls")] HRESULT split_mult_xls([in] BYTE newVal);
// get/set 'Convert table definitions only' property
[propget, id(14), helpstring("property tabdef_only")] HRESULT tabdef_only([out, retval] LONG* pVal);
[propput, id(14), helpstring("property tabdef_only")] HRESULT tabdef_only([in] LONG newVal);
// get/set 'wrap text into multiple lines in a cell' property (true/false)
// true - text will be wrapped, false - text will not be wrapped
[propget, id(15), helpstring("property wrap_text")] HRESULT wrap_text([out, retval] BYTE* pVal);
[propput, id(15), helpstring("property wrap_text")] HRESULT wrap_text([in] BYTE newVal);
};
OraDump2MSSQL - this class is used to migrate data from Oracle dump files to MS SQL server. It implements the following COM interface:
__interface IOraDump2MSSQL : IDispatch
{
// add individual table to convert
[id(1),helpstring("method add_table_to_convert")] HRESULT add_table_to_convert([in] BSTR table_name);
// the main conversion cycle
[id(2), helpstring("method convert")] HRESULT convert(BSTR database);
// get the progress of 1st reading the dump file (in percents 1..100)
[id(3), helpstring("method get_open_progress")] HRESULT get_open_progress([out,retval] LONG* progress);
// get the progress of conversion (in percents 1..100)
[id(4), helpstring("method get_conversion_progress")]
HRESULT get_conversion_progress([out,retval] LONG* progress);
// get total number of tables in the opened dump file
[id(5),helpstring("method get_tables_count")] HRESULT get_tables_count([out,retval] LONG *pVal);
// get name of table by ordinal position in the tables list
[id(6),helpstring("method get_table_name_by_index")]
HRESULT get_table_name_by_index([in] LONG nIdx, [out,retval] BSTR *pVal );
// return true if dump file is valid and false otherwise
[id(7),helpstring("method is_dump_file_valid")] HRESULT is_dump_file_valid([out,retval] LONG *pVal);
// open source dump file and do first pass of reading
[id(8), helpstring("method open")] HRESULT open(BSTR ora_dump);
// set up logfile to write conversion traces
[id(9), helpstring("method set_logfile")] HRESULT set_logfile([in] BSTR file_name);
// specify file to load list of tables to convert (one table name per line)
[id(10), helpstring("method set_tabfile")] HRESULT set_tabfile([in] BSTR file_name);
// get/set MS SQL server. It can be either network name or IP address.
// If you leave it empty, the local server is assumed.
// Also, you can specify custom MS SQL port (other than 1433)
// as follows: Sql_server_name,port_number
[propget, id(11), helpstring("property host")] HRESULT host([out, retval] BSTR* pVal);
[propput, id(11), helpstring("property host")] HRESULT host([in] BSTR newVal);
// get/set how to process existing database (0 - overwrite
// the entire database, 1 - overwrite existing tables only,
// 2 - skip existing tables, 3 - merge
[propget, id(12), helpstring("property mode")] HRESULT mode([out, retval] LONG* pVal);
[propput, id(12), helpstring("property mode")] HRESULT mode([in] LONG newVal);
// get/set MS SQL password
[propget, id(13), helpstring("property password")] HRESULT password([out, retval] BSTR* pVal);
[propput, id(13), helpstring("property password")] HRESULT password([in] BSTR newVal);
// get/set 'Convert table definitions only' property
[propget, id(14), helpstring("property tabdef_only")] HRESULT tabdef_only([out, retval] LONG* pVal);
[propput, id(14), helpstring("property tabdef_only")] HRESULT tabdef_only([in] LONG newVal);
// get/set MS SQL user. You can leave 'user' and 'password' empty
// to connect to MS SQL server using Windows authentication
[propget, id(15), helpstring("property user")] HRESULT user([out, retval] BSTR* pVal);
[propput, id(15), helpstring("property user")] HRESULT user([in] BSTR newVal);
};
OraDump2MySQL - this class is used to migrate data from Oracle dump files to MySQL server. It implements the following COM interface:
__interface IOraDump2MSSQL : IDispatch
{
// open source dump file and do first pass of reading
[id(1), helpstring("method open")] HRESULT open([in] BSTR ora_dump);
// the main conversion cycle
[id(2), helpstring("method convert")] HRESULT convert([in] BSTR database);
// get the progress of 1st reading the dump file (in percents 1..100)
[id(3), helpstring("method get_open_progress")] HRESULT get_open_progress([out,retval] LONG* progress);
// get the progress of conversion (in percents 1..100)
[id(4), helpstring("method get_conversion_progress")]
HRESULT get_conversion_progress([out,retval] LONG* progress);
// get total number of tables in the opened dump file
[id(5),helpstring("method get_tables_count")] HRESULT get_tables_count([out,retval] LONG *pVal);
// get name of table by ordinal position in the tables list
[id(6),helpstring("method get_table_name_by_index")]
HRESULT get_table_name_by_index([in] LONG nIdx, [out,retval] BSTR *pVal );
// add individual table to convert
[id(7),helpstring("method add_table_to_convert")] HRESULT add_table_to_convert([in] BSTR table_name);
// return true if dump file is valid and false otherwise
[id(8),helpstring("method is_dump_file_valid")] HRESULT is_dump_file_valid([out,retval] LONG *pVal);
// set up logfile to write conversion traces
[id(9), helpstring("method set_logfile")] HRESULT set_logfile([in] BSTR file_name);
// specify file to load list of tables to convert (one table name per line)
[id(10), helpstring("method set_tabfile")] HRESULT set_tabfile([in] BSTR file_name);
// get/set MySQL server. It can be either network name or IP address.
// If you leave it empty, the local server is assumed.
[propget, id(11), helpstring("property host")] HRESULT host([out, retval] BSTR* pVal);
[propput, id(11), helpstring("property host")] HRESULT host([in] BSTR newVal);
// get/set how to process existing database (0 - overwrite
// the entire database, 1 - overwrite existing tables only,
// 2 - skip existing tables, 3 - merge
[propget, id(12), helpstring("property mode")] HRESULT mode([out, retval] LONG* pVal);
[propput, id(12), helpstring("property mode")] HRESULT mode([in] LONG newVal);
// get/set MySQL password
[propget, id(13), helpstring("property password")] HRESULT password([out, retval] BSTR* pVal);
[propput, id(13), helpstring("property password")] HRESULT password([in] BSTR newVal);
// get/set MySQL port. It is necessary to specify 'port' parameter only if it deffers
// from the default MySQL port 3306
[propget, id(14), helpstring("property port")] HRESULT port([out, retval] BSTR* pVal);
[propput, id(14), helpstring("property port")] HRESULT port([in] BSTR newVal);
// get/set 'Convert table definitions only' property
[propget, id(15), helpstring("property tabdef_only")] HRESULT tabdef_only([out, retval] LONG* pVal);
[propput, id(15), helpstring("property tabdef_only")] HRESULT tabdef_only([in] LONG newVal);
// get/set MySQL user
[propget, id(16), helpstring("property user")] HRESULT user([out, retval] BSTR* pVal);
[propput, id(16), helpstring("property user")] HRESULT user([in] BSTR newVal);
};
You can also find definitions of all classes and interfaces mentioned above in file _ordecom.idl in the installation folder.