Win32::SqlServer::DTS::Task::DataPump - a Perl subclass of Win32::SqlServer::DTS::Task to represent a DTSDataPumpTask object
use warnings; use strict; use Win32::SqlServer::DTS::Application; use Test::More; use XML::Simple; my $xml = XML::Simple->new(); my $config = $xml->XMLin('test-config.xml'); my $app = Win32::SqlServer::DTS::Application->new( $config->{credential} ); my $package = $app->get_db_package( { id => '', version_id => '', name => $config->{package}, package_password => '' } ); my $iterator = $package->get_datapumps(); foreach my $datapump ( $iterator->() ) { print $datapump->to_string(), "\n"; }
Win32::SqlServer::DTS::Task::DataPump implements a convenient way to fetch properties from a DTS DataPumpTask Task object of a DTS Package.
Win32::SqlServer::DTS::Task::DataPump
Nothing.
A good amount of methods available in the original DTS API are available, including methods to access the properties. There are some methods that do not exists in the DTS API.
Overrided method from Win32::SqlServer::DTS::Task to define additional attributes during object creation. See Win32::SqlServer::DTS::Task::new method for more information.
Returns the value of DestinationConnectionID property.
Returns the value of DestinationObjectName property.
Returns the value of DestinationSQLStatement property.
Returns the value of SourceObjectName property.
Returns the value of SourceSQLStatement property.
Returns the value of SourceConnectionID property.
Returns the value of ProgressRowCount property.
Returns the value of RowsComplete property.
Returns the value of FetchBufferSize property.
Returns the value of FirstRow property.
Returns the value of ExceptionFileTextQualifier property.
Returns the value of InputGlobalVariablesNames property.
Returns the value of ExceptionFileName property.
Returns the value of InsertCommitSize property.
Returns the value of MaximumErrorCount property.
Returns true or false depending if errors, source, and destination exception rows are all written to a single ANSI file.
Returns true or false depending if source exception rows are written to the source exception file.
Returns true or false if error rows are written to a error file.
Returns true or false if data is overwritten, rather than appended, to file.
Returns true or false if termination of the data pump if execution logging fails is enable.
Returns true or false if destination exception rows are written to the destination exception file.
Returns true or false if the use of the FastLoad option (where rows are processed in batches under a single transaction commit) is enabled.
Returns true or false if the encoding of the log file is ANSI ASCII.
Returns true or false if the encoding of the log file is OEM.
Returns true or false if the encoding of the log file is Unicode (UTF-16LE).
Returns true or false if the DataPumpTask task will commit all successful batches including the final batch, even if the data pump terminates. Use this option to support restartability.
DataPumpTask
Strange as it may seen, this is called as Always commit final batch option in the DTS designer application, but receives the name DataPumpOptions property in the DTS API.
DataPumpOptions
Returns true or false if the datapump will check for the constrainst of the table before inserting new rows.
Returns true or false if the datapump will insert will insert NULL values from the data source into the destination.
Returns true or false if the datapump will lock the entire table instead using lock by page.
Returns true or false if Identity inserts will be used.
Returns a string with all attributes from the datapump object, separated by new line characters and with a short description of each attribute.
Returns a string or a list of Data Transformation Services (DTS) global variable names that are to be used as parameters in a query or created in a subpackage, depending on the context that the method is invoked.
The returned string is made of the global variable names separated by semi-colons characters.
Returns the number of source rows, including rows for which errors occurred, processed by the task or transformation set.
Returns the file name path where exception rows are written.
Returns the number of rows that are inserted in a single transaction when the FastLoad option is being used.
Returns the maximum number of error rows before the data pump terminates.
This class is incomplete. There are several properties not defined here that exists in the DTS API.
Win32::SqlServer::DTS::Task, the superclass from where Win32::SqlServer::DTS::Task::DataPump inherits, at perldoc.
perldoc
Win32::OLE at perldoc.
MSDN on Microsoft website and MS SQL Server 2000 Books Online are a reference about using DTS' object hierarchy, but one will need to convert examples written in VBScript to Perl code.
Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>
Copyright (C) 2006 by Alceu Rodrigues de Freitas Junior
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.
To install Win32::SqlServer::DTS, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Win32::SqlServer::DTS
CPAN shell
perl -MCPAN -e shell install Win32::SqlServer::DTS
For more information on module installation, please visit the detailed CPAN module installation guide.