summaryrefslogtreecommitdiff
path: root/contrib/oracle/ora2pg.html
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/oracle/ora2pg.html')
-rw-r--r--contrib/oracle/ora2pg.html480
1 files changed, 0 insertions, 480 deletions
diff --git a/contrib/oracle/ora2pg.html b/contrib/oracle/ora2pg.html
deleted file mode 100644
index 544ddcfae54..00000000000
--- a/contrib/oracle/ora2pg.html
+++ /dev/null
@@ -1,480 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>Ora2Pg - Oracle to PostgreSQL database schema converter</TITLE>
-<LINK REV="made" HREF="mailto:darold@localhost.localdomain">
-</HEAD>
-
-<BODY>
-
-<A NAME="__index__"></A>
-<!-- INDEX BEGIN -->
-
-<UL>
-
- <LI><A HREF="#name">NAME</A></LI>
- <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
- <LI><A HREF="#description">DESCRIPTION</A></LI>
- <LI><A HREF="#abstract">ABSTRACT</A></LI>
- <LI><A HREF="#requirement">REQUIREMENT</A></LI>
- <LI><A HREF="#public methods">PUBLIC METHODS</A></LI>
- <UL>
-
- <LI><A HREF="#new hash_options">new HASH_OPTIONS</A></LI>
- <LI><A HREF="#export_data filename">export_data FILENAME</A></LI>
- <LI><A HREF="#export_sql filename">export_sql FILENAME</A></LI>
- <LI><A HREF="#send_to_pgdb dest_datasrc dest_user dest_passwd">send_to_pgdb DEST_DATASRC DEST_USER DEST_PASSWD</A></LI>
- <LI><A HREF="#modify_struct table_name arrayof_fieldname">modify_struct TABLE_NAME ARRAYOF_FIELDNAME</A></LI>
- </UL>
-
- <LI><A HREF="#private methods">PRIVATE METHODS</A></LI>
- <UL>
-
- <LI><A HREF="#_init hash_options">_init HASH_OPTIONS</A></LI>
- <LI><A HREF="#_grants">_grants</A></LI>
- <LI><A HREF="#_sequences">_sequences</A></LI>
- <LI><A HREF="#_triggers">_triggers</A></LI>
- <LI><A HREF="#_functions">_functions</A></LI>
- <LI><A HREF="#_packages">_packages</A></LI>
- <LI><A HREF="#_tables">_tables</A></LI>
- <LI><A HREF="#_views">_views</A></LI>
- <LI><A HREF="#_get_sql_data">_get_sql_data</A></LI>
- <LI><A HREF="#_get_data table">_get_data TABLE</A></LI>
- <LI><A HREF="#_sql_type internal_type length precision scale">_sql_type INTERNAL_TYPE LENGTH PRECISION SCALE</A></LI>
- <LI><A HREF="#_column_info table">_column_info TABLE</A></LI>
- <LI><A HREF="#_primary_key table">_primary_key TABLE</A></LI>
- <LI><A HREF="#_unique_key table">_unique_key TABLE</A></LI>
- <LI><A HREF="#_foreign_key table">_foreign_key TABLE</A></LI>
- <LI><A HREF="#_get_users">_get_users</A></LI>
- <LI><A HREF="#_get_roles">_get_roles</A></LI>
- <LI><A HREF="#_get_all_grants">_get_all_grants</A></LI>
- <LI><A HREF="#_get_indexes table">_get_indexes TABLE</A></LI>
- <LI><A HREF="#_get_sequences">_get_sequences</A></LI>
- <LI><A HREF="#_get_views">_get_views</A></LI>
- <LI><A HREF="#_alias_info">_alias_info</A></LI>
- <LI><A HREF="#_get_triggers">_get_triggers</A></LI>
- <LI><A HREF="#_get_functions">_get_functions</A></LI>
- <LI><A HREF="#_get_packages">_get_packages</A></LI>
- <LI><A HREF="#_table_info">_table_info</A></LI>
- </UL>
-
- <LI><A HREF="#author">AUTHOR</A></LI>
- <LI><A HREF="#copyright">COPYRIGHT</A></LI>
- <LI><A HREF="#bugs">BUGS</A></LI>
- <LI><A HREF="#see also">SEE ALSO</A></LI>
- <LI><A HREF="#acknowledgements">ACKNOWLEDGEMENTS</A></LI>
-</UL>
-<!-- INDEX END -->
-
-<HR>
-<P>
-<H1><A NAME="name">NAME</A></H1>
-<P>Ora2Pg - Oracle to PostgreSQL database schema converter</P>
-<P>
-<HR>
-<H1><A NAME="synopsis">SYNOPSIS</A></H1>
-<PRE>
- BEGIN {
- $ENV{ORACLE_HOME} = '/usr/local/oracle/oracle816';
- }</PRE>
-<PRE>
- use strict;</PRE>
-<PRE>
- use Ora2Pg;</PRE>
-<PRE>
- # Init the database connection
- my $dbsrc = 'dbi:Oracle:host=testdb.samse.fr;sid=TEST;port=1521';
- my $dbuser = 'system';
- my $dbpwd = 'manager';</PRE>
-<PRE>
- # Create an instance of the Ora2Pg perl module
- my $schema = new Ora2Pg (
- datasource =&gt; $dbsrc, # Database DBD datasource
- user =&gt; $dbuser, # Database user
- password =&gt; $dbpwd, # Database password
- {
- PrintError =&gt; 0,
- RaiseError =&gt; 1,
- AutoCommit =&gt; 0
- }
- );</PRE>
-<PRE>
- # Create the POSTGRESQL representation of all objects in the database
- $schema-&gt;export_schema(&quot;output.sql&quot;);</PRE>
-<PRE>
- exit(0);</PRE>
-<P>or if you only want to extract some tables:</P>
-<PRE>
- # Create an instance of the Ora2Pg perl module
- my @tables = ('tab1', 'tab2', 'tab3');
- my $schema = new Ora2Pg (
- datasource =&gt; $dbsrc, # Database DBD datasource
- user =&gt; $dbuser, # Database user
- password =&gt; $dbpwd, # Database password
- tables =&gt; \@tables,
- or # Tables to extract
- tables =&gt; [('tab1','tab2')],
- debug =&gt; 1 # To show somethings when running
- );</PRE>
-<P>or if you only want to extract the 10 first tables:</P>
-<PRE>
- # Create an instance of the Ora2Pg perl module
- my $schema = new Ora2Pg (
- datasource =&gt; $dbsrc, # Database DBD datasource
- user =&gt; $dbuser, # Database user
- password =&gt; $dbpwd, # Database password
- max =&gt; 10 # 10 first tables to extract
- );</PRE>
-<P>or if you only want to extract tables 10 to 20:</P>
-<PRE>
- # Create an instance of the Ora2Pg perl module
- my $schema = new Ora2Pg (
- datasource =&gt; $dbsrc, # Database DBD datasource
- user =&gt; $dbuser, # Database user
- password =&gt; $dbpwd, # Database password
- min =&gt; 10, # Begin extraction at indice 10
- max =&gt; 20 # End extraction at indice 20
- );</PRE>
-<P>To choose a particular Oracle schema to export just set the following option
-to your schema name:</P>
-<PRE>
- schema =&gt; 'APPS'</PRE>
-<P>This schema definition can also be needed when you want to export data. If export
-failed and complain that the table doesn't exists use this to prefix the table name
-by the schema name.</P>
-<P>To know at which indices tables can be found during extraction use the option:</P>
-<PRE>
- showtableid =&gt; 1</PRE>
-<P>To extract all views set the type option as follow:</P>
-<PRE>
- type =&gt; 'VIEW'</PRE>
-<P>To extract all grants set the type option as follow:</P>
-<PRE>
- type =&gt; 'GRANT'</PRE>
-<P>To extract all sequences set the type option as follow:</P>
-<PRE>
- type =&gt; 'SEQUENCE'</PRE>
-<P>To extract all triggers set the type option as follow:</P>
-<PRE>
- type =&gt; 'TRIGGER'</PRE>
-<P>To extract all functions set the type option as follow:</P>
-<PRE>
- type =&gt; 'FUNCTION'</PRE>
-<P>To extract all procedures set the type option as follow:</P>
-<PRE>
- type =&gt; 'PROCEDURE'</PRE>
-<P>To extract all packages and body set the type option as follow:</P>
-<PRE>
- type =&gt; 'PACKAGE'</PRE>
-<P>Default is table extraction</P>
-<PRE>
- type =&gt; 'TABLE'</PRE>
-<P>To extract all data from table extraction as INSERT statement use:</P>
-<PRE>
- type =&gt; 'DATA'</PRE>
-<P>To extract all data from table extraction as COPY statement use:</P>
-<PRE>
- type =&gt; 'COPY'</PRE>
-<P>and data_limit =&gt; n to specify the max tuples to return. If you set
-this options to 0 or nothing, no limitation are used. Additional option
-'table', 'min' and 'max' can also be used.</P>
-<P>When use of COPY or DATA you can export data by calling method:</P>
-<P>$schema-&gt;export_data(``output.sql'');</P>
-<P>Data are dumped to the given filename or to STDOUT with no argument.
-You can also send these data directly to a PostgreSQL backend using
- the following method:</P>
-<P>$schema-&gt;send_to_pgdb($destdatasrc,$destuser,$destpasswd);</P>
-<P>In this case you must call <CODE>export_data()</CODE> without argument after the
-call to method send_to_pgdb().</P>
-<P>If you set type to COPY and you want to dump data directly to a PG database,
-you must call method send_to_pgdb but data will not be sent via DBD::Pg but
-they will be load to the database using the psql command. Calling this method
-is istill required to be able to extract database name, hostname and port
-information. Edit the $PSQL variable to match the path of your psql
-command (nothing to edit if psql is in your path).</P>
-<P>
-<HR>
-<H1><A NAME="description">DESCRIPTION</A></H1>
-<P>Ora2Pg is a perl OO module used to export an Oracle database schema
-to a PostgreSQL compatible schema.</P>
-<P>It simply connect to your Oracle database, extract its structure and
-generate a SQL script that you can load into your PostgreSQL database.</P>
-<P>I'm not a Oracle DBA so I don't really know something about its internal
-structure so you may find some incorrect things. Please tell me what is
-wrong and what can be better.</P>
-<P>It currently dump the database schema (tables, views, sequences, indexes, grants),
-with primary, unique and foreign keys into PostgreSQL syntax without editing the
-SQL code generated.</P>
-<P>It now can dump Oracle data into PostgreSQL DB as online process. You can choose
-what columns can be exported for each table.</P>
-<P>Functions, procedures and triggers PL/SQL code generated must be reviewed to match
-the PostgreSQL syntax. Some usefull recommandation on porting Oracle to PostgreSQL
-can be found at <A HREF="http://techdocs.postgresql.org/">http://techdocs.postgresql.org/</A> under the ``Converting from other
-Databases to PostgreSQL'' Oracle part. I just notice one thing more is that the
-<CODE>trunc()</CODE> function in Oracle is the same for number or date so be carefull when
-porting to PostgreSQL to use <CODE>trunc()</CODE> for number and <CODE>date_trunc()</CODE> for date.</P>
-<P>
-<HR>
-<H1><A NAME="abstract">ABSTRACT</A></H1>
-<P>The goal of the Ora2Pg perl module is to cover all part needed to export
-an Oracle database to a PostgreSQL database without other thing that provide
-the connection parameters to the Oracle database.</P>
-<P>Features must include:</P>
-<PRE>
- - Database schema export (tables, views, sequences, indexes),
- with unique, primary and foreign key.
- - Grants/privileges export by user and group.
- - Table selection (by name and max table) export.
- - Predefined functions/triggers/procedures/packages export.
- - Data export.
- - Sql query converter (todo)</PRE>
-<P>My knowledge regarding database is really poor especially for Oracle
-so contribution is welcome.</P>
-<P>
-<HR>
-<H1><A NAME="requirement">REQUIREMENT</A></H1>
-<P>You just need the DBI, DBD::Pg and DBD::Oracle perl module to be installed</P>
-<P>
-<HR>
-<H1><A NAME="public methods">PUBLIC METHODS</A></H1>
-<P>
-<H2><A NAME="new hash_options">new HASH_OPTIONS</A></H2>
-<P>Creates a new Ora2Pg object.</P>
-<P>Supported options are:</P>
-<PRE>
- - datasource : DBD datasource (required)
- - user : DBD user (optional with public access)
- - password : DBD password (optional with public access)
- - schema : Oracle internal schema to extract
- - type : Type of data to extract, can be TABLE,VIEW,GRANT,SEQUENCE,
- TRIGGER,FUNCTION,PROCEDURE,DATA,COPY,PACKAGE
- - debug : Print the current state of the parsing
- - tables : Extract only the given tables (arrayref)
- - showtableid : Display only the table indice during extraction
- - min : Indice to begin extraction. Default to 0
- - max : Indice to end extraction. Default to 0 mean no limits
- - data_limit : Number max of tuples to return during data extraction (default 10)</PRE>
-<P>Attempt that this list should grow a little more because all initialization is
-done by this way.</P>
-<P>
-<H2><A NAME="export_data filename">export_data FILENAME</A></H2>
-<P>Print SQL data output to a filename or
-to STDOUT if no file is given.</P>
-<P>Must be used only if type option is set to DATA or COPY
-=cut</P>
-<P>sub export_data
-{
- my ($self, $outfile) = @_;</P>
-<PRE>
- $self-&gt;_get_sql_data($outfile);
-}</PRE>
-<P>
-<H2><A NAME="export_sql filename">export_sql FILENAME</A></H2>
-<P>Print SQL conversion output to a filename or
-simply return these data if no file is given.</P>
-<P>
-<H2><A NAME="send_to_pgdb dest_datasrc dest_user dest_passwd">send_to_pgdb DEST_DATASRC DEST_USER DEST_PASSWD</A></H2>
-<P>Open a DB handle to a PostgreSQL database</P>
-<P>
-<H2><A NAME="modify_struct table_name arrayof_fieldname">modify_struct TABLE_NAME ARRAYOF_FIELDNAME</A></H2>
-<P>Modify a table structure during export. Only given fieldname
-will be exported.</P>
-<P>
-<HR>
-<H1><A NAME="private methods">PRIVATE METHODS</A></H1>
-<P>
-<H2><A NAME="_init hash_options">_init HASH_OPTIONS</A></H2>
-<P>Initialize a Ora2Pg object instance with a connexion to the
-Oracle database.</P>
-<P>
-<H2><A NAME="_grants">_grants</A></H2>
-<P>This function is used to retrieve all privilege information.</P>
-<P>It extract all Oracle's ROLES to convert them as Postgres groups
-and search all users associated to these roles.</P>
-<P>Set the main hash $self-&gt;{groups}.
-Set the main hash $self-&gt;{grantss}.</P>
-<P>
-<H2><A NAME="_sequences">_sequences</A></H2>
-<P>This function is used to retrieve all sequences information.</P>
-<P>Set the main hash $self-&gt;{sequences}.</P>
-<P>
-<H2><A NAME="_triggers">_triggers</A></H2>
-<P>This function is used to retrieve all triggers information.</P>
-<P>Set the main hash $self-&gt;{triggers}.</P>
-<P>
-<H2><A NAME="_functions">_functions</A></H2>
-<P>This function is used to retrieve all functions information.</P>
-<P>Set the main hash $self-&gt;{functions}.</P>
-<P>
-<H2><A NAME="_packages">_packages</A></H2>
-<P>This function is used to retrieve all packages information.</P>
-<P>Set the main hash $self-&gt;{packages}.</P>
-<P>
-<H2><A NAME="_tables">_tables</A></H2>
-<P>This function is used to retrieve all table information.</P>
-<P>Set the main hash of the database structure $self-&gt;{tables}.
-Keys are the names of all tables retrieved from the current
-database. Each table information compose an array associated
-to the table_info key as array reference. In other way:</P>
-<PRE>
- $self-&gt;{tables}{$class_name}{table_info} = [(OWNER,TYPE)];</PRE>
-<P>DBI TYPE can be TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY,
-ALIAS, SYNONYM or a data source specific type identifier. This only extract
-TABLE type.</P>
-<P>It also get the following informations in the DBI object to affect the
-main hash of the database structure :</P>
-<PRE>
- $self-&gt;{tables}{$class_name}{field_name} = $sth-&gt;{NAME};
- $self-&gt;{tables}{$class_name}{field_type} = $sth-&gt;{TYPE};</PRE>
-<P>It also call these other private subroutine to affect the main hash
-of the database structure :</P>
-<PRE>
- @{$self-&gt;{tables}{$class_name}{column_info}} = $self-&gt;_column_info($class_name);
- @{$self-&gt;{tables}{$class_name}{primary_key}} = $self-&gt;_primary_key($class_name);
- @{$self-&gt;{tables}{$class_name}{unique_key}} = $self-&gt;_unique_key($class_name);
- @{$self-&gt;{tables}{$class_name}{foreign_key}} = $self-&gt;_foreign_key($class_name);</PRE>
-<P>
-<H2><A NAME="_views">_views</A></H2>
-<P>This function is used to retrieve all views information.</P>
-<P>Set the main hash of the views definition $self-&gt;{views}.
-Keys are the names of all views retrieved from the current
-database values are the text definition of the views.</P>
-<P>It then set the main hash as follow:</P>
-<PRE>
- # Definition of the view
- $self-&gt;{views}{$table}{text} = $view_infos{$table};</PRE>
-<P>
-<H2><A NAME="_get_sql_data">_get_sql_data</A></H2>
-<P>Returns a string containing the entire SQL Schema definition compatible with PostgreSQL</P>
-<P>
-<H2><A NAME="_get_data table">_get_data TABLE</A></H2>
-<P>This function implements a Oracle-native data extraction.</P>
-<P>Return a list of array reference containing the data</P>
-<P>
-<H2><A NAME="_sql_type internal_type length precision scale">_sql_type INTERNAL_TYPE LENGTH PRECISION SCALE</A></H2>
-<P>This function return the PostgreSQL datatype corresponding to the
-Oracle internal type.</P>
-<P>
-<H2><A NAME="_column_info table">_column_info TABLE</A></H2>
-<P>This function implements a Oracle-native column information.</P>
-<P>Return a list of array reference containing the following informations
-for each column the given a table</P>
-<P>[(
- column name,
- column type,
- column length,
- nullable column,
- default value
-)]</P>
-<P>
-<H2><A NAME="_primary_key table">_primary_key TABLE</A></H2>
-<P>This function implements a Oracle-native primary key column
-information.</P>
-<P>Return a list of all column name defined as primary key
-for the given table.</P>
-<P>
-<H2><A NAME="_unique_key table">_unique_key TABLE</A></H2>
-<P>This function implements a Oracle-native unique key column
-information.</P>
-<P>Return a list of all column name defined as unique key
-for the given table.</P>
-<P>
-<H2><A NAME="_foreign_key table">_foreign_key TABLE</A></H2>
-<P>This function implements a Oracle-native foreign key reference
-information.</P>
-<P>Return a list of hash of hash of array reference. Ouuf! Nothing very difficult.
-The first hash is composed of all foreign key name. The second hash just have
-two key known as 'local' and remote' corresponding to the local table where the
-foreign key is defined and the remote table where the key refer.</P>
-<P>The foreign key name is composed as follow:</P>
-<PRE>
- 'local_table_name-&gt;remote_table_name'</PRE>
-<P>Foreign key data consist in two array representing at the same indice the local
-field and the remote field where the first one refer to the second.
-Just like this:</P>
-<PRE>
- @{$link{$fkey_name}{local}} = @local_columns;
- @{$link{$fkey_name}{remote}} = @remote_columns;</PRE>
-<P>
-<H2><A NAME="_get_users">_get_users</A></H2>
-<P>This function implements a Oracle-native users information.</P>
-<P>Return a hash of all users as an array.</P>
-<P>
-<H2><A NAME="_get_roles">_get_roles</A></H2>
-<P>This function implements a Oracle-native roles
-information.</P>
-<P>Return a hash of all groups (roles) as an array of associated users.</P>
-<P>
-<H2><A NAME="_get_all_grants">_get_all_grants</A></H2>
-<P>This function implements a Oracle-native user privilege
-information.</P>
-<P>Return a hash of all tables grants as an array of associated users.</P>
-<P>
-<H2><A NAME="_get_indexes table">_get_indexes TABLE</A></H2>
-<P>This function implements a Oracle-native indexes information.</P>
-<P>Return hash of array containing all unique index and a hash of
-array of all indexes name which are not primary keys for the
-given table.</P>
-<P>
-<H2><A NAME="_get_sequences">_get_sequences</A></H2>
-<P>This function implements a Oracle-native sequences
-information.</P>
-<P>Return a hash of array of sequence name with MIN_VALUE, MAX_VALUE,
-INCREMENT and LAST_NUMBER for the given table.</P>
-<P>
-<H2><A NAME="_get_views">_get_views</A></H2>
-<P>This function implements a Oracle-native views information.</P>
-<P>Return a hash of view name with the SQL query it is based on.</P>
-<P>
-<H2><A NAME="_alias_info">_alias_info</A></H2>
-<P>This function implements a Oracle-native column information.</P>
-<P>Return a list of array reference containing the following informations
-for each alias of the given view</P>
-<P>[(
- column name,
- column id
-)]</P>
-<P>
-<H2><A NAME="_get_triggers">_get_triggers</A></H2>
-<P>This function implements a Oracle-native triggers information.</P>
-<P>Return an array of refarray of all triggers informations</P>
-<P>
-<H2><A NAME="_get_functions">_get_functions</A></H2>
-<P>This function implements a Oracle-native functions information.</P>
-<P>Return a hash of all function name with their PLSQL code</P>
-<P>
-<H2><A NAME="_get_packages">_get_packages</A></H2>
-<P>This function implements a Oracle-native packages information.</P>
-<P>Return a hash of all function name with their PLSQL code</P>
-<P>
-<H2><A NAME="_table_info">_table_info</A></H2>
-<P>This function retrieve all Oracle-native tables information.</P>
-<P>Return a handle to a DB query statement</P>
-<P>
-<HR>
-<H1><A NAME="author">AUTHOR</A></H1>
-<P>Gilles Darold &lt;<A HREF="mailto:gilles@darold.net">gilles@darold.net</A>&gt;</P>
-<P>
-<HR>
-<H1><A NAME="copyright">COPYRIGHT</A></H1>
-<P>Copyright (c) 2001 Gilles Darold - All rights reserved.</P>
-<P>This program is free software; you can redistribute it and/or modify it under
-the same terms as Perl itself.</P>
-<P>
-<HR>
-<H1><A NAME="bugs">BUGS</A></H1>
-<P>This perl module is in the same state as my knowledge regarding database,
-it can move and not be compatible with older version so I will do my best
-to give you official support for Ora2Pg. Your volontee to help construct
-it and your contribution are welcome.</P>
-<P>
-<HR>
-<H1><A NAME="see also">SEE ALSO</A></H1>
-<P><EM>DBI</EM>, <A HREF="/DBD/Oracle.html">the DBD::Oracle manpage</A>, <A HREF="/DBD/Pg.html">the DBD::Pg manpage</A></P>
-<P>
-<HR>
-<H1><A NAME="acknowledgements">ACKNOWLEDGEMENTS</A></H1>
-<P>Thanks to Jason Servetar who decided me to implement data extraction.</P>
-
-</BODY>
-
-</HTML>