Changeset 9330

Timestamp:

04/11/08 20:32:36 (5 years ago)

Author:

kazuho

Message:

update pod

Files:

• lang/perl/DBIx-Replicate/trunk/lib/DBIx/Replicate.pm (modified) (3 diffs)

lang/perl/DBIx-Replicate/trunk/lib/DBIx/Replicate.pm

@@ -119 +119 @@
     dest_table   => 'tbl',
     copy_by      => [ qw/zipcode/ ],
+    load         => 0.5,
   });
   
@@ -131 +132 @@
     block        => 1000,
     extra_cond   => 'age<20',
+    load         => 0.1,
   });
 
@@ -144 +146 @@
 =head1 DESCRIPTION
 
-...
+DBIx::Replicate is a perl module that incrementally copies SQL tables using C<DBI> connections.  The granuality and speed of the copy can be controlled.
+
+=head1 FUNCTIONS
+
+=head2 dbi_replicate
+
+A functional interface of DBIx::Replicate.  Accepts following parameters through a hashref argument.
+
+=head3 src_conn
+
+C<DBI> connection to source database
+
+=head3 src_table
+
+name of the source table (mandatory)
+
+=head3 dest_conn
+
+C<DBI> connection to destination database (mandatory)
+
+=head3 dest_table
+
+name of the destination table (mandatory)
+
+=head3 columns
+
+an arrayref containing the name of columns to be copied (mandatory)
+
+=head3 extra_cond
+
+sql expression to filter rows to be copied (optional)
+
+=head3 load
+
+load average for the copy operation (optional).  The value should be greater than 0 and less or equal to 1.
+
+=head3 copy_by
+
+optionally takes an arrayref of column names.  If given, C<DBIx::Replicate::Strategy::CopyBy> will be used for copying tables.  The strategy repeatedly copies a set of rows that contain identical values in the specified columns.
+
+=head3 primary_key
+
+optionally takes an arrayref of primary key column names.  If given, C<DBIx::Replicate::Strategy::PK> will be used for copying tables.  The strategy copies certain number of rows at once specified by parameter C<block>, in the order sorted by C<primary_key>.
+
+=head3 block
+
+used together with C<primary_key> to specify the number of rows copied at once
 
 =head1 AUTHOR