| Current File : /home/mmdealscpanel/yummmdeals.com/DBI.zip |
PK V`[B�2� � ProfileDumper/Apache.pmnu �[��� package DBI::ProfileDumper::Apache;
use strict;
=head1 NAME
DBI::ProfileDumper::Apache - capture DBI profiling data from Apache/mod_perl
=head1 SYNOPSIS
Add this line to your F<httpd.conf>:
PerlSetEnv DBI_PROFILE 2/DBI::ProfileDumper::Apache
(If you're using mod_perl2, see L</When using mod_perl2> for some additional notes.)
Then restart your server. Access the code you wish to test using a
web browser, then shutdown your server. This will create a set of
F<dbi.prof.*> files in your Apache log directory.
Get a profiling report with L<dbiprof|dbiprof>:
dbiprof /path/to/your/apache/logs/dbi.prof.*
When you're ready to perform another profiling run, delete the old files and start again.
=head1 DESCRIPTION
This module interfaces DBI::ProfileDumper to Apache/mod_perl. Using
this module you can collect profiling data from mod_perl applications.
It works by creating a DBI::ProfileDumper data file for each Apache
process. These files are created in your Apache log directory. You
can then use the dbiprof utility to analyze the profile files.
=head1 USAGE
=head2 LOADING THE MODULE
The easiest way to use this module is just to set the DBI_PROFILE
environment variable in your F<httpd.conf>:
PerlSetEnv DBI_PROFILE 2/DBI::ProfileDumper::Apache
The DBI will look after loading and using the module when the first DBI handle
is created.
It's also possible to use this module by setting the Profile attribute
of any DBI handle:
$dbh->{Profile} = "2/DBI::ProfileDumper::Apache";
See L<DBI::ProfileDumper> for more possibilities, and L<DBI::Profile> for full
details of the DBI's profiling mechanism.
=head2 WRITING PROFILE DATA
The profile data files will be written to your Apache log directory by default.
The user that the httpd processes run as will need write access to the
directory. So, for example, if you're running the child httpds as user 'nobody'
and using chronolog to write to the logs directory, then you'll need to change
the default.
You can change the destination directory either by specifying a C<Dir> value
when creating the profile (like C<File> in the L<DBI::ProfileDumper> docs),
or you can use the C<DBI_PROFILE_APACHE_LOG_DIR> env var to change that. For example:
PerlSetEnv DBI_PROFILE_APACHE_LOG_DIR /server_root/logs
=head3 When using mod_perl2
Under mod_perl2 you'll need to either set the C<DBI_PROFILE_APACHE_LOG_DIR> env var,
or enable the mod_perl2 C<GlobalRequest> option, like this:
PerlOptions +GlobalRequest
to the global config section you're about test with DBI::ProfileDumper::Apache.
If you don't do one of those then you'll see messages in your error_log similar to:
DBI::ProfileDumper::Apache on_destroy failed: Global $r object is not available. Set:
PerlOptions +GlobalRequest in httpd.conf at ..../DBI/ProfileDumper/Apache.pm line 144
=head3 Naming the files
The default file name is inherited from L<DBI::ProfileDumper> via the
filename() method, but DBI::ProfileDumper::Apache appends the parent pid and
the current pid, separated by dots, to that name.
=head3 Silencing the log
By default a message is written to STDERR (i.e., the apache error_log file)
when flush_to_disk() is called (either explicitly, or implicitly via DESTROY).
That's usually very useful. If you don't want the log message you can silence
it by setting the C<Quiet> attribute true.
PerlSetEnv DBI_PROFILE 2/DBI::ProfileDumper::Apache/Quiet:1
$dbh->{Profile} = "!Statement/DBI::ProfileDumper/Quiet:1";
$dbh->{Profile} = DBI::ProfileDumper->new(
Path => [ '!Statement' ]
Quiet => 1
);
=head2 GATHERING PROFILE DATA
Once you have the module loaded, use your application as you normally
would. Stop the webserver when your tests are complete. Profile data
files will be produced when Apache exits and you'll see something like
this in your error_log:
DBI::ProfileDumper::Apache writing to /usr/local/apache/logs/dbi.prof.2604.2619
Now you can use dbiprof to examine the data:
dbiprof /usr/local/apache/logs/dbi.prof.2604.*
By passing dbiprof a list of all generated files, dbiprof will
automatically merge them into one result set. You can also pass
dbiprof sorting and querying options, see L<dbiprof> for details.
=head2 CLEANING UP
Once you've made some code changes, you're ready to start again.
First, delete the old profile data files:
rm /usr/local/apache/logs/dbi.prof.*
Then restart your server and get back to work.
=head1 OTHER ISSUES
=head2 Memory usage
DBI::Profile can use a lot of memory for very active applications because it
collects profiling data in memory for each distinct query run.
Calling C<flush_to_disk()> will write the current data to disk and free the
memory it's using. For example:
$dbh->{Profile}->flush_to_disk() if $dbh->{Profile};
or, rather than flush every time, you could flush less often:
$dbh->{Profile}->flush_to_disk()
if $dbh->{Profile} and ++$i % 100;
=head1 AUTHOR
Sam Tregar <sam@tregar.com>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2002 Sam Tregar
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl 5 itself.
=cut
our $VERSION = "2.014121";
our @ISA = qw(DBI::ProfileDumper);
use DBI::ProfileDumper;
use File::Spec;
my $initial_pid = $$;
use constant MP2 => ($ENV{MOD_PERL_API_VERSION} and $ENV{MOD_PERL_API_VERSION} == 2) ? 1 : 0;
my $server_root_dir;
if (MP2) {
require Apache2::ServerUtil;
$server_root_dir = Apache2::ServerUtil::server_root();
}
else {
require Apache;
$server_root_dir = eval { Apache->server_root_relative('') } || "/tmp";
}
sub _dirname {
my $self = shift;
return $self->{Dir} ||= $ENV{DBI_PROFILE_APACHE_LOG_DIR}
|| File::Spec->catdir($server_root_dir, "logs");
}
sub filename {
my $self = shift;
my $filename = $self->SUPER::filename(@_);
return $filename if not $filename; # not set yet
# to be able to identify groups of profile files from the same set of
# apache processes, we include the parent pid in the file name
# as well as the pid.
my $group_pid = ($$ eq $initial_pid) ? $$ : getppid();
$filename .= ".$group_pid.$$";
return $filename if File::Spec->file_name_is_absolute($filename);
return File::Spec->catfile($self->_dirname, $filename);
}
sub flush_to_disk {
my $self = shift;
my $filename = $self->SUPER::flush_to_disk(@_);
print STDERR ref($self)." pid$$ written to $filename\n"
if $filename && not $self->{Quiet};
return $filename;
}
1;
PK V`[Q�G� G� DBD/SqlEngine.pmnu �[��� # -*- perl -*-
#
# DBI::DBD::SqlEngine - A base class for implementing DBI drivers that
# have not an own SQL engine
#
# This module is currently maintained by
#
# H.Merijn Brand & Jens Rehsack
#
# The original author is Jochen Wiedmann.
#
# Copyright (C) 2009-2013 by H.Merijn Brand & Jens Rehsack
# Copyright (C) 2004 by Jeff Zucker
# Copyright (C) 1998 by Jochen Wiedmann
#
# All rights reserved.
#
# You may distribute this module under the terms of either the GNU
# General Public License or the Artistic License, as specified in
# the Perl README file.
require 5.008;
use strict;
use DBI ();
require DBI::SQL::Nano;
package DBI::DBD::SqlEngine;
use strict;
use Carp;
use vars qw( @ISA $VERSION $drh %methods_installed);
$VERSION = "0.06";
$drh = undef; # holds driver handle(s) once initialized
DBI->setup_driver("DBI::DBD::SqlEngine"); # only needed once but harmless to repeat
my %accessors = (
versions => "get_driver_versions",
new_meta => "new_sql_engine_meta",
get_meta => "get_sql_engine_meta",
set_meta => "set_sql_engine_meta",
clear_meta => "clear_sql_engine_meta",
);
sub driver ($;$)
{
my ( $class, $attr ) = @_;
# Drivers typically use a singleton object for the $drh
# We use a hash here to have one singleton per subclass.
# (Otherwise DBD::CSV and DBD::DBM, for example, would
# share the same driver object which would cause problems.)
# An alternative would be to not cache the $drh here at all
# and require that subclasses do that. Subclasses should do
# their own caching, so caching here just provides extra safety.
$drh->{$class} and return $drh->{$class};
$attr ||= {};
{
no strict "refs";
unless ( $attr->{Attribution} )
{
$class eq "DBI::DBD::SqlEngine"
and $attr->{Attribution} = "$class by Jens Rehsack";
$attr->{Attribution} ||= ${ $class . "::ATTRIBUTION" }
|| "oops the author of $class forgot to define this";
}
$attr->{Version} ||= ${ $class . "::VERSION" };
$attr->{Name} or ( $attr->{Name} = $class ) =~ s/^DBD\:\://;
}
$drh->{$class} = DBI::_new_drh( $class . "::dr", $attr );
$drh->{$class}->STORE( ShowErrorStatement => 1 );
my $prefix = DBI->driver_prefix($class);
if ($prefix)
{
my $dbclass = $class . "::db";
while ( my ( $accessor, $funcname ) = each %accessors )
{
my $method = $prefix . $accessor;
$dbclass->can($method) and next;
my $inject = sprintf <<'EOI', $dbclass, $method, $dbclass, $funcname;
sub %s::%s
{
my $func = %s->can (q{%s});
goto &$func;
}
EOI
eval $inject;
$dbclass->install_method($method);
}
}
else
{
warn "Using DBI::DBD::SqlEngine with unregistered driver $class.\n"
. "Reading documentation how to prevent is strongly recommended.\n";
}
# XXX inject DBD::XXX::Statement unless exists
my $stclass = $class . "::st";
$stclass->install_method("sql_get_colnames") unless ( $methods_installed{__PACKAGE__}++ );
return $drh->{$class};
} # driver
sub CLONE
{
undef $drh;
} # CLONE
# ====== DRIVER ================================================================
package DBI::DBD::SqlEngine::dr;
use strict;
use warnings;
use vars qw(@ISA $imp_data_size);
use Carp qw/carp/;
$imp_data_size = 0;
sub connect ($$;$$$)
{
my ( $drh, $dbname, $user, $auth, $attr ) = @_;
# create a 'blank' dbh
my $dbh = DBI::_new_dbh(
$drh,
{
Name => $dbname,
USER => $user,
CURRENT_USER => $user,
}
);
if ($dbh)
{
# must be done first, because setting flags implicitly calls $dbdname::db->STORE
$dbh->func( 0, "init_default_attributes" );
my $two_phased_init;
defined $dbh->{sql_init_phase} and $two_phased_init = ++$dbh->{sql_init_phase};
my %second_phase_attrs;
my @func_inits;
# this must be done to allow DBI.pm reblessing got handle after successful connecting
exists $attr->{RootClass} and $second_phase_attrs{RootClass} = delete $attr->{RootClass};
my ( $var, $val );
while ( length $dbname )
{
if ( $dbname =~ s/^((?:[^\\;]|\\.)*?);//s )
{
$var = $1;
}
else
{
$var = $dbname;
$dbname = "";
}
if ( $var =~ m/^(.+?)=(.*)/s )
{
$var = $1;
( $val = $2 ) =~ s/\\(.)/$1/g;
exists $attr->{$var}
and carp("$var is given in DSN *and* \$attr during DBI->connect()")
if ($^W);
exists $attr->{$var} or $attr->{$var} = $val;
}
elsif ( $var =~ m/^(.+?)=>(.*)/s )
{
$var = $1;
( $val = $2 ) =~ s/\\(.)/$1/g;
my $ref = eval $val;
# $dbh->$var($ref);
push( @func_inits, $var, $ref );
}
}
# The attributes need to be sorted in a specific way as the
# assignment is through tied hashes and calls STORE on each
# attribute. Some attributes require to be called prior to
# others
# e.g. f_dir *must* be done before xx_tables in DBD::File
# The dbh attribute sql_init_order is a hash with the order
# as key (low is first, 0 .. 100) and the attributes that
# are set to that oreder as anon-list as value:
# { 0 => [qw( AutoCommit PrintError RaiseError Profile ... )],
# 10 => [ list of attr to be dealt with immediately after first ],
# 50 => [ all fields that are unspecified or default sort order ],
# 90 => [ all fields that are needed after other initialisation ],
# }
my %order = map {
my $order = $_;
map { ( $_ => $order ) } @{ $dbh->{sql_init_order}{$order} };
} sort { $a <=> $b } keys %{ $dbh->{sql_init_order} || {} };
my @ordered_attr =
map { $_->[0] }
sort { $a->[1] <=> $b->[1] }
map { [ $_, defined $order{$_} ? $order{$_} : 50 ] }
keys %$attr;
# initialize given attributes ... lower weighted before higher weighted
foreach my $a (@ordered_attr)
{
exists $attr->{$a} or next;
$two_phased_init and eval {
$dbh->{$a} = $attr->{$a};
delete $attr->{$a};
};
$@ and $second_phase_attrs{$a} = delete $attr->{$a};
$two_phased_init or $dbh->STORE( $a, delete $attr->{$a} );
}
$two_phased_init and $dbh->func( 1, "init_default_attributes" );
%$attr = %second_phase_attrs;
for ( my $i = 0; $i < scalar(@func_inits); $i += 2 )
{
my $func = $func_inits[$i];
my $arg = $func_inits[ $i + 1 ];
$dbh->$func($arg);
}
$dbh->func("init_done");
$dbh->STORE( Active => 1 );
}
return $dbh;
} # connect
sub data_sources ($;$)
{
my ( $drh, $attr ) = @_;
my $tbl_src;
$attr
and defined $attr->{sql_table_source}
and $attr->{sql_table_source}->isa('DBI::DBD::SqlEngine::TableSource')
and $tbl_src = $attr->{sql_table_source};
!defined($tbl_src)
and $drh->{ImplementorClass}->can('default_table_source')
and $tbl_src = $drh->{ImplementorClass}->default_table_source();
defined($tbl_src) or return;
$tbl_src->data_sources( $drh, $attr );
} # data_sources
sub disconnect_all
{
} # disconnect_all
sub DESTROY
{
undef;
} # DESTROY
# ====== DATABASE ==============================================================
package DBI::DBD::SqlEngine::db;
use strict;
use warnings;
use vars qw(@ISA $imp_data_size);
use Carp;
if ( eval { require Clone; } )
{
Clone->import("clone");
}
else
{
require Storable; # in CORE since 5.7.3
*clone = \&Storable::dclone;
}
$imp_data_size = 0;
sub ping
{
( $_[0]->FETCH("Active") ) ? 1 : 0;
} # ping
sub data_sources
{
my ( $dbh, $attr, @other ) = @_;
my $drh = $dbh->{Driver}; # XXX proxy issues?
ref($attr) eq 'HASH' or $attr = {};
defined( $attr->{sql_table_source} ) or $attr->{sql_table_source} = $dbh->{sql_table_source};
return $drh->data_sources( $attr, @other );
}
sub prepare ($$;@)
{
my ( $dbh, $statement, @attribs ) = @_;
# create a 'blank' sth
my $sth = DBI::_new_sth( $dbh, { Statement => $statement } );
if ($sth)
{
my $class = $sth->FETCH("ImplementorClass");
$class =~ s/::st$/::Statement/;
my $stmt;
# if using SQL::Statement version > 1
# cache the parser object if the DBD supports parser caching
# SQL::Nano and older SQL::Statements don't support this
if ( $class->isa("SQL::Statement") )
{
my $parser = $dbh->{sql_parser_object};
$parser ||= eval { $dbh->func("sql_parser_object") };
if ($@)
{
$stmt = eval { $class->new($statement) };
}
else
{
$stmt = eval { $class->new( $statement, $parser ) };
}
}
else
{
$stmt = eval { $class->new($statement) };
}
if ( $@ || $stmt->{errstr} )
{
$dbh->set_err( $DBI::stderr, $@ || $stmt->{errstr} );
undef $sth;
}
else
{
$sth->STORE( "sql_stmt", $stmt );
$sth->STORE( "sql_params", [] );
$sth->STORE( "NUM_OF_PARAMS", scalar( $stmt->params() ) );
my @colnames = $sth->sql_get_colnames();
$sth->STORE( "NUM_OF_FIELDS", scalar @colnames );
}
}
return $sth;
} # prepare
sub set_versions
{
my $dbh = $_[0];
$dbh->{sql_engine_version} = $DBI::DBD::SqlEngine::VERSION;
for (qw( nano_version statement_version ))
{
defined $DBI::SQL::Nano::versions->{$_} or next;
$dbh->{"sql_$_"} = $DBI::SQL::Nano::versions->{$_};
}
$dbh->{sql_handler} =
$dbh->{sql_statement_version}
? "SQL::Statement"
: "DBI::SQL::Nano";
return $dbh;
} # set_versions
sub init_valid_attributes
{
my $dbh = $_[0];
$dbh->{sql_valid_attrs} = {
sql_engine_version => 1, # DBI::DBD::SqlEngine version
sql_handler => 1, # Nano or S:S
sql_nano_version => 1, # Nano version
sql_statement_version => 1, # S:S version
sql_flags => 1, # flags for SQL::Parser
sql_dialect => 1, # dialect for SQL::Parser
sql_quoted_identifier_case => 1, # case for quoted identifiers
sql_identifier_case => 1, # case for non-quoted identifiers
sql_parser_object => 1, # SQL::Parser instance
sql_sponge_driver => 1, # Sponge driver for table_info ()
sql_valid_attrs => 1, # SQL valid attributes
sql_readonly_attrs => 1, # SQL readonly attributes
sql_init_phase => 1, # Only during initialization
sql_meta => 1, # meta data for tables
sql_meta_map => 1, # mapping table for identifier case
sql_data_source => 1, # reasonable datasource class
};
$dbh->{sql_readonly_attrs} = {
sql_engine_version => 1, # DBI::DBD::SqlEngine version
sql_handler => 1, # Nano or S:S
sql_nano_version => 1, # Nano version
sql_statement_version => 1, # S:S version
sql_quoted_identifier_case => 1, # case for quoted identifiers
sql_parser_object => 1, # SQL::Parser instance
sql_sponge_driver => 1, # Sponge driver for table_info ()
sql_valid_attrs => 1, # SQL valid attributes
sql_readonly_attrs => 1, # SQL readonly attributes
};
return $dbh;
} # init_valid_attributes
sub init_default_attributes
{
my ( $dbh, $phase ) = @_;
my $given_phase = $phase;
unless ( defined($phase) )
{
# we have an "old" driver here
$phase = defined $dbh->{sql_init_phase};
$phase and $phase = $dbh->{sql_init_phase};
}
if ( 0 == $phase )
{
# must be done first, because setting flags implicitly calls $dbdname::db->STORE
$dbh->func("init_valid_attributes");
$dbh->func("set_versions");
$dbh->{sql_identifier_case} = 2; # SQL_IC_LOWER
$dbh->{sql_quoted_identifier_case} = 3; # SQL_IC_SENSITIVE
$dbh->{sql_dialect} = "CSV";
$dbh->{sql_init_phase} = $given_phase;
# complete derived attributes, if required
( my $drv_class = $dbh->{ImplementorClass} ) =~ s/::db$//;
my $drv_prefix = DBI->driver_prefix($drv_class);
my $valid_attrs = $drv_prefix . "valid_attrs";
my $ro_attrs = $drv_prefix . "readonly_attrs";
# check whether we're running in a Gofer server or not (see
# validate_FETCH_attr for details)
$dbh->{sql_engine_in_gofer} =
( defined $INC{"DBD/Gofer.pm"} && ( caller(5) )[0] eq "DBI::Gofer::Execute" );
$dbh->{sql_meta} = {};
$dbh->{sql_meta_map} = {}; # choose new name because it contains other keys
# init_default_attributes calls inherited routine before derived DBD's
# init their default attributes, so we don't override something here
#
# defining an order of attribute initialization from connect time
# specified ones with a magic baarier (see next statement)
my $drv_pfx_meta = $drv_prefix . "meta";
$dbh->{sql_init_order} = {
0 => [qw( Profile RaiseError PrintError AutoCommit )],
90 => [ "sql_meta", $dbh->{$drv_pfx_meta} ? $dbh->{$drv_pfx_meta} : () ],
};
# ensuring Profile, RaiseError, PrintError, AutoCommit are initialized
# first when initializing attributes from connect time specified
# attributes
# further, initializations to predefined tables are happens after any
# unspecified attribute initialization (that default to order 50)
my @comp_attrs = qw(valid_attrs version readonly_attrs);
if ( exists $dbh->{$drv_pfx_meta} and !$dbh->{sql_engine_in_gofer} )
{
my $attr = $dbh->{$drv_pfx_meta};
defined $attr
and defined $dbh->{$valid_attrs}
and !defined $dbh->{$valid_attrs}{$attr}
and $dbh->{$valid_attrs}{$attr} = 1;
my %h;
tie %h, "DBI::DBD::SqlEngine::TieTables", $dbh;
$dbh->{$attr} = \%h;
push @comp_attrs, "meta";
}
foreach my $comp_attr (@comp_attrs)
{
my $attr = $drv_prefix . $comp_attr;
defined $dbh->{$valid_attrs}
and !defined $dbh->{$valid_attrs}{$attr}
and $dbh->{$valid_attrs}{$attr} = 1;
defined $dbh->{$ro_attrs}
and !defined $dbh->{$ro_attrs}{$attr}
and $dbh->{$ro_attrs}{$attr} = 1;
}
}
return $dbh;
} # init_default_attributes
sub init_done
{
defined $_[0]->{sql_init_phase} and delete $_[0]->{sql_init_phase};
delete $_[0]->{sql_valid_attrs}->{sql_init_phase};
return;
}
sub sql_parser_object
{
my $dbh = $_[0];
my $dialect = $dbh->{sql_dialect} || "CSV";
my $parser = {
RaiseError => $dbh->FETCH("RaiseError"),
PrintError => $dbh->FETCH("PrintError"),
};
my $sql_flags = $dbh->FETCH("sql_flags") || {};
%$parser = ( %$parser, %$sql_flags );
$parser = SQL::Parser->new( $dialect, $parser );
$dbh->{sql_parser_object} = $parser;
return $parser;
} # sql_parser_object
sub sql_sponge_driver
{
my $dbh = $_[0];
my $dbh2 = $dbh->{sql_sponge_driver};
unless ($dbh2)
{
$dbh2 = $dbh->{sql_sponge_driver} = DBI->connect("DBI:Sponge:");
unless ($dbh2)
{
$dbh->set_err( $DBI::stderr, $DBI::errstr );
return;
}
}
}
sub disconnect ($)
{
%{ $_[0]->{sql_meta} } = ();
%{ $_[0]->{sql_meta_map} } = ();
$_[0]->STORE( Active => 0 );
return 1;
} # disconnect
sub validate_FETCH_attr
{
my ( $dbh, $attrib ) = @_;
# If running in a Gofer server, access to our tied compatibility hash
# would force Gofer to serialize the tieing object including it's
# private $dbh reference used to do the driver function calls.
# This will result in nasty exceptions. So return a copy of the
# sql_meta structure instead, which is the source of for the compatibility
# tie-hash. It's not as good as liked, but the best we can do in this
# situation.
if ( $dbh->{sql_engine_in_gofer} )
{
( my $drv_class = $dbh->{ImplementorClass} ) =~ s/::db$//;
my $drv_prefix = DBI->driver_prefix($drv_class);
exists $dbh->{ $drv_prefix . "meta" } && $attrib eq $dbh->{ $drv_prefix . "meta" }
and $attrib = "sql_meta";
}
return $attrib;
}
sub FETCH ($$)
{
my ( $dbh, $attrib ) = @_;
$attrib eq "AutoCommit"
and return 1;
# Driver private attributes are lower cased
if ( $attrib eq ( lc $attrib ) )
{
# first let the implementation deliver an alias for the attribute to fetch
# after it validates the legitimation of the fetch request
$attrib = $dbh->func( $attrib, "validate_FETCH_attr" ) or return;
my $attr_prefix;
$attrib =~ m/^([a-z]+_)/ and $attr_prefix = $1;
unless ($attr_prefix)
{
( my $drv_class = $dbh->{ImplementorClass} ) =~ s/::db$//;
$attr_prefix = DBI->driver_prefix($drv_class);
$attrib = $attr_prefix . $attrib;
}
my $valid_attrs = $attr_prefix . "valid_attrs";
my $ro_attrs = $attr_prefix . "readonly_attrs";
exists $dbh->{$valid_attrs}
and ( $dbh->{$valid_attrs}{$attrib}
or return $dbh->set_err( $DBI::stderr, "Invalid attribute '$attrib'" ) );
exists $dbh->{$ro_attrs}
and $dbh->{$ro_attrs}{$attrib}
and defined $dbh->{$attrib}
and refaddr( $dbh->{$attrib} )
and return clone( $dbh->{$attrib} );
return $dbh->{$attrib};
}
# else pass up to DBI to handle
return $dbh->SUPER::FETCH($attrib);
} # FETCH
sub validate_STORE_attr
{
my ( $dbh, $attrib, $value ) = @_;
if ( $attrib eq "sql_identifier_case" || $attrib eq "sql_quoted_identifier_case"
and $value < 1 || $value > 4 )
{
croak "attribute '$attrib' must have a value from 1 .. 4 (SQL_IC_UPPER .. SQL_IC_MIXED)";
# XXX correctly a remap of all entries in sql_meta/sql_meta_map is required here
}
( my $drv_class = $dbh->{ImplementorClass} ) =~ s/::db$//;
my $drv_prefix = DBI->driver_prefix($drv_class);
exists $dbh->{ $drv_prefix . "meta" }
and $attrib eq $dbh->{ $drv_prefix . "meta" }
and $attrib = "sql_meta";
return ( $attrib, $value );
}
# the ::db::STORE method is what gets called when you set
# a lower-cased database handle attribute such as $dbh->{somekey}=$someval;
#
# STORE should check to make sure that "somekey" is a valid attribute name
# but only if it is really one of our attributes (starts with dbm_ or foo_)
# You can also check for valid values for the attributes if needed
# and/or perform other operations
#
sub STORE ($$$)
{
my ( $dbh, $attrib, $value ) = @_;
if ( $attrib eq "AutoCommit" )
{
$value and return 1; # is already set
croak "Can't disable AutoCommit";
}
if ( $attrib eq lc $attrib )
{
# Driver private attributes are lower cased
( $attrib, $value ) = $dbh->func( $attrib, $value, "validate_STORE_attr" );
$attrib or return;
my $attr_prefix;
$attrib =~ m/^([a-z]+_)/ and $attr_prefix = $1;
unless ($attr_prefix)
{
( my $drv_class = $dbh->{ImplementorClass} ) =~ s/::db$//;
$attr_prefix = DBI->driver_prefix($drv_class);
$attrib = $attr_prefix . $attrib;
}
my $valid_attrs = $attr_prefix . "valid_attrs";
my $ro_attrs = $attr_prefix . "readonly_attrs";
exists $dbh->{$valid_attrs}
and ( $dbh->{$valid_attrs}{$attrib}
or return $dbh->set_err( $DBI::stderr, "Invalid attribute '$attrib'" ) );
exists $dbh->{$ro_attrs}
and $dbh->{$ro_attrs}{$attrib}
and defined $dbh->{$attrib}
and return $dbh->set_err( $DBI::stderr,
"attribute '$attrib' is readonly and must not be modified" );
if ( $attrib eq "sql_meta" )
{
while ( my ( $k, $v ) = each %$value )
{
$dbh->{$attrib}{$k} = $v;
}
}
else
{
$dbh->{$attrib} = $value;
}
return 1;
}
return $dbh->SUPER::STORE( $attrib, $value );
} # STORE
sub get_driver_versions
{
my ( $dbh, $table ) = @_;
my %vsn = (
OS => "$^O ($Config::Config{osvers})",
Perl => "$] ($Config::Config{archname})",
DBI => $DBI::VERSION,
);
my %vmp;
my $sql_engine_verinfo =
join " ",
$dbh->{sql_engine_version}, "using", $dbh->{sql_handler},
$dbh->{sql_handler} eq "SQL::Statement"
? $dbh->{sql_statement_version}
: $dbh->{sql_nano_version};
my $indent = 0;
my @deriveds = ( $dbh->{ImplementorClass} );
while (@deriveds)
{
my $derived = shift @deriveds;
$derived eq "DBI::DBD::SqlEngine::db" and last;
$derived->isa("DBI::DBD::SqlEngine::db") or next;
#no strict 'refs';
eval "push \@deriveds, \@${derived}::ISA";
#use strict;
( my $drv_class = $derived ) =~ s/::db$//;
my $drv_prefix = DBI->driver_prefix($drv_class);
my $ddgv = $dbh->{ImplementorClass}->can("get_${drv_prefix}versions");
my $drv_version = $ddgv ? &$ddgv( $dbh, $table ) : $dbh->{ $drv_prefix . "version" };
$drv_version ||=
eval { $derived->VERSION() }; # XXX access $drv_class::VERSION via symbol table
$vsn{$drv_class} = $drv_version;
$indent and $vmp{$drv_class} = " " x $indent . $drv_class;
$indent += 2;
}
$vsn{"DBI::DBD::SqlEngine"} = $sql_engine_verinfo;
$indent and $vmp{"DBI::DBD::SqlEngine"} = " " x $indent . "DBI::DBD::SqlEngine";
$DBI::PurePerl and $vsn{"DBI::PurePerl"} = $DBI::PurePerl::VERSION;
$indent += 20;
my @versions = map { sprintf "%-${indent}s %s", $vmp{$_} || $_, $vsn{$_} }
sort {
$a->isa($b) and return -1;
$b->isa($a) and return 1;
$a->isa("DBI::DBD::SqlEngine") and return -1;
$b->isa("DBI::DBD::SqlEngine") and return 1;
return $a cmp $b;
} keys %vsn;
return wantarray ? @versions : join "\n", @versions;
} # get_versions
sub get_single_table_meta
{
my ( $dbh, $table, $attr ) = @_;
my $meta;
$table eq "."
and return $dbh->FETCH($attr);
( my $class = $dbh->{ImplementorClass} ) =~ s/::db$/::Table/;
( undef, $meta ) = $class->get_table_meta( $dbh, $table, 1 );
$meta or croak "No such table '$table'";
# prevent creation of undef attributes
return $class->get_table_meta_attr( $meta, $attr );
} # get_single_table_meta
sub get_sql_engine_meta
{
my ( $dbh, $table, $attr ) = @_;
my $gstm = $dbh->{ImplementorClass}->can("get_single_table_meta");
$table eq "*"
and $table = [ ".", keys %{ $dbh->{sql_meta} } ];
$table eq "+"
and $table = [ grep { m/^[_A-Za-z0-9]+$/ } keys %{ $dbh->{sql_meta} } ];
ref $table eq "Regexp"
and $table = [ grep { $_ =~ $table } keys %{ $dbh->{sql_meta} } ];
ref $table || ref $attr
or return $gstm->( $dbh, $table, $attr );
ref $table or $table = [$table];
ref $attr or $attr = [$attr];
"ARRAY" eq ref $table
or return
$dbh->set_err( $DBI::stderr,
"Invalid argument for \$table - SCALAR, Regexp or ARRAY expected but got " . ref $table );
"ARRAY" eq ref $attr
or return $dbh->set_err(
"Invalid argument for \$attr - SCALAR or ARRAY expected but got " . ref $attr );
my %results;
foreach my $tname ( @{$table} )
{
my %tattrs;
foreach my $aname ( @{$attr} )
{
$tattrs{$aname} = $gstm->( $dbh, $tname, $aname );
}
$results{$tname} = \%tattrs;
}
return \%results;
} # get_sql_engine_meta
sub new_sql_engine_meta
{
my ( $dbh, $table, $values ) = @_;
my $respect_case = 0;
"HASH" eq ref $values
or croak "Invalid argument for \$values - SCALAR or HASH expected but got " . ref $values;
$table =~ s/^\"// and $respect_case = 1; # handle quoted identifiers
$table =~ s/\"$//;
unless ($respect_case)
{
defined $dbh->{sql_meta_map}{$table} and $table = $dbh->{sql_meta_map}{$table};
}
$dbh->{sql_meta}{$table} = { %{$values} };
my $class;
defined $values->{sql_table_class} and $class = $values->{sql_table_class};
defined $class or ( $class = $dbh->{ImplementorClass} ) =~ s/::db$/::Table/;
# XXX we should never hit DBD::File::Table::get_table_meta here ...
my ( undef, $meta ) = $class->get_table_meta( $dbh, $table, $respect_case );
1;
} # new_sql_engine_meta
sub set_single_table_meta
{
my ( $dbh, $table, $attr, $value ) = @_;
my $meta;
$table eq "."
and return $dbh->STORE( $attr, $value );
( my $class = $dbh->{ImplementorClass} ) =~ s/::db$/::Table/;
( undef, $meta ) = $class->get_table_meta( $dbh, $table, 1 ); # 1 means: respect case
$meta or croak "No such table '$table'";
$class->set_table_meta_attr( $meta, $attr, $value );
return $dbh;
} # set_single_table_meta
sub set_sql_engine_meta
{
my ( $dbh, $table, $attr, $value ) = @_;
my $sstm = $dbh->{ImplementorClass}->can("set_single_table_meta");
$table eq "*"
and $table = [ ".", keys %{ $dbh->{sql_meta} } ];
$table eq "+"
and $table = [ grep { m/^[_A-Za-z0-9]+$/ } keys %{ $dbh->{sql_meta} } ];
ref($table) eq "Regexp"
and $table = [ grep { $_ =~ $table } keys %{ $dbh->{sql_meta} } ];
ref $table || ref $attr
or return $sstm->( $dbh, $table, $attr, $value );
ref $table or $table = [$table];
ref $attr or $attr = { $attr => $value };
"ARRAY" eq ref $table
or croak "Invalid argument for \$table - SCALAR, Regexp or ARRAY expected but got "
. ref $table;
"HASH" eq ref $attr
or croak "Invalid argument for \$attr - SCALAR or HASH expected but got " . ref $attr;
foreach my $tname ( @{$table} )
{
while ( my ( $aname, $aval ) = each %$attr )
{
$sstm->( $dbh, $tname, $aname, $aval );
}
}
return $dbh;
} # set_file_meta
sub clear_sql_engine_meta
{
my ( $dbh, $table ) = @_;
( my $class = $dbh->{ImplementorClass} ) =~ s/::db$/::Table/;
my ( undef, $meta ) = $class->get_table_meta( $dbh, $table, 1 );
$meta and %{$meta} = ();
return;
} # clear_file_meta
sub DESTROY ($)
{
my $dbh = shift;
$dbh->SUPER::FETCH("Active") and $dbh->disconnect;
undef $dbh->{sql_parser_object};
} # DESTROY
sub type_info_all ($)
{
[
{
TYPE_NAME => 0,
DATA_TYPE => 1,
PRECISION => 2,
LITERAL_PREFIX => 3,
LITERAL_SUFFIX => 4,
CREATE_PARAMS => 5,
NULLABLE => 6,
CASE_SENSITIVE => 7,
SEARCHABLE => 8,
UNSIGNED_ATTRIBUTE => 9,
MONEY => 10,
AUTO_INCREMENT => 11,
LOCAL_TYPE_NAME => 12,
MINIMUM_SCALE => 13,
MAXIMUM_SCALE => 14,
},
[
"VARCHAR", DBI::SQL_VARCHAR(), undef, "'", "'", undef, 0, 1, 1, 0, 0, 0, undef, 1, 999999,
],
[ "CHAR", DBI::SQL_CHAR(), undef, "'", "'", undef, 0, 1, 1, 0, 0, 0, undef, 1, 999999, ],
[ "INTEGER", DBI::SQL_INTEGER(), undef, "", "", undef, 0, 0, 1, 0, 0, 0, undef, 0, 0, ],
[ "REAL", DBI::SQL_REAL(), undef, "", "", undef, 0, 0, 1, 0, 0, 0, undef, 0, 0, ],
[
"BLOB", DBI::SQL_LONGVARBINARY(), undef, "'", "'", undef, 0, 1, 1, 0, 0, 0, undef, 1,
999999,
],
[
"BLOB", DBI::SQL_LONGVARBINARY(), undef, "'", "'", undef, 0, 1, 1, 0, 0, 0, undef, 1,
999999,
],
[
"TEXT", DBI::SQL_LONGVARCHAR(), undef, "'", "'", undef, 0, 1, 1, 0, 0, 0, undef, 1,
999999,
],
];
} # type_info_all
sub get_avail_tables
{
my $dbh = $_[0];
my @tables = ();
if ( $dbh->{sql_handler} eq "SQL::Statement" and $dbh->{sql_ram_tables} )
{
# XXX map +[ undef, undef, $_, "TABLE", "TEMP" ], keys %{...}
foreach my $table ( keys %{ $dbh->{sql_ram_tables} } )
{
push @tables, [ undef, undef, $table, "TABLE", "TEMP" ];
}
}
my $tbl_src;
defined $dbh->{sql_table_source}
and $dbh->{sql_table_source}->isa('DBI::DBD::SqlEngine::TableSource')
and $tbl_src = $dbh->{sql_table_source};
!defined($tbl_src)
and $dbh->{Driver}->{ImplementorClass}->can('default_table_source')
and $tbl_src = $dbh->{Driver}->{ImplementorClass}->default_table_source();
defined($tbl_src) and push( @tables, $tbl_src->avail_tables($dbh) );
return @tables;
} # get_avail_tables
{
my $names = [qw( TABLE_QUALIFIER TABLE_OWNER TABLE_NAME TABLE_TYPE REMARKS )];
sub table_info ($)
{
my $dbh = shift;
my @tables = $dbh->func("get_avail_tables");
# Temporary kludge: DBD::Sponge dies if @tables is empty. :-(
# this no longer seems to be true @tables or return;
my $dbh2 = $dbh->func("sql_sponge_driver");
my $sth = $dbh2->prepare(
"TABLE_INFO",
{
rows => \@tables,
NAME => $names,
}
);
$sth or return $dbh->set_err( $DBI::stderr, $dbh2->errstr );
$sth->execute or return;
return $sth;
} # table_info
}
sub list_tables ($)
{
my $dbh = shift;
my @table_list;
my @tables = $dbh->func("get_avail_tables") or return;
foreach my $ref (@tables)
{
# rt69260 and rt67223 - the same issue in 2 different queues
push @table_list, $ref->[2];
}
return @table_list;
} # list_tables
sub quote ($$;$)
{
my ( $self, $str, $type ) = @_;
defined $str or return "NULL";
defined $type && ( $type == DBI::SQL_NUMERIC()
|| $type == DBI::SQL_DECIMAL()
|| $type == DBI::SQL_INTEGER()
|| $type == DBI::SQL_SMALLINT()
|| $type == DBI::SQL_FLOAT()
|| $type == DBI::SQL_REAL()
|| $type == DBI::SQL_DOUBLE()
|| $type == DBI::SQL_TINYINT() )
and return $str;
$str =~ s/\\/\\\\/sg;
$str =~ s/\0/\\0/sg;
$str =~ s/\'/\\\'/sg;
$str =~ s/\n/\\n/sg;
$str =~ s/\r/\\r/sg;
return "'$str'";
} # quote
sub commit ($)
{
my $dbh = shift;
$dbh->FETCH("Warn")
and carp "Commit ineffective while AutoCommit is on", -1;
return 1;
} # commit
sub rollback ($)
{
my $dbh = shift;
$dbh->FETCH("Warn")
and carp "Rollback ineffective while AutoCommit is on", -1;
return 0;
} # rollback
# ====== Tie-Meta ==============================================================
package DBI::DBD::SqlEngine::TieMeta;
use Carp qw(croak);
require Tie::Hash;
@DBI::DBD::SqlEngine::TieMeta::ISA = qw(Tie::Hash);
sub TIEHASH
{
my ( $class, $tblClass, $tblMeta ) = @_;
my $self = bless(
{
tblClass => $tblClass,
tblMeta => $tblMeta,
},
$class
);
return $self;
} # new
sub STORE
{
my ( $self, $meta_attr, $meta_val ) = @_;
$self->{tblClass}->set_table_meta_attr( $self->{tblMeta}, $meta_attr, $meta_val );
return;
} # STORE
sub FETCH
{
my ( $self, $meta_attr ) = @_;
return $self->{tblClass}->get_table_meta_attr( $self->{tblMeta}, $meta_attr );
} # FETCH
sub FIRSTKEY
{
my $a = scalar keys %{ $_[0]->{tblMeta} };
each %{ $_[0]->{tblMeta} };
} # FIRSTKEY
sub NEXTKEY
{
each %{ $_[0]->{tblMeta} };
} # NEXTKEY
sub EXISTS
{
exists $_[0]->{tblMeta}{ $_[1] };
} # EXISTS
sub DELETE
{
croak "Can't delete single attributes from table meta structure";
} # DELETE
sub CLEAR
{
%{ $_[0]->{tblMeta} } = ();
} # CLEAR
sub SCALAR
{
scalar %{ $_[0]->{tblMeta} };
} # SCALAR
# ====== Tie-Tables ============================================================
package DBI::DBD::SqlEngine::TieTables;
use Carp qw(croak);
require Tie::Hash;
@DBI::DBD::SqlEngine::TieTables::ISA = qw(Tie::Hash);
sub TIEHASH
{
my ( $class, $dbh ) = @_;
( my $tbl_class = $dbh->{ImplementorClass} ) =~ s/::db$/::Table/;
my $self = bless(
{
dbh => $dbh,
tblClass => $tbl_class,
},
$class
);
return $self;
} # new
sub STORE
{
my ( $self, $table, $tbl_meta ) = @_;
"HASH" eq ref $tbl_meta
or croak "Invalid data for storing as table meta data (must be hash)";
( undef, my $meta ) = $self->{tblClass}->get_table_meta( $self->{dbh}, $table, 1 );
$meta or croak "Invalid table name '$table'";
while ( my ( $meta_attr, $meta_val ) = each %$tbl_meta )
{
$self->{tblClass}->set_table_meta_attr( $meta, $meta_attr, $meta_val );
}
return;
} # STORE
sub FETCH
{
my ( $self, $table ) = @_;
( undef, my $meta ) = $self->{tblClass}->get_table_meta( $self->{dbh}, $table, 1 );
$meta or croak "Invalid table name '$table'";
my %h;
tie %h, "DBI::DBD::SqlEngine::TieMeta", $self->{tblClass}, $meta;
return \%h;
} # FETCH
sub FIRSTKEY
{
my $a = scalar keys %{ $_[0]->{dbh}->{sql_meta} };
each %{ $_[0]->{dbh}->{sql_meta} };
} # FIRSTKEY
sub NEXTKEY
{
each %{ $_[0]->{dbh}->{sql_meta} };
} # NEXTKEY
sub EXISTS
{
exists $_[0]->{dbh}->{sql_meta}->{ $_[1] }
or exists $_[0]->{dbh}->{sql_meta_map}->{ $_[1] };
} # EXISTS
sub DELETE
{
my ( $self, $table ) = @_;
( undef, my $meta ) = $self->{tblClass}->get_table_meta( $self->{dbh}, $table, 1 );
$meta or croak "Invalid table name '$table'";
delete $_[0]->{dbh}->{sql_meta}->{ $meta->{table_name} };
} # DELETE
sub CLEAR
{
%{ $_[0]->{dbh}->{sql_meta} } = ();
%{ $_[0]->{dbh}->{sql_meta_map} } = ();
} # CLEAR
sub SCALAR
{
scalar %{ $_[0]->{dbh}->{sql_meta} };
} # SCALAR
# ====== STATEMENT =============================================================
package DBI::DBD::SqlEngine::st;
use strict;
use warnings;
use vars qw(@ISA $imp_data_size);
$imp_data_size = 0;
sub bind_param ($$$;$)
{
my ( $sth, $pNum, $val, $attr ) = @_;
if ( $attr && defined $val )
{
my $type = ref $attr eq "HASH" ? $attr->{TYPE} : $attr;
if ( $type == DBI::SQL_BIGINT()
|| $type == DBI::SQL_INTEGER()
|| $type == DBI::SQL_SMALLINT()
|| $type == DBI::SQL_TINYINT() )
{
$val += 0;
}
elsif ( $type == DBI::SQL_DECIMAL()
|| $type == DBI::SQL_DOUBLE()
|| $type == DBI::SQL_FLOAT()
|| $type == DBI::SQL_NUMERIC()
|| $type == DBI::SQL_REAL() )
{
$val += 0.;
}
else
{
$val = "$val";
}
}
$sth->{sql_params}[ $pNum - 1 ] = $val;
return 1;
} # bind_param
sub execute
{
my $sth = shift;
my $params = @_ ? ( $sth->{sql_params} = [@_] ) : $sth->{sql_params};
$sth->finish;
my $stmt = $sth->{sql_stmt};
# must not proved when already executed - SQL::Statement modifies
# received params
unless ( $sth->{sql_params_checked}++ )
{
# SQL::Statement and DBI::SQL::Nano will return the list of required params
# when called in list context. Do not look into the several items, they're
# implementation specific and may change without warning
unless ( ( my $req_prm = $stmt->params() ) == ( my $nparm = @$params ) )
{
my $msg = "You passed $nparm parameters where $req_prm required";
return $sth->set_err( $DBI::stderr, $msg );
}
}
my @err;
my $result;
eval {
local $SIG{__WARN__} = sub { push @err, @_ };
$result = $stmt->execute( $sth, $params );
};
unless ( defined $result )
{
$sth->set_err( $DBI::stderr, $@ || $stmt->{errstr} || $err[0] );
return;
}
if ( $stmt->{NUM_OF_FIELDS} )
{ # is a SELECT statement
$sth->STORE( Active => 1 );
$sth->FETCH("NUM_OF_FIELDS")
or $sth->STORE( "NUM_OF_FIELDS", $stmt->{NUM_OF_FIELDS} );
}
return $result;
} # execute
sub finish
{
my $sth = $_[0];
$sth->SUPER::STORE( Active => 0 );
delete $sth->{sql_stmt}{data};
return 1;
} # finish
sub fetch ($)
{
my $sth = $_[0];
my $data = $sth->{sql_stmt}{data};
if ( !$data || ref $data ne "ARRAY" )
{
$sth->set_err(
$DBI::stderr,
"Attempt to fetch row without a preceding execute () call or from a non-SELECT statement"
);
return;
}
my $dav = shift @$data;
unless ($dav)
{
$sth->finish;
return;
}
if ( $sth->FETCH("ChopBlanks") ) # XXX: (TODO) Only chop on CHAR fields,
{ # not on VARCHAR or NUMERIC (see DBI docs)
$_ && $_ =~ s/ +$// for @$dav;
}
return $sth->_set_fbav($dav);
} # fetch
no warnings 'once';
*fetchrow_arrayref = \&fetch;
use warnings;
sub sql_get_colnames
{
my $sth = $_[0];
# Being a bit dirty here, as neither SQL::Statement::Structure nor
# DBI::SQL::Nano::Statement_ does not offer an interface to the
# required data
my @colnames;
if ( $sth->{sql_stmt}->{NAME} and "ARRAY" eq ref( $sth->{sql_stmt}->{NAME} ) )
{
@colnames = @{ $sth->{sql_stmt}->{NAME} };
}
elsif ( $sth->{sql_stmt}->isa('SQL::Statement') )
{
my $stmt = $sth->{sql_stmt} || {};
my @coldefs = @{ $stmt->{column_defs} || [] };
@colnames = map { $_->{name} || $_->{value} } @coldefs;
}
@colnames = $sth->{sql_stmt}->column_names() unless (@colnames);
@colnames = () if ( grep { m/\*/ } @colnames );
return @colnames;
}
sub FETCH ($$)
{
my ( $sth, $attrib ) = @_;
$attrib eq "NAME" and return [ $sth->sql_get_colnames() ];
$attrib eq "TYPE" and return [ ( DBI::SQL_VARCHAR() ) x scalar $sth->sql_get_colnames() ];
$attrib eq "TYPE_NAME" and return [ ("VARCHAR") x scalar $sth->sql_get_colnames() ];
$attrib eq "PRECISION" and return [ (0) x scalar $sth->sql_get_colnames() ];
$attrib eq "NULLABLE" and return [ (1) x scalar $sth->sql_get_colnames() ];
if ( $attrib eq lc $attrib )
{
# Private driver attributes are lower cased
return $sth->{$attrib};
}
# else pass up to DBI to handle
return $sth->SUPER::FETCH($attrib);
} # FETCH
sub STORE ($$$)
{
my ( $sth, $attrib, $value ) = @_;
if ( $attrib eq lc $attrib ) # Private driver attributes are lower cased
{
$sth->{$attrib} = $value;
return 1;
}
return $sth->SUPER::STORE( $attrib, $value );
} # STORE
sub DESTROY ($)
{
my $sth = shift;
$sth->SUPER::FETCH("Active") and $sth->finish;
undef $sth->{sql_stmt};
undef $sth->{sql_params};
} # DESTROY
sub rows ($)
{
return $_[0]->{sql_stmt}{NUM_OF_ROWS};
} # rows
# ====== TableSource ===========================================================
package DBI::DBD::SqlEngine::TableSource;
use strict;
use warnings;
use Carp;
sub data_sources ($;$)
{
my ( $class, $drh, $attrs ) = @_;
croak( ( ref( $_[0] ) ? ref( $_[0] ) : $_[0] ) . " must implement data_sources" );
}
sub avail_tables
{
my ( $self, $dbh ) = @_;
croak( ( ref( $_[0] ) ? ref( $_[0] ) : $_[0] ) . " must implement avail_tables" );
}
# ====== DataSource ============================================================
package DBI::DBD::SqlEngine::DataSource;
use strict;
use warnings;
use Carp;
sub complete_table_name ($$;$)
{
my ( $self, $meta, $table, $respect_case ) = @_;
croak( ( ref( $_[0] ) ? ref( $_[0] ) : $_[0] ) . " must implement complete_table_name" );
}
sub open_data ($)
{
my ( $self, $meta, $attrs, $flags ) = @_;
croak( ( ref( $_[0] ) ? ref( $_[0] ) : $_[0] ) . " must implement open_data" );
}
# ====== SQL::STATEMENT ========================================================
package DBI::DBD::SqlEngine::Statement;
use strict;
use warnings;
use Carp;
@DBI::DBD::SqlEngine::Statement::ISA = qw(DBI::SQL::Nano::Statement);
sub open_table ($$$$$)
{
my ( $self, $data, $table, $createMode, $lockMode ) = @_;
my $class = ref $self;
$class =~ s/::Statement/::Table/;
my $flags = {
createMode => $createMode,
lockMode => $lockMode,
};
$self->{command} eq "DROP" and $flags->{dropMode} = 1;
my ( $tblnm, $table_meta ) = $class->get_table_meta( $data->{Database}, $table, 1 )
or croak "Cannot find appropriate meta for table '$table'";
defined $table_meta->{sql_table_class} and $class = $table_meta->{sql_table_class};
# because column name mapping is initialized in constructor ...
# and therefore specific opening operations might be done before
# reaching DBI::DBD::SqlEngine::Table->new(), we need to intercept
# ReadOnly here
my $write_op = $createMode || $lockMode || $flags->{dropMode};
if ($write_op)
{
$table_meta->{readonly}
and croak "Table '$table' is marked readonly - "
. $self->{command}
. ( $lockMode ? " with locking" : "" )
. " command forbidden";
}
return $class->new( $data, { table => $table }, $flags );
} # open_table
# ====== SQL::TABLE ============================================================
package DBI::DBD::SqlEngine::Table;
use strict;
use warnings;
use Carp;
@DBI::DBD::SqlEngine::Table::ISA = qw(DBI::SQL::Nano::Table);
sub bootstrap_table_meta
{
my ( $self, $dbh, $meta, $table ) = @_;
defined $dbh->{ReadOnly}
and !defined( $meta->{readonly} )
and $meta->{readonly} = $dbh->{ReadOnly};
defined $meta->{sql_identifier_case}
or $meta->{sql_identifier_case} = $dbh->{sql_identifier_case};
exists $meta->{sql_data_source} or $meta->{sql_data_source} = $dbh->{sql_data_source};
$meta;
}
sub init_table_meta
{
my ( $self, $dbh, $meta, $table ) = @_ if (0);
return;
} # init_table_meta
sub get_table_meta ($$$;$)
{
my ( $self, $dbh, $table, $respect_case, @other ) = @_;
unless ( defined $respect_case )
{
$respect_case = 0;
$table =~ s/^\"// and $respect_case = 1; # handle quoted identifiers
$table =~ s/\"$//;
}
unless ($respect_case)
{
defined $dbh->{sql_meta_map}{$table} and $table = $dbh->{sql_meta_map}{$table};
}
my $meta = {};
defined $dbh->{sql_meta}{$table} and $meta = $dbh->{sql_meta}{$table};
do_initialize:
unless ( $meta->{initialized} )
{
$self->bootstrap_table_meta( $dbh, $meta, $table, @other );
$meta->{sql_data_source}->complete_table_name( $meta, $table, $respect_case, @other )
or return;
if ( defined $meta->{table_name} and $table ne $meta->{table_name} )
{
$dbh->{sql_meta_map}{$table} = $meta->{table_name};
$table = $meta->{table_name};
}
# now we know a bit more - let's check if user can't use consequent spelling
# XXX add know issue about reset sql_identifier_case here ...
if ( defined $dbh->{sql_meta}{$table} )
{
$meta = delete $dbh->{sql_meta}{$table}; # avoid endless loop
$meta->{initialized}
or goto do_initialize;
#or $meta->{sql_data_source}->complete_table_name( $meta, $table, $respect_case, @other )
#or return;
}
unless ( $dbh->{sql_meta}{$table}{initialized} )
{
$self->init_table_meta( $dbh, $meta, $table );
$meta->{initialized} = 1;
$dbh->{sql_meta}{$table} = $meta;
}
}
return ( $table, $meta );
} # get_table_meta
my %reset_on_modify = ();
my %compat_map = ();
sub register_reset_on_modify
{
my ( $proto, $extra_resets ) = @_;
foreach my $cv ( keys %$extra_resets )
{
#%reset_on_modify = ( %reset_on_modify, %$extra_resets );
push @{ $reset_on_modify{$cv} },
ref $extra_resets->{$cv} ? @{ $extra_resets->{$cv} } : ( $extra_resets->{$cv} );
}
return;
} # register_reset_on_modify
sub register_compat_map
{
my ( $proto, $extra_compat_map ) = @_;
%compat_map = ( %compat_map, %$extra_compat_map );
return;
} # register_compat_map
sub get_table_meta_attr
{
my ( $class, $meta, $attrib ) = @_;
exists $compat_map{$attrib}
and $attrib = $compat_map{$attrib};
exists $meta->{$attrib}
and return $meta->{$attrib};
return;
} # get_table_meta_attr
sub set_table_meta_attr
{
my ( $class, $meta, $attrib, $value ) = @_;
exists $compat_map{$attrib}
and $attrib = $compat_map{$attrib};
$class->table_meta_attr_changed( $meta, $attrib, $value );
$meta->{$attrib} = $value;
} # set_table_meta_attr
sub table_meta_attr_changed
{
my ( $class, $meta, $attrib, $value ) = @_;
defined $reset_on_modify{$attrib}
and delete @$meta{ @{ $reset_on_modify{$attrib} } }
and $meta->{initialized} = 0;
} # table_meta_attr_changed
sub open_data
{
my ( $self, $meta, $attrs, $flags ) = @_;
$meta->{sql_data_source}
or croak "Table " . $meta->{table_name} . " not completely initialized";
$meta->{sql_data_source}->open_data( $meta, $attrs, $flags );
return;
} # open_data
# ====== SQL::Eval API =========================================================
sub new
{
my ( $className, $data, $attrs, $flags ) = @_;
my $dbh = $data->{Database};
my ( $tblnm, $meta ) = $className->get_table_meta( $dbh, $attrs->{table}, 1 )
or croak "Cannot find appropriate table '$attrs->{table}'";
$attrs->{table} = $tblnm;
# Being a bit dirty here, as SQL::Statement::Structure does not offer
# me an interface to the data I want
$flags->{createMode} && $data->{sql_stmt}{table_defs}
and $meta->{table_defs} = $data->{sql_stmt}{table_defs};
# open_file must be called before inherited new is invoked
# because column name mapping is initialized in constructor ...
$className->open_data( $meta, $attrs, $flags );
my $tbl = {
%{$attrs},
meta => $meta,
col_names => $meta->{col_names} || [],
};
return $className->SUPER::new($tbl);
} # new
sub DESTROY
{
my $self = shift;
my $meta = $self->{meta};
$self->{row} and undef $self->{row};
()
}
1;
=pod
=head1 NAME
DBI::DBD::SqlEngine - Base class for DBI drivers without their own SQL engine
=head1 SYNOPSIS
package DBD::myDriver;
use base qw(DBI::DBD::SqlEngine);
sub driver
{
...
my $drh = $proto->SUPER::driver($attr);
...
return $drh->{class};
}
package DBD::myDriver::dr;
@ISA = qw(DBI::DBD::SqlEngine::dr);
sub data_sources { ... }
...
package DBD::myDriver::db;
@ISA = qw(DBI::DBD::SqlEngine::db);
sub init_valid_attributes { ... }
sub init_default_attributes { ... }
sub set_versions { ... }
sub validate_STORE_attr { my ($dbh, $attrib, $value) = @_; ... }
sub validate_FETCH_attr { my ($dbh, $attrib) = @_; ... }
sub get_myd_versions { ... }
sub get_avail_tables { ... }
package DBD::myDriver::st;
@ISA = qw(DBI::DBD::SqlEngine::st);
sub FETCH { ... }
sub STORE { ... }
package DBD::myDriver::Statement;
@ISA = qw(DBI::DBD::SqlEngine::Statement);
sub open_table { ... }
package DBD::myDriver::Table;
@ISA = qw(DBI::DBD::SqlEngine::Table);
sub new { ... }
=head1 DESCRIPTION
DBI::DBD::SqlEngine abstracts the usage of SQL engines from the
DBD. DBD authors can concentrate on the data retrieval they want to
provide.
It is strongly recommended that you read L<DBD::File::Developers> and
L<DBD::File::Roadmap>, because many of the DBD::File API is provided
by DBI::DBD::SqlEngine.
Currently the API of DBI::DBD::SqlEngine is experimental and will
likely change in the near future to provide the table meta data basics
like DBD::File.
DBI::DBD::SqlEngine expects that any driver in inheritance chain has
a L<DBI prefix|DBI::DBD/The_database_handle_constructor>.
=head2 Metadata
The following attributes are handled by DBI itself and not by
DBI::DBD::SqlEngine, thus they all work as expected:
Active
ActiveKids
CachedKids
CompatMode (Not used)
InactiveDestroy
AutoInactiveDestroy
Kids
PrintError
RaiseError
Warn (Not used)
=head3 The following DBI attributes are handled by DBI::DBD::SqlEngine:
=head4 AutoCommit
Always on.
=head4 ChopBlanks
Works.
=head4 NUM_OF_FIELDS
Valid after C<< $sth->execute >>.
=head4 NUM_OF_PARAMS
Valid after C<< $sth->prepare >>.
=head4 NAME
Valid after C<< $sth->execute >>; probably undef for Non-Select statements.
=head4 NULLABLE
Not really working, always returns an array ref of ones, as DBD::CSV
does not verify input data. Valid after C<< $sth->execute >>; undef for
non-select statements.
=head3 The following DBI attributes and methods are not supported:
=over 4
=item bind_param_inout
=item CursorName
=item LongReadLen
=item LongTruncOk
=back
=head3 DBI::DBD::SqlEngine specific attributes
In addition to the DBI attributes, you can use the following dbh
attributes:
=head4 sql_engine_version
Contains the module version of this driver (B<readonly>)
=head4 sql_nano_version
Contains the module version of DBI::SQL::Nano (B<readonly>)
=head4 sql_statement_version
Contains the module version of SQL::Statement, if available (B<readonly>)
=head4 sql_handler
Contains the SQL Statement engine, either DBI::SQL::Nano or SQL::Statement
(B<readonly>).
=head4 sql_parser_object
Contains an instantiated instance of SQL::Parser (B<readonly>).
This is filled when used first time (only when used with SQL::Statement).
=head4 sql_sponge_driver
Contains an internally used DBD::Sponge handle (B<readonly>).
=head4 sql_valid_attrs
Contains the list of valid attributes for each DBI::DBD::SqlEngine based
driver (B<readonly>).
=head4 sql_readonly_attrs
Contains the list of those attributes which are readonly (B<readonly>).
=head4 sql_identifier_case
Contains how DBI::DBD::SqlEngine deals with non-quoted SQL identifiers:
* SQL_IC_UPPER (1) means all identifiers are internally converted
into upper-cased pendants
* SQL_IC_LOWER (2) means all identifiers are internally converted
into lower-cased pendants
* SQL_IC_MIXED (4) means all identifiers are taken as they are
These conversions happen if (and only if) no existing identifier matches.
Once existing identifier is used as known.
The SQL statement execution classes doesn't have to care, so don't expect
C<sql_identifier_case> affects column names in statements like
SELECT * FROM foo
=head4 sql_quoted_identifier_case
Contains how DBI::DBD::SqlEngine deals with quoted SQL identifiers
(B<readonly>). It's fixated to SQL_IC_SENSITIVE (3), which is interpreted
as SQL_IC_MIXED.
=head4 sql_flags
Contains additional flags to instantiate an SQL::Parser. Because an
SQL::Parser is instantiated only once, it's recommended to set this flag
before any statement is executed.
=head4 sql_dialect
Controls the dialect understood by SQL::Parser. Possible values (delivery
state of SQL::Statement):
* ANSI
* CSV
* AnyData
Defaults to "CSV". Because an SQL::Parser is instantiated only once and
SQL::Parser doesn't allow one to modify the dialect once instantiated,
it's strongly recommended to set this flag before any statement is
executed (best place is connect attribute hash).
=head4 sql_engine_in_gofer
This value has a true value in case of this driver is operated via
L<DBD::Gofer>. The impact of being operated via Gofer is a read-only
driver (not read-only databases!), so you cannot modify any attributes
later - neither any table settings. B<But> you won't get an error in
cases you modify table attributes, so please carefully watch
C<sql_engine_in_gofer>.
=head4 sql_meta
Private data area which contains information about the tables this
module handles. Table meta data might not be available until the
table has been accessed for the first time e.g., by issuing a select
on it however it is possible to pre-initialize attributes for each table
you use.
DBI::DBD::SqlEngine recognizes the (public) attributes C<col_names>,
C<table_name>, C<readonly>, C<sql_data_source> and C<sql_identifier_case>.
Be very careful when modifying attributes you do not know, the consequence
might be a destroyed or corrupted table.
While C<sql_meta> is a private and readonly attribute (which means, you
cannot modify it's values), derived drivers might provide restricted
write access through another attribute. Well known accessors are
C<csv_tables> for L<DBD::CSV>, C<ad_tables> for L<DBD::AnyData> and
C<dbm_tables> for L<DBD::DBM>.
=head4 sql_table_source
Controls the class which will be used for fetching available tables.
See L</DBI::DBD::SqlEngine::TableSource> for details.
=head4 sql_data_source
Contains the class name to be used for opening tables.
See L</DBI::DBD::SqlEngine::DataSource> for details.
=head2 Driver private methods
=head3 Default DBI methods
=head4 data_sources
The C<data_sources> method returns a list of subdirectories of the current
directory in the form "dbi:CSV:f_dir=$dirname".
If you want to read the subdirectories of another directory, use
my ($drh) = DBI->install_driver ("CSV");
my (@list) = $drh->data_sources (f_dir => "/usr/local/csv_data");
=head4 list_tables
This method returns a list of file names inside $dbh->{f_dir}.
Example:
my ($dbh) = DBI->connect ("dbi:CSV:f_dir=/usr/local/csv_data");
my (@list) = $dbh->func ("list_tables");
Note that the list includes all files contained in the directory, even
those that have non-valid table names, from the view of SQL.
=head3 Additional methods
The following methods are only available via their documented name when
DBI::DBD::SQlEngine is used directly. Because this is only reasonable for
testing purposes, the real names must be used instead. Those names can be
computed by replacing the C<sql_> in the method name with the driver prefix.
=head4 sql_versions
Signature:
sub sql_versions (;$) {
my ($table_name) = @_;
$table_name ||= ".";
...
}
Returns the versions of the driver, including the DBI version, the Perl
version, DBI::PurePerl version (if DBI::PurePerl is active) and the version
of the SQL engine in use.
my $dbh = DBI->connect ("dbi:File:");
my $sql_versions = $dbh->func( "sql_versions" );
print "$sql_versions\n";
__END__
# DBI::DBD::SqlEngine 0.05 using SQL::Statement 1.402
# DBI 1.623
# OS netbsd (6.99.12)
# Perl 5.016002 (x86_64-netbsd-thread-multi)
Called in list context, sql_versions will return an array containing each
line as single entry.
Some drivers might use the optional (table name) argument and modify
version information related to the table (e.g. DBD::DBM provides storage
backend information for the requested table, when it has a table name).
=head4 sql_get_meta
Signature:
sub sql_get_meta ($$)
{
my ($table_name, $attrib) = @_;
...
}
Returns the value of a meta attribute set for a specific table, if any.
See L<sql_meta> for the possible attributes.
A table name of C<"."> (single dot) is interpreted as the default table.
This will retrieve the appropriate attribute globally from the dbh.
This has the same restrictions as C<< $dbh->{$attrib} >>.
=head4 sql_set_meta
Signature:
sub sql_set_meta ($$$)
{
my ($table_name, $attrib, $value) = @_;
...
}
Sets the value of a meta attribute set for a specific table.
See L<sql_meta> for the possible attributes.
A table name of C<"."> (single dot) is interpreted as the default table
which will set the specified attribute globally for the dbh.
This has the same restrictions as C<< $dbh->{$attrib} = $value >>.
=head4 sql_clear_meta
Signature:
sub sql_clear_meta ($)
{
my ($table_name) = @_;
...
}
Clears the table specific meta information in the private storage of the
dbh.
=head2 Extensibility
=head3 DBI::DBD::SqlEngine::TableSource
Provides data sources and table information on database driver and database
handle level.
package DBI::DBD::SqlEngine::TableSource;
sub data_sources ($;$)
{
my ( $class, $drh, $attrs ) = @_;
...
}
sub avail_tables
{
my ( $class, $drh ) = @_;
...
}
The C<data_sources> method is called when the user invokes any of the
following:
@ary = DBI->data_sources($driver);
@ary = DBI->data_sources($driver, \%attr);
@ary = $dbh->data_sources();
@ary = $dbh->data_sources(\%attr);
The C<avail_tables> method is called when the user invokes any of the
following:
@names = $dbh->tables( $catalog, $schema, $table, $type );
$sth = $dbh->table_info( $catalog, $schema, $table, $type );
$sth = $dbh->table_info( $catalog, $schema, $table, $type, \%attr );
$dbh->func( "list_tables" );
Every time where an C<\%attr> argument can be specified, this C<\%attr>
object's C<sql_table_source> attribute is preferred over the C<$dbh>
attribute or the driver default, eg.
@ary = DBI->data_sources("dbi:CSV:", {
f_dir => "/your/csv/tables",
# note: this class doesn't comes with DBI
sql_table_source => "DBD::File::Archive::Tar::TableSource",
# scan tarballs instead of directories
});
When you're going to implement such a DBD::File::Archive::Tar::TableSource
class, remember to add correct attributes (including C<sql_table_source>
and C<sql_data_source>) to the returned DSN's.
=head3 DBI::DBD::SqlEngine::DataSource
Provides base functionality for dealing with tables. It is primarily
designed for allowing transparent access to files on disk or already
opened (file-)streams (eg. for DBD::CSV).
Derived classes shall be restricted to similar functionality, too (eg.
opening streams from an archive, transparently compress/uncompress
log files before parsing them,
package DBI::DBD::SqlEngine::DataSource;
sub complete_table_name ($$;$)
{
my ( $self, $meta, $table, $respect_case ) = @_;
...
}
The method C<complete_table_name> is called when first setting up the
I<meta information> for a table:
"SELECT user.id, user.name, user.shell FROM user WHERE ..."
results in opening the table C<user>. First step of the table open
process is completing the name. Let's imagine you're having a L<DBD::CSV>
handle with following settings:
$dbh->{sql_identifier_case} = SQL_IC_LOWER;
$dbh->{f_ext} = '.lst';
$dbh->{f_dir} = '/data/web/adrmgr';
Those settings will result in looking for files matching
C<[Uu][Ss][Ee][Rr](\.lst)?$> in C</data/web/adrmgr/>. The scanning of the
directory C</data/web/adrmgr/> and the pattern match check will be done
in C<DBD::File::DataSource::File> by the C<complete_table_name> method.
If you intend to provide other sources of data streams than files, in
addition to provide an appropriate C<complete_table_name> method, a method
to open the resource is required:
package DBI::DBD::SqlEngine::DataSource;
sub open_data ($)
{
my ( $self, $meta, $attrs, $flags ) = @_;
...
}
After the method C<open_data> has been run successfully, the table's meta
information are in a state which allowes the table's data accessor methods
will be able to fetch/store row information. Implementation details heavily
depends on the table implementation, whereby the most famous is surely
L<DBD::File::Table|DBD::File/DBD::File::Table>.
=head1 SQL ENGINES
DBI::DBD::SqlEngine currently supports two SQL engines:
L<SQL::Statement|SQL::Statement> and
L<DBI::SQL::Nano::Statement_|DBI::SQL::Nano>. DBI::SQL::Nano supports a
I<very> limited subset of SQL statements, but it might be faster for some
very simple tasks. SQL::Statement in contrast supports a much larger subset
of ANSI SQL.
To use SQL::Statement, you need at least version 1.401 of
SQL::Statement and the environment variable C<DBI_SQL_NANO> must not
be set to a true value.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc DBI::DBD::SqlEngine
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=DBI>
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=SQL-Statement>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/DBI>
L<http://annocpan.org/dist/SQL-Statement>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/DBI>
=item * Search CPAN
L<http://search.cpan.org/dist/DBI/>
=back
=head2 Where can I go for more help?
For questions about installation or usage, please ask on the
dbi-dev@perl.org mailing list.
If you have a bug report, patch or suggestion, please open
a new report ticket on CPAN, if there is not already one for
the issue you want to report. Of course, you can mail any of the
module maintainers, but it is less likely to be missed if
it is reported on RT.
Report tickets should contain a detailed description of the bug or
enhancement request you want to report and at least an easy way to
verify/reproduce the issue and any supplied fix. Patches are always
welcome, too.
=head1 ACKNOWLEDGEMENTS
Thanks to Tim Bunce, Martin Evans and H.Merijn Brand for their continued
support while developing DBD::File, DBD::DBM and DBD::AnyData.
Their support, hints and feedback helped to design and implement this
module.
=head1 AUTHOR
This module is currently maintained by
H.Merijn Brand < h.m.brand at xs4all.nl > and
Jens Rehsack < rehsack at googlemail.com >
The original authors are Jochen Wiedmann and Jeff Zucker.
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2009-2013 by H.Merijn Brand & Jens Rehsack
Copyright (C) 2004-2009 by Jeff Zucker
Copyright (C) 1998-2004 by Jochen Wiedmann
All rights reserved.
You may freely distribute and/or modify this module under the terms of
either the GNU General Public License (GPL) or the Artistic License, as
specified in the Perl README file.
=head1 SEE ALSO
L<DBI>, L<DBD::File>, L<DBD::AnyData> and L<DBD::Sys>.
=cut
PK V`[�ma��: �: DBD/Metadata.pmnu �[��� package DBI::DBD::Metadata;
# $Id: Metadata.pm 14213 2010-06-30 19:29:18Z Martin $
#
# Copyright (c) 1997-2003 Jonathan Leffler, Jochen Wiedmann,
# Steffen Goeldner and Tim Bunce
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
use Exporter ();
use Carp;
use DBI;
use DBI::Const::GetInfoType qw(%GetInfoType);
our @ISA = qw(Exporter);
our @EXPORT = qw(write_getinfo_pm write_typeinfo_pm);
our $VERSION = "2.014214";
=head1 NAME
DBI::DBD::Metadata - Generate the code and data for some DBI metadata methods
=head1 SYNOPSIS
The idea is to extract metadata information from a good quality
ODBC driver and use it to generate code and data to use in your own
DBI driver for the same database.
To generate code to support the get_info method:
perl -MDBI::DBD::Metadata -e "write_getinfo_pm('dbi:ODBC:dsn-name','user','pass','Driver')"
perl -MDBI::DBD::Metadata -e write_getinfo_pm dbi:ODBC:foo_db username password Driver
To generate code to support the type_info method:
perl -MDBI::DBD::Metadata -e "write_typeinfo_pm('dbi:ODBC:dsn-name','user','pass','Driver')"
perl -MDBI::DBD::Metadata -e write_typeinfo_pm dbi:ODBC:dsn-name user pass Driver
Where C<dbi:ODBC:dsn-name> is the connection to use to extract the
data, and C<Driver> is the name of the driver you want the code
generated for (the driver name gets embedded into the output in
numerous places).
=head1 Generating a GetInfo package for a driver
The C<write_getinfo_pm> in the DBI::DBD::Metadata module generates a
DBD::Driver::GetInfo package on standard output.
This method generates a DBD::Driver::GetInfo package from the data
source you specified in the parameter list or in the environment
variable DBI_DSN.
DBD::Driver::GetInfo should help a DBD author implement the DBI
get_info() method.
Because you are just creating this package, it is very unlikely that
DBD::Driver already provides a good implementation for get_info().
Thus you will probably connect via DBD::ODBC.
Once you are sure that it is producing reasonably sane data, you should
typically redirect the standard output to lib/DBD/Driver/GetInfo.pm, and
then hand edit the result.
Do not forget to update your Makefile.PL and MANIFEST to include this as
an extra PM file that should be installed.
If you connect via DBD::ODBC, you should use version 0.38 or greater;
Please take a critical look at the data returned!
ODBC drivers vary dramatically in their quality.
The generator assumes that most values are static and places these
values directly in the %info hash.
A few examples show the use of CODE references and the implementation
via subroutines.
It is very likely that you will have to write additional subroutines for
values depending on the session state or server version, e.g.
SQL_DBMS_VER.
A possible implementation of DBD::Driver::db::get_info() may look like:
sub get_info {
my($dbh, $info_type) = @_;
require DBD::Driver::GetInfo;
my $v = $DBD::Driver::GetInfo::info{int($info_type)};
$v = $v->($dbh) if ref $v eq 'CODE';
return $v;
}
Please replace Driver (or "<foo>") with the name of your driver.
Note that this stub function is generated for you by write_getinfo_pm
function, but you must manually transfer the code to Driver.pm.
=cut
sub write_getinfo_pm
{
my ($dsn, $user, $pass, $driver) = @_ ? @_ : @ARGV;
my $dbh = DBI->connect($dsn, $user, $pass, {RaiseError=>1});
$driver = "<foo>" unless defined $driver;
print <<PERL;
# Transfer this to ${driver}.pm
# The get_info function was automatically generated by
# DBI::DBD::Metadata::write_getinfo_pm v$DBI::DBD::Metadata::VERSION.
package DBD::${driver}::db; # This line can be removed once transferred.
sub get_info {
my(\$dbh, \$info_type) = \@_;
require DBD::${driver}::GetInfo;
my \$v = \$DBD::${driver}::GetInfo::info{int(\$info_type)};
\$v = \$v->(\$dbh) if ref \$v eq 'CODE';
return \$v;
}
# Transfer this to lib/DBD/${driver}/GetInfo.pm
# The \%info hash was automatically generated by
# DBI::DBD::Metadata::write_getinfo_pm v$DBI::DBD::Metadata::VERSION.
package DBD::${driver}::GetInfo;
use strict;
use DBD::${driver};
# Beware: not officially documented interfaces...
# use DBI::Const::GetInfoType qw(\%GetInfoType);
# use DBI::Const::GetInfoReturn qw(\%GetInfoReturnTypes \%GetInfoReturnValues);
my \$sql_driver = '${driver}';
my \$sql_ver_fmt = '%02d.%02d.%04d'; # ODBC version string: ##.##.#####
my \$sql_driver_ver = sprintf \$sql_ver_fmt, split (/\\./, \$DBD::${driver}::VERSION);
PERL
my $kw_map = 0;
{
# Informix CLI (ODBC) v3.81.0000 does not return a list of keywords.
local $\ = "\n";
local $, = "\n";
my ($kw) = $dbh->get_info($GetInfoType{SQL_KEYWORDS});
if ($kw)
{
print "\nmy \@Keywords = qw(\n";
print sort split /,/, $kw;
print ");\n\n";
print "sub sql_keywords {\n";
print q% return join ',', @Keywords;%;
print "\n}\n\n";
$kw_map = 1;
}
}
print <<'PERL';
sub sql_data_source_name {
my $dbh = shift;
return "dbi:$sql_driver:" . $dbh->{Name};
}
sub sql_user_name {
my $dbh = shift;
# CURRENT_USER is a non-standard attribute, probably undef
# Username is a standard DBI attribute
return $dbh->{CURRENT_USER} || $dbh->{Username};
}
PERL
print "\nour \%info = (\n";
foreach my $key (sort keys %GetInfoType)
{
my $num = $GetInfoType{$key};
my $val = eval { $dbh->get_info($num); };
if ($key eq 'SQL_DATA_SOURCE_NAME') {
$val = '\&sql_data_source_name';
}
elsif ($key eq 'SQL_KEYWORDS') {
$val = ($kw_map) ? '\&sql_keywords' : 'undef';
}
elsif ($key eq 'SQL_DRIVER_NAME') {
$val = "\$INC{'DBD/$driver.pm'}";
}
elsif ($key eq 'SQL_DRIVER_VER') {
$val = '$sql_driver_ver';
}
elsif ($key eq 'SQL_USER_NAME') {
$val = '\&sql_user_name';
}
elsif (not defined $val) {
$val = 'undef';
}
elsif ($val eq '') {
$val = "''";
}
elsif ($val =~ /\D/) {
$val =~ s/\\/\\\\/g;
$val =~ s/'/\\'/g;
$val = "'$val'";
}
printf "%s %5d => %-30s # %s\n", (($val eq 'undef') ? '#' : ' '), $num, "$val,", $key;
}
print ");\n\n1;\n\n__END__\n";
}
=head1 Generating a TypeInfo package for a driver
The C<write_typeinfo_pm> function in the DBI::DBD::Metadata module generates
on standard output the data needed for a driver's type_info_all method.
It also provides default implementations of the type_info_all
method for inclusion in the driver's main implementation file.
The driver parameter is the name of the driver for which the methods
will be generated; for the sake of examples, this will be "Driver".
Typically, the dsn parameter will be of the form "dbi:ODBC:odbc_dsn",
where the odbc_dsn is a DSN for one of the driver's databases.
The user and pass parameters are the other optional connection
parameters that will be provided to the DBI connect method.
Once you are sure that it is producing reasonably sane data, you should
typically redirect the standard output to lib/DBD/Driver/TypeInfo.pm,
and then hand edit the result if necessary.
Do not forget to update your Makefile.PL and MANIFEST to include this as
an extra PM file that should be installed.
Please take a critical look at the data returned!
ODBC drivers vary dramatically in their quality.
The generator assumes that all the values are static and places these
values directly in the %info hash.
A possible implementation of DBD::Driver::type_info_all() may look like:
sub type_info_all {
my ($dbh) = @_;
require DBD::Driver::TypeInfo;
return [ @$DBD::Driver::TypeInfo::type_info_all ];
}
Please replace Driver (or "<foo>") with the name of your driver.
Note that this stub function is generated for you by the write_typeinfo_pm
function, but you must manually transfer the code to Driver.pm.
=cut
# These two are used by fmt_value...
my %dbi_inv;
my %sql_type_inv;
#-DEBUGGING-#
#sub print_hash
#{
# my ($name, %hash) = @_;
# print "Hash: $name\n";
# foreach my $key (keys %hash)
# {
# print "$key => $hash{$key}\n";
# }
#}
#-DEBUGGING-#
sub inverse_hash
{
my (%hash) = @_;
my (%inv);
foreach my $key (keys %hash)
{
my $val = $hash{$key};
die "Double mapping for key value $val ($inv{$val}, $key)!"
if (defined $inv{$val});
$inv{$val} = $key;
}
return %inv;
}
sub fmt_value
{
my ($num, $val) = @_;
if (!defined $val)
{
$val = "undef";
}
elsif ($val !~ m/^[-+]?\d+$/)
{
# All the numbers in type_info_all are integers!
# Anything that isn't an integer is a string.
# Ensure that no double quotes screw things up.
$val =~ s/"/\\"/g if ($val =~ m/"/o);
$val = qq{"$val"};
}
elsif ($dbi_inv{$num} =~ m/^(SQL_)?DATA_TYPE$/)
{
# All numeric...
$val = $sql_type_inv{$val}
if (defined $sql_type_inv{$val});
}
return $val;
}
sub write_typeinfo_pm
{
my ($dsn, $user, $pass, $driver) = @_ ? @_ : @ARGV;
my $dbh = DBI->connect($dsn, $user, $pass, {AutoCommit=>1, RaiseError=>1});
$driver = "<foo>" unless defined $driver;
print <<PERL;
# Transfer this to ${driver}.pm
# The type_info_all function was automatically generated by
# DBI::DBD::Metadata::write_typeinfo_pm v$DBI::DBD::Metadata::VERSION.
package DBD::${driver}::db; # This line can be removed once transferred.
sub type_info_all
{
my (\$dbh) = \@_;
require DBD::${driver}::TypeInfo;
return [ \@\$DBD::${driver}::TypeInfo::type_info_all ];
}
# Transfer this to lib/DBD/${driver}/TypeInfo.pm.
# Don't forget to add version and intellectual property control information.
# The \%type_info_all hash was automatically generated by
# DBI::DBD::Metadata::write_typeinfo_pm v$DBI::DBD::Metadata::VERSION.
package DBD::${driver}::TypeInfo;
{
require Exporter;
require DynaLoader;
\@ISA = qw(Exporter DynaLoader);
\@EXPORT = qw(type_info_all);
use DBI qw(:sql_types);
PERL
# Generate SQL type name mapping hashes.
# See code fragment in DBI specification.
my %sql_type_map;
foreach (@{$DBI::EXPORT_TAGS{sql_types}})
{
no strict 'refs';
$sql_type_map{$_} = &{"DBI::$_"}();
$sql_type_inv{$sql_type_map{$_}} = $_;
}
#-DEBUG-# print_hash("sql_type_map", %sql_type_map);
#-DEBUG-# print_hash("sql_type_inv", %sql_type_inv);
my %dbi_map =
(
TYPE_NAME => 0,
DATA_TYPE => 1,
COLUMN_SIZE => 2,
LITERAL_PREFIX => 3,
LITERAL_SUFFIX => 4,
CREATE_PARAMS => 5,
NULLABLE => 6,
CASE_SENSITIVE => 7,
SEARCHABLE => 8,
UNSIGNED_ATTRIBUTE => 9,
FIXED_PREC_SCALE => 10,
AUTO_UNIQUE_VALUE => 11,
LOCAL_TYPE_NAME => 12,
MINIMUM_SCALE => 13,
MAXIMUM_SCALE => 14,
SQL_DATA_TYPE => 15,
SQL_DATETIME_SUB => 16,
NUM_PREC_RADIX => 17,
INTERVAL_PRECISION => 18,
);
#-DEBUG-# print_hash("dbi_map", %dbi_map);
%dbi_inv = inverse_hash(%dbi_map);
#-DEBUG-# print_hash("dbi_inv", %dbi_inv);
my $maxlen = 0;
foreach my $key (keys %dbi_map)
{
$maxlen = length($key) if length($key) > $maxlen;
}
# Print the name/value mapping entry in the type_info_all array;
my $fmt = " \%-${maxlen}s => \%2d,\n";
my $numkey = 0;
my $maxkey = 0;
print " \$type_info_all = [\n {\n";
foreach my $i (sort { $a <=> $b } keys %dbi_inv)
{
printf($fmt, $dbi_inv{$i}, $i);
$numkey++;
$maxkey = $i;
}
print " },\n";
print STDERR "### WARNING - Non-dense set of keys ($numkey keys, $maxkey max key)\n"
unless $numkey = $maxkey + 1;
my $h = $dbh->type_info_all;
my @tia = @$h;
my %odbc_map = map { uc $_ => $tia[0]->{$_} } keys %{$tia[0]};
shift @tia; # Remove the mapping reference.
my $numtyp = $#tia;
#-DEBUG-# print_hash("odbc_map", %odbc_map);
# In theory, the key/number mapping sequence for %dbi_map
# should be the same as the one from the ODBC driver. However, to
# prevent the possibility of mismatches, and to deal with older
# missing attributes or unexpected new ones, we chase back through
# the %dbi_inv and %odbc_map hashes, generating @dbi_to_odbc
# to map our new key number to the old one.
# Report if @dbi_to_odbc is not an identity mapping.
my @dbi_to_odbc;
foreach my $num (sort { $a <=> $b } keys %dbi_inv)
{
# Find the name in %dbi_inv that matches this index number.
my $dbi_key = $dbi_inv{$num};
#-DEBUG-# print "dbi_key = $dbi_key\n";
#-DEBUG-# print "odbc_key = $odbc_map{$dbi_key}\n";
# Find the index in %odbc_map that has this key.
$dbi_to_odbc[$num] = (defined $odbc_map{$dbi_key}) ? $odbc_map{$dbi_key} : undef;
}
# Determine the length of the longest formatted value in each field
my @len;
for (my $i = 0; $i <= $numtyp; $i++)
{
my @odbc_val = @{$tia[$i]};
for (my $num = 0; $num <= $maxkey; $num++)
{
# Find the value of the entry in the @odbc_val array.
my $val = (defined $dbi_to_odbc[$num]) ? $odbc_val[$dbi_to_odbc[$num]] : undef;
$val = fmt_value($num, $val);
#-DEBUG-# print "val = $val\n";
$val = "$val,";
$len[$num] = length($val) if !defined $len[$num] || length($val) > $len[$num];
}
}
# Generate format strings to left justify each string in maximum field width.
my @fmt;
for (my $i = 0; $i <= $maxkey; $i++)
{
$fmt[$i] = "%-$len[$i]s";
#-DEBUG-# print "fmt[$i] = $fmt[$i]\n";
}
# Format the data from type_info_all
for (my $i = 0; $i <= $numtyp; $i++)
{
my @odbc_val = @{$tia[$i]};
print " [ ";
for (my $num = 0; $num <= $maxkey; $num++)
{
# Find the value of the entry in the @odbc_val array.
my $val = (defined $dbi_to_odbc[$num]) ? $odbc_val[$dbi_to_odbc[$num]] : undef;
$val = fmt_value($num, $val);
printf $fmt[$num], "$val,";
}
print " ],\n";
}
print " ];\n\n 1;\n}\n\n__END__\n";
}
1;
__END__
=head1 AUTHORS
Jonathan Leffler <jleffler@us.ibm.com> (previously <jleffler@informix.com>),
Jochen Wiedmann <joe@ispsoft.de>,
Steffen Goeldner <sgoeldner@cpan.org>,
and Tim Bunce <dbi-users@perl.org>.
=cut
PK V`[ `y �j �j DBD/SqlEngine/Developers.podnu �[��� =head1 NAME
DBI::DBD::SqlEngine::Developers - Developers documentation for DBI::DBD::SqlEngine
=head1 SYNOPSIS
package DBD::myDriver;
use base qw(DBI::DBD::SqlEngine);
sub driver
{
...
my $drh = $proto->SUPER::driver($attr);
...
return $drh->{class};
}
sub CLONE { ... }
package DBD::myDriver::dr;
@ISA = qw(DBI::DBD::SqlEngine::dr);
sub data_sources { ... }
...
package DBD::myDriver::db;
@ISA = qw(DBI::DBD::SqlEngine::db);
sub init_valid_attributes { ... }
sub init_default_attributes { ... }
sub set_versions { ... }
sub validate_STORE_attr { my ($dbh, $attrib, $value) = @_; ... }
sub validate_FETCH_attr { my ($dbh, $attrib) = @_; ... }
sub get_myd_versions { ... }
sub get_avail_tables { ... }
package DBD::myDriver::st;
@ISA = qw(DBI::DBD::SqlEngine::st);
sub FETCH { ... }
sub STORE { ... }
package DBD::myDriver::Statement;
@ISA = qw(DBI::DBD::SqlEngine::Statement);
sub open_table { ... }
package DBD::myDriver::Table;
@ISA = qw(DBI::DBD::SqlEngine::Table);
my %reset_on_modify = (
myd_abc => "myd_foo",
myd_mno => "myd_bar",
);
__PACKAGE__->register_reset_on_modify( \%reset_on_modify );
my %compat_map = (
abc => 'foo_abc',
xyz => 'foo_xyz',
);
__PACKAGE__->register_compat_map( \%compat_map );
sub bootstrap_table_meta { ... }
sub init_table_meta { ... }
sub table_meta_attr_changed { ... }
sub open_data { ... }
sub new { ... }
sub fetch_row { ... }
sub push_row { ... }
sub push_names { ... }
sub seek { ... }
sub truncate { ... }
sub drop { ... }
# optimize the SQL engine by add one or more of
sub update_current_row { ... }
# or
sub update_specific_row { ... }
# or
sub update_one_row { ... }
# or
sub insert_new_row { ... }
# or
sub delete_current_row { ... }
# or
sub delete_one_row { ... }
=head1 DESCRIPTION
This document describes the interface of DBI::DBD::SqlEngine for DBD
developers who write DBI::DBD::SqlEngine based DBI drivers. It supplements
L<DBI::DBD> and L<DBI::DBD::SqlEngine::HowTo>, which you should read first.
=head1 CLASSES
Each DBI driver must provide a package global C<< driver >> method and
three DBI related classes:
=over 4
=item DBI::DBD::SqlEngine::dr
Driver package, contains the methods DBI calls indirectly via DBI
interface:
DBI->connect ('DBI:DBM:', undef, undef, {})
# invokes
package DBD::DBM::dr;
@DBD::DBM::dr::ISA = qw(DBI::DBD::SqlEngine::dr);
sub connect ($$;$$$)
{
...
}
Similar for C<data_sources ()> and C<disconnect_all()>.
Pure Perl DBI drivers derived from DBI::DBD::SqlEngine usually don't need to
override any of the methods provided through the DBD::XXX::dr package.
However if you need additional initialization not fitting in
C<init_valid_attributes()> and C<init_default_attributes()> of you're ::db
class, the connect method might be the final place to be modified.
=item DBI::DBD::SqlEngine::db
Contains the methods which are called through DBI database handles
(C<< $dbh >>). e.g.,
$sth = $dbh->prepare ("select * from foo");
# returns the f_encoding setting for table foo
$dbh->csv_get_meta ("foo", "f_encoding");
DBI::DBD::SqlEngine provides the typical methods required here. Developers who
write DBI drivers based on DBI::DBD::SqlEngine need to override the methods
C<< set_versions >> and C<< init_valid_attributes >>.
=item DBI::DBD::SqlEngine::TieMeta;
Provides the tie-magic for C<< $dbh->{$drv_pfx . "_meta"} >>. Routes
C<STORE> through C<< $drv->set_sql_engine_meta() >> and C<FETCH> through
C<< $drv->get_sql_engine_meta() >>. C<DELETE> is not supported, you have
to execute a C<DROP TABLE> statement, where applicable.
=item DBI::DBD::SqlEngine::TieTables;
Provides the tie-magic for tables in C<< $dbh->{$drv_pfx . "_meta"} >>.
Routes C<STORE> though C<< $tblClass->set_table_meta_attr() >> and C<FETCH>
though C<< $tblClass->get_table_meta_attr() >>. C<DELETE> removes an
attribute from the I<meta object> retrieved by
C<< $tblClass->get_table_meta() >>.
=item DBI::DBD::SqlEngine::st
Contains the methods to deal with prepared statement handles. e.g.,
$sth->execute () or die $sth->errstr;
=item DBI::DBD::SqlEngine::TableSource;
Base class for 3rd party table sources:
$dbh->{sql_table_source} = "DBD::Foo::TableSource";
=item DBI::DBD::SqlEngine::DataSource;
Base class for 3rd party data sources:
$dbh->{sql_data_source} = "DBD::Foo::DataSource";
=item DBI::DBD::SqlEngine::Statement;
Base class for derived drivers statement engine. Implements C<open_table>.
=item DBI::DBD::SqlEngine::Table;
Contains tailoring between SQL engine's requirements and
C<DBI::DBD::SqlEngine> magic for finding the right tables and storage.
Builds bridges between C<sql_meta> handling of C<DBI::DBD::SqlEngine::db>,
table initialization for SQL engines and I<meta object>'s attribute
management for derived drivers.
=back
=head2 DBI::DBD::SqlEngine
This is the main package containing the routines to initialize
DBI::DBD::SqlEngine based DBI drivers. Primarily the
C<< DBI::DBD::SqlEngine::driver >> method is invoked, either directly
from DBI when the driver is initialized or from the derived class.
package DBD::DBM;
use base qw( DBI::DBD::SqlEngine );
sub driver
{
my ( $class, $attr ) = @_;
...
my $drh = $class->SUPER::driver( $attr );
...
return $drh;
}
It is not necessary to implement your own driver method as long as
additional initialization (e.g. installing more private driver
methods) is not required. You do not need to call C<< setup_driver >>
as DBI::DBD::SqlEngine takes care of it.
=head2 DBI::DBD::SqlEngine::dr
The driver package contains the methods DBI calls indirectly via the DBI
interface (see L<DBI/DBI Class Methods>).
DBI::DBD::SqlEngine based DBI drivers usually do not need to implement anything here,
it is enough to do the basic initialization:
package DBD:XXX::dr;
@DBD::XXX::dr::ISA = qw (DBI::DBD::SqlEngine::dr);
$DBD::XXX::dr::imp_data_size = 0;
$DBD::XXX::dr::data_sources_attr = undef;
$DBD::XXX::ATTRIBUTION = "DBD::XXX $DBD::XXX::VERSION by Hans Mustermann";
=head3 Methods provided by C<< DBI::DBD::SqlEngine::dr >>:
=over 4
=item connect
Supervises the driver bootstrap when calling
DBI->connect( "dbi:Foo", , , { ... } );
First it instantiates a new driver using C<DBI::_new_dbh>. After that,
initial bootstrap of the newly instantiated driver is done by
$dbh->func( 0, "init_default_attributes" );
The first argument (C<0>) signals that this is the very first call to
C<init_default_attributes>. Modern drivers understand that and do early
stage setup here after calling
package DBD::Foo::db;
our @DBD::Foo::db::ISA = qw(DBI::DBD::SqlEngine::db);
sub init_default_attributes
{
my ($dbh, $phase) = @_;
$dbh->SUPER::init_default_attributes($phase);
...; # own setup code, maybe separated by phases
}
When the C<$phase> argument is passed down until
C<DBI::DBD::SqlEngine::db::init_default_attributes>, C<connect()> recognizes
a I<modern> driver and initializes the attributes from I<DSN> and I<$attr>
arguments passed via C<< DBI->connect( $dsn, $user, $pass, \%attr ) >>.
At the end of the attribute initialization after I<phase 0>, C<connect()>
invoked C<init_default_attributes> again for I<phase 1>:
$dbh->func( 1, "init_default_attributes" );
=item data_sources
Returns a list of I<DSN>'s using the C<data_sources> method of the
class specified in C<< $dbh->{sql_table_source} >> or via C<\%attr>:
@ary = DBI->data_sources($driver);
@ary = DBI->data_sources($driver, \%attr);
=item disconnect_all
C<DBI::DBD::SqlEngine> doesn't have an overall driver cache, so nothing
happens here at all.
=back
=head2 DBI::DBD::SqlEngine::db
This package defines the database methods, which are called via the DBI
database handle C<< $dbh >>.
=head3 Methods provided by C<< DBI::DBD::SqlEngine::db >>:
=over 4
=item ping
Simply returns the content of the C<< Active >> attribute. Override
when your driver needs more complicated actions here.
=item prepare
Prepares a new SQL statement to execute. Returns a statement handle,
C<< $sth >> - instance of the DBD:XXX::st. It is neither required nor
recommended to override this method.
=item validate_FETCH_attr
Called by C<FETCH> to allow inherited drivers do their own attribute
name validation. Calling convention is similar to C<FETCH> and the
return value is the approved attribute name.
return $validated_attribute_name;
In case of validation fails (e.g. accessing private attribute or similar),
C<validate_FETCH_attr> is permitted to throw an exception.
=item FETCH
Fetches an attribute of a DBI database object. Private handle attributes
must have a prefix (this is mandatory). If a requested attribute is
detected as a private attribute without a valid prefix, the driver prefix
(written as C<$drv_prefix>) is added.
The driver prefix is extracted from the attribute name and verified against
C<< $dbh->{ $drv_prefix . "valid_attrs" } >> (when it exists). If the
requested attribute value is not listed as a valid attribute, this method
croaks. If the attribute is valid and readonly (listed in C<< $dbh->{
$drv_prefix . "readonly_attrs" } >> when it exists), a real copy of the
attribute value is returned. So it's not possible to modify
C<f_valid_attrs> from outside of DBI::DBD::SqlEngine::db or a derived class.
=item validate_STORE_attr
Called by C<STORE> to allow inherited drivers do their own attribute
name validation. Calling convention is similar to C<STORE> and the
return value is the approved attribute name followed by the approved
new value.
return ($validated_attribute_name, $validated_attribute_value);
In case of validation fails (e.g. accessing private attribute or similar),
C<validate_STORE_attr> is permitted to throw an exception
(C<DBI::DBD::SqlEngine::db::validate_STORE_attr> throws an exception when
someone tries to assign value other than C<SQL_IC_UPPER .. SQL_IC_MIXED>
to C<< $dbh->{sql_identifier_case} >> or
C<< $dbh->{sql_quoted_identifier_case} >>).
=item STORE
Stores a database private attribute. Private handle attributes must have a
prefix (this is mandatory). If a requested attribute is detected as a private
attribute without a valid prefix, the driver prefix (written as
C<$drv_prefix>) is added. If the database handle has an attribute
C<${drv_prefix}_valid_attrs> - for attribute names which are not listed in
that hash, this method croaks. If the database handle has an attribute
C<${drv_prefix}_readonly_attrs>, only attributes which are not listed there
can be stored (once they are initialized). Trying to overwrite such an
immutable attribute forces this method to croak.
An example of a valid attributes list can be found in
C<< DBI::DBD::SqlEngine::db::init_valid_attributes >>.
=item set_versions
This method sets the attributes C<< f_version >>, C<< sql_nano_version >>,
C<< sql_statement_version >> and (if not prohibited by a restrictive
C<< ${prefix}_valid_attrs >>) C<< ${prefix}_version >>.
This method is called at the end of the C<< connect () >> phase.
When overriding this method, do not forget to invoke the superior one.
=item init_valid_attributes
This method is called after the database handle is instantiated as the
first attribute initialization.
C<< DBI::DBD::SqlEngine::db::init_valid_attributes >> initializes the
attributes C<sql_valid_attrs> and C<sql_readonly_attrs>.
When overriding this method, do not forget to invoke the superior one,
preferably before doing anything else.
=item init_default_attributes
This method is called after the database handle is instantiated to
initialize the default attributes. It expects one argument: C<$phase>.
If C<$phase> is not given, C<connect> of C<DBI::DBD::SqlEngine::dr>
expects this is an old-fashioned driver which isn't capable of multi-phased
initialization.
C<< DBI::DBD::SqlEngine::db::init_default_attributes >> initializes the
attributes C<sql_identifier_case>, C<sql_quoted_identifier_case>,
C<sql_handler>, C<sql_init_order>, C<sql_meta>, C<sql_engine_version>,
C<sql_nano_version> and C<sql_statement_version> when L<SQL::Statement>
is available.
It sets C<sql_init_order> to the given C<$phase>.
When the derived implementor class provides the attribute to validate
attributes (e.g. C<< $dbh->{dbm_valid_attrs} = {...}; >>) or the attribute
containing the immutable attributes (e.g. C<< $dbh->{dbm_readonly_attrs}
= {...}; >>), the attributes C<drv_valid_attrs>, C<drv_readonly_attrs> and
C<drv_version> are added (when available) to the list of valid and
immutable attributes (where C<drv_> is interpreted as the driver prefix).
=item get_versions
This method is called by the code injected into the instantiated driver to
provide the user callable driver method C<< ${prefix}versions >> (e.g.
C<< dbm_versions >>, C<< csv_versions >>, ...).
The DBI::DBD::SqlEngine implementation returns all version information known by
DBI::DBD::SqlEngine (e.g. DBI version, Perl version, DBI::DBD::SqlEngine version and
the SQL handler version).
C<get_versions> takes the C<$dbh> as the first argument and optionally a
second argument containing a table name. The second argument is not
evaluated in C<< DBI::DBD::SqlEngine::db::get_versions >> itself - but
might be in the future.
If the derived implementor class provides a method named
C<get_${drv_prefix}versions>, this is invoked and the return value of
it is associated to the derived driver name:
if (my $dgv = $dbh->{ImplementorClass}->can ("get_" . $drv_prefix . "versions") {
(my $derived_driver = $dbh->{ImplementorClass}) =~ s/::db$//;
$versions{$derived_driver} = &$dgv ($dbh, $table);
}
Override it to add more version information about your module, (e.g.
some kind of parser version in case of DBD::CSV, ...), if one line is not
enough room to provide all relevant information.
=item sql_parser_object
Returns a L<SQL::Parser> instance, when C<< sql_handler >> is set to
"SQL::Statement". The parser instance is stored in C<< sql_parser_object >>.
It is not recommended to override this method.
=item disconnect
Disconnects from a database. All local table information is discarded and
the C<< Active >> attribute is set to 0.
=item type_info_all
Returns information about all the types supported by DBI::DBD::SqlEngine.
=item table_info
Returns a statement handle which is prepared to deliver information about
all known tables.
=item list_tables
Returns a list of all known table names.
=item quote
Quotes a string for use in SQL statements.
=item commit
Warns about a useless call (if warnings enabled) and returns.
DBI::DBD::SqlEngine is typically a driver which commits every action
instantly when executed.
=item rollback
Warns about a useless call (if warnings enabled) and returns.
DBI::DBD::SqlEngine is typically a driver which commits every action
instantly when executed.
=back
=head3 Attributes used by C<< DBI::DBD::SqlEngine::db >>:
This section describes attributes which are important to developers of DBI
Database Drivers derived from C<DBI::DBD::SqlEngine>.
=over 4
=item sql_init_order
This attribute contains a hash with priorities as key and an array
containing the C<$dbh> attributes to be initialized during before/after
other attributes.
C<DBI::DBD::SqlEngine> initializes following attributes:
$dbh->{sql_init_order} = {
0 => [qw( Profile RaiseError PrintError AutoCommit )],
90 => [ "sql_meta", $dbh->{$drv_pfx_meta} ? $dbh->{$drv_pfx_meta} : () ]
}
The default priority of not listed attribute keys is C<50>. It is well
known that a lot of attributes needed to be set before some table settings
are initialized. For example, for L<DBD::DBM>, when using
my $dbh = DBI->connect( "dbi:DBM:", undef, undef, {
f_dir => "/path/to/dbm/databases",
dbm_type => "BerkeleyDB",
dbm_mldbm => "JSON", # use MLDBM::Serializer::JSON
dbm_tables => {
quick => {
dbm_type => "GDBM_File",
dbm_MLDBM => "FreezeThaw"
}
}
});
This defines a known table C<quick> which uses the L<GDBM_File> backend and
L<FreezeThaw> as serializer instead of the overall default L<BerkeleyDB> and
L<JSON>. B<But> all files containing the table data have to be searched in
C<< $dbh->{f_dir} >>, which requires C<< $dbh->{f_dir} >> must be initialized
before C<< $dbh->{sql_meta}->{quick} >> is initialized by
C<bootstrap_table_meta> method of L</DBI::DBD::SqlEngine::Table> to get
C<< $dbh->{sql_meta}->{quick}->{f_dir} >> being initialized properly.
=item sql_init_phase
This attribute is only set during the initialization steps of the DBI
Database Driver. It contains the value of the currently run initialization
phase. Currently supported phases are I<phase 0> and I<phase 1>. This
attribute is set in C<init_default_attributes> and removed in C<init_done>.
=item sql_engine_in_gofer
This value has a true value in case of this driver is operated via
L<DBD::Gofer>. The impact of being operated via Gofer is a read-only
driver (not read-only databases!), so you cannot modify any attributes
later - neither any table settings. B<But> you won't get an error in
cases you modify table attributes, so please carefully watch
C<sql_engine_in_gofer>.
=item sql_table_source
Names a class which is responsible for delivering I<data sources> and
I<available tables> (Database Driver related). I<data sources> here
refers to L<DBI/data_sources>, not C<sql_data_source>.
See L</DBI::DBD::SqlEngine::TableSource> for details.
=item sql_data_source
Name a class which is responsible for handling table resources open
and completing table names requested via SQL statements.
See L</DBI::DBD::SqlEngine::DataSource> for details.
=item sql_dialect
Controls the dialect understood by SQL::Parser. Possible values (delivery
state of SQL::Statement):
* ANSI
* CSV
* AnyData
Defaults to "CSV". Because an SQL::Parser is instantiated only once and
SQL::Parser doesn't allow one to modify the dialect once instantiated,
it's strongly recommended to set this flag before any statement is
executed (best place is connect attribute hash).
=back
=head2 DBI::DBD::SqlEngine::st
Contains the methods to deal with prepared statement handles:
=over 4
=item bind_param
Common routine to bind placeholders to a statement for execution. It
is dangerous to override this method without detailed knowledge about
the DBI::DBD::SqlEngine internal storage structure.
=item execute
Executes a previously prepared statement (with placeholders, if any).
=item finish
Finishes a statement handle, discards all buffered results. The prepared
statement is not discarded so the statement can be executed again.
=item fetch
Fetches the next row from the result-set. This method may be rewritten
in a later version and if it's overridden in a derived class, the
derived implementation should not rely on the storage details.
=item fetchrow_arrayref
Alias for C<< fetch >>.
=item FETCH
Fetches statement handle attributes. Supported attributes (for full overview
see L<DBI/Statement Handle Attributes>) are C<NAME>, C<TYPE>, C<PRECISION>
and C<NULLABLE>. Each column is returned as C<NULLABLE> which might be wrong
depending on the derived backend storage. If the statement handle has
private attributes, they can be fetched using this method, too. B<Note> that
statement attributes are not associated with any table used in this statement.
This method usually requires extending in a derived implementation.
See L<DBD::CSV> or L<DBD::DBM> for some example.
=item STORE
Allows storing of statement private attributes. No special handling is
currently implemented here.
=item rows
Returns the number of rows affected by the last execute. This method might
return C<undef>.
=back
=head2 DBI::DBD::SqlEngine::TableSource
Provides data sources and table information on database driver and database
handle level.
package DBI::DBD::SqlEngine::TableSource;
sub data_sources ($;$)
{
my ( $class, $drh, $attrs ) = @_;
...
}
sub avail_tables
{
my ( $class, $drh ) = @_;
...
}
The C<data_sources> method is called when the user invokes any of the
following:
@ary = DBI->data_sources($driver);
@ary = DBI->data_sources($driver, \%attr);
@ary = $dbh->data_sources();
@ary = $dbh->data_sources(\%attr);
The C<avail_tables> method is called when the user invokes any of the
following:
@names = $dbh->tables( $catalog, $schema, $table, $type );
$sth = $dbh->table_info( $catalog, $schema, $table, $type );
$sth = $dbh->table_info( $catalog, $schema, $table, $type, \%attr );
$dbh->func( "list_tables" );
Every time where an C<\%attr> argument can be specified, this C<\%attr>
object's C<sql_table_source> attribute is preferred over the C<$dbh>
attribute or the driver default.
=head2 DBI::DBD::SqlEngine::DataSource
Provides base functionality for dealing with tables. It is primarily
designed for allowing transparent access to files on disk or already
opened (file-)streams (e.g. for DBD::CSV).
Derived classes shall be restricted to similar functionality, too (e.g.
opening streams from an archive, transparently compress/uncompress
log files before parsing them,
package DBI::DBD::SqlEngine::DataSource;
sub complete_table_name ($$;$)
{
my ( $self, $meta, $table, $respect_case ) = @_;
...
}
The method C<complete_table_name> is called when first setting up the
I<meta information> for a table:
"SELECT user.id, user.name, user.shell FROM user WHERE ..."
results in opening the table C<user>. First step of the table open
process is completing the name. Let's imagine you're having a L<DBD::CSV>
handle with following settings:
$dbh->{sql_identifier_case} = SQL_IC_LOWER;
$dbh->{f_ext} = '.lst';
$dbh->{f_dir} = '/data/web/adrmgr';
Those settings will result in looking for files matching
C<[Uu][Ss][Ee][Rr](\.lst)?$> in C</data/web/adrmgr/>. The scanning of the
directory C</data/web/adrmgr/> and the pattern match check will be done
in C<DBD::File::DataSource::File> by the C<complete_table_name> method.
If you intend to provide other sources of data streams than files, in
addition to provide an appropriate C<complete_table_name> method, a method
to open the resource is required:
package DBI::DBD::SqlEngine::DataSource;
sub open_data ($)
{
my ( $self, $meta, $attrs, $flags ) = @_;
...
}
After the method C<open_data> has been run successfully, the table's meta
information are in a state which allows the table's data accessor methods
will be able to fetch/store row information. Implementation details heavily
depends on the table implementation, whereby the most famous is surely
L<DBD::File::Table|DBD::File/DBD::File::Table>.
=head2 DBI::DBD::SqlEngine::Statement
Derives from DBI::SQL::Nano::Statement for unified naming when deriving
new drivers. No additional feature is provided from here.
=head2 DBI::DBD::SqlEngine::Table
Derives from DBI::SQL::Nano::Table for unified naming when deriving
new drivers.
You should consult the documentation of C<< SQL::Eval::Table >> (see
L<SQL::Eval>) to get more information about the abstract methods of the
table's base class you have to override and a description of the table
meta information expected by the SQL engines.
=over 4
=item bootstrap_table_meta
Initializes a table meta structure. Can be safely overridden in a
derived class, as long as the C<< SUPER >> method is called at the end
of the overridden method.
It copies the following attributes from the database into the table meta data
C<< $dbh->{ReadOnly} >> into C<< $meta->{readonly} >>, C<sql_identifier_case>
and C<sql_data_source> and makes them sticky to the table.
This method should be called before you attempt to map between file
name and table name to ensure the correct directory, extension etc. are
used.
=item init_table_meta
Initializes more attributes of the table meta data - usually more
expensive ones (e.g. those which require class instantiations) - when
the file name and the table name could mapped.
=item get_table_meta
Returns the table meta data. If there are none for the required table,
a new one is initialized. When after bootstrapping a new I<table_meta>
and L<completing the table name|/DBI::DBD::SqlEngine::DataSource> a
mapping can be established between an existing I<table_meta> and the
new bootstrapped one, the already existing is used and a mapping
shortcut between the recent used table name and the already known
table name is hold in C<< $dbh->{sql_meta_map} >>. When it fails,
nothing is returned. On success, the name of the table and the meta data
structure is returned.
=item get_table_meta_attr
Returns a single attribute from the table meta data. If the attribute
name appears in C<%compat_map>, the attribute name is updated from
there.
=item set_table_meta_attr
Sets a single attribute in the table meta data. If the attribute
name appears in C<%compat_map>, the attribute name is updated from
there.
=item table_meta_attr_changed
Called when an attribute of the meta data is modified.
If the modified attribute requires to reset a calculated attribute, the
calculated attribute is reset (deleted from meta data structure) and
the I<initialized> flag is removed, too. The decision is made based on
C<%register_reset_on_modify>.
=item register_reset_on_modify
Allows C<set_table_meta_attr> to reset meta attributes when special
attributes are modified. For DBD::File, modifying one of C<f_file>, C<f_dir>,
C<f_ext> or C<f_lockfile> will reset C<f_fqfn>. DBD::DBM extends the
list for C<dbm_type> and C<dbm_mldbm> to reset the value of C<dbm_tietype>.
If your DBD has calculated values in the meta data area, then call
C<register_reset_on_modify>:
my %reset_on_modify = ( "xxx_foo" => "xxx_bar" );
__PACKAGE__->register_reset_on_modify( \%reset_on_modify );
=item register_compat_map
Allows C<get_table_meta_attr> and C<set_table_meta_attr> to update the
attribute name to the current favored one:
# from DBD::DBM
my %compat_map = ( "dbm_ext" => "f_ext" );
__PACKAGE__->register_compat_map( \%compat_map );
=item open_data
Called to open the table's data storage. This is silently forwarded
to C<< $meta->{sql_data_source}->open_data() >>.
After this is done, a derived class might add more steps in an overridden
C<< open_file >> method.
=item new
Instantiates the table. This is done in 3 steps:
1. get the table meta data
2. open the data file
3. bless the table data structure using inherited constructor new
It is not recommended to override the constructor of the table class.
Find a reasonable place to add you extensions in one of the above four
methods.
=back
=head1 AUTHOR
The module DBI::DBD::SqlEngine is currently maintained by
H.Merijn Brand < h.m.brand at xs4all.nl > and
Jens Rehsack < rehsack at googlemail.com >
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2010 by H.Merijn Brand & Jens Rehsack
All rights reserved.
You may freely distribute and/or modify this module under the terms of
either the GNU General Public License (GPL) or the Artistic License, as
specified in the Perl README file.
=cut
PK V`[�S�K* K* DBD/SqlEngine/HowTo.podnu �[��� =head1 NAME
DBI::DBD::SqlEngine::HowTo - Guide to create DBI::DBD::SqlEngine based driver
=head1 SYNOPSIS
perldoc DBI::DBD::SqlEngine::HowTo
perldoc DBI
perldoc DBI::DBD
perldoc DBI::DBD::SqlEngine::Developers
perldoc SQL::Eval
perldoc DBI::DBD::SqlEngine
perldoc DBI::DBD::SqlEngine::HowTo
perldoc SQL::Statement::Embed
=head1 DESCRIPTION
This document provides a step-by-step guide, how to create a new
C<DBI::DBD::SqlEngine> based DBD. It expects that you carefully read the
L<DBI> documentation and that you're familiar with L<DBI::DBD> and had
read and understood L<DBD::ExampleP>.
This document addresses experienced developers who are really sure that
they need to invest time when writing a new DBI Driver. Writing a DBI
Driver is neither a weekend project nor an easy job for hobby coders
after work. Expect one or two man-month of time for the first start.
Those who are still reading, should be able to sing the rules of
L<DBI::DBD/CREATING A NEW DRIVER>.
=head1 CREATING DRIVER CLASSES
Do you have an entry in DBI's DBD registry? DBI::DBD::SqlEngine expect
having a unique prefix for every driver class in inheritance chain.
It's easy to get a prefix - just drop the DBI team a note
(L<DBI/GETTING_HELP>). If you want for some reason hide your work, take
a look at L<Class::Method::Modifiers> how to wrap a private prefix method
around existing C<driver_prefix>.
For this guide, a prefix of C<foo_> is assumed.
=head2 Sample Skeleton
package DBD::Foo;
use strict;
use warnings;
use vars qw($VERSION);
use base qw(DBI::DBD::SqlEngine);
use DBI ();
$VERSION = "0.001";
package DBD::Foo::dr;
use vars qw(@ISA $imp_data_size);
@ISA = qw(DBI::DBD::SqlEngine::dr);
$imp_data_size = 0;
package DBD::Foo::db;
use vars qw(@ISA $imp_data_size);
@ISA = qw(DBI::DBD::SqlEngine::db);
$imp_data_size = 0;
package DBD::Foo::st;
use vars qw(@ISA $imp_data_size);
@ISA = qw(DBI::DBD::SqlEngine::st);
$imp_data_size = 0;
package DBD::Foo::Statement;
use vars qw(@ISA);
@ISA = qw(DBI::DBD::SqlEngine::Statement);
package DBD::Foo::Table;
use vars qw(@ISA);
@ISA = qw(DBI::DBD::SqlEngine::Table);
1;
Tiny, eh? And all you have now is a DBD named foo which will is able to
deal with temporary tables, as long as you use L<SQL::Statement>. In
L<DBI::SQL::Nano> environments, this DBD can do nothing.
=head2 Deal with own attributes
Before we start doing usable stuff with our DBI driver, we need to think
about what we want to do and how we want to do it.
Do we need tunable knobs accessible by users? Do we need status
information? All this is handled in attributes of the database handles (be
careful when your DBD is running "behind" a L<DBD::Gofer> proxy).
How come the attributes into the DBD and how are they fetchable by the
user? Good question, but you should know because you've read the L<DBI>
documentation.
C<DBI::DBD::SqlEngine::db::FETCH> and C<DBI::DBD::SqlEngine::db::STORE>
taking care for you - all they need to know is which attribute names
are valid and mutable or immutable. Tell them by adding
C<init_valid_attributes> to your db class:
sub init_valid_attributes
{
my $dbh = $_[0];
$dbh->SUPER::init_valid_attributes ();
$dbh->{foo_valid_attrs} = {
foo_version => 1, # contains version of this driver
foo_valid_attrs => 1, # contains the valid attributes of foo drivers
foo_readonly_attrs => 1, # contains immutable attributes of foo drivers
foo_bar => 1, # contains the bar attribute
foo_baz => 1, # contains the baz attribute
foo_manager => 1, # contains the manager of the driver instance
foo_manager_type => 1, # contains the manager class of the driver instance
};
$dbh->{foo_readonly_attrs} = {
foo_version => 1, # ensure no-one modifies the driver version
foo_valid_attrs => 1, # do not permit one to add more valid attributes ...
foo_readonly_attrs => 1, # ... or make the immutable mutable
foo_manager => 1, # manager is set internally only
};
return $dbh;
}
Woooho - but now the user cannot assign new managers? This is intended,
overwrite C<STORE> to handle it!
sub STORE ($$$)
{
my ( $dbh, $attrib, $value ) = @_;
$dbh->SUPER::STORE( $attrib, $value );
# we're still alive, so no exception is thrown ...
# by DBI::DBD::SqlEngine::db::STORE
if ( $attrib eq "foo_manager_type" )
{
$dbh->{foo_manager} = $dbh->{foo_manager_type}->new();
# ... probably correct some states based on the new
# foo_manager_type - see DBD::Sys for an example
}
}
But ... my driver runs without a manager until someone first assignes
a C<foo_manager_type>. Well, no - there're two places where you can
initialize defaults:
sub init_default_attributes
{
my ($dbh, $phase) = @_;
$dbh->SUPER::init_default_attributes($phase);
if( 0 == $phase )
{
# init all attributes which have no knowledge about
# user settings from DSN or the attribute hash
$dbh->{foo_manager_type} = "DBD::Foo::Manager";
}
elsif( 1 == $phase )
{
# init phase with more knowledge from DSN or attribute
# hash
$dbh->{foo_manager} = $dbh->{foo_manager_type}->new();
}
return $dbh;
}
So far we can prevent the users to use our database driver as data
storage for anything and everything. We care only about the real important
stuff for peace on earth and alike attributes. But in fact, the driver
still can't do anything. It can do less than nothing - meanwhile it's
not a stupid storage area anymore.
=head2 User comfort
C<DBI::DBD::SqlEngine> since C<0.05> consolidates all persistent meta data
of a table into a single structure stored in C<< $dbh->{sql_meta} >>. While
DBI::DBD::SqlEngine provides only readonly access to this structure,
modifications are still allowed.
Primarily DBI::DBD::SqlEngine provides access via the setters
C<new_sql_engine_meta>, C<get_sql_engine_meta>, C<get_single_table_meta>,
C<set_single_table_meta>, C<set_sql_engine_meta> and C<clear_sql_engine_meta>.
Those methods are easily accessible by the users via the C<< $dbh->func () >>
interface provided by DBI. Well, many users don't feel comfortize when calling
# don't require extension for tables cars
$dbh->func ("cars", "f_ext", ".csv", "set_sql_engine_meta");
DBI::DBD::SqlEngine will inject a method into your driver to increase the
user comfort to allow:
# don't require extension for tables cars
$dbh->foo_set_meta ("cars", "f_ext", ".csv");
Better, but here and there users likes to do:
# don't require extension for tables cars
$dbh->{foo_tables}->{cars}->{f_ext} = ".csv";
This interface is provided when derived DBD's define following in
C<init_valid_attributes> (re-capture L</Deal with own attributes>):
sub init_valid_attributes
{
my $dbh = $_[0];
$dbh->SUPER::init_valid_attributes ();
$dbh->{foo_valid_attrs} = {
foo_version => 1, # contains version of this driver
foo_valid_attrs => 1, # contains the valid attributes of foo drivers
foo_readonly_attrs => 1, # contains immutable attributes of foo drivers
foo_bar => 1, # contains the bar attribute
foo_baz => 1, # contains the baz attribute
foo_manager => 1, # contains the manager of the driver instance
foo_manager_type => 1, # contains the manager class of the driver instance
foo_meta => 1, # contains the public interface to modify table meta attributes
};
$dbh->{foo_readonly_attrs} = {
foo_version => 1, # ensure no-one modifies the driver version
foo_valid_attrs => 1, # do not permit one to add more valid attributes ...
foo_readonly_attrs => 1, # ... or make the immutable mutable
foo_manager => 1, # manager is set internally only
foo_meta => 1, # ensure public interface to modify table meta attributes are immutable
};
$dbh->{foo_meta} = "foo_tables";
return $dbh;
}
This provides a tied hash in C<< $dbh->{foo_tables} >> and a tied hash for
each table's meta data in C<< $dbh->{foo_tables}->{$table_name} >>.
Modifications on the table meta attributes are done using the table
methods:
sub get_table_meta_attr { ... }
sub set_table_meta_attr { ... }
Both methods can adjust the attribute name for compatibility reasons, e.g.
when former versions of the DBD allowed different names to be used for the
same flag:
my %compat_map = (
abc => 'foo_abc',
xyz => 'foo_xyz',
);
__PACKAGE__->register_compat_map( \%compat_map );
If any user modification on a meta attribute needs reinitialization of
the meta structure (in case of C<DBI::DBD::SqlEngine> these are the attributes
C<f_file>, C<f_dir>, C<f_ext> and C<f_lockfile>), inform DBI::DBD::SqlEngine by
doing
my %reset_on_modify = (
foo_xyz => "foo_bar",
foo_abc => "foo_bar",
);
__PACKAGE__->register_reset_on_modify( \%reset_on_modify );
The next access to the table meta data will force DBI::DBD::SqlEngine to re-do the
entire meta initialization process.
Any further action which needs to be taken can handled in
C<table_meta_attr_changed>:
sub table_meta_attr_changed
{
my ($class, $meta, $attrib, $value) = @_;
...
$class->SUPER::table_meta_attr_changed ($meta, $attrib, $value);
}
This is done before the new value is set in C<$meta>, so the attribute
changed handler can act depending on the old value.
=head2 Dealing with Tables
Let's put some life into it - it's going to be time for it.
This is a good point where a quick side step to L<SQL::Statement::Embed>
will help to shorten the next paragraph. The documentation in
SQL::Statement::Embed regarding embedding in own DBD's works pretty
fine with SQL::Statement and DBI::SQL::Nano.
Second look should go to L<DBI::DBD::SqlEngine::Developers> to get a
picture over the driver part of the table API. Usually there isn't much
to do for an easy driver.
=head2 Testing
Now you should have your first own DBD. Was easy, wasn't it? But does
it work well? Prove it by writing tests and remember to use
dbd_edit_mm_attribs from L<DBI::DBD> to ensure testing even rare cases.
=head1 AUTHOR
This guide is written by Jens Rehsack. DBI::DBD::SqlEngine is written by
Jens Rehsack using code from DBD::File originally written by Jochen
Wiedmann and Jeff Zucker.
The module DBI::DBD::SqlEngine is currently maintained by
H.Merijn Brand < h.m.brand at xs4all.nl > and
Jens Rehsack < rehsack at googlemail.com >
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2010 by H.Merijn Brand & Jens Rehsack
All rights reserved.
You may freely distribute and/or modify this module under the terms of
either the GNU General Public License (GPL) or the Artistic License, as
specified in the Perl README file.
=cut
PK V`[E
� N N ProfileData.pmnu �[��� package DBI::ProfileData;
use strict;
=head1 NAME
DBI::ProfileData - manipulate DBI::ProfileDumper data dumps
=head1 SYNOPSIS
The easiest way to use this module is through the dbiprof frontend
(see L<dbiprof> for details):
dbiprof --number 15 --sort count
This module can also be used to roll your own profile analysis:
# load data from dbi.prof
$prof = DBI::ProfileData->new(File => "dbi.prof");
# get a count of the records (unique paths) in the data set
$count = $prof->count();
# sort by longest overall time
$prof->sort(field => "longest");
# sort by longest overall time, least to greatest
$prof->sort(field => "longest", reverse => 1);
# exclude records with key2 eq 'disconnect'
$prof->exclude(key2 => 'disconnect');
# exclude records with key1 matching /^UPDATE/i
$prof->exclude(key1 => qr/^UPDATE/i);
# remove all records except those where key1 matches /^SELECT/i
$prof->match(key1 => qr/^SELECT/i);
# produce a formatted report with the given number of items
$report = $prof->report(number => 10);
# clone the profile data set
$clone = $prof->clone();
# get access to hash of header values
$header = $prof->header();
# get access to sorted array of nodes
$nodes = $prof->nodes();
# format a single node in the same style as report()
$text = $prof->format($nodes->[0]);
# get access to Data hash in DBI::Profile format
$Data = $prof->Data();
=head1 DESCRIPTION
This module offers the ability to read, manipulate and format
L<DBI::ProfileDumper> profile data.
Conceptually, a profile consists of a series of records, or nodes,
each of each has a set of statistics and set of keys. Each record
must have a unique set of keys, but there is no requirement that every
record have the same number of keys.
=head1 METHODS
The following methods are supported by DBI::ProfileData objects.
=cut
our $VERSION = "2.010008";
use Carp qw(croak);
use Symbol;
use Fcntl qw(:flock);
use DBI::Profile qw(dbi_profile_merge);
# some constants for use with node data arrays
sub COUNT () { 0 };
sub TOTAL () { 1 };
sub FIRST () { 2 };
sub SHORTEST () { 3 };
sub LONGEST () { 4 };
sub FIRST_AT () { 5 };
sub LAST_AT () { 6 };
sub PATH () { 7 };
my $HAS_FLOCK = (defined $ENV{DBI_PROFILE_FLOCK})
? $ENV{DBI_PROFILE_FLOCK}
: do { local $@; eval { flock STDOUT, 0; 1 } };
=head2 $prof = DBI::ProfileData->new(File => "dbi.prof")
=head2 $prof = DBI::ProfileData->new(File => "dbi.prof", Filter => sub { ... })
=head2 $prof = DBI::ProfileData->new(Files => [ "dbi.prof.1", "dbi.prof.2" ])
Creates a new DBI::ProfileData object. Takes either a single file
through the File option or a list of Files in an array ref. If
multiple files are specified then the header data from the first file
is used.
=head3 Files
Reference to an array of file names to read.
=head3 File
Name of file to read. Takes precedence over C<Files>.
=head3 DeleteFiles
If true, the files are deleted after being read.
Actually the files are renamed with a C<deleteme> suffix before being read,
and then, after reading all the files, they're all deleted together.
The files are locked while being read which, combined with the rename, makes it
safe to 'consume' files that are still being generated by L<DBI::ProfileDumper>.
=head3 Filter
The C<Filter> parameter can be used to supply a code reference that can
manipulate the profile data as it is being read. This is most useful for
editing SQL statements so that slightly different statements in the raw data
will be merged and aggregated in the loaded data. For example:
Filter => sub {
my ($path_ref, $data_ref) = @_;
s/foo = '.*?'/foo = '...'/ for @$path_ref;
}
Here's an example that performs some normalization on the SQL. It converts all
numbers to C<N> and all quoted strings to C<S>. It can also convert digits to
N within names. Finally, it summarizes long "IN (...)" clauses.
It's aggressive and simplistic, but it's often sufficient, and serves as an
example that you can tailor to suit your own needs:
Filter => sub {
my ($path_ref, $data_ref) = @_;
local $_ = $path_ref->[0]; # whichever element contains the SQL Statement
s/\b\d+\b/N/g; # 42 -> N
s/\b0x[0-9A-Fa-f]+\b/N/g; # 0xFE -> N
s/'.*?'/'S'/g; # single quoted strings (doesn't handle escapes)
s/".*?"/"S"/g; # double quoted strings (doesn't handle escapes)
# convert names like log_20001231 into log_NNNNNNNN, controlled by $opt{n}
s/([a-z_]+)(\d{$opt{n},})/$1.('N' x length($2))/ieg if $opt{n};
# abbreviate massive "in (...)" statements and similar
s!(([NS],){100,})!sprintf("$2,{repeated %d times}",length($1)/2)!eg;
}
It's often better to perform this kinds of normalization in the DBI while the
data is being collected, to avoid too much memory being used by storing profile
data for many different SQL statement. See L<DBI::Profile>.
=cut
sub new {
my $pkg = shift;
my $self = {
Files => [ "dbi.prof" ],
Filter => undef,
DeleteFiles => 0,
LockFile => $HAS_FLOCK,
_header => {},
_nodes => [],
_node_lookup => {},
_sort => 'none',
@_
};
bless $self, $pkg;
# File (singular) overrides Files (plural)
$self->{Files} = [ $self->{File} ] if exists $self->{File};
$self->_read_files();
return $self;
}
# read files into _header and _nodes
sub _read_files {
my $self = shift;
my $files = $self->{Files};
my $read_header = 0;
my @files_to_delete;
my $fh = gensym;
foreach (@$files) {
my $filename = $_;
if ($self->{DeleteFiles}) {
my $newfilename = $filename . ".deleteme";
if ($^O eq 'VMS') {
# VMS default filesystem can only have one period
$newfilename = $filename . 'deleteme';
}
# will clobber an existing $newfilename
rename($filename, $newfilename)
or croak "Can't rename($filename, $newfilename): $!";
# On a versioned filesystem we want old versions to be removed
1 while (unlink $filename);
$filename = $newfilename;
}
open($fh, "<", $filename)
or croak("Unable to read profile file '$filename': $!");
# lock the file in case it's still being written to
# (we'll be forced to wait till the write is complete)
flock($fh, LOCK_SH) if $self->{LockFile};
if (-s $fh) { # not empty
$self->_read_header($fh, $filename, $read_header ? 0 : 1);
$read_header = 1;
$self->_read_body($fh, $filename);
}
close($fh); # and release lock
push @files_to_delete, $filename
if $self->{DeleteFiles};
}
for (@files_to_delete){
# for versioned file systems
1 while (unlink $_);
if(-e $_){
warn "Can't delete '$_': $!";
}
}
# discard node_lookup now that all files are read
delete $self->{_node_lookup};
}
# read the header from the given $fh named $filename. Discards the
# data unless $keep.
sub _read_header {
my ($self, $fh, $filename, $keep) = @_;
# get profiler module id
my $first = <$fh>;
chomp $first;
$self->{_profiler} = $first if $keep;
# collect variables from the header
local $_;
while (<$fh>) {
chomp;
last unless length $_;
/^(\S+)\s*=\s*(.*)/
or croak("Syntax error in header in $filename line $.: $_");
# XXX should compare new with existing (from previous file)
# and warn if they differ (different program or path)
$self->{_header}{$1} = unescape_key($2) if $keep;
}
}
sub unescape_key { # inverse of escape_key() in DBI::ProfileDumper
local $_ = shift;
s/(?<!\\)\\n/\n/g; # expand \n, unless it's a \\n
s/(?<!\\)\\r/\r/g; # expand \r, unless it's a \\r
s/\\\\/\\/g; # \\ to \
return $_;
}
# reads the body of the profile data
sub _read_body {
my ($self, $fh, $filename) = @_;
my $nodes = $self->{_nodes};
my $lookup = $self->{_node_lookup};
my $filter = $self->{Filter};
# build up node array
my @path = ("");
my (@data, $path_key);
local $_;
while (<$fh>) {
chomp;
if (/^\+\s+(\d+)\s?(.*)/) {
# it's a key
my ($key, $index) = ($2, $1 - 1);
$#path = $index; # truncate path to new length
$path[$index] = unescape_key($key); # place new key at end
}
elsif (s/^=\s+//) {
# it's data - file in the node array with the path in index 0
# (the optional minus is to make it more robust against systems
# with unstable high-res clocks - typically due to poor NTP config
# of kernel SMP behaviour, i.e. min time may be -0.000008))
@data = split / /, $_;
# corrupt data?
croak("Invalid number of fields in $filename line $.: $_")
unless @data == 7;
croak("Invalid leaf node characters $filename line $.: $_")
unless m/^[-+ 0-9eE\.]+$/;
# hook to enable pre-processing of the data - such as mangling SQL
# so that slightly different statements get treated as the same
# and so merged in the results
$filter->(\@path, \@data) if $filter;
# elements of @path can't have NULLs in them, so this
# forms a unique string per @path. If there's some way I
# can get this without arbitrarily stripping out a
# character I'd be happy to hear it!
$path_key = join("\0",@path);
# look for previous entry
if (exists $lookup->{$path_key}) {
# merge in the new data
dbi_profile_merge($nodes->[$lookup->{$path_key}], \@data);
} else {
# insert a new node - nodes are arrays with data in 0-6
# and path data after that
push(@$nodes, [ @data, @path ]);
# record node in %seen
$lookup->{$path_key} = $#$nodes;
}
}
else {
croak("Invalid line type syntax error in $filename line $.: $_");
}
}
}
=head2 $copy = $prof->clone();
Clone a profile data set creating a new object.
=cut
sub clone {
my $self = shift;
# start with a simple copy
my $clone = bless { %$self }, ref($self);
# deep copy nodes
$clone->{_nodes} = [ map { [ @$_ ] } @{$self->{_nodes}} ];
# deep copy header
$clone->{_header} = { %{$self->{_header}} };
return $clone;
}
=head2 $header = $prof->header();
Returns a reference to a hash of header values. These are the key
value pairs included in the header section of the L<DBI::ProfileDumper>
data format. For example:
$header = {
Path => [ '!Statement', '!MethodName' ],
Program => 't/42profile_data.t',
};
Note that modifying this hash will modify the header data stored
inside the profile object.
=cut
sub header { shift->{_header} }
=head2 $nodes = $prof->nodes()
Returns a reference the sorted nodes array. Each element in the array
is a single record in the data set. The first seven elements are the
same as the elements provided by L<DBI::Profile>. After that each key is
in a separate element. For example:
$nodes = [
[
2, # 0, count
0.0312958955764771, # 1, total duration
0.000490069389343262, # 2, first duration
0.000176072120666504, # 3, shortest duration
0.00140702724456787, # 4, longest duration
1023115819.83019, # 5, time of first event
1023115819.86576, # 6, time of last event
'SELECT foo FROM bar' # 7, key1
'execute' # 8, key2
# 6+N, keyN
],
# ...
];
Note that modifying this array will modify the node data stored inside
the profile object.
=cut
sub nodes { shift->{_nodes} }
=head2 $count = $prof->count()
Returns the number of items in the profile data set.
=cut
sub count { scalar @{shift->{_nodes}} }
=head2 $prof->sort(field => "field")
=head2 $prof->sort(field => "field", reverse => 1)
Sorts data by the given field. Available fields are:
longest
total
count
shortest
The default sort is greatest to smallest, which is the opposite of the
normal Perl meaning. This, however, matches the expected behavior of
the dbiprof frontend.
=cut
# sorts data by one of the available fields
{
my %FIELDS = (
longest => LONGEST,
total => TOTAL,
count => COUNT,
shortest => SHORTEST,
key1 => PATH+0,
key2 => PATH+1,
key3 => PATH+2,
);
sub sort {
my $self = shift;
my $nodes = $self->{_nodes};
my %opt = @_;
croak("Missing required field option.") unless $opt{field};
my $index = $FIELDS{$opt{field}};
croak("Unrecognized sort field '$opt{field}'.")
unless defined $index;
# sort over index
if ($opt{reverse}) {
@$nodes = sort {
$a->[$index] <=> $b->[$index]
} @$nodes;
} else {
@$nodes = sort {
$b->[$index] <=> $a->[$index]
} @$nodes;
}
# remember how we're sorted
$self->{_sort} = $opt{field};
return $self;
}
}
=head2 $count = $prof->exclude(key2 => "disconnect")
=head2 $count = $prof->exclude(key2 => "disconnect", case_sensitive => 1)
=head2 $count = $prof->exclude(key1 => qr/^SELECT/i)
Removes records from the data set that match the given string or
regular expression. This method modifies the data in a permanent
fashion - use clone() first to maintain the original data after
exclude(). Returns the number of nodes left in the profile data set.
=cut
sub exclude {
my $self = shift;
my $nodes = $self->{_nodes};
my %opt = @_;
# find key index number
my ($index, $val);
foreach (keys %opt) {
if (/^key(\d+)$/) {
$index = PATH + $1 - 1;
$val = $opt{$_};
last;
}
}
croak("Missing required keyN option.") unless $index;
if (UNIVERSAL::isa($val,"Regexp")) {
# regex match
@$nodes = grep {
$#$_ < $index or $_->[$index] !~ /$val/
} @$nodes;
} else {
if ($opt{case_sensitive}) {
@$nodes = grep {
$#$_ < $index or $_->[$index] ne $val;
} @$nodes;
} else {
$val = lc $val;
@$nodes = grep {
$#$_ < $index or lc($_->[$index]) ne $val;
} @$nodes;
}
}
return scalar @$nodes;
}
=head2 $count = $prof->match(key2 => "disconnect")
=head2 $count = $prof->match(key2 => "disconnect", case_sensitive => 1)
=head2 $count = $prof->match(key1 => qr/^SELECT/i)
Removes records from the data set that do not match the given string
or regular expression. This method modifies the data in a permanent
fashion - use clone() first to maintain the original data after
match(). Returns the number of nodes left in the profile data set.
=cut
sub match {
my $self = shift;
my $nodes = $self->{_nodes};
my %opt = @_;
# find key index number
my ($index, $val);
foreach (keys %opt) {
if (/^key(\d+)$/) {
$index = PATH + $1 - 1;
$val = $opt{$_};
last;
}
}
croak("Missing required keyN option.") unless $index;
if (UNIVERSAL::isa($val,"Regexp")) {
# regex match
@$nodes = grep {
$#$_ >= $index and $_->[$index] =~ /$val/
} @$nodes;
} else {
if ($opt{case_sensitive}) {
@$nodes = grep {
$#$_ >= $index and $_->[$index] eq $val;
} @$nodes;
} else {
$val = lc $val;
@$nodes = grep {
$#$_ >= $index and lc($_->[$index]) eq $val;
} @$nodes;
}
}
return scalar @$nodes;
}
=head2 $Data = $prof->Data()
Returns the same Data hash structure as seen in L<DBI::Profile>. This
structure is not sorted. The nodes() structure probably makes more
sense for most analysis.
=cut
sub Data {
my $self = shift;
my (%Data, @data, $ptr);
foreach my $node (@{$self->{_nodes}}) {
# traverse to key location
$ptr = \%Data;
foreach my $key (@{$node}[PATH .. $#$node - 1]) {
$ptr->{$key} = {} unless exists $ptr->{$key};
$ptr = $ptr->{$key};
}
# slice out node data
$ptr->{$node->[-1]} = [ @{$node}[0 .. 6] ];
}
return \%Data;
}
=head2 $text = $prof->format($nodes->[0])
Formats a single node into a human-readable block of text.
=cut
sub format {
my ($self, $node) = @_;
my $format;
# setup keys
my $keys = "";
for (my $i = PATH; $i <= $#$node; $i++) {
my $key = $node->[$i];
# remove leading and trailing space
$key =~ s/^\s+//;
$key =~ s/\s+$//;
# if key has newlines or is long take special precautions
if (length($key) > 72 or $key =~ /\n/) {
$keys .= " Key " . ($i - PATH + 1) . " :\n\n$key\n\n";
} else {
$keys .= " Key " . ($i - PATH + 1) . " : $key\n";
}
}
# nodes with multiple runs get the long entry format, nodes with
# just one run get a single count.
if ($node->[COUNT] > 1) {
$format = <<END;
Count : %d
Total Time : %3.6f seconds
Longest Time : %3.6f seconds
Shortest Time : %3.6f seconds
Average Time : %3.6f seconds
END
return sprintf($format, @{$node}[COUNT,TOTAL,LONGEST,SHORTEST],
$node->[TOTAL] / $node->[COUNT]) . $keys;
} else {
$format = <<END;
Count : %d
Time : %3.6f seconds
END
return sprintf($format, @{$node}[COUNT,TOTAL]) . $keys;
}
}
=head2 $text = $prof->report(number => 10)
Produces a report with the given number of items.
=cut
sub report {
my $self = shift;
my $nodes = $self->{_nodes};
my %opt = @_;
croak("Missing required number option") unless exists $opt{number};
$opt{number} = @$nodes if @$nodes < $opt{number};
my $report = $self->_report_header($opt{number});
for (0 .. $opt{number} - 1) {
$report .= sprintf("#" x 5 . "[ %d ]". "#" x 59 . "\n",
$_ + 1);
$report .= $self->format($nodes->[$_]);
$report .= "\n";
}
return $report;
}
# format the header for report()
sub _report_header {
my ($self, $number) = @_;
my $nodes = $self->{_nodes};
my $node_count = @$nodes;
# find total runtime and method count
my ($time, $count) = (0,0);
foreach my $node (@$nodes) {
$time += $node->[TOTAL];
$count += $node->[COUNT];
}
my $header = <<END;
DBI Profile Data ($self->{_profiler})
END
# output header fields
while (my ($key, $value) = each %{$self->{_header}}) {
$header .= sprintf(" %-13s : %s\n", $key, $value);
}
# output summary data fields
$header .= sprintf(<<END, $node_count, $number, $self->{_sort}, $count, $time);
Total Records : %d (showing %d, sorted by %s)
Total Count : %d
Total Runtime : %3.6f seconds
END
return $header;
}
1;
__END__
=head1 AUTHOR
Sam Tregar <sam@tregar.com>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2002 Sam Tregar
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl 5 itself.
=cut
PK V`[{q���� ��
Changes.pmnu �[��� =head1 NAME
DBI::Changes - List of significant changes to the DBI
=encoding ISO8859-1
=cut
=head2 Changes in DBI 1.641 - 19th March 2018
Remove dependency on Storable 2.16 introduced in DBI 1.639
thanks to Ribasushi #60
Avoid compiler warnings in Driver.xst #59
thanks to pali #59
=head2 Changes in DBI 1.640 - 28th January 2018
Fix test t/91_store_warning.t for perl 5.10.0
thanks to pali #57
Add Perl 5.10.0 and 5.8.1 specific versions to Travis testing
thanks to pali #57
Add registration of mariadb_ prefix for new DBD::MariaDB driver
thanks to pali #56
=head2 Changes in DBI 1.639 - 28th December 2017
Fix UTF-8 support for warn/croak calls within DBI internals,
thanks to pali #53
Fix dependency on Storable for perl older than 5.8.9,
thanks to H.Merijn Brand.
Add DBD::Mem driver, a pure-perl in-memory driver using DBI::DBD::SqlEngine,
thanks to Jens Rehsack #42
Corrected missing semicolon in example in documentation,
thanks to pali #55
=head2 Changes in DBI 1.637 - 16th August 2017
Fix use of externally controlled format string (CWE-134) thanks to pali #44
This could cause a crash if, for example, a db error contained a %.
https://cwe.mitre.org/data/definitions/134.html
Fix extension detection for DBD::File related drivers
Fix tests for perl without dot in @INC RT#120443
Fix loss of error message on parent handle, thanks to charsbar #34
Fix disappearing $_ inside callbacks, thanks to robschaber #47
Fix dependency on Storable for perl older than 5.8.9
Allow objects to be used as passwords without throwing an error, thanks to demerphq #40
Allow $sth NAME_* attributes to be set from Perl code, re #45
Added support for DBD::XMLSimple thanks to nigelhorne #38
Documentation updates:
Improve examples using eval to be more correct, thanks to pali #39
Add cautionary note to prepare_cached docs re refs in %attr #46
Small POD changes (Getting Help -> Online) thanks to openstrike #33
Adds links to more module names and fix typo, thanks to oalders #43
Typo fix thanks to bor #37
=head2 Changes in DBI 1.636 - 24th April 2016
Fix compilation for threaded perl <= 5.12 broken in 1.635 RT#113955
Revert change to DBI::PurePerl DESTROY in 1.635
Change t/16destroy.t to avoid race hazard RT#113951
Output perl version and archname in t/01basics.t
Add perl 5.22 and 5.22-extras to travis-ci config
=head2 Changes in DBI 1.635 - 24th April 2016
Fixed RaiseError/PrintError for UTF-8 errors/warnings. RT#102404
Fixed cases where ShowErrorStatement might show incorrect Statement RT#97434
Fixed DBD::Gofer for UTF-8-enabled STDIN/STDOUT
thanks to mauke PR#32
Fixed fetchall_arrayref({}) behavior with no columns
thanks to Dan McGee PR#31
Fixed tied CachedKids ref leak in attribute cache by weakening
thanks to Michael Conrad RT#113852
Fixed "panic: attempt to copy freed scalar" upon commit() or rollback()
thanks to fbriere for detailed bug report RT#102791
Ceased to ignore DESTROY of outer handle in DBI::PurePerl
Treat undef in DBI::Profile Path as string "undef"
thanks to fREW Schmidt RT#113298
Fix SQL::Nano parser to ignore trailing semicolon
thanks to H.Merijn Brand.
Added @ary = $dbh->selectall_array(...) method
thanks to Ed Avis RT#106411
Added appveyor support (Travis like CI for windows)
thanks to mbeijen PR#30
Corrected spelling errors in pod
thanks to Gregor Herrmann RT#107838
Corrected and/or removed broken links to SQL standards
thanks to David Pottage RT#111437
Corrected doc example to use dbi: instead of DBI: in DSN
thanks to Michael R. Davis RT#101181
Removed/updated broken links in docs
thanks to mbeijen PR#29
Clarified docs for DBI::hash($string)
Removed the ancient DBI::FAQ module RT#102714
Fixed t/pod.t to require Test::Pod >= 1.41 RT#101769
This release was developed at the Perl QA Hackathon 2016
L<http://act.qa-hackathon.org/qa2016/>
which was made possible by the generosity of many sponsors:
L<https://www.fastmail.com> FastMail,
L<https://www.ziprecruiter.com> ZipRecruiter,
L<http://www.activestate.com> ActiveState,
L<http://www.opusvl.com> OpusVL,
L<https://www.strato.com> Strato,
L<http://www.surevoip.co.uk> SureVoIP,
L<http://www.cv-library.co.uk> CV-Library,
L<https://www.iinteractive.com/> Infinity,
L<https://opensource.careers/perl-careers/> Perl Careers,
L<https://www.mongodb.com> MongoDB,
L<https://www.thinkproject.com> thinkproject!,
L<https://www.dreamhost.com/> Dreamhost,
L<http://www.perl6.org/> Perl 6,
L<http://www.perl-services.de/> Perl Services,
L<https://www.evozon.com/> Evozon,
L<http://www.booking.com> Booking,
L<http://eligo.co.uk> Eligo,
L<http://www.oetiker.ch/> Oetiker+Partner,
L<http://capside.com/en/> CAPSiDE,
L<https://www.procura.nl/> Procura,
L<https://constructor.io/> Constructor.io,
L<https://metacpan.org/author/BABF> Robbie Bow,
L<https://metacpan.org/author/RSAVAGE> Ron Savage,
L<https://metacpan.org/author/ITCHARLIE> Charlie Gonzalez,
L<https://twitter.com/jscook2345> Justin Cook.
=head2 Changes in DBI 1.634 - 3rd August 2015
Enabled strictures on all modules (Jose Luis Perez Diez) #22
Note that this might cause new exceptions in existing code.
Please take time for extra testing before deploying to production.
Improved handling of row counts for compiled drivers and enable them to
return larger row counts (IV type) by defining new *_iv macros.
Fixed quote_identifier that was adding a trailing separator when there
was only a catalog (Martin J. Evans)
Removed redundant keys() call in fetchall_arrayref with hash slice (ilmari) #24
Corrected pod xref to Placeholders section (Matthew D. Fuller)
Corrected pod grammar (Nick Tonkin) #25
Added support for tables('', '', '', '%') special case (Martin J. Evans)
Added support for DBD prefixes with numbers (Jens Rehsack) #19
Added extra initializer for DBI::DBD::SqlEngine based DBD's (Jens Rehsack)
Added Memory Leaks section to the DBI docs (Tim)
Added Artistic v1 & GPL v1 LICENSE file (Jose Luis Perez Diez) #21
=head2 Changes in DBI 1.633 - 11th Jan 2015
Fixed selectrow_*ref to return undef on error in list context
instead if an empty list.
Changed t/42prof_data.t more informative
Changed $sth->{TYPE} to be NUMERIC in DBD::File drivers as per the
DBI docs. Note TYPE_NAME is now also available. [H.Merijn Brand]
Fixed compilation error on bleadperl due DEFSV no longer being an lvalue
[Dagfinn Ilmari Manns�ker]
Added docs for escaping placeholders using a backslash.
Added docs for get_info(9000) indicating ability to escape placeholders.
Added multi_ prefix for DBD::Multi (Dan Wright) and ad2_ prefix for
DBD::AnyData2
=head2 Changes in DBI 1.632 - 9th Nov 2014
Fixed risk of memory corruption with many arguments to methods
originally reported by OSCHWALD for Callbacks but may apply
to other functionality in DBI method dispatch RT#86744.
Fixed DBD::PurePerl to not set $sth->{Active} true by default
drivers are expected to set it true as needed.
Fixed DBI::DBD::SqlEngine to complain loudly when prerequite
driver_prefix is not fulfilled (RT#93204) [Jens Rehsack]
Fixed redundant sprintf argument warning RT#97062 [Reini Urban]
Fixed security issue where DBD::File drivers would open files
from folders other than specifically passed using the
f_dir attribute RT#99508 [H.Merijn Brand]
Changed delete $h->{$key} to work for keys with 'private_' prefix
per request in RT#83156. local $h->{$key} works as before.
Added security notice to DBD::Proxy and DBI::ProxyServer because they
use Storable which is insecure. Thanks to ppisar@redhat.com RT#90475
Added note to AutoInactiveDestroy docs strongly recommending that it
is enabled in all new code.
=head2 Changes in DBI 1.631 - 20th Jan 2014
NOTE: This release changes the handle passed to Callbacks from being an 'inner'
handle to being an 'outer' handle. If you have code that makes use of Callbacks,
ensure that you understand what this change means and review your callback code.
Fixed err_hash handling of integer err RT#92172 [Dagfinn Ilmari]
Fixed use of \Q vs \E in t/70callbacks.t
Changed the handle passed to Callbacks from being an 'inner'
handle to being an 'outer' handle.
Improved reliability of concurrent testing
PR#8 [Peter Rabbitson]
Changed optional dependencies to "suggest"
PR#9 [Karen Etheridge]
Changed to avoid mg_get in neatsvpv during global destruction
PR#10 [Matt Phillips]
=head2 Changes in DBI 1.630 - 28th Oct 2013
NOTE: This release enables PrintWarn by default regardless of $^W.
Your applications may generate more log messages than before.
Fixed err for new drh to be undef not to 0 [Martin J. Evans]
Fixed RT#83132 - moved DBIstcf* constants to util
export tag [Martin J. Evans]
PrintWarn is now triggered by warnings recorded in methods like STORE
that don't clear err RT#89015 [Tim Bunce]
Changed tracing to no longer show quote and quote_identifier calls
at trace level 1.
Changed DBD::Gofer ping while disconnected set_err from warn to info.
Clarified wording of log message when err is cleared.
Changed bootstrap to use $XS_VERSION RT#89618 [Andreas Koenig]
Added connect_cached.connected Callback PR#3 [David E. Wheeler]
Clarified effect of refs in connect_cached attributes [David E. Wheeler]
Extended ReadOnly attribute docs for when the driver cannot
ensure read only [Martin J. Evans]
Corrected SQL_BIGINT docs to say ODBC value is used PR#5 [ilmari]
There was no DBI 1.629 release.
=head2 Changes in DBI 1.628 - 22nd July 2013
Fixed missing fields on partial insert via DBI::DBD::SqlEngine
engines (DBD::CSV, DBD::DBM etc.) [H.Merijn Brand, Jens Rehsack]
Fixed stack corruption on callbacks RT#85562 RT#84974 [Aaron Schweiger]
Fixed DBI::SQL::Nano_::Statement handling of "0" [Jens Rehsack]
Fixed exit op precedence in test RT#87029 [Reni Urban]
Added support for finding tables in multiple directories
via new DBD::File f_dir_search attribute [H.Merijn Brand]
Enable compiling by C++ RT#84285 [Kurt Jaeger]
Typo fixes in pod and comment [David Steinbrunner]
Change DBI's docs to refer to git not svn [H.Merijn Brand]
Clarify bind_col TYPE attribute is sticky [Martin J. Evans]
Fixed reference to $sth in selectall_arrayref docs RT#84873
Spelling fixes [Ville Skytt�]
Changed $VERSIONs to hardcoded strings [H.Merijn Brand]
=head2 Changes in DBI 1.627 - 16th May 2013
Fixed VERSION regression in DBI::SQL::Nano [Tim Bunce]
=head2 Changes in DBI 1.626 - 15th May 2013
Fixed pod text/link was reversed in a few cases RT#85168
[H.Merijn Brand]
Handle aliasing of STORE'd attributes in DBI::DBD::SqlEngine
[Jens Rehsack]
Updated repository URI to git [Jens Rehsack]
Fixed skip() count arg in t/48dbi_dbd_sqlengine.t [Tim Bunce]
=head2 Changes in DBI 1.625 (svn r15595) 28th March 2013
Fixed heap-use-after-free during global destruction RT#75614
thanks to Reini Urban.
Fixed ignoring RootClass attribute during connect() by
DBI::DBD::SqlEngine reported in RT#84260 by Michael Schout
=head2 Changes in DBI 1.624 (svn r15576) 22nd March 2013
Fixed Gofer for hash randomization in perl 5.17.10+ RT#84146
Clarify docs for can() re RT#83207
=head2 Changes in DBI 1.623 (svn r15547) 2nd Jan 2013
Fixed RT#64330 - ping wipes out errstr (Martin J. Evans).
Fixed RT#75868 - DBD::Proxy shouldn't call connected() on the server.
Fixed RT#80474 - segfault in DESTROY with threads.
Fixed RT#81516 - Test failures due to hash randomisation in perl 5.17.6
thanks to Jens Rehsack and H.Merijn Brand and feedback on IRC
Fixed RT#81724 - Handle copy-on-write scalars (sprout)
Fixed unused variable / self-assignment compiler warnings.
Fixed default table_info in DBI::DBD::SqlEngine which passed NAMES
attribute instead of NAME to DBD::Sponge RT72343 (Martin J. Evans)
Corrected a spelling error thanks to Chris Sanders.
Corrected typo in DBI->installed_versions docs RT#78825
thanks to Jan Dubois.
Refactored table meta information management from DBD::File into
DBI::DBD::SqlEngine (H.Merijn Brand, Jens Rehsack)
Prevent undefined f_dir being used in opendir (H.Merijn Brand)
Added logic to force destruction of children before parents
during global destruction. See RT#75614.
Added DBD::File Plugin-Support for table names and data sources
(Jens Rehsack, #dbi Team)
Added new tests to 08keeperr for RT#64330
thanks to Kenichi Ishigaki.
Added extra internal handle type check, RT#79952
thanks to Reini Urban.
Added cubrid_ registered prefix for DBD::cubrid, RT#78453
Removed internal _not_impl method (Martin J. Evans).
NOTE: The "old-style" DBD::DBM attributes 'dbm_ext' and 'dbm_lockfile'
have been deprecated for several years and their use will now generate
a warning.
=head2 Changes in DBI 1.622 (svn r15327) 6th June 2012
Fixed lack of =encoding in non-ASCII pod docs. RT#77588
Corrected typo in DBI::ProfileDumper thanks to Finn Hakansson.
=head2 Changes in DBI 1.621 (svn r15315) 21st May 2012
Fixed segmentation fault when a thread is created from
within another thread RT#77137, thanks to Dave Mitchell.
Updated previous Changes to credit Booking.com for sponsoring
Dave Mitchell's recent DBI optimization work.
=head2 Changes in DBI 1.620 (svn r15300) 25th April 2012
Modified column renaming in fetchall_arrayref, added in 1.619,
to work on column index numbers not names (an incompatible change).
Reworked the fetchall_arrayref documentation.
Hash slices in fetchall_arrayref now detect invalid column names.
=head2 Changes in DBI 1.619 (svn r15294) 23rd April 2012
Fixed the connected method to stop showing the password in
trace file (Martin J. Evans).
Fixed _install_method to set CvFILE correctly
thanks to sprout RT#76296
Fixed SqlEngine "list_tables" thanks to David McMath
and Norbert Gruener. RT#67223 RT#69260
Optimized DBI method dispatch thanks to Dave Mitchell.
Optimized driver access to DBI internal state thanks to Dave Mitchell.
Optimized driver access to handle data thanks to Dave Mitchell.
Dave's work on these optimizations was sponsored by Booking.com.
Optimized fetchall_arrayref with hash slice thanks
to Dagfinn Ilmari Manns�ker. RT#76520
Allow renaming columns in fetchall_arrayref hash slices
thanks to Dagfinn Ilmari Manns�ker. RT#76572
Reserved snmp_ and tree_ for DBD::SNMP and DBD::TreeData
=head2 Changes in DBI 1.618 (svn r15170) 25rd February 2012
Fixed compiler warnings in Driver_xst.h (Martin J. Evans)
Fixed compiler warning in DBI.xs (H.Merijn Brand)
Fixed Gofer tests failing on Windows RT74975 (Manoj Kumar)
Fixed my_ctx compile errors on Windows (Dave Mitchell)
Significantly optimized method dispatch via cache (Dave Mitchell)
Significantly optimized DBI internals for threads (Dave Mitchell)
Dave's work on these optimizations was sponsored by Booking.com.
Xsub to xsub calling optimization now enabled for threaded perls.
Corrected typo in example in docs (David Precious)
Added note that calling clone() without an arg may warn in future.
Minor changes to the install_method() docs in DBI::DBD.
Updated dbipport.h from Devel::PPPort 3.20
=head2 Changes in DBI 1.617 (svn r15107) 30th January 2012
NOTE: The officially supported minimum perl version will change
from perl 5.8.1 (2003) to perl 5.8.3 (2004) in a future release.
(The last change, from perl 5.6 to 5.8.1, was announced
in July 2008 and implemented in DBI 1.611 in April 2010.)
Fixed ParamTypes example in the pod (Martin J. Evans)
Fixed the definition of ArrayTupleStatus and remove confusion over
rows affected in list context of execute_array (Martin J. Evans)
Fixed sql_type_cast example and typo in errors (Martin J. Evans)
Fixed Gofer error handling for keeperr methods like ping (Tim Bunce)
Fixed $dbh->clone({}) RT73250 (Tim Bunce)
Fixed is_nested_call logic error RT73118 (Reini Urban)
Enhanced performance for threaded perls (Dave Mitchell, Tim Bunce)
Dave's work on this optimization was sponsored by Booking.com.
Enhanced and standardized driver trace level mechanism (Tim Bunce)
Removed old code that was an inneffective attempt to detect
people doing DBI->{Attrib}.
Clear ParamValues on bind_param param count error RT66127 (Tim Bunce)
Changed DBI::ProxyServer to require DBI at compile-time RT62672 (Tim Bunce)
Added pod for default_user to DBI::DBD (Martin J. Evans)
Added CON, ENC and DBD trace flags and extended 09trace.t (Martin J. Evans)
Added TXN trace flags and applied CON and TXN to relevant methods (Tim Bunce)
Added some more fetchall_arrayref(..., $maxrows) tests (Tim Bunce)
Clarified docs for fetchall_arrayref called on an inactive handle.
Clarified docs for clone method (Tim Bunce)
Added note to DBI::Profile about async queries (Marcel Gr�nauer).
Reserved spatialite_ as a driver prefix for DBD::Spatialite
Reserved mo_ as a driver prefix for DBD::MO
Updated link to the SQL Reunion 95 docs, RT69577 (Ash Daminato)
Changed links for DBI recipes. RT73286 (Martin J. Evans)
=head2 Changes in DBI 1.616 (svn r14616) 30th December 2010
Fixed spurious dbi_profile lines written to the log when
profiling is enabled and a trace flag, like SQL, is used.
Fixed to recognize SQL::Statement errors even if instantiated
with RaiseError=0 (Jens Rehsack)
Fixed RT#61513 by catching attribute assignment to tied table access
interface (Jens Rehsack)
Fixing some misbehavior of DBD::File when running within the Gofer
server.
Fixed compiler warnings RT#62640
Optimized connect() to remove redundant FETCH of \%attrib values.
Improved initialization phases in DBI::DBD::SqlEngine (Jens Rehsack)
Added DBD::Gofer::Transport::corostream. An experimental proof-of-concept
transport that enables asynchronous database calls with few code changes.
It enables asynchronous use of DBI frameworks like DBIx::Class.
Added additional notes on DBDs which avoid creating a statement in
the do() method and the effects on error handlers (Martin J. Evans)
Adding new attribute "sql_dialect" to DBI::DBD::SqlEngine to allow
users control used SQL dialect (ANSI, CSV or AnyData), defaults to
CSV (Jens Rehsack)
Add documentation for DBI::DBD::SqlEngine attributes (Jens Rehsack)
Documented dbd_st_execute return (Martin J. Evans)
Fixed typo in InactiveDestroy thanks to Emmanuel Rodriguez.
=head2 Changes in DBI 1.615 (svn r14438) 21st September 2010
Fixed t/51dbm_file for file/directory names with whitespaces in them
RT#61445 (Jens Rehsack)
Fixed compiler warnings from ignored hv_store result (Martin J. Evans)
Fixed portability to VMS (Craig A. Berry)
=head2 Changes in DBI 1.614 (svn r14408) 17th September 2010
Fixed bind_param () in DBI::DBD::SqlEngine (rt#61281)
Fixed internals to not refer to old perl symbols that
will no longer be visible in perl >5.13.3 (Andreas Koenig)
Many compiled drivers are likely to need updating.
Fixed issue in DBD::File when absolute filename is used as table name
(Jens Rehsack)
Croak manually when file after tie doesn't exists in DBD::DBM
when it have to exists (Jens Rehsack)
Fixed issue in DBD::File when users set individual file name for tables
via f_meta compatibility interface - reported by H.Merijn Brand while
working on RT#61168 (Jens Rehsack)
Changed 50dbm_simple to simplify and fix problems (Martin J. Evans)
Changed 50dbm_simple to skip aggregation tests when not using
SQL::Statement (Jens Rehsack)
Minor speed improvements in DBD::File (Jens Rehsack)
Added $h->{AutoInactiveDestroy} as simpler safer form of
$h->{InactiveDestroy} (David E. Wheeler)
Added ability for parallel testing "prove -j4 ..." (Jens Rehsack)
Added tests for delete in DBM (H.Merijn Brand)
Added test for absolute filename as table to 51dbm_file (Jens Rehsack)
Added two initialization phases to DBI::DBD::SqlEngine (Jens Rehsack)
Added improved developers documentation for DBI::DBD::SqlEngine
(Jens Rehsack)
Added guides how to write DBI drivers using DBI::DBD::SqlEngine
or DBD::File (Jens Rehsack)
Added register_compat_map() and table_meta_attr_changed() to
DBD::File::Table to support clean fix of RT#61168 (Jens Rehsack)
=head2 Changes in DBI 1.613 (svn r14271) 22nd July 2010
Fixed Win32 prerequisite module from PathTools to File::Spec.
Changed attribute headings and fixed references in DBI pod (Martin J. Evans)
Corrected typos in DBI::FAQ and DBI::ProxyServer (Ansgar Burchardt)
=head2 Changes in DBI 1.612 (svn r14254) 16th July 2010
NOTE: This is a minor release for the DBI core but a major release for
DBD::File and drivers that depend on it, like DBD::DBM and DBD::CSV.
This is also the first release where the bulk of the development work
has been done by other people. I'd like to thank (in no particular order)
Jens Rehsack, Martin J. Evans, and H.Merijn Brand for all their contributions.
Fixed DBD::File's {ChopBlank} handling (it stripped \s instead of space
only as documented in DBI) (H.Merijn Brand)
Fixed DBD::DBM breakage with SQL::Statement (Jens Rehsack, fixes RT#56561)
Fixed DBD::File file handle leak (Jens Rehsack)
Fixed problems in 50dbm.t when running tests with multiple
dbms (Martin J. Evans)
Fixed DBD::DBM bugs found during tests (Jens Rehsack)
Fixed DBD::File doesn't find files without extensions under some
circumstances (Jens Rehsack, H.Merijn Brand, fixes RT#59038)
Changed Makefile.PL to modernize with CONFLICTS, recommended dependencies
and resources (Jens Rehsack)
Changed DBI::ProfileDumper to rename any existing profile file by
appending .prev, instead of overwriting it.
Changed DBI::ProfileDumper::Apache to work in more configurations
including vhosts using PerlOptions +Parent.
Add driver_prefix method to DBI (Jens Rehsack)
Added more tests to 50dbm_simple.t to prove optimizations in
DBI::SQL::Nano and SQL::Statement (Jens Rehsack)
Updated tests to cover optional installed SQL::Statement (Jens Rehsack)
Synchronize API between SQL::Statement and DBI::SQL::Nano (Jens Rehsack)
Merged some optimizations from SQL::Statement into DBI::SQL::Nano
(Jens Rehsack)
Added basic test for DBD::File (H.Merijn Brand, Jens Rehsack)
Extract dealing with Perl SQL engines from DBD::File into
DBI::DBD::SqlEngine for better subclassing of 3rd party non-db DBDs
(Jens Rehsack)
Updated and clarified documentation for finish method (Tim Bunce).
Changes to DBD::File for better English and hopefully better
explanation (Martin J. Evans)
Update documentation of DBD::DBM to cover current implementation,
tried to explain some things better and changes most examples to
preferred style of Merijn and myself (Jens Rehsack)
Added developer documentation (including a roadmap of future plans)
for DBD::File
=head2 Changes in DBI 1.611 (svn r13935) 29th April 2010
NOTE: minimum perl version is now 5.8.1 (as announced in DBI 1.607)
Fixed selectcol_arrayref MaxRows attribute to count rows not values
thanks to Vernon Lyon.
Fixed DBI->trace(0, *STDERR); (H.Merijn Brand)
which tried to open a file named "*main::STDERR" in perl-5.10.x
Fixes in DBD::DBM for use under threads (Jens Rehsack)
Changed "Issuing rollback() due to DESTROY without explicit disconnect"
warning to not be issued if ReadOnly set for that dbh.
Added f_lock and f_encoding support to DBD::File (H.Merijn Brand)
Added ChildCallbacks => { ... } to Callbacks as a way to
specify Callbacks for child handles.
With tests added by David E. Wheeler.
Added DBI::sql_type_cast($value, $type, $flags) to cast a string value
to an SQL type. e.g. SQL_INTEGER effectively does $value += 0;
Has other options plus an internal interface for drivers.
Documentation changes:
Small fixes in the documentation of DBD::DBM (H.Merijn Brand)
Documented specification of type casting behaviour for bind_col()
based on DBI::sql_type_cast() and two new bind_col attributes
StrictlyTyped and DiscardString. Thanks to Martin Evans.
Document fetchrow_hashref() behaviour for functions,
aliases and duplicate names (H.Merijn Brand)
Updated DBI::Profile and DBD::File docs to fix pod nits
thanks to Frank Wiegand.
Corrected typos in Gopher documentation reported by Jan Krynicky.
Documented the Callbacks attribute thanks to David E. Wheeler.
Corrected the Timeout examples as per rt 50621 (Martin J. Evans).
Removed some internal broken links in the pod (Martin J. Evans)
Added Note to column_info for drivers which do not
support it (Martin J. Evans)
Updated dbipport.h to Devel::PPPort 3.19 (H.Merijn Brand)
=head2 Changes in DBI 1.609 (svn r12816) 8th June 2009
Fixes to DBD::File (H.Merijn Brand)
added f_schema attribute
table names case sensitive when quoted, insensitive when unquoted
workaround a bug in SQL::Statement (temporary fix) related
to the "You passed x parameters where y required" error
Added ImplementorClass and Name info to the "Issuing rollback() due to
DESTROY without explicit disconnect" warning to identify the handle.
Applies to compiled drivers when they are recompiled.
Added DBI->visit_handles($coderef) method.
Added $h->visit_child_handles($coderef) method.
Added docs for column_info()'s COLUMN_DEF value.
Clarified docs on stickyness of data type via bind_param().
Clarified docs on stickyness of data type via bind_col().
=head2 Changes in DBI 1.608 (svn r12742) 5th May 2009
Fixes to DBD::File (H.Merijn Brand)
bind_param () now honors the attribute argument
added f_ext attribute
File::Spec is always required. (CORE since 5.00405)
Fail and set errstr on parameter count mismatch in execute ()
Fixed two small memory leaks when running in mod_perl
one in DBI->connect and one in DBI::Gofer::Execute.
Both due to "local $ENV{...};" leaking memory.
Fixed DBD_ATTRIB_DELETE macro for driver authors
and updated DBI::DBD docs thanks to Martin J. Evans.
Fixed 64bit issues in trace messages thanks to Charles Jardine.
Fixed FETCH_many() method to work with drivers that incorrectly return
an empty list from $h->FETCH. Affected gofer.
Added 'sqlite_' as registered prefix for DBD::SQLite.
Corrected many typos in DBI docs thanks to Martin J. Evans.
Improved DBI::DBD docs thanks to H.Merijn Brand.
=head2 Changes in DBI 1.607 (svn r11571) 22nd July 2008
NOTE: Perl 5.8.1 is now the minimum supported version.
If you need support for earlier versions send me a patch.
Fixed missing import of carp in DBI::Gofer::Execute.
Added note to docs about effect of execute(@empty_array).
Clarified docs for ReadOnly thanks to Martin Evans.
=head2 Changes in DBI 1.605 (svn r11434) 16th June 2008
Fixed broken DBIS macro with threads on big-endian machines
with 64bit ints but 32bit pointers. Ticket #32309.
Fixed the selectall_arrayref, selectrow_arrayref, and selectrow_array
methods that get embedded into compiled drivers to use the
inner sth handle when passed a $sth instead of an sql string.
Drivers will need to be recompiled to pick up this change.
Fixed leak in neat() for some kinds of values thanks to Rudolf Lippan.
Fixed DBI::PurePerl neat() to behave more like XS neat().
Increased default $DBI::neat_maxlen from 400 to 1000.
Increased timeout on tests to accommodate very slow systems.
Changed behaviour of trace levels 1..4 to show less information
at lower levels.
Changed the format of the key used for $h->{CachedKids}
(which is undocumented so you shouldn't depend on it anyway)
Changed gofer error handling to avoid duplicate error text in errstr.
Clarified docs re ":N" style placeholders.
Improved gofer retry-on-error logic and refactored to aid subclassing.
Improved gofer trace output in assorted ways.
Removed the beeps "\a" from Makefile.PL warnings.
Removed check for PlRPC-modules from Makefile.PL
Added sorting of ParamValues reported by ShowErrorStatement
thanks to to Rudolf Lippan.
Added cache miss trace message to DBD::Gofer transport class.
Added $drh->dbixs_revision method.
Added explicit LICENSE specification (perl) to META.yaml
=head2 Changes in DBI 1.604 (svn rev 10994) 24th March 2008
Fixed fetchall_arrayref with $max_rows argument broken in 1.603,
thanks to Greg Sabino Mullane.
Fixed a few harmless compiler warnings on cygwin.
=head2 Changes in DBI 1.603
Fixed pure-perl fetchall_arrayref with $max_rows argument
to not error when fetching after all rows already fetched.
(Was fixed for compiled drivers back in DBI 1.31.)
Thanks to Mark Overmeer.
Fixed C sprintf formats and casts, fixing compiler warnings.
Changed dbi_profile() to accept a hash of profiles and apply to all.
Changed gofer stream transport to improve error reporting.
Changed gofer test timeout to avoid spurious failures on slow systems.
Added options to t/85gofer.t so it's more useful for manual testing.
=head2 Changes in DBI 1.602 (svn rev 10706) 8th February 2008
Fixed potential coredump if stack reallocated while calling back
into perl from XS code. Thanks to John Gardiner Myers.
Fixed DBI::Util::CacheMemory->new to not clear the cache.
Fixed avg in DBI::Profile as_text() thanks to Abe Ingersoll.
Fixed DBD::DBM bug in push_names thanks to J M Davitt.
Fixed take_imp_data for some platforms thanks to Jeffrey Klein.
Fixed docs tie'ing CacheKids (ie LRU cache) thanks to Peter John Edwards.
Expanded DBI::DBD docs for driver authors thanks to Martin Evans.
Enhanced t/80proxy.t test script.
Enhanced t/85gofer.t test script thanks to Stig.
Enhanced t/10examp.t test script thanks to David Cantrell.
Documented $DBI::stderr as the default value of err for internal errors.
Gofer changes:
track_recent now also keeps track of N most recent errors.
The connect method is now also counted in stats.
=head2 Changes in DBI 1.601 (svn rev 10103), 21st October 2007
Fixed t/05thrclone.t to work with Test::More >= 0.71
thanks to Jerry D. Hedden and Michael G Schwern.
Fixed DBI for VMS thanks to Peter (Stig) Edwards.
Added client-side caching to DBD::Gofer. Can use any cache with
get($k)/set($k,$v) methods, including all the Cache and Cache::Cache
distribution modules plus Cache::Memcached, Cache::FastMmap etc.
Works for all transports. Overridable per handle.
Added DBI::Util::CacheMemory for use with DBD::Gofer caching.
It's a very fast and small strict subset of Cache::Memory.
=head2 Changes in DBI 1.59 (svn rev 9874), 23rd August 2007
Fixed DBI::ProfileData to unescape headers lines read from data file.
Fixed DBI::ProfileData to not clobber $_, thanks to Alexey Tourbin.
Fixed DBI::SQL::Nano to not clobber $_, thanks to Alexey Tourbin.
Fixed DBI::PurePerl to return undef for ChildHandles if weaken not available.
Fixed DBD::Proxy disconnect error thanks to Philip Dye.
Fixed DBD::Gofer::Transport::Base bug (typo) in timeout code.
Fixed DBD::Proxy rows method thanks to Philip Dye.
Fixed dbiprof compile errors, thanks to Alexey Tourbin.
Fixed t/03handle.t to skip some tests if ChildHandles not available.
Added check_response_sub to DBI::Gofer::Execute
=head2 Changes in DBI 1.58 (svn rev 9678), 25th June 2007
Fixed code triggering fatal error in bleadperl, thanks to Steve Hay.
Fixed compiler warning thanks to Jerry D. Hedden.
Fixed t/40profile.t to use int(dbi_time()) for systems like Cygwin where
time() seems to be rounded not truncated from the high resolution time.
Removed dump_results() test from t/80proxy.t.
=head2 Changes in DBI 1.57 (svn rev 9639), 13th June 2007
Note: this release includes a change to the DBI::hash() function which will
now produce different values than before *if* your perl was built with 64-bit
'int' type (i.e. "perl -V:intsize" says intsize='8'). It's relatively rare
for perl to be configured that way, even on 64-bit systems.
Fixed XS versions of select*_*() methods to call execute()
fetch() etc., with inner handle instead of outer.
Fixed execute_for_fetch() to not cache errstr values
thanks to Bart Degryse.
Fixed unused var compiler warning thanks to JDHEDDEN.
Fixed t/86gofer_fail tests to be less likely to fail falsely.
Changed DBI::hash to return 'I32' type instead of 'int' so results are
portable/consistent regardless of size of the int type.
Corrected timeout example in docs thanks to Egmont Koblinger.
Changed t/01basic.t to warn instead of failing when it detects
a problem with Math::BigInt (some recent versions had problems).
Added support for !Time and !Time~N to DBI::Profile Path. See docs.
Added extra trace info to connect_cached thanks to Walery Studennikov.
Added non-random (deterministic) mode to DBI_GOFER_RANDOM mechanism.
Added DBIXS_REVISION macro that drivers can use.
Added more docs for private_attribute_info() method.
DBI::Profile changes:
dbi_profile() now returns ref to relevant leaf node.
Don't profile DESTROY during global destruction.
Added as_node_path_list() and as_text() methods.
DBI::ProfileDumper changes:
Don't write file if there's no profile data.
Uses full natural precision when saving data (was using %.6f)
Optimized flush_to_disk().
Locks the data file while writing.
Enabled filename to be a code ref for dynamic names.
DBI::ProfileDumper::Apache changes:
Added Quiet=>1 to avoid write to STDERR in flush_to_disk().
Added Dir=>... to specify a writable destination directory.
Enabled DBI_PROFILE_APACHE_LOG_DIR for mod_perl 1 as well as 2.
Added parent pid to default data file name.
DBI::ProfileData changes:
Added DeleteFiles option to rename & delete files once read.
Locks the data files while reading.
Added ability to sort by Path elements.
dbiprof changes:
Added --dumpnodes and --delete options.
Added/updated docs for both DBI::ProfileDumper && ::Apache.
=head2 Changes in DBI 1.56 (svn rev 9660), 18th June 2007
Fixed printf arg warnings thanks to JDHEDDEN.
Fixed returning driver-private sth attributes via gofer.
Changed pod docs docs to use =head3 instead of =item
so now in html you get links to individual methods etc.
Changed default gofer retry_limit from 2 to 0.
Changed tests to workaround Math::BigInt broken versions.
Changed dbi_profile_merge() to dbi_profile_merge_nodes()
old name still works as an alias for the new one.
Removed old DBI internal sanity check that's no longer valid
causing "panic: DESTROY (dbih_clearcom)" when tracing enabled
Added DBI_GOFER_RANDOM env var that can be use to trigger random
failures and delays when executing gofer requests. Designed to help
test automatic retry on failures and timeout handling.
Added lots more docs to all the DBD::Gofer and DBI::Gofer classes.
=head2 Changes in DBI 1.55 (svn rev 9504), 4th May 2007
Fixed set_err() so HandleSetErr hook is executed reliably, if set.
Fixed accuracy of profiling when perl configured to use long doubles.
Fixed 42prof_data.t on fast systems with poor timers thanks to Malcolm Nooning.
Fixed potential corruption in selectall_arrayref and selectrow_arrayref
for compiled drivers, thanks to Rob Davies.
Rebuild your compiled drivers after installing DBI.
Changed some handle creation code from perl to C code,
to reduce handle creation cost by ~20%.
Changed internal implementation of the CachedKids attribute
so it's a normal handle attribute (and initially undef).
Changed connect_cached and prepare_cached to avoid a FETCH method call,
and thereby reduced cost by ~5% and ~30% respectively.
Changed _set_fbav to not croak when given a wrongly sized array,
it now warns and adjusts the row buffer to match.
Changed some internals to improve performance with threaded perls.
Changed DBD::NullP to be slightly more useful for testing.
Changed File::Spec prerequisite to not require a minimum version.
Changed tests to work with other DBMs thanks to ZMAN.
Changed ex/perl_dbi_nulls_test.pl to be more descriptive.
Added more functionality to the (undocumented) Callback mechanism.
Callbacks can now elect to provide a value to be returned, in which case
the method won't be called. A callback for "*" is applied to all methods
that don't have their own callback.
Added $h->{ReadOnly} attribute.
Added support for DBI Profile Path to contain refs to scalars
which will be de-ref'd for each profile sample.
Added dbilogstrip utility to edit DBI logs for diff'ing (gets installed)
Added details for SQLite 3.3 to NULL handling docs thanks to Alex Teslik.
Added take_imp_data() to DBI::PurePerl.
Gofer related changes:
Fixed gofer pipeone & stream transports to avoid risk of hanging.
Improved error handling and tracing significantly.
Added way to generate random 1-in-N failures for methods.
Added automatic retry-on-error mechanism to gofer transport base class.
Added tests to show automatic retry mechanism works a treat!
Added go_retry_hook callback hook so apps can fine-tune retry behaviour.
Added header to request and response packets for sanity checking
and to enable version skew between client and server.
Added forced_single_resultset, max_cached_sth_per_dbh and max_cached_dbh_per_drh
to gofer executor config.
Driver-private methods installed with install_method are now proxied.
No longer does a round-trip to the server for methods it knows
have not been overridden by the remote driver.
Most significant aspects of gofer behaviour are controlled by policy mechanism.
Added policy-controlled caching of results for some methods, such as schema metadata.
The connect_cached and prepare_cached methods cache on client and server.
The bind_param_array and execute_array methods are now supported.
Worked around a DBD::Sybase bind_param bug (which is fixed in DBD::Sybase 1.07)
Added goferperf.pl utility (doesn't get installed).
Many other assorted Gofer related bug fixes, enhancements and docs.
The http and mod_perl transports have been remove to their own distribution.
Client and server will need upgrading together for this release.
=head2 Changes in DBI 1.54 (svn rev 9157), 23rd February 2007
NOTE: This release includes the 'next big thing': DBD::Gofer.
Take a look!
WARNING: This version has some subtle changes in DBI internals.
It's possible, though doubtful, that some may affect your code.
I recommend some extra testing before using this release.
Or perhaps I'm just being over cautious...
Fixed type_info when called for multiple dbh thanks to Cosimo Streppone.
Fixed compile warnings in bleadperl on freebsd-6.1-release
and solaris 10g thanks to Philip M. Gollucci.
Fixed to compile for perl built with -DNO_MATHOMS thanks to Jerry D. Hedden.
Fixed to work for bleadperl (r29544) thanks to Nicholas Clark.
Users of Perl >= 5.9.5 will require DBI >= 1.54.
Fixed rare error when profiling access to $DBI::err etc tied variables.
Fixed DBI::ProfileDumper to not be affected by changes to $/ and $,
thanks to Michael Schwern.
Changed t/40profile.t to skip tests for perl < 5.8.0.
Changed setting trace file to no longer write "Trace file set" to new file.
Changed 'handle cleared whilst still active' warning for dbh
to only be given for dbh that have active sth or are not AutoCommit.
Changed take_imp_data to call finish on all Active child sth.
Changed DBI::PurePerl trace() method to be more consistent.
Changed set_err method to effectively not append to errstr if the new errstr
is the same as the current one.
Changed handle factory methods, like connect, prepare, and table_info,
to copy any error/warn/info state of the handle being returned
up into the handle the method was called on.
Changed row buffer handling to not alter NUM_OF_FIELDS if it's
inconsistent with number of elements in row buffer array.
Updated DBI::DBD docs re handling multiple result sets.
Updated DBI::DBD docs for driver authors thanks to Ammon Riley
and Dean Arnold.
Updated column_info docs to note that if a table doesn't exist
you get an sth for an empty result set and not an error.
Added new DBD::Gofer 'stateless proxy' driver and framework,
and the DBI test suite is now also executed via DBD::Gofer,
and DBD::Gofer+DBI::PurePerl, in addition to DBI::PurePerl.
Added ability for trace() to support filehandle argument,
including tracing into a string, thanks to Dean Arnold.
Added ability for drivers to implement func() method
so proxy drivers can proxy the func method itself.
Added SQL_BIGINT type code (resolved to the ODBC/JDBC value (-5))
Added $h->private_attribute_info method.
=head2 Changes in DBI 1.53 (svn rev 7995), 31st October 2006
Fixed checks for weaken to work with early 5.8.x versions
Fixed DBD::Proxy handling of some methods, including commit and rollback.
Fixed t/40profile.t to be more insensitive to long double precision.
Fixed t/40profile.t to be insensitive to small negative shifts in time
thanks to Jamie McCarthy.
Fixed t/40profile.t to skip tests for perl < 5.8.0.
Fixed to work with current 'bleadperl' (~5.9.5) thanks to Steve Peters.
Users of Perl >= 5.9.5 will require DBI >= 1.53.
Fixed to be more robust against drivers not handling multiple result
sets properly, thanks to Gisle Aas.
Added array context support to execute_array and execute_for_fetch
methods which returns executed tuples and rows affected.
Added Tie::Cache::LRU example to docs thanks to Brandon Black.
=head2 Changes in DBI 1.52 (svn rev 6840), 30th July 2006
Fixed memory leak (per handle) thanks to Nicholas Clark and Ephraim Dan.
Fixed memory leak (16 bytes per sth) thanks to Doru Theodor Petrescu.
Fixed execute_for_fetch/execute_array to RaiseError thanks to Martin J. Evans.
Fixed for perl 5.9.4. Users of Perl >= 5.9.4 will require DBI >= 1.52.
Updated DBD::File to 0.35 to match the latest release on CPAN.
Added $dbh->statistics_info specification thanks to Brandon Black.
Many changes and additions to profiling:
Profile Path can now uses sane strings instead of obscure numbers,
can refer to attributes, assorted magical values, and even code refs!
Parsing of non-numeric DBI_PROFILE env var values has changed.
Changed DBI::Profile docs extensively - many new features.
See DBI::Profile docs for more information.
=head2 Changes in DBI 1.51 (svn rev 6475), 6th June 2006
Fixed $dbh->clone method 'signature' thanks to Jeffrey Klein.
Fixed default ping() method to return false if !$dbh->{Active}.
Fixed t/40profile.t to be insensitive to long double precision.
Fixed for perl 5.8.0's more limited weaken() function.
Fixed DBD::Proxy to not alter $@ in disconnect or AUTOLOADd methods.
Fixed bind_columns() to use return set_err(...) instead of die()
to report incorrect number of parameters, thanks to Ben Thul.
Fixed bind_col() to ignore undef as bind location, thanks to David Wheeler.
Fixed for perl 5.9.x for non-threaded builds thanks to Nicholas Clark.
Users of Perl >= 5.9.x will require DBI >= 1.51.
Fixed fetching of rows as hash refs to preserve utf8 on field names
from $sth->{NAME} thanks to Alexey Gaidukov.
Fixed build on Win32 (dbd_postamble) thanks to David Golden.
Improved performance for thread-enabled perls thanks to Gisle Aas.
Drivers can now use PERL_NO_GET_CONTEXT thanks to Gisle Aas.
Driver authors please read the notes in the DBI::DBD docs.
Changed DBI::Profile format to always include a percentage,
if not exiting then uses time between the first and last DBI call.
Changed DBI::ProfileData to be more forgiving of systems with
unstable clocks (where time may go backwards occasionally).
Clarified the 'Subclassing the DBI' docs.
Assorted minor changes to docs from comments on annocpan.org.
Changed Makefile.PL to avoid incompatible options for old gcc.
Added 'fetch array of hash refs' example to selectall_arrayref
docs thanks to Tom Schindl.
Added docs for $sth->{ParamArrays} thanks to Martin J. Evans.
Added reference to $DBI::neat_maxlen in TRACING section of docs.
Added ability for DBI::Profile Path to include attributes
and a summary of where the code was called from.
=head2 Changes in DBI 1.50 (svn rev 2307), 13 December 2005
Fixed Makefile.PL options for gcc bug introduced in 1.49.
Fixed handle magic order to keep DBD::Oracle happy.
Fixed selectrow_array to return empty list on error.
Changed dbi_profile_merge() to be able to recurse and merge
sub-trees of profile data.
Added documentation for dbi_profile_merge(), including how to
measure the time spent inside the DBI for an http request.
=head2 Changes in DBI 1.49 (svn rev 2287), 29th November 2005
Fixed assorted attribute handling bugs in DBD::Proxy.
Fixed croak() in DBD::NullP thanks to Sergey Skvortsov.
Fixed handling of take_imp_data() and dbi_imp_data attribute.
Fixed bugs in DBD::DBM thanks to Jeff Zucker.
Fixed bug in DBI::ProfileDumper thanks to Sam Tregar.
Fixed ping in DBD::Proxy thanks to George Campbell.
Fixed dangling ref in $sth after parent $dbh destroyed
with thanks to il@rol.ru for the bug report #13151
Fixed prerequisites to include Storable thanks to Michael Schwern.
Fixed take_imp_data to be more practical.
Change to require perl 5.6.1 (as advertised in 2003) not 5.6.0.
Changed internals to be more strictly coded thanks to Andy Lester.
Changed warning about multiple copies of Driver.xst found in @INC
to ignore duplicated directories thanks to Ed Avis.
Changed Driver.xst to enable drivers to define an dbd_st_prepare_sv
function where the statement parameter is an SV. That enables
compiled drivers to support SQL strings that are UTF-8.
Changed "use DBI" to only set $DBI::connect_via if not already set.
Changed docs to clarify pre-method clearing of err values.
Added ability for DBI::ProfileData to edit profile path on loading.
This enables aggregation of different SQL statements into the same
profile node - very handy when not using placeholders or when working
multiple separate tables for the same thing (ie logtable_2005_11_28)
Added $sth->{ParamTypes} specification thanks to Dean Arnold.
Added $h->{Callbacks} attribute to enable code hooks to be invoked
when certain methods are called. For example:
$dbh->{Callbacks}->{prepare} = sub { ... };
With thanks to David Wheeler for the kick start.
Added $h->{ChildHandles} (using weakrefs) thanks to Sam Tregar
I've recoded it in C so there's no significant performance impact.
Added $h->{Type} docs (returns 'dr', 'db', or 'st')
Adding trace message in DESTROY if InactiveDestroy enabled.
Added %drhs = DBI->installed_drivers();
Ported DBI::ProfileDumper::Apache to mod_perl2 RC5+
thanks to Philip M. Golluci
=head2 Changes in DBI 1.48 (svn rev 928), 14th March 2005
Fixed DBI::DBD::Metadata generation of type_info_all thanks to Steffen Goeldner
(driver authors who have used it should rerun it).
Updated docs for NULL Value placeholders thanks to Brian Campbell.
Added multi-keyfield nested hash fetching to fetchall_hashref()
thanks to Zhuang (John) Li for polishing up my draft.
Added registered driver prefixes: amzn_ for DBD::Amazon and yaswi_ for DBD::Yaswi.
=head2 Changes in DBI 1.47 (svn rev 854), 2nd February 2005
Fixed DBI::ProxyServer to not create pid files by default.
References: Ubuntu Security Notice USN-70-1, CAN-2005-0077
Thanks to Javier Fern�ndez-Sanguino Pe�a from the
Debian Security Audit Project, and Jonathan Leffler.
Fixed some tests to work with older Test::More versions.
Fixed setting $DBI::err/errstr in DBI::PurePerl.
Fixed potential undef warning from connect_cached().
Fixed $DBI::lasth handling for DESTROY so lasth points to
parent even if DESTROY called other methods.
Fixed DBD::Proxy method calls to not alter $@.
Fixed DBD::File problem with encoding pragma thanks to Erik Rijkers.
Changed error handling so undef errstr doesn't cause warning.
Changed DBI::DBD docs to use =head3/=head4 pod thanks to
Jonathan Leffler. This may generate warnings for perl 5.6.
Changed DBI::PurePerl to set autoflush on trace filehandle.
Changed DBD::Proxy to treat Username as a local attribute
so recent DBI version can be used with old DBI::ProxyServer.
Changed driver handle caching in DBD::File.
Added $GetInfoType{SQL_DATABASE_NAME} thanks to Steffen Goeldner.
Updated docs to recommend some common DSN string attributes.
Updated connect_cached() docs with issues and suggestions.
Updated docs for NULL Value placeholders thanks to Brian Campbell.
Updated docs for primary_key_info and primary_keys.
Updated docs to clarify that the default fetchrow_hashref behaviour,
of returning a ref to a new hash for each row, will not change.
Updated err/errstr/state docs for DBD authors thanks to Steffen Goeldner.
Updated handle/attribute docs for DBD authors thanks to Steffen Goeldner.
Corrected and updated LongReadLen docs thanks to Bart Lateur.
Added DBD::JDBC as a registered driver.
=head2 Changes in DBI 1.46 (svn rev 584), 16th November 2004
Fixed parsing bugs in DBI::SQL::Nano thanks to Jeff Zucker.
Fixed a couple of bad links in docs thanks to Graham Barr.
Fixed test.pl Win32 undef warning thanks to H.Merijn Brand & David Repko.
Fixed minor issues in DBI::DBD::Metadata thanks to Steffen Goeldner.
Fixed DBI::PurePerl neat() to use double quotes for utf8.
Changed execute_array() definition, and default implementation,
to not consider scalar values for execute tuple count. See docs.
Changed DBD::File to enable ShowErrorStatement by default,
which affects DBD::File subclasses such as DBD::CSV and DBD::DBM.
Changed use DBI qw(:utils) tag to include $neat_maxlen.
Updated Roadmap and ToDo.
Added data_string_diff() data_string_desc() and data_diff()
utility functions to help diagnose Unicode issues.
All can be imported via the use DBI qw(:utils) tag.
=head2 Changes in DBI 1.45 (svn rev 480), 6th October 2004
Fixed DBI::DBD code for drivers broken in 1.44.
Fixed "Free to wrong pool"/"Attempt to free unreferenced scalar" in FETCH.
=head2 Changes in DBI 1.44 (svn rev 478), 5th October 2004
Fixed build issues on VMS thanks to Jakob Snoer.
Fixed DBD::File finish() method to return 1 thanks to Jan Dubois.
Fixed rare core dump during global destruction thanks to Mark Jason Dominus.
Fixed risk of utf8 flag persisting from one row to the next.
Changed bind_param_array() so it doesn't require all bind arrays
to have the same number of elements.
Changed bind_param_array() to error if placeholder number <= 0.
Changed execute_array() definition, and default implementation,
to effectively NULL-pad shorter bind arrays.
Changed execute_array() to return "0E0" for 0 as per the docs.
Changed execute_for_fetch() definition, and default implementation,
to return "0E0" for 0 like execute() and execute_array().
Changed Test::More prerequisite to Test::Simple (which is also the name
of the distribution both are packaged in) to work around ppm behaviour.
Corrected docs to say that get/set of unknown attribute generates
a warning and is no longer fatal. Thanks to Vadim.
Corrected fetchall_arrayref() docs example thanks to Drew Broadley.
Added $h1->swap_inner_handle($h2) sponsored by BizRate.com
=head2 Changes in DBI 1.43 (svn rev 377), 2nd July 2004
Fixed connect() and connect_cached() RaiseError/PrintError
which would sometimes show "(no error string)" as the error.
Fixed compiler warning thanks to Paul Marquess.
Fixed "trace level set to" trace message thanks to H.Merijn Brand.
Fixed DBD::DBM $dbh->{dbm_tables}->{...} to be keyed by the
table name not the file name thanks to Jeff Zucker.
Fixed last_insert_id(...) thanks to Rudy Lippan.
Fixed propagation of scalar/list context into proxied methods.
Fixed DBI::Profile::DESTROY to not alter $@.
Fixed DBI::ProfileDumper new() docs thanks to Michael Schwern.
Fixed _load_class to propagate $@ thanks to Drew Taylor.
Fixed compile warnings on Win32 thanks to Robert Baron.
Fixed problem building with recent versions of MakeMaker.
Fixed DBD::Sponge not to generate warning with threads.
Fixed DBI_AUTOPROXY to work more than once thanks to Steven Hirsch.
Changed TraceLevel 1 to not show recursive/nested calls.
Changed getting or setting an invalid attribute to no longer be
a fatal error but generate a warning instead.
Changed selectall_arrayref() to call finish() if
$attr->{MaxRows} is defined.
Changed all tests to use Test::More and enhanced the tests thanks
to Stevan Little and Andy Lester. See http://qa.perl.org/phalanx/
Changed Test::More minimum prerequisite version to 0.40 (2001).
Changed DBI::Profile header to include the date and time.
Added DBI->parse_dsn($dsn) method.
Added warning if build directory path contains white space.
Added docs for parse_trace_flags() and parse_trace_flag().
Removed "may change" warnings from the docs for table_info(),
primary_key_info(), and foreign_key_info() methods.
=head2 Changes in DBI 1.42 (svn rev 222), 12th March 2004
Fixed $sth->{NUM_OF_FIELDS} of non-executed statement handle
to be undef as per the docs (it was 0).
Fixed t/41prof_dump.t to work with perl5.9.1.
Fixed DBD_ATTRIB_DELETE macro thanks to Marco Paskamp.
Fixed DBI::PurePerl looks_like_number() and $DBI::rows.
Fixed ref($h)->can("foo") to not croak.
Changed attributes (NAME, TYPE etc) of non-executed statement
handle to be undef instead of triggering an error.
Changed ShowErrorStatement to apply to more $dbh methods.
Changed DBI_TRACE env var so just does this at load time:
DBI->trace(split '=', $ENV{DBI_TRACE}, 2);
Improved "invalid number of parameters" error message.
Added DBI::common as base class for DBI::db, DBD::st etc.
Moved methods common to all handles into DBI::common.
Major tracing enhancement:
Added $h->parse_trace_flags("foo|SQL|7") to map a group of
trace flags into the corresponding trace flag bits.
Added automatic calling of parse_trace_flags() if
setting the trace level to a non-numeric value:
$h->{TraceLevel}="foo|SQL|7"; $h->trace("foo|SQL|7");
DBI->connect("dbi:Driver(TraceLevel=SQL|foo):...", ...);
Currently no trace flags have been defined.
Added to, and reworked, the trace documentation.
Added dbivport.h for driver authors to use.
Major driver additions that Jeff Zucker and I have been working on:
Added DBI::SQL::Nano a 'smaller than micro' SQL parser
with an SQL::Statement compatible API. If SQL::Statement
is installed then DBI::SQL::Nano becomes an empty subclass
of SQL::Statement, unless the DBI_SQL_NANO env var is true.
Added DBD::File, modified to use DBI::SQL::Nano.
Added DBD::DBM, an SQL interface to DBM files using DBD::File.
Documentation changes:
Corrected typos in docs thanks to Steffen Goeldner.
Corrected execute_for_fetch example thanks to Dean Arnold.
=head2 Changes in DBI 1.41 (svn rev 130), 22nd February 2004
Fixed execute_for_array() so tuple_status parameter is optional
as per docs, thanks to Ed Avis.
Fixed execute_for_array() docs to say that it returns undef if
any of the execute() calls fail.
Fixed take_imp_data() test on m68k reported by Christian Hammers.
Fixed write_typeinfo_pm inconsistencies in DBI::DBD::Metadata
thanks to Andy Hassall.
Fixed $h->{TraceLevel} to not return DBI->trace trace level
which it used to if DBI->trace trace level was higher.
Changed set_err() to append to errstr, with a leading "\n" if it's
not empty, so that multiple error/warning messages are recorded.
Changed trace to limit elements dumped when an array reference is
returned from a method to the max(40, $DBI::neat_maxlen/10)
so that fetchall_arrayref(), for example, doesn't flood the trace.
Changed trace level to be a four bit integer (levels 0 thru 15)
and a set of topic flags (no topics have been assigned yet).
Changed column_info() to check argument count.
Extended bind_param() TYPE attribute specification to imply
standard formating of value, eg SQL_DATE implies 'YYYY-MM-DD'.
Added way for drivers to indicate 'success with info' or 'warning'
by setting err to "0" for warning and "" for information.
Both values are false and so don't trigger RaiseError etc.
Thanks to Steffen Goeldner for the original idea.
Added $h->{HandleSetErr} = sub { ... } to be called at the
point that an error, warn, or info state is recorded.
The code can alter the err, errstr, and state values
(e.g., to promote an error to a warning, or the reverse).
Added $h->{PrintWarn} attribute to enable printing of warnings
recorded by the driver. Defaults to same value as $^W (perl -w).
Added $h->{ErrCount} attribute, incremented whenever an error is
recorded by the driver via set_err().
Added $h->{Executed} attribute, set if do()/execute() called.
Added \%attr parameter to foreign_key_info() method.
Added ref count of inner handle to "DESTROY ignored for outer" msg.
Added Win32 build config checks to DBI::DBD thanks to Andy Hassall.
Added bind_col to Driver.xst so drivers can define their own.
Added TYPE attribute to bind_col and specified the expected
driver behaviour.
Major update to signal handling docs thanks to Lincoln Baxter.
Corrected dbiproxy usage doc thanks to Christian Hammers.
Corrected type_info_all index hash docs thanks to Steffen Goeldner.
Corrected type_info COLUMN_SIZE to chars not bytes thanks to Dean Arnold.
Corrected get_info() docs to include details of DBI::Const::GetInfoType.
Clarified that $sth->{PRECISION} is OCTET_LENGTH for char types.
=head2 Changes in DBI 1.40, 7th January 2004
Fixed handling of CachedKids when DESTROYing threaded handles.
Fixed sql_user_name() in DBI::DBD::Metadata (used by write_getinfo_pm)
to use $dbh->{Username}. Driver authors please update your code.
Changed connect_cached() when running under Apache::DBI
to route calls to Apache::DBI::connect().
Added CLONE() to DBD::Sponge and DBD::ExampleP.
Added warning when starting a new thread about any loaded driver
which does not have a CLONE() function.
Added new prepare_cache($sql, \%attr, 3) option to manage Active handles.
Added SCALE and NULLABLE support to DBD::Sponge.
Added missing execute() in fetchall_hashref docs thanks to Iain Truskett.
Added a CONTRIBUTING section to the docs with notes on creating patches.
=head2 Changes in DBI 1.39, 27th November 2003
Fixed STORE to not clear error during nested DBI call, again/better,
thanks to Tony Bowden for the report and helpful test case.
Fixed DBI dispatch to not try to use AUTOLOAD for driver methods unless
the method has been declared (as methods should be when using AUTOLOAD).
This fixes a problem when the Attribute::Handlers module is loaded.
Fixed cwd check code to use $Config{path_sep} thanks to Steve Hay.
Fixed unqualified croak() calls thanks to Steffen Goeldner.
Fixed DBD::ExampleP TYPE and PRECISION attributes thanks to Tom Lowery.
Fixed tracing of methods that only get traced at high trace levels.
The level 1 trace no longer includes nested method calls so it generally
just shows the methods the application explicitly calls.
Added line to trace log (level>=4) when err/errstr is cleared.
Updated docs for InactiveDestroy and point out where and when the
trace includes the process id.
Update DBI::DBD docs thanks to Steffen Goeldner.
Removed docs saying that the DBI->data_sources method could be
passed a $dbh. The $dbh->data_sources method should be used instead.
Added link to 'DBI recipes' thanks to Giuseppe Maxia:
http://gmax.oltrelinux.com/dbirecipes.html (note that this
is not an endorsement that the recipies are 'optimal')
Note: There is a bug in perl 5.8.2 when configured with threads
and debugging enabled (bug #24463) which causes a DBI test to fail.
=head2 Changes in DBI 1.38, 21th August 2003
NOTE: The DBI now requires perl version 5.6.0 or later.
(As per notice in DBI 1.33 released 27th February 2003)
Fixed spurious t/03handles failure on 64bit perls reported by H.Merijn Brand.
Fixed spurious t/15array failure on some perl versions thanks to Ed Avis.
Fixed build using dmake on windows thanks to Steffen Goeldner.
Fixed build on using some shells thanks to Gurusamy Sarathy.
Fixed ParamValues to only be appended to ShowErrorStatement if not empty.
Fixed $dbh->{Statement} not being writable by drivers in some cases.
Fixed occasional undef warnings on connect failures thanks to Ed Avis.
Fixed small memory leak when using $sth->{NAME..._hash}.
Fixed 64bit warnings thanks to Marian Jancar.
Fixed DBD::Proxy::db::DESTROY to not alter $@ thanks to Keith Chapman.
Fixed Makefile.PL status from WriteMakefile() thanks to Leon Brocard.
Changed "Can't set ...->{Foo}: unrecognised attribute" from an error to a
warning when running with DBI::ProxyServer to simplify upgrades.
Changed execute_array() to no longer require ArrayTupleStatus attribute.
Changed DBI->available_drivers to not hide DBD::Sponge.
Updated/moved placeholder docs to a better place thanks to Johan Vromans.
Changed dbd_db_do4 api in Driver.xst to match dbd_st_execute (return int,
not bool), relevant only to driver authors.
Changed neat(), and thus trace(), so strings marked as utf8 are presented
in double quotes instead of single quotes and are not sanitized.
Added $dbh->data_sources method.
Added $dbh->last_insert_id method.
Added $sth->execute_for_fetch($fetch_tuple_sub, \@tuple_status) method.
Added DBI->installed_versions thanks to Jeff Zucker.
Added $DBI::Profile::ON_DESTROY_DUMP variable.
Added docs for DBD::Sponge thanks to Mark Stosberg.
=head2 Changes in DBI 1.37, 15th May 2003
Fixed "Can't get dbh->{Statement}: unrecognised attribute" error in test
caused by change to perl internals in 5.8.0
Fixed to build with latest development perl (5.8.1@19525).
Fixed C code to use all ANSI declarations thanks to Steven Lembark.
=head2 Changes in DBI 1.36, 11th May 2003
Fixed DBI->connect to carp instead of croak on 'old-style' usage.
Fixed connect(,,, { RootClass => $foo }) to not croak if module not found.
Fixed code generated by DBI::DBD::Metadata thanks to DARREN@cpan.org (#2270)
Fixed DBI::PurePerl to not reset $@ during method dispatch.
Fixed VMS build thanks to Michael Schwern.
Fixed Proxy disconnect thanks to Steven Hirsch.
Fixed error in DBI::DBD docs thanks to Andy Hassall.
Changed t/40profile.t to not require Time::HiRes.
Changed DBI::ProxyServer to load DBI only on first request, which
helps threaded server mode, thanks to Bob Showalter.
Changed execute_array() return value from row count to executed
tuple count, and now the ArrayTupleStatus attribute is mandatory.
NOTE: That is an API definition change that may affect your code.
Changed CompatMode attribute to also disable attribute 'quick FETCH'.
Changed attribute FETCH to be slightly faster thanks to Stas Bekman.
Added workaround for perl bug #17575 tied hash nested FETCH
thanks to Silvio Wanka.
Added Username and Password attributes to connect(..., \%attr) and so
also embedded in DSN like "dbi:Driver(Username=user,Password=pass):..."
Username and Password can't contain ")", ",", or "=" characters.
The predence is DSN first, then \%attr, then $user & $pass parameters,
and finally the DBI_USER & DBI_PASS environment variables.
The Username attribute is stored in the $dbh but the Password is not.
Added ProxyServer HOWTO configure restrictions docs thanks to Jochen Wiedmann.
Added MaxRows attribute to selectcol_arrayref prompted by Wojciech Pietron.
Added dump_handle as a method not just a DBI:: utility function.
Added on-demand by-row data feed into execute_array() using code ref,
or statement handle. For example, to insert from a select:
$insert_sth->execute_array( { ArrayTupleFetch => $select_sth, ... } )
Added warning to trace log when $h->{foo}=... is ignored due to
invalid prefix (e.g., not 'private_').
=head2 Changes in DBI 1.35, 7th March 2003
Fixed memory leak in fetchrow_hashref introduced in DBI 1.33.
Fixed various DBD::Proxy errors introduced in DBI 1.33.
Fixed to ANSI C in dbd_dr_data_sources thanks to Jonathan Leffler.
Fixed $h->can($method_name) to return correct code ref.
Removed DBI::Format from distribution as it's now part of the
separate DBI::Shell distribution by Tom Lowery.
Updated DBI::DBD docs with a note about the CLONE method.
Updated DBI::DBD docs thanks to Jonathan Leffler.
Updated DBI::DBD::Metadata for perl 5.5.3 thanks to Jonathan Leffler.
Added note to install_method docs about setup_driver() method.
=head2 Changes in DBI 1.34, 28th February 2003
Fixed DBI::DBD docs to refer to DBI::DBD::Metadata thanks to Jonathan Leffler.
Fixed dbi_time() compile using BorlandC on Windows thanks to Steffen Goeldner.
Fixed profile tests to do enough work to measure on Windows.
Fixed disconnect_all() to not be required by drivers.
Added $okay = $h->can($method_name) to check if a method exists.
Added DBD::*::*->install_method($method_name, \%attr) so driver private
methods can be 'installed' into the DBI dispatcher and no longer
need to be called using $h->func(..., $method_name).
Enhanced $dbh->clone() and documentation.
Enhanced docs to note that dbi_time(), and thus profiling, is limited
to only millisecond (seconds/1000) resolution on Windows.
Removed old DBI::Shell from distribution and added Tom Lowery's improved
version to the Bundle::DBI file.
Updated minimum version numbers for modules in Bundle::DBI.
=head2 Changes in DBI 1.33, 27th February 2003
NOTE: Future versions of the DBI *will not* support perl 5.6.0 or earlier.
: Perl 5.6.1 will be the minimum supported version.
NOTE: The "old-style" connect: DBI->connect($database, $user, $pass, $driver);
: has been deprecated for several years and will now generate a warning.
: It will be removed in a later release. Please change any old connect() calls.
Added $dbh2 = $dbh1->clone to make a new connection to the database
that is identical to the original one. clone() can be called even after
the original handle has been disconnected. See the docs for more details.
Fixed merging of profile data to not sum DBIprof_FIRST_TIME values.
Fixed unescaping of newlines in DBI::ProfileData thanks to Sam Tregar.
Fixed Taint bug with fetchrow_hashref with help from Bradley Baetz.
Fixed $dbh->{Active} for DBD::Proxy, reported by Bob Showalter.
Fixed STORE to not clear error during nested DBI call,
thanks to Tony Bowden for the report and helpful test case.
Fixed DBI::PurePerl error clearing behaviour.
Fixed dbi_time() and thus DBI::Profile on Windows thanks to Smejkal Petr.
Fixed problem that meant ShowErrorStatement could show wrong statement,
thanks to Ron Savage for the report and test case.
Changed Apache::DBI hook to check for $ENV{MOD_PERL} instead of
$ENV{GATEWAY_INTERFACE} thanks to Ask Bjoern Hansen.
No longer tries to dup trace logfp when an interpreter is being cloned.
Database handles no longer inherit shared $h->err/errstr/state storage
from their drivers, so each $dbh has it's own $h->err etc. values
and is no longer affected by calls made on other dbh's.
Now when a dbh is destroyed it's err/errstr/state values are copied
up to the driver so checking $DBI::errstr still works as expected.
Build / portability fixes:
Fixed t/40profile.t to not use Time::HiRes.
Fixed t/06attrs.t to not be locale sensitive, reported by Christian Hammers.
Fixed sgi compiler warnings, reported by Paul Blake.
Fixed build using make -j4, reported by Jonathan Leffler.
Fixed build and tests under VMS thanks to Craig A. Berry.
Documentation changes:
Documented $high_resolution_time = dbi_time() function.
Documented that bind_col() can take an attribute hash.
Clarified documentation for ParamValues attribute hash keys.
Many good DBI documentation tweaks from Jonathan Leffler,
including a major update to the DBI::DBD driver author guide.
Clarified that execute() should itself call finish() if it's
called on a statement handle that's still active.
Clarified $sth->{ParamValues}. Driver authors please note.
Removed "NEW" markers on some methods and attributes and
added text to each giving the DBI version it was added in,
if it was added after DBI 1.21 (Feb 2002).
Changes of note for authors of all drivers:
Added SQL_DATA_TYPE, SQL_DATETIME_SUB, NUM_PREC_RADIX, and
INTERVAL_PRECISION fields to docs for type_info_all. There were
already in type_info(), but type_info_all() didn't specify the
index values. Please check and update your type_info_all() code.
Added DBI::DBD::Metadata module that auto-generates your drivers
get_info and type_info_all data and code, thanks mainly to
Jonathan Leffler and Steffen Goeldner. If you've not implemented
get_info and type_info_all methods and your database has an ODBC
driver available then this will do all the hard work for you!
Drivers should no longer pass Err, Errstr, or State to _new_drh
or _new_dbh functions.
Please check that you support the slightly modified behaviour of
$sth->{ParamValues}, e.g., always return hash with keys if possible.
Changes of note for authors of compiled drivers:
Added dbd_db_login6 & dbd_st_finish3 prototypes thanks to Jonathan Leffler.
All dbd_*_*() functions implemented by drivers must have a
corresponding #define dbd_*_* <driver_prefix>_*_* otherwise
the driver may not work with a future release of the DBI.
Changes of note for authors of drivers which use Driver.xst:
Some new method hooks have been added are are enabled by
defining corresponding macros:
$drh->data_sources() - dbd_dr_data_sources
$dbh->do() - dbd_db_do4
The following methods won't be compiled into the driver unless
the corresponding macro has been #defined:
$drh->disconnect_all() - dbd_discon_all
=head2 Changes in DBI 1.32, 1st December 2002
Fixed to work with 5.005_03 thanks to Tatsuhiko Miyagawa (I've not tested it).
Reenabled taint tests (accidentally left disabled) spotted by Bradley Baetz.
Improved docs for FetchHashKeyName attribute thanks to Ian Barwick.
Fixed core dump if fetchrow_hashref given bad argument (name of attribute
with a value that wasn't an array reference), spotted by Ian Barwick.
Fixed some compiler warnings thanks to David Wheeler.
Updated Steven Hirsch's enhanced proxy work (seems I left out a bit).
Made t/40profile.t tests more reliable, reported by Randy, who is part of
the excellent CPAN testers team: http://testers.cpan.org/
(Please visit, see the valuable work they do and, ideally, join in!)
=head2 Changes in DBI 1.31, 29th November 2002
The fetchall_arrayref method, when called with a $maxrows parameter,
no longer gives an error if called again after all rows have been
fetched. This simplifies application logic when fetching in batches.
Also added batch-fetch while() loop example to the docs.
The proxy now supports non-lazy (synchronous) prepare, positioned
updates (for selects containing 'for update'), PlRPC config set
via attributes, and accurate propagation of errors, all thanks
to Steven Hirsch (plus a minor fix from Sean McMurray and doc
tweaks from Michael A Chase).
The DBI_AUTOPROXY env var can now hold the full dsn of the proxy driver
plus attributes, like "dbi:Proxy(proxy_foo=>1):host=...".
Added TaintIn & TaintOut attributes to give finer control over
tainting thanks to Bradley Baetz.
The RootClass attribute no longer ignores failure to load a module,
but also doesn't try to load a module if the class already exists,
with thanks to James FitzGibbon.
HandleError attribute works for connect failures thanks to David Wheeler.
The connect() RaiseError/PrintError message now includes the username.
Changed "last handle unknown or destroyed" warning to be a trace message.
Removed undocumented $h->event() method.
Further enhancements to DBD::PurePerl accuracy.
The CursorName attribute now defaults to undef and not an error.
DBI::Profile changes:
New DBI::ProfileDumper, DBI::ProfileDumper::Apache, and
DBI::ProfileData modules (to manage the storage and processing
of profile data), plus dbiprof program for analyzing profile
data - with many thanks to Sam Tregar.
Added $DBI::err (etc) tied variable lookup time to profile.
Added time for DESTROY method into parent handles profile (used to be ignored).
Documentation changes:
Documented $dbh = $sth->{Database} attribute.
Documented $dbh->connected(...) post-connection call when subclassing.
Updated some minor doc issues thanks to H.Merijn Brand.
Updated Makefile.PL example in DBI::DBD thanks to KAWAI,Takanori.
Fixed execute_array() example thanks to Peter van Hardenberg.
Changes for driver authors, not required but strongly recommended:
Change DBIS to DBIc_DBISTATE(imp_xxh) [or imp_dbh, imp_sth etc]
Change DBILOGFP to DBIc_LOGPIO(imp_xxh) [or imp_dbh, imp_sth etc]
Any function from which all instances of DBIS and DBILOGFP are
removed can also have dPERLINTERP removed (a good thing).
All use of the DBIh_EVENT* macros should be removed.
Major update to DBI::DBD docs thanks largely to Jonathan Leffler.
Add these key values: 'Err' => \my $err, 'Errstr' => \my $errstr,
to the hash passed to DBI::_new_dbh() in your driver source code.
That will make each $dbh have it's own $h->err and $h->errstr
values separate from other $dbh belonging to the same driver.
If you have a ::db or ::st DESTROY methods that do nothing
you can now remove them - which speeds up handle destruction.
=head2 Changes in DBI 1.30, 18th July 2002
Fixed problems with selectrow_array, selectrow_arrayref, and
selectall_arrayref introduced in DBI 1.29.
Fixed FETCHing a handle attribute to not clear $DBI::err etc (broken in 1.29).
Fixed core dump at trace level 9 or above.
Fixed compilation with perl 5.6.1 + ithreads (i.e. Windows).
Changed definition of behaviour of selectrow_array when called in a scalar
context to match fetchrow_array.
Corrected selectrow_arrayref docs which showed selectrow_array thanks to Paul DuBois.
=head2 Changes in DBI 1.29, 15th July 2002
NOTE: This release changes the specified behaviour for the
: fetchrow_array method when called in a scalar context:
: The DBI spec used to say that it would return the FIRST field.
: Which field it returns (i.e., the first or the last) is now undefined.
: This does not affect statements that only select one column, which is
: usually the case when fetchrow_array is called in a scalar context.
: FYI, this change was triggered by discovering that the fetchrow_array
: implementation in Driver.xst (used by most compiled drivers)
: didn't match the DBI specification. Rather than change the code
: to match, and risk breaking existing applications, I've changed the
: specification (that part was always of dubious value anyway).
NOTE: Future versions of the DBI may not support for perl 5.5 much longer.
: If you are still using perl 5.005_03 you should be making plans to
: upgrade to at least perl 5.6.1, or 5.8.0. Perl 5.8.0 is due to be
: released in the next week or so. (Although it's a "point 0" release,
: it is the most thoroughly tested release ever.)
Added XS/C implementations of selectrow_array, selectrow_arrayref, and
selectall_arrayref to Driver.xst. See DBI 1.26 Changes for more info.
Removed support for the old (fatally flawed) "5005" threading model.
Added support for new perl 5.8 iThreads thanks to Gerald Richter.
(Threading support and safety should still be regarded as beta
quality until further notice. But it's much better than it was.)
Updated the "Threads and Thread Safety" section of the docs.
The trace output can be sent to STDOUT instead of STDERR by using
"STDOUT" as the name of the file, i.e., $h->trace(..., "STDOUT")
Added pointer to perlreftut, perldsc, perllol, and perlboot manuals
into the intro section of the docs, suggested by Brian McCain.
Fixed DBI::Const::GetInfo::* pod docs thanks to Zack Weinberg.
Some changes to how $dbh method calls are treated by DBI::Profile:
Meta-data methods now clear $dbh->{Statement} on entry.
Some $dbh methods are now profiled as if $dbh->{Statement} was empty
(because thet're unlikely to actually relate to its contents).
Updated dbiport.h to ppport.h from perl 5.8.0.
Tested with perl 5.5.3 (vanilla, Solaris), 5.6.1 (vanilla, Solaris), and
perl 5.8.0 (RC3@17527 with iThreads & Multiplicity on Solaris and FreeBSD).
=head2 Changes in DBI 1.28, 14th June 2002
Added $sth->{ParamValues} to return a hash of the most recent
values bound to placeholders via bind_param() or execute().
Individual drivers need to be updated to support it.
Enhanced ShowErrorStatement to include ParamValues if available:
"DBD::foo::st execute failed: errstr [for statement ``...'' with params: 1='foo']"
Further enhancements to DBD::PurePerl accuracy.
=head2 Changes in DBI 1.27, 13th June 2002
Fixed missing column in C implementation of fetchall_arrayref()
thanks to Philip Molter for the prompt reporting of the problem.
=head2 Changes in DBI 1.26, 13th June 2002
Fixed t/40profile.t to work on Windows thanks to Smejkal Petr.
Fixed $h->{Profile} to return undef, not error, if not set.
Fixed DBI->available_drivers in scalar context thanks to Michael Schwern.
Added C implementations of selectrow_arrayref() and fetchall_arrayref()
in Driver.xst. All compiled drivers using Driver.xst will now be
faster making those calls. Most noticeable with fetchall_arrayref for
many rows or selectrow_arrayref with a fast query. For example, using
DBD::mysql a selectrow_arrayref for a single row using a primary key
is ~20% faster, and fetchall_arrayref for 20000 rows is twice as fast!
Drivers just need to be recompiled and reinstalled to enable it.
The fetchall_arrayref speed up only applies if $slice parameter is not used.
Added $max_rows parameter to fetchall_arrayref() to optionally limit
the number of rows returned. Can now fetch batches of rows.
Added MaxRows attribute to selectall_arrayref()
which then passes it to fetchall_arrayref().
Changed selectrow_array to make use of selectrow_arrayref.
Trace level 1 now shows first two parameters of all methods
(used to only for that for some, like prepare,execute,do etc)
Trace indicator for recursive calls (first char on trace lines)
now starts at 1 not 2.
Documented that $h->func() does not trigger RaiseError etc
so applications must explicitly check for errors.
DBI::Profile with DBI_PROFILE now shows percentage time inside DBI.
HandleError docs updated to show that handler can edit error message.
HandleError subroutine interface is now regarded as stable.
=head2 Changes in DBI 1.25, 5th June 2002
Fixed build problem on Windows and some compiler warnings.
Fixed $dbh->{Driver} and $sth->{Statement} for driver internals
These are 'inner' handles as per behaviour prior to DBI 1.16.
Further minor improvements to DBI::PurePerl accuracy.
=head2 Changes in DBI 1.24, 4th June 2002
Fixed reference loop causing a handle/memory leak
that was introduced in DBI 1.16.
Fixed DBI::Format to work with 'filehandles' from IO::Scalar
and similar modules thanks to report by Jeff Boes.
Fixed $h->func for DBI::PurePerl thanks to Jeff Zucker.
Fixed $dbh->{Name} for DBI::PurePerl thanks to Dean Arnold.
Added DBI method call profiling and benchmarking.
This is a major new addition to the DBI.
See $h->{Profile} attribute and DBI::Profile module.
For a quick trial, set the DBI_PROFILE environment variable and
run your favourite DBI script. Try it with DBI_PROFILE set to 1,
then try 2, 4, 8, 10, and -10. Have fun!
Added execute_array() and bind_param_array() documentation
with thanks to Dean Arnold.
Added notes about the DBI having not yet been tested with iThreads
(testing and patches for SvLOCK etc welcome).
Removed undocumented Handlers attribute (replaced by HandleError).
Tested with 5.5.3 and 5.8.0 RC1.
=head2 Changes in DBI 1.23, 25th May 2002
Greatly improved DBI::PurePerl in performance and accuracy.
Added more detail to DBI::PurePerl docs about what's not supported.
Fixed undef warnings from t/15array.t and DBD::Sponge.
=head2 Changes in DBI 1.22, 22nd May 2002
Added execute_array() and bind_param_array() with special thanks
to Dean Arnold. Not yet documented. See t/15array.t for examples.
All drivers now automatically support these methods.
Added DBI::PurePerl, a transparent DBI emulation for pure-perl drivers
with special thanks to Jeff Zucker. Perldoc DBI::PurePerl for details.
Added DBI::Const::GetInfo* modules thanks to Steffen Goeldner.
Added write_getinfo_pm utility to DBI::DBD thanks to Steffen Goeldner.
Added $allow_active==2 mode for prepare_cached() thanks to Stephen Clouse.
Updated DBI::Format to Revision 11.4 thanks to Tom Lowery.
Use File::Spec in Makefile.PL (helps VMS etc) thanks to Craig Berry.
Extend $h->{Warn} to commit/rollback ineffective warning thanks to Jeff Baker.
Extended t/preparse.t and removed "use Devel::Peek" thanks to Scott Hildreth.
Only copy Changes to blib/lib/Changes.pm once thanks to Jonathan Leffler.
Updated internals for modern perls thanks to Jonathan Leffler and Jeff Urlwin.
Tested with perl 5.7.3 (just using default perl config).
Documentation changes:
Added 'Catalog Methods' section to docs thanks to Steffen Goeldner.
Updated README thanks to Michael Schwern.
Clarified that driver may choose not to start new transaction until
next use of $dbh after commit/rollback.
Clarified docs for finish method.
Clarified potentials problems with prepare_cached() thanks to Stephen Clouse.
=head2 Changes in DBI 1.21, 7th February 2002
The minimum supported perl version is now 5.005_03.
Fixed DBD::Proxy support for AutoCommit thanks to Jochen Wiedmann.
Fixed DBI::ProxyServer bind_param(_inout) handing thanks to Oleg Mechtcheriakov.
Fixed DBI::ProxyServer fetch loop thanks to nobull@mail.com.
Fixed install_driver do-the-right-thing with $@ on error. It, and connect(),
will leave $@ empty on success and holding the error message on error.
Thanks to Jay Lawrence, Gavin Sherlock and others for the bug report.
Fixed fetchrow_hashref to assign columns to the hash left-to-right
so later fields with the same name overwrite earlier ones
as per DBI < 1.15, thanks to Kay Roepke.
Changed tables() to use quote_indentifier() if the driver returns a
true value for $dbh->get_info(29) # SQL_IDENTIFIER_QUOTE_CHAR
Changed ping() so it no longer triggers RaiseError/PrintError.
Changed connect() to not call $class->install_driver unless needed.
Changed DESTROY to catch fatal exceptions and append to $@.
Added ISO SQL/CLI & ODBCv3 data type definitions thanks to Steffen Goeldner.
Removed the definition of SQL_BIGINT data type constant as the value is
inconsistent between standards (ODBC=-5, SQL/CLI=25).
Added $dbh->column_info(...) thanks to Steffen Goeldner.
Added $dbh->foreign_key_info(...) thanks to Steffen Goeldner.
Added $dbh->quote_identifier(...) insipred by Simon Oliver.
Added $dbh->set_err(...) for DBD authors and DBI subclasses
(actually been there for a while, now expanded and documented).
Added $h->{HandleError} = sub { ... } addition and/or alternative
to RaiseError/PrintError. See the docs for more info.
Added $h->{TraceLevel} = N attribute to set/get trace level of handle
thus can set trace level via an (eg externally specified) DSN
using the embedded attribute syntax:
$dsn = 'dbi:DB2(PrintError=1,TraceLevel=2):dbname';
Plus, you can also now do: local($h->{TraceLevel}) = N;
(but that leaks a little memory in some versions of perl).
Added some call tree information to trace output if trace level >= 3
With thanks to Graham Barr for the stack walking code.
Added experimental undocumented $dbh->preparse(), see t/preparse.t
With thanks to Scott T. Hildreth for much of the work.
Added Fowler/Noll/Vo hash type as an option to DBI::hash().
Documentation changes:
Added DBI::Changes so now you can "perldoc DBI::Changes", yeah!
Added selectrow_arrayref & selectrow_hashref docs thanks to Doug Wilson.
Added 'Standards Reference Information' section to docs to gather
together all references to relevant on-line standards.
Added link to poop.sourceforge.net into the docs thanks to Dave Rolsky.
Added link to hyperlinked BNF for SQL92 thanks to Jeff Zucker.
Added 'Subclassing the DBI' docs thanks to Stephen Clouse, and
then changed some of them to reflect the new approach to subclassing.
Added stronger wording to description of $h->{private_*} attributes.
Added docs for DBI::hash.
Driver API changes:
Now a COPY of the DBI->connect() attributes is passed to the driver
connect() method, so it can process and delete any elements it wants.
Deleting elements reduces/avoids the explicit
$dbh->{$_} = $attr->{$_} foreach keys %$attr;
that DBI->connect does after the driver connect() method returns.
=head2 Changes in DBI 1.20, 24th August 2001
WARNING: This release contains two changes that may affect your code.
: Any code using selectall_hashref(), which was added in March 2001, WILL
: need to be changed. Any code using fetchall_arrayref() with a non-empty
: hash slice parameter may, in a few rare cases, need to be changed.
: See the change list below for more information about the changes.
: See the DBI documentation for a description of current behaviour.
Fixed memory leak thanks to Toni Andjelkovic.
Changed fetchall_arrayref({ foo=>1, ...}) specification again (sorry):
The key names of the returned hashes is identical to the letter case of
the names in the parameter hash, regardless of the L</FetchHashKeyName>
attribute. The letter case is ignored for matching.
Changed fetchall_arrayref([...]) array slice syntax specification to
clarify that the numbers in the array slice are perl index numbers
(which start at 0) and not column numbers (which start at 1).
Added { Columns=>... } and { Slice =>... } attributes to selectall_arrayref()
which is passed to fetchall_arrayref() so it can fetch hashes now.
Added a { Columns => [...] } attribute to selectcol_arrayref() so that
the list it returns can be built from more than one column per row.
Why? Consider my %hash = @{$dbh->selectcol_arrayref($sql,{ Columns=>[1,2]})}
to return id-value pairs which can be used directly to build a hash.
Added $hash_ref = $sth->fetchall_hashref( $key_field )
which returns a ref to a hash with, typically, one element per row.
$key_field is the name of the field to get the key for each row from.
The value of the hash for each row is a hash returned by fetchrow_hashref.
Changed selectall_hashref to return a hash ref (from fetchall_hashref)
and not an array of hashes as it has since DBI 1.15 (end March 2001).
WARNING: THIS CHANGE WILL BREAK ANY CODE USING selectall_hashref()!
Sorry, but I think this is an important regularization of the API.
To get previous selectall_hashref() behaviour (an array of hash refs)
change $ary_ref = $dbh->selectall_hashref( $statement, undef, @bind);
to $ary_ref = $dbh->selectall_arrayref($statement, { Columns=>{} }, @bind);
Added NAME_lc_hash, NAME_uc_hash, NAME_hash statement handle attributes.
which return a ref to a hash of field_name => field_index (0..n-1) pairs.
Fixed select_hash() example thanks to Doug Wilson.
Removed (unbundled) DBD::ADO and DBD::Multiplex from the DBI distribution.
The latest versions of those modules are available from CPAN sites.
Added $dbh->begin_work. This method causes AutoCommit to be turned
off just until the next commit() or rollback().
Driver authors: if the DBIcf_BegunWork flag is set when your commit or
rollback method is called then please turn AutoCommit on and clear the
DBIcf_BegunWork flag. If you don't then the DBI will but it'll be much
less efficient and won't handle error conditions very cleanly.
Retested on perl 5.4.4, but the DBI won't support 5.4.x much longer.
Added text to SUPPORT section of the docs:
For direct DBI and DBD::Oracle support, enhancement, and related work
I am available for consultancy on standard commercial terms.
Added text to ACKNOWLEDGEMENTS section of the docs:
Much of the DBI and DBD::Oracle was developed while I was Technical
Director (CTO) of the Paul Ingram Group (www.ig.co.uk). So I'd
especially like to thank Paul for his generosity and vision in
supporting this work for many years.
=head2 Changes in DBI 1.19, 20th July 2001
Made fetchall_arrayref({ foo=>1, ...}) be more strict to the specification
in relation to wanting hash slice keys to be lowercase names.
WARNING: If you've used fetchall_arrayref({...}) with a hash slice
that contains keys with uppercase letters then your code will break.
(As far as I recall the spec has always said don't do that.)
Fixed $sth->execute() to update $dbh->{Statement} to $sth->{Statement}.
Added row number to trace output for fetch method calls.
Trace level 1 no longer shows fetches with row>1 (to reduce output volume).
Added $h->{FetchHashKeyName} = 'NAME_lc' or 'NAME_uc' to alter
behaviour of fetchrow_hashref() method. See docs.
Added type_info quote caching to quote() method thanks to Dean Kopesky.
Makes using quote() with second data type param much much faster.
Added type_into_all() caching to type_info(), spotted by Dean Kopesky.
Added new API definition for table_info() and tables(),
driver authors please note!
Added primary_key_info() to DBI API thanks to Steffen Goeldner.
Added primary_key() to DBI API as simpler interface to primary_key_info().
Indent and other fixes for DBI::DBD doc thanks to H.Merijn Brand.
Added prepare_cached() insert_hash() example thanks to Doug Wilson.
Removed false docs for fetchall_hashref(), use fetchall_arrayref({}).
=head2 Changes in DBI 1.18, 4th June 2001
Fixed that altering ShowErrorStatement also altered AutoCommit!
Thanks to Jeff Boes for spotting that clanger.
Fixed DBD::Proxy to handle commit() and rollback(). Long overdue, sorry.
Fixed incompatibility with perl 5.004 (but no one's using that right? :)
Fixed connect_cached and prepare_cached to not be affected by the order
of elements in the attribute hash. Spotted by Mitch Helle-Morrissey.
Fixed version number of DBI::Shell
reported by Stuhlpfarrer Gerhard and others.
Defined and documented table_info() attribute semantics (ODBC compatible)
thanks to Olga Voronova, who also implemented then in DBD::Oracle.
Updated Win32::DBIODBC (Win32::ODBC emulation) thanks to Roy Lee.
=head2 Changes in DBI 1.16, 30th May 2001
Reimplemented fetchrow_hashref in C, now fetches about 25% faster!
Changed behaviour if both PrintError and RaiseError are enabled
to simply do both (in that order, obviously :)
Slight reduction in DBI handle creation overhead.
Fixed $dbh->{Driver} & $sth->{Database} to return 'outer' handles.
Fixed execute param count check to honour RaiseError spotted by Belinda Giardie.
Fixed build for perl5.6.1 with PERLIO thanks to H.Merijn Brand.
Fixed client sql restrictions in ProxyServer.pm thanks to Jochen Wiedmann.
Fixed batch mode command parsing in Shell thanks to Christian Lemburg.
Fixed typo in selectcol_arrayref docs thanks to Jonathan Leffler.
Fixed selectrow_hashref to be available to callers thanks to T.J.Mather.
Fixed core dump if statement handle didn't define Statement attribute.
Added bind_param_inout docs to DBI::DBD thanks to Jonathan Leffler.
Added note to data_sources() method docs that some drivers may
require a connected database handle to be supplied as an attribute.
Trace of install_driver method now shows path of driver file loaded.
Changed many '||' to 'or' in the docs thanks to H.Merijn Brand.
Updated DBD::ADO again (improvements in error handling) from Tom Lowery.
Updated Win32::DBIODBC (Win32::ODBC emulation) thanks to Roy Lee.
Updated email and web addresses in DBI::FAQ thanks to Michael A Chase.
=head2 Changes in DBI 1.15, 28th March 2001
Added selectrow_arrayref
Added selectrow_hashref
Added selectall_hashref thanks to Leon Brocard.
Added DBI->connect(..., { dbi_connect_method => 'method' })
Added $dbh->{Statement} aliased to most recent child $sth->{Statement}.
Added $h->{ShowErrorStatement}=1 to cause the appending of the
relevant Statement text to the RaiseError/PrintError text.
Modified type_info to always return hash keys in uppercase and
to not require uppercase 'DATA_TYPE' key from type_info_all.
Thanks to Jennifer Tong and Rob Douglas.
Added \%attr param to tables() and table_info() methods.
Trace method uses warn() if it can't open the new file.
Trace shows source line and filename during global destruction.
Updated packages:
Updated Win32::DBIODBC (Win32::ODBC emulation) thanks to Roy Lee.
Updated DBD::ADO to much improved version 0.4 from Tom Lowery.
Updated DBD::Sponge to include $sth->{PRECISION} thanks to Tom Lowery.
Changed DBD::ExampleP to use lstat() instead of stat().
Documentation:
Documented $DBI::lasth (which has been there since day 1).
Documented SQL_* names.
Clarified and extended docs for $h->state thanks to Masaaki Hirose.
Clarified fetchall_arrayref({}) docs (thanks to, er, someone!).
Clarified type_info_all re lettercase and index values.
Updated DBI::FAQ to 0.38 thanks to Alligator Descartes.
Added cute bind_columns example thanks to H.Merijn Brand.
Extended docs on \%attr arg to data_sources method.
Makefile.PL
Removed obscure potential 'rm -rf /' (thanks to Ulrich Pfeifer).
Removed use of glob and find (thanks to Michael A. Chase).
Proxy:
Removed debug messages from DBD::Proxy AUTOLOAD thanks to Brian McCauley.
Added fix for problem using table_info thanks to Tom Lowery.
Added better determination of where to put the pid file, and...
Added KNOWN ISSUES section to DBD::Proxy docs thanks to Jochen Wiedmann.
Shell:
Updated DBI::Format to include DBI::Format::String thanks to Tom Lowery.
Added describe command thanks to Tom Lowery.
Added columnseparator option thanks to Tom Lowery (I think).
Added 'raw' format thanks to, er, someone, maybe Tom again.
Known issues:
Perl 5.005 and 5.006 both leak memory doing local($handle->{Foo}).
Perl 5.004 doesn't. The leak is not a DBI or driver bug.
=head2 Changes in DBI 1.14, 14th June 2000
NOTE: This version is the one the DBI book is based on.
NOTE: This version requires at least Perl 5.004.
Perl 5.6 ithreads changes with thanks to Doug MacEachern.
Changed trace output to use PerlIO thanks to Paul Moore.
Fixed bug in RaiseError/PrintError handling.
(% chars in the error string could cause a core dump.)
Fixed Win32 PerlEx IIS concurrency bugs thanks to Murray Nesbitt.
Major documentation polishing thanks to Linda Mui at O'Reilly.
Password parameter now shown as **** in trace output.
Added two fields to type_info and type_info_all.
Added $dsn to PrintError/RaiseError message from DBI->connect().
Changed prepare_cached() croak to carp if sth still Active.
Added prepare_cached() example to the docs.
Added further DBD::ADO enhancements from Thomas Lowery.
=head2 Changes in DBI 1.13, 11th July 1999
Fixed Win32 PerlEx IIS concurrency bugs thanks to Murray Nesbitt.
Fixed problems with DBD::ExampleP long_list test mode.
Added SQL_WCHAR SQL_WVARCHAR SQL_WLONGVARCHAR and SQL_BIT
to list of known and exportable SQL types.
Improved data fetch performance of DBD::ADO.
Added GetTypeInfo to DBD::ADO thanks to Thomas Lowery.
Actually documented connect_cached thanks to Michael Schwern.
Fixed user/key/cipher bug in ProxyServer thanks to Joshua Pincus.
=head2 Changes in DBI 1.12, 29th June 1999
Fixed significant DBD::ADO bug (fetch skipped first row).
Fixed ProxyServer bug handling non-select statements.
Fixed VMS problem with t/examp.t thanks to Craig Berry.
Trace only shows calls to trace_msg and _set_fbav at high levels.
Modified t/examp.t to workaround Cygwin buffering bug.
=head2 Changes in DBI 1.11, 17th June 1999
Fixed bind_columns argument checking to allow a single arg.
Fixed problems with internal default_user method.
Fixed broken DBD::ADO.
Made default $DBI::rows more robust for some obscure cases.
=head2 Changes in DBI 1.10, 14th June 1999
Fixed trace_msg.al error when using Apache.
Fixed dbd_st_finish enhancement in Driver.xst (internals).
Enable drivers to define default username and password
and temporarily disabled warning added in 1.09.
Thread safety optimised for single thread case.
=head2 Changes in DBI 1.09, 9th June 1999
Added optional minimum trace level parameter to trace_msg().
Added warning in Makefile.PL that DBI will require 5.004 soon.
Added $dbh->selectcol_arrayref($statement) method.
Fixed fetchall_arrayref hash-slice mode undef NAME problem.
Fixed problem with tainted parameter checking and t/examp.t.
Fixed problem with thread safety code, including 64 bit machines.
Thread safety now enabled by default for threaded perls.
Enhanced code for MULTIPLICITY/PERL_OBJECT from ActiveState.
Enhanced prepare_cached() method.
Minor changes to trace levels (less internal info at level 2).
Trace log now shows "!! ERROR..." before the "<- method" line.
DBI->connect() now warn's if user / password is undefined and
DBI_USER / DBI_PASS environment variables are not defined.
The t/proxy.t test now ignores any /etc/dbiproxy.conf file.
Added portability fixes for MacOS from Chris Nandor.
Updated mailing list address from fugue.com to isc.org.
=head2 Changes in DBI 1.08, 12th May 1999
Much improved DBD::ADO driver thanks to Phlip Plumlee and others.
Connect now allows you to specify attribute settings within the DSN
E.g., "dbi:Driver(RaiseError=>1,Taint=>1,AutoCommit=>0):dbname"
The $h->{Taint} attribute now also enables taint checking of
arguments to almost all DBI methods.
Improved trace output in various ways.
Fixed bug where $sth->{NAME_xx} was undef in some situations.
Fixed code for MULTIPLICITY/PERL_OBJECT thanks to Alex Smishlajev.
Fixed and documented DBI->connect_cached.
Workaround for Cygwin32 build problem with help from Jong-Pork Park.
bind_columns no longer needs undef or hash ref as first parameter.
=head2 Changes in DBI 1.07, 6th May 1999
Trace output now shows contents of array refs returned by DBI.
Changed names of some result columns from type_info, type_info_all,
tables and table_info to match ODBC 3.5 / ISO/IEC standards.
Many fixes for DBD::Proxy and ProxyServer.
Fixed error reporting in install_driver.
Major enhancement to DBI::W32ODBC from Patrick Hollins.
Added $h->{Taint} to taint fetched data if tainting (perl -T).
Added code for MULTIPLICITY/PERL_OBJECT contributed by ActiveState.
Added $sth->more_results (undocumented for now).
=head2 Changes in DBI 1.06, 6th January 1999
Fixed Win32 Makefile.PL problem in 1.04 and 1.05.
Significant DBD::Proxy enhancements and fixes
including support for bind_param_inout (Jochen and I)
Added experimental DBI->connect_cached method.
Added $sth->{NAME_uc} and $sth->{NAME_lc} attributes.
Enhanced fetchrow_hashref to take an attribute name arg.
=head2 Changes in DBI 1.05, 4th January 1999
Improved DBD::ADO connect (thanks to Phlip Plumlee).
Improved thread safety (thanks to Jochen Wiedmann).
[Quick release prompted by truncation of copies on CPAN]
=head2 Changes in DBI 1.04, 3rd January 1999
Fixed error in Driver.xst. DBI build now tests Driver.xst.
Removed unused variable compiler warnings in Driver.xst.
DBI::DBD module now tested during DBI build.
Further clarification in the DBI::DBD driver writers manual.
Added optional name parameter to $sth->fetchrow_hashref.
=head2 Changes in DBI 1.03, 1st January 1999
Now builds with Perl>=5.005_54 (PERL_POLLUTE in DBIXS.h)
DBI trace trims path from "at yourfile.pl line nnn".
Trace level 1 now shows statement passed to prepare.
Assorted improvements to the DBI manual.
Assorted improvements to the DBI::DBD driver writers manual.
Fixed $dbh->quote prototype to include optional $data_type.
Fixed $dbh->prepare_cached problems.
$dbh->selectrow_array behaves better in scalar context.
Added a (very) experimental DBD::ADO driver for Win32 ADO.
Added experimental thread support (perl Makefile.PL -thread).
Updated the DBI::FAQ - thanks to Alligator Descartes.
The following changes were implemented and/or packaged
by Jochen Wiedmann - thanks Jochen:
Added a Bundle for CPAN installation of DBI, the DBI proxy
server and prerequisites (lib/Bundle/DBI.pm).
DBI->available_drivers uses File::Spec, if available.
This makes it work on MacOS. (DBI.pm)
Modified type_info to work with read-only values returned
by type_info_all. (DBI.pm)
Added handling of magic values in $sth->execute,
$sth->bind_param and other methods (Driver.xst)
Added Perl's CORE directory to the linkers path on Win32,
required by recent versions of ActiveState Perl.
Fixed DBD::Sponge to work with empty result sets.
Complete rewrite of DBI::ProxyServer and DBD::Proxy.
=head2 Changes in DBI 1.02, 2nd September 1998
Fixed DBI::Shell including @ARGV and /current.
Added basic DBI::Shell test.
Renamed DBI::Shell /display to /format.
=head2 Changes in DBI 1.01, 2nd September 1998
Many enhancements to Shell (with many contributions from
Jochen Wiedmann, Tom Lowery and Adam Marks).
Assorted fixes to DBD::Proxy and DBI::ProxyServer.
Tidied up trace messages - trace(2) much cleaner now.
Added $dbh->{RowCacheSize} and $sth->{RowsInCache}.
Added experimental DBI::Format (mainly for DBI::Shell).
Fixed fetchall_arrayref($slice_hash).
DBI->connect now honours PrintError=1 if connect fails.
Assorted clarifications to the docs.
=head2 Changes in DBI 1.00, 14th August 1998
The DBI is no longer 'alpha' software!
Added $dbh->tables and $dbh->table_info.
Documented \%attr arg to data_sources method.
Added $sth->{TYPE}, $sth->{PRECISION} and $sth->{SCALE}.
Added $sth->{Statement}.
DBI::Shell now uses neat_list to print results
It also escapes "'" chars and converts newlines to spaces.
=head2 Changes in DBI 0.95, 10th August 1998
WARNING: THIS IS AN EXPERIMENTAL RELEASE!
Fixed 0.94 slip so it will build on pre-5.005 again.
Added DBI_AUTOPROXY environment variable.
Array ref returned from fetch/fetchrow_arrayref now readonly.
Improved connect error reporting by DBD::Proxy.
All trace/debug messages from DBI now go to trace file.
=head2 Changes in DBI 0.94, 9th August 1998
WARNING: THIS IS AN EXPERIMENTAL RELEASE!
Added DBD::Shell and dbish interactive DBI shell. Try it!
Any database attribs can be set via DBI->connect(,,, \%attr).
Added _get_fbav and _set_fbav methods for Perl driver developers
(see ExampleP driver for perl usage). Drivers which don't use
one of these methods (either via XS or Perl) are not compliant.
DBI trace now shows adds " at yourfile.pl line nnn"!
PrintError and RaiseError now prepend driver and method name.
The available_drivers method no longer returns NullP or Sponge.
Added $dbh->{Name}.
Added $dbh->quote($value, $data_type).
Added more hints to install_driver failure message.
Added DBD::Proxy and DBI::ProxyServer (from Jochen Wiedmann).
Added $DBI::neat_maxlen to control truncation of trace output.
Added $dbh->selectall_arrayref and $dbh->selectrow_array methods.
Added $dbh->tables.
Added $dbh->type_info and $dbh->type_info_all.
Added $h->trace_msg($msg) to write to trace log.
Added @bool = DBI::looks_like_number(@ary).
Many assorted improvements to the DBI docs.
=head2 Changes in DBI 0.93, 13th February 1998
Fixed DBI::DBD::dbd_postamble bug causing 'Driver.xsi not found' errors.
Changes to handling of 'magic' values in neatsvpv (used by trace).
execute (in Driver.xst) stops binding after first bind error.
This release requires drivers to be rebuilt.
=head2 Changes in DBI 0.92, 3rd February 1998
Fixed per-handle memory leak (with many thanks to Irving Reid).
Added $dbh->prepare_cached() caching variant of $dbh->prepare.
Added some attributes:
$h->{Active} is the handle 'Active' (vague concept) (boolean)
$h->{Kids} e.g. number of sth's associated with a dbh
$h->{ActiveKids} number of the above which are 'Active'
$dbh->{CachedKids} ref to prepare_cached sth cache
Added support for general-purpose 'private_' attributes.
Added experimental support for subclassing the DBI: see t/subclass.t
Added SQL_ALL_TYPES to exported :sql_types.
Added dbd_dbi_dir() and dbd_dbi_arch_dir() to DBI::DBD module so that
DBD Makefile.PLs can work with the DBI installed in non-standard locations.
Fixed 'Undefined value' warning and &sv_no output from neatsvpv/trace.
Fixed small 'once per interpreter' leak.
Assorted minor documentation fixes.
=head2 Changes in DBI 0.91, 10th December 1997
NOTE: This fix may break some existing scripts:
DBI->connect("dbi:...",$user,$pass) was not setting AutoCommit and PrintError!
DBI->connect(..., { ... }) no longer sets AutoCommit or PrintError twice.
DBI->connect(..., { RaiseError=>1 }) now croaks if connect fails.
Fixed $fh parameter of $sth->dump_results;
Added default statement DESTROY method which carps.
Added default driver DESTROY method to silence AUTOLOAD/__DIE__/CGI::Carp
Added more SQL_* types to %EXPORT_TAGS and @EXPORT_OK.
Assorted documentation updates (mainly clarifications).
Added workaround for perl's 'sticky lvalue' bug.
Added better warning for bind_col(umns) where fields==0.
Fixed to build okay with 5.004_54 with or without USE_THREADS.
Note that the DBI has not been tested for thread safety yet.
=head2 Changes in DBI 0.90, 6th September 1997
Can once again be built with Perl 5.003.
The DBI class can be subclassed more easily now.
InactiveDestroy fixed for drivers using the *.xst template.
Slightly faster handle creation.
Changed prototype for dbd_*_*_attrib() to add extra param.
Note: 0.90, 0.89 and possibly some other recent versions have
a small memory leak. This will be fixed in the next release.
=head2 Changes in DBI 0.89, 25th July 1997
Minor fix to neatsvpv (mainly used for debug trace) to workaround
bug in perl where SvPV removes IOK flag from an SV.
Minor updates to the docs.
=head2 Changes in DBI 0.88, 22nd July 1997
Fixed build for perl5.003 and Win32 with Borland.
Fixed documentation formatting.
Fixed DBI_DSN ignored for old-style connect (with explicit driver).
Fixed AutoCommit in DBD::ExampleP
Fixed $h->trace.
The DBI can now export SQL type values: use DBI ':sql_types';
Modified Driver.xst and renamed DBDI.h to dbd_xsh.h
=head2 Changes in DBI 0.87, 18th July 1997
Fixed minor type clashes.
Added more docs about placeholders and bind values.
=head2 Changes in DBI 0.86, 16th July 1997
Fixed failed connect causing 'unblessed ref' and other errors.
Drivers must handle AutoCommit FETCH and STORE else DBI croaks.
Added $h->{LongReadLen} and $h->{LongTruncOk} attributes for BLOBS.
Added DBI_USER and DBI_PASS env vars. See connect docs for usage.
Added DBI->trace() to set global trace level (like per-handle $h->trace).
PERL_DBI_DEBUG env var renamed DBI_DEBUG (old name still works for now).
Updated docs, including commit, rollback, AutoCommit and Transactions sections.
Added bind_param method and execute(@bind_values) to docs.
Fixed fetchall_arrayref.
Since the DBIS structure has change the internal version numbers have also
changed (DBIXS_VERSION == 9 and DBISTATE_VERSION == 9) so drivers will have
to be recompiled. The test is also now more sensitive and the version
mismatch error message now more clear about what to do. Old drivers are
likely to core dump (this time) until recompiled for this DBI. In future
DBI/DBD version mismatch will always produce a clear error message.
Note that this DBI release contains and documents many new features
that won't appear in drivers for some time. Driver writers might like
to read perldoc DBI::DBD and comment on or apply the information given.
=head2 Changes in DBI 0.85, 25th June 1997
NOTE: New-style connect now defaults to AutoCommit mode unless
{ AutoCommit => 0 } specified in connect attributes. See the docs.
AutoCommit attribute now defined and tracked by DBI core.
Drivers should use/honour this and not implement their own.
Added pod doc changes from Andreas and Jonathan.
New DBI_DSN env var default for connect method. See docs.
Documented the func method.
Fixed "Usage: DBD::_::common::DESTROY" error.
Fixed bug which set some attributes true when there value was fetched.
Added new internal DBIc_set() macro for drivers to use.
=head2 Changes in DBI 0.84, 20th June 1997
Added $h->{PrintError} attribute which, if set true, causes all errors to
trigger a warn().
New-style DBI->connect call now automatically sets PrintError=1 unless
{ PrintError => 0 } specified in the connect attributes. See the docs.
The old-style connect with a separate driver parameter is deprecated.
Fixed fetchrow_hashref.
Renamed $h->debug to $h->trace() and added a trace filename arg.
Assorted other minor tidy-ups.
=head2 Changes in DBI 0.83, 11th June 1997
Added driver specification syntax to DBI->connect data_source
parameter: DBI->connect('dbi:driver:...', $user, $passwd);
The DBI->data_sources method should return data_source
names with the appropriate 'dbi:driver:' prefix.
DBI->connect will warn if \%attr is true but not a hash ref.
Added the new fetchrow methods:
@row_ary = $sth->fetchrow_array;
$ary_ref = $sth->fetchrow_arrayref;
$hash_ref = $sth->fetchrow_hashref;
The old fetch and fetchrow methods still work.
Driver implementors should implement the new names for
fetchrow_array and fetchrow_arrayref ASAP (use the xs ALIAS:
directive to define aliases for fetch and fetchrow).
Fixed occasional problems with t/examp.t test.
Added automatic errstr reporting to the debug trace output.
Added the DBI FAQ from Alligator Descartes in module form for
easy reading via "perldoc DBI::FAQ". Needs reformatting.
Unknown driver specific attribute names no longer croak.
Fixed problem with internal neatsvpv macro.
=head2 Changes in DBI 0.82, 23rd May 1997
Added $h->{RaiseError} attribute which, if set true, causes all errors to
trigger a die(). This makes it much easier to implement robust applications
in terms of higher level eval { ... } blocks and rollbacks.
Added DBI->data_sources($driver) method for implementation by drivers.
The quote method now returns the string NULL (without quotes) for undef.
Added VMS support thanks to Dan Sugalski.
Added a 'quick start guide' to the README.
Added neatsvpv function pointer to DBIS structure to make it available for
use by drivers. A macro defines neatsvpv(sv,len) as (DBIS->neatsvpv(sv,len)).
Old XS macro SV_YES_NO changes to standard boolSV.
Since the DBIS structure has change the internal version numbers have also
changed (DBIXS_VERSION == 8 and DBISTATE_VERSION == 8) so drivers will have
to be recompiled.
=head2 Changes in DBI 0.81, 7th May 1997
Minor fix to let DBI build using less modern perls.
Fixed a suprious typo warning.
=head2 Changes in DBI 0.80, 6th May 1997
Builds with no changes on NT using perl5.003_99 (with thanks to Jeffrey Urlwin).
Automatically supports Apache::DBI (with thanks to Edmund Mergl).
DBI scripts no longer need to be modified to make use of Apache::DBI.
Added a ping method and an experimental connect_test_perf method.
Added a fetchhash and fetch_all methods.
The func method no longer pre-clears err and errstr.
Added ChopBlanks attribute (currently defaults to off, that may change).
Support for the attribute needs to be implemented by individual drivers.
Reworked tests into standard t/*.t form.
Added more pod text. Fixed assorted bugs.
=head2 Changes in DBI 0.79, 7th Apr 1997
Minor release. Tidied up pod text and added some more descriptions
(especially disconnect). Minor changes to DBI.xs to remove compiler
warnings.
=head2 Changes in DBI 0.78, 28th Mar 1997
Greatly extended the pod documentation in DBI.pm, including the under
used bind_columns method. Use 'perldoc DBI' to read after installing.
Fixed $h->err. Fetching an attribute value no longer resets err.
Added $h->{InactiveDestroy}, see documentation for details.
Improved debugging of cached ('quick') attribute fetches.
errstr will return err code value if there is no string value.
Added DBI/W32ODBC to the distribution. This is a pure-perl experimental
DBI emulation layer for Win32::ODBC. Note that it's unsupported, your
mileage will vary, and bug reports without fixes will probably be ignored.
=head2 Changes in DBI 0.77, 21st Feb 1997
Removed erroneous $h->errstate and $h->errmsg methods from DBI.pm.
Added $h->err, $h->errstr and $h->state default methods in DBI.xs.
Updated informal DBI API notes in DBI.pm. Updated README slightly.
DBIXS.h now correctly installed into INST_ARCHAUTODIR.
(DBD authors will need to edit their Makefile.PL's to use
-I$(INSTALLSITEARCH)/auto/DBI -I$(INSTALLSITEARCH)/DBI)
=head2 Changes in DBI 0.76, 3rd Feb 1997
Fixed a compiler type warnings (pedantic IRIX again).
=head2 Changes in DBI 0.75, 27th Jan 1997
Fix problem introduced by a change in Perl5.003_XX.
Updated README and DBI.pm docs.
=head2 Changes in DBI 0.74, 14th Jan 1997
Dispatch now sets dbi_debug to the level of the current handle
(this makes tracing/debugging individual handles much easier).
The '>> DISPATCH' log line now only logged at debug >= 3 (was 2).
The $csr->NUM_OF_FIELDS attribute can be set if not >0 already.
You can log to a file using the env var PERL_DBI_DEBUG=/tmp/dbi.log.
Added a type cast needed by IRIX.
No longer sets perl_destruct_level unless debug set >= 4.
Make compatible with PerlIO and sfio.
=head2 Changes in DBI 0.73, 10th Oct 1996
Fixed some compiler type warnings (IRIX).
Fixed DBI->internal->{DebugLog} = $filename.
Made debug log file unbuffered.
Added experimental bind_param_inout method to interface.
Usage: $dbh->bind_param_inout($param, \$value, $maxlen [, \%attribs ])
(only currently used by DBD::Oracle at this time.)
=head2 Changes in DBI 0.72, 23 Sep 1996
Using an undefined value as a handle now gives a better
error message (mainly useful for emulators like Oraperl).
$dbh->do($sql, @params) now works for binding placeholders.
=head2 Changes in DBI 0.71, 10 July 1996
Removed spurious abort() from invalid handle check.
Added quote method to DBI interface and added test.
=head2 Changes in DBI 0.70, 16 June 1996
Added extra invalid handle check (dbih_getcom)
Fixed broken $dbh->quote method.
Added check for old GCC in Makefile.PL
=head2 Changes in DBI 0.69
Fixed small memory leak.
Clarified the behaviour of DBI->connect.
$dbh->do now returns '0E0' instead of 'OK'.
Fixed "Can't read $DBI::errstr, lost last handle" problem.
=head2 Changes in DBI 0.68, 2 Mar 1996
Changes to suit perl5.002 and site_lib directories.
Detects old versions ahead of new in @INC.
=head2 Changes in DBI 0.67, 15 Feb 1996
Trivial change to test suite to fix a problem shown up by the
Perl5.002gamma release Test::Harness.
=head2 Changes in DBI 0.66, 29 Jan 1996
Minor changes to bring the DBI into line with 5.002 mechanisms,
specifically the xs/pm VERSION checking mechanism.
No functionality changes. One no-last-handle bug fix (rare problem).
Requires 5.002 (beta2 or later).
=head2 Changes in DBI 0.65, 23 Oct 1995
Added $DBI::state to hold SQL CLI / ODBC SQLSTATE value.
SQLSTATE "00000" (success) is returned as "" (false), all else is true.
If a driver does not explicitly initialise it (via $h->{State} or
DBIc_STATE(imp_xxh) then $DBI::state will automatically return "" if
$DBI::err is false otherwise "S1000" (general error).
As always, this is a new feature and liable to change.
The is *no longer* a default error handler!
You can add your own using push(@{$h->{Handlers}}, sub { ... })
but be aware that this interface may change (or go away).
The DBI now automatically clears $DBI::err, errstr and state before
calling most DBI methods. Previously error conditions would persist.
Added DBIh_CLEAR_ERROR(imp_xxh) macro.
DBI now EXPORT_OK's some utility functions, neat($value),
neat_list(@values) and dump_results($sth).
Slightly enhanced t/min.t minimal test script in an effort to help
narrow down the few stray core dumps that some porters still report.
Renamed readblob to blob_read (old name still works but warns).
Added default blob_copy_to_file method.
Added $sth = $dbh->tables method. This returns an $sth for a query
which has these columns: TABLE_CATALOGUE, TABLE_OWNER, TABLE_NAME,
TABLE_TYPE, REMARKS in that order. The TABLE_CATALOGUE column
should be ignored for now.
=head2 Changes in DBI 0.64, 23 Oct 1995
Fixed 'disconnect invalidates 1 associated cursor(s)' problem.
Drivers using DBIc_ACTIVE_on/off() macros should not need any changes
other than to test for DBIc_ACTIVE_KIDS() instead of DBIc_KIDS().
Fixed possible core dump in dbih_clearcom during global destruction.
=head2 Changes in DBI 0.63, 1 Sep 1995
Minor update. Fixed uninitialised memory bug in method
attribute handling and streamlined processing and debugging.
Revised usage definitions for bind_* methods and readblob.
=head2 Changes in DBI 0.62, 26 Aug 1995
Added method redirection method $h->func(..., $method_name).
This is now the official way to call private driver methods
that are not part of the DBI standard. E.g.:
@ary = $sth->func('ora_types');
It can also be used to call existing methods. Has very low cost.
$sth->bind_col columns now start from 1 (not 0) to match SQL.
$sth->bind_columns now takes a leading attribute parameter (or undef),
e.g., $sth->bind_columns($attribs, \$col1 [, \$col2 , ...]);
Added handy DBD_ATTRIBS_CHECK macro to vet attribs in XS.
Added handy DBD_ATTRIB_GET_SVP, DBD_ATTRIB_GET_BOOL and
DBD_ATTRIB_GET_IV macros for handling attributes.
Fixed STORE for NUM_OF_FIELDS and NUM_OF_PARAMS.
Added FETCH for NUM_OF_FIELDS and NUM_OF_PARAMS.
Dispatch no longer bothers to call _untie().
Faster startup via install_method/_add_dispatch changes.
=head2 Changes in DBI 0.61, 22 Aug 1995
Added $sth->bind_col($column, \$var [, \%attribs ]);
This method enables perl variable to be directly and automatically
updated when a row is fetched. It requires no driver support
(if the driver has been written to use DBIS->get_fbav).
Currently \%attribs is unused.
Added $sth->bind_columns(\$var [, \$var , ...]);
This method is a short-cut for bind_col which binds all the
columns of a query in one go (with no attributes). It also
requires no driver support.
Added $sth->bind_param($parameter, $var [, \%attribs ]);
This method enables attributes to be specified when values are
bound to placeholders. It also enables binding to occur away
from the execute method to improve execute efficiency.
The DBI does not provide a default implementation of this.
See the DBD::Oracle module for a detailed example.
The DBI now provides default implementations of both fetch and
fetchrow. Each is written in terms of the other. A driver is
expected to implement at least one of them.
More macro and assorted structure changes in DBDXS.h. Sorry!
The old dbihcom definitions have gone. All fields have macros.
The imp_xxh_t type is now used within the DBI as well as drivers.
Drivers must set DBIc_NUM_FIELDS(imp_sth) and DBIc_NUM_PARAMS(imp_sth).
test.pl includes a trivial test of bind_param and bind_columns.
=head2 Changes in DBI 0.60, 17 Aug 1995
This release has significant code changes but much less
dramatic than the previous release. The new implementors data
handling mechanism has matured significantly (don't be put off
by all the struct typedefs in DBIXS.h, there's just to make it
easier for drivers while keeping things type-safe).
The DBI now includes two new methods:
do $dbh->do($statement)
This method prepares, executes and finishes a statement. It is
designed to be used for executing one-off non-select statements
where there is no benefit in reusing a prepared statement handle.
fetch $array_ref = $sth->fetch;
This method is the new 'lowest-level' row fetching method. The
previous @row = $sth->fetchrow method now defaults to calling
the fetch method and expanding the returned array reference.
The DBI now provides fallback attribute FETCH and STORE functions
which drivers should call if they don't recognise an attribute.
THIS RELEASE IS A GOOD STARTING POINT FOR DRIVER DEVELOPERS!
Study DBIXS.h from the DBI and Oracle.xs etc from DBD::Oracle.
There will be further changes in the interface but nothing
as dramatic as these last two releases! (I hope :-)
=head2 Changes in DBI 0.59 15 Aug 1995
NOTE: THIS IS AN UNSTABLE RELEASE!
Major reworking of internal data management!
Performance improvements and memory leaks fixed.
Added a new NullP (empty) driver and a -m flag
to test.pl to help check for memory leaks.
Study DBD::Oracle version 0.21 for more details.
(Comparing parts of v0.21 with v0.20 may be useful.)
=head2 Changes in DBI 0.58 21 June 1995
Added DBI->internal->{DebugLog} = $filename;
Reworked internal logging.
Added $VERSION.
Made disconnect_all a compulsory method for drivers.
=head1 ANCIENT HISTORY
12th Oct 1994: First public release of the DBI module.
(for Perl 5.000-beta-3h)
19th Sep 1994: DBperl project renamed to DBI.
29th Sep 1992: DBperl project started.
=cut
PK V`[^q�� Util/CacheMemory.pmnu �[��� package DBI::Util::CacheMemory;
# $Id: CacheMemory.pm 10314 2007-11-26 22:25:33Z Tim $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
use warnings;
=head1 NAME
DBI::Util::CacheMemory - a very fast but very minimal subset of Cache::Memory
=head1 DESCRIPTION
Like Cache::Memory (part of the Cache distribution) but doesn't support any fancy features.
This module aims to be a very fast compatible strict sub-set for simple cases,
such as basic client-side caching for DBD::Gofer.
Like Cache::Memory, and other caches in the Cache and Cache::Cache
distributions, the data will remain in the cache until cleared, it expires,
or the process dies. The cache object simply going out of scope will I<not>
destroy the data.
=head1 METHODS WITH CHANGES
=head2 new
All options except C<namespace> are ignored.
=head2 set
Doesn't support expiry.
=head2 purge
Same as clear() - deletes everything in the namespace.
=head1 METHODS WITHOUT CHANGES
=over
=item clear
=item count
=item exists
=item remove
=back
=head1 UNSUPPORTED METHODS
If it's not listed above, it's not supported.
=cut
our $VERSION = "0.010315";
my %cache;
sub new {
my ($class, %options ) = @_;
my $namespace = $options{namespace} ||= 'Default';
#$options{_cache} = \%cache; # can be handy for debugging/dumping
my $self = bless \%options => $class;
$cache{ $namespace } ||= {}; # init - ensure it exists
return $self;
}
sub set {
my ($self, $key, $value) = @_;
$cache{ $self->{namespace} }->{$key} = $value;
}
sub get {
my ($self, $key) = @_;
return $cache{ $self->{namespace} }->{$key};
}
sub exists {
my ($self, $key) = @_;
return exists $cache{ $self->{namespace} }->{$key};
}
sub remove {
my ($self, $key) = @_;
return delete $cache{ $self->{namespace} }->{$key};
}
sub purge {
return shift->clear;
}
sub clear {
$cache{ shift->{namespace} } = {};
}
sub count {
return scalar keys %{ $cache{ shift->{namespace} } };
}
sub size {
my $c = $cache{ shift->{namespace} };
my $size = 0;
while ( my ($k,$v) = each %$c ) {
$size += length($k) + length($v);
}
return $size;
}
1;
PK V`[!3т � Util/_accessor.pmnu �[��� package DBI::Util::_accessor;
use strict;
use Carp;
our $VERSION = "0.009479";
# inspired by Class::Accessor::Fast
sub new {
my($proto, $fields) = @_;
my($class) = ref $proto || $proto;
$fields ||= {};
my @dubious = grep { !m/^_/ && !$proto->can($_) } keys %$fields;
carp "$class doesn't have accessors for fields: @dubious" if @dubious;
# make a (shallow) copy of $fields.
bless {%$fields}, $class;
}
sub mk_accessors {
my($self, @fields) = @_;
$self->mk_accessors_using('make_accessor', @fields);
}
sub mk_accessors_using {
my($self, $maker, @fields) = @_;
my $class = ref $self || $self;
# So we don't have to do lots of lookups inside the loop.
$maker = $self->can($maker) unless ref $maker;
no strict 'refs';
foreach my $field (@fields) {
my $accessor = $self->$maker($field);
*{$class."\:\:$field"} = $accessor
unless defined &{$class."\:\:$field"};
}
#my $hash_ref = \%{$class."\:\:_accessors_hash};
#$hash_ref->{$_}++ for @fields;
# XXX also copy down _accessors_hash of base class(es)
# so one in this class is complete
return;
}
sub make_accessor {
my($class, $field) = @_;
return sub {
my $self = shift;
return $self->{$field} unless @_;
croak "Too many arguments to $field" if @_ > 1;
return $self->{$field} = shift;
};
}
sub make_accessor_autoviv_hashref {
my($class, $field) = @_;
return sub {
my $self = shift;
return $self->{$field} ||= {} unless @_;
croak "Too many arguments to $field" if @_ > 1;
return $self->{$field} = shift;
};
}
1;
PK V`[����� � ProfileSubs.pmnu �[��� package DBI::ProfileSubs;
our $VERSION = "0.009396";
=head1 NAME
DBI::ProfileSubs - Subroutines for dynamic profile Path
=head1 SYNOPSIS
DBI_PROFILE='&norm_std_n3' prog.pl
This is new and still experimental.
=head1 TO DO
Define come kind of naming convention for the subs.
=cut
use strict;
use warnings;
# would be good to refactor these regex into separate subs and find some
# way to compose them in various combinations into multiple subs.
# Perhaps via AUTOLOAD where \&auto_X_Y_Z creates a sub that does X, Y, and Z.
# The final subs always need to be very fast.
#
sub norm_std_n3 {
# my ($h, $method_name) = @_;
local $_ = $_;
s/\b\d+\b/<N>/g; # 42 -> <N>
s/\b0x[0-9A-Fa-f]+\b/<N>/g; # 0xFE -> <N>
s/'.*?'/'<S>'/g; # single quoted strings (doesn't handle escapes)
s/".*?"/"<S>"/g; # double quoted strings (doesn't handle escapes)
# convert names like log20001231 into log<N>
s/([a-z_]+)(\d{3,})\b/${1}<N>/ig;
# abbreviate massive "in (...)" statements and similar
s!((\s*<[NS]>\s*,\s*){100,})!sprintf("$2,<repeated %d times>",length($1)/2)!eg;
return $_;
}
1;
PK V`[��Gf
v
v SQL/Nano.pmnu �[��� #######################################################################
#
# DBI::SQL::Nano - a very tiny SQL engine
#
# Copyright (c) 2010 by Jens Rehsack < rehsack AT cpan.org >
# Copyright (c) 2004 by Jeff Zucker < jzucker AT cpan.org >
#
# All rights reserved.
#
# You may freely distribute and/or modify this module under the terms
# of either the GNU General Public License (GPL) or the Artistic License,
# as specified in the Perl README file.
#
# See the pod at the bottom of this file for help information
#
#######################################################################
#######################
package DBI::SQL::Nano;
#######################
use strict;
use warnings;
use vars qw( $VERSION $versions );
use Carp qw(croak);
require DBI; # for looks_like_number()
BEGIN
{
$VERSION = "1.015544";
$versions->{nano_version} = $VERSION;
if ( $ENV{DBI_SQL_NANO} || !eval { require SQL::Statement; $SQL::Statement::VERSION ge '1.400' } )
{
@DBI::SQL::Nano::Statement::ISA = qw(DBI::SQL::Nano::Statement_);
@DBI::SQL::Nano::Table::ISA = qw(DBI::SQL::Nano::Table_);
}
else
{
@DBI::SQL::Nano::Statement::ISA = qw( SQL::Statement );
@DBI::SQL::Nano::Table::ISA = qw( SQL::Eval::Table);
$versions->{statement_version} = $SQL::Statement::VERSION;
}
}
###################################
package DBI::SQL::Nano::Statement_;
###################################
use Carp qw(croak);
use Errno;
if ( eval { require Clone; } )
{
Clone->import("clone");
}
else
{
require Storable; # in CORE since 5.7.3
*clone = \&Storable::dclone;
}
sub new
{
my ( $class, $sql ) = @_;
my $self = {};
bless $self, $class;
return $self->prepare($sql);
}
#####################################################################
# PREPARE
#####################################################################
sub prepare
{
my ( $self, $sql ) = @_;
$sql =~ s/\s+$//;
$sql =~ s/\s*;$//;
for ($sql)
{
/^\s*CREATE\s+TABLE\s+(.*?)\s*\((.+)\)\s*$/is
&& do
{
$self->{command} = 'CREATE';
$self->{table_name} = $1;
defined $2 and $2 ne "" and
$self->{column_names} = parse_coldef_list($2);
$self->{column_names} or croak "Can't find columns";
};
/^\s*DROP\s+TABLE\s+(IF\s+EXISTS\s+)?(.*?)\s*$/is
&& do
{
$self->{command} = 'DROP';
$self->{table_name} = $2;
defined $1 and $1 ne "" and
$self->{ignore_missing_table} = 1;
};
/^\s*SELECT\s+(.*?)\s+FROM\s+(\S+)((.*))?/is
&& do
{
$self->{command} = 'SELECT';
defined $1 and $1 ne "" and
$self->{column_names} = parse_comma_list($1);
$self->{column_names} or croak "Can't find columns";
$self->{table_name} = $2;
if ( my $clauses = $4 )
{
if ( $clauses =~ /^(.*)\s+ORDER\s+BY\s+(.*)$/is )
{
$clauses = $1;
$self->{order_clause} = $self->parse_order_clause($2);
}
$self->{where_clause} = $self->parse_where_clause($clauses) if ($clauses);
}
};
/^\s*INSERT\s+(?:INTO\s+)?(\S+)\s*(\((.*?)\))?\s*VALUES\s*\((.+)\)/is
&& do
{
$self->{command} = 'INSERT';
$self->{table_name} = $1;
defined $2 and $2 ne "" and
$self->{column_names} = parse_comma_list($2);
defined $4 and $4 ne "" and
$self->{values} = $self->parse_values_list($4);
$self->{values} or croak "Can't parse values";
};
/^\s*DELETE\s+FROM\s+(\S+)((.*))?/is
&& do
{
$self->{command} = 'DELETE';
$self->{table_name} = $1;
defined $3 and $3 ne "" and
$self->{where_clause} = $self->parse_where_clause($3);
};
/^\s*UPDATE\s+(\S+)\s+SET\s+(.+)(\s+WHERE\s+.+)/is
&& do
{
$self->{command} = 'UPDATE';
$self->{table_name} = $1;
defined $2 and $2 ne "" and
$self->parse_set_clause($2);
defined $3 and $3 ne "" and
$self->{where_clause} = $self->parse_where_clause($3);
};
}
croak "Couldn't parse" unless ( $self->{command} and $self->{table_name} );
return $self;
}
sub parse_order_clause
{
my ( $self, $str ) = @_;
my @clause = split /\s+/, $str;
return { $clause[0] => 'ASC' } if ( @clause == 1 );
croak "Bad ORDER BY clause '$str'" if ( @clause > 2 );
$clause[1] ||= '';
return { $clause[0] => uc $clause[1] }
if $clause[1] =~ /^ASC$/i
or $clause[1] =~ /^DESC$/i;
croak "Bad ORDER BY clause '$clause[1]'";
}
sub parse_coldef_list
{ # check column definitions
my @col_defs;
for ( split ',', shift )
{
my $col = clean_parse_str($_);
if ( $col =~ /^(\S+?)\s+.+/ )
{ # doesn't check what it is
$col = $1; # just checks if it exists
}
else
{
croak "No column definition for '$_'";
}
push @col_defs, $col;
}
return \@col_defs;
}
sub parse_comma_list
{
[ map { clean_parse_str($_) } split( ',', shift ) ];
}
sub clean_parse_str { local $_ = shift; s/\(//; s/\)//; s/^\s+//; s/\s+$//; $_; }
sub parse_values_list
{
my ( $self, $str ) = @_;
[ map { $self->parse_value( clean_parse_str($_) ) } split( ',', $str ) ];
}
sub parse_set_clause
{
my $self = shift;
my @cols = split /,/, shift;
my $set_clause;
for my $col (@cols)
{
my ( $col_name, $value ) = $col =~ /^\s*(.+?)\s*=\s*(.+?)\s*$/s;
push @{ $self->{column_names} }, $col_name;
push @{ $self->{values} }, $self->parse_value($value);
}
croak "Can't parse set clause" unless ( $self->{column_names} and $self->{values} );
}
sub parse_value
{
my ( $self, $str ) = @_;
return unless ( defined $str );
$str =~ s/\s+$//;
$str =~ s/^\s+//;
if ( $str =~ /^\?$/ )
{
push @{ $self->{params} }, '?';
return {
value => '?',
type => 'placeholder'
};
}
return {
value => undef,
type => 'NULL'
} if ( $str =~ /^NULL$/i );
return {
value => $1,
type => 'string'
} if ( $str =~ /^'(.+)'$/s );
return {
value => $str,
type => 'number'
} if ( DBI::looks_like_number($str) );
return {
value => $str,
type => 'column'
};
}
sub parse_where_clause
{
my ( $self, $str ) = @_;
$str =~ s/\s+$//;
if ( $str =~ /^\s*WHERE\s+(.*)/i )
{
$str = $1;
}
else
{
croak "Couldn't find WHERE clause in '$str'";
}
my ($neg) = $str =~ s/^\s*(NOT)\s+//is;
my $opexp = '=|<>|<=|>=|<|>|LIKE|CLIKE|IS';
my ( $val1, $op, $val2 ) = $str =~ /^(.+?)\s*($opexp)\s*(.+)\s*$/iso;
croak "Couldn't parse WHERE expression '$str'" unless ( defined $val1 and defined $op and defined $val2 );
return {
arg1 => $self->parse_value($val1),
arg2 => $self->parse_value($val2),
op => $op,
neg => $neg,
};
}
#####################################################################
# EXECUTE
#####################################################################
sub execute
{
my ( $self, $data, $params ) = @_;
my $num_placeholders = $self->params;
my $num_params = scalar @$params || 0;
croak "Number of params '$num_params' does not match number of placeholders '$num_placeholders'"
unless ( $num_placeholders == $num_params );
if ( scalar @$params )
{
for my $i ( 0 .. $#{ $self->{values} } )
{
if ( $self->{values}->[$i]->{type} eq 'placeholder' )
{
$self->{values}->[$i]->{value} = shift @$params;
}
}
if ( $self->{where_clause} )
{
if ( $self->{where_clause}->{arg1}->{type} eq 'placeholder' )
{
$self->{where_clause}->{arg1}->{value} = shift @$params;
}
if ( $self->{where_clause}->{arg2}->{type} eq 'placeholder' )
{
$self->{where_clause}->{arg2}->{value} = shift @$params;
}
}
}
my $command = $self->{command};
( $self->{'NUM_OF_ROWS'}, $self->{'NUM_OF_FIELDS'}, $self->{'data'}, ) = $self->$command( $data, $params );
$self->{NAME} ||= $self->{column_names};
return $self->{'NUM_OF_ROWS'} || '0E0';
}
my $enoentstr = "Cannot open .*\(" . Errno::ENOENT . "\)";
my $enoentrx = qr/$enoentstr/;
sub DROP ($$$)
{
my ( $self, $data, $params ) = @_;
my $table;
my @err;
eval {
local $SIG{__WARN__} = sub { push @err, @_ };
($table) = $self->open_tables( $data, 0, 1 );
};
if ( $self->{ignore_missing_table} and ( $@ or @err ) and grep { $_ =~ $enoentrx } ( @err, $@ ) )
{
$@ = '';
return ( -1, 0 );
}
croak( $@ || $err[0] ) if ( $@ || @err );
return ( -1, 0 ) unless $table;
$table->drop($data);
( -1, 0 );
}
sub CREATE ($$$)
{
my ( $self, $data, $params ) = @_;
my $table = $self->open_tables( $data, 1, 1 );
$table->push_names( $data, $self->{column_names} );
( 0, 0 );
}
sub INSERT ($$$)
{
my ( $self, $data, $params ) = @_;
my $table = $self->open_tables( $data, 0, 1 );
$self->verify_columns($table);
my $all_columns = $table->{col_names};
$table->seek( $data, 0, 2 ) unless ( $table->can('insert_one_row') );
my ($array) = [];
my ( $val, $col, $i );
$self->{column_names} = $table->col_names() unless ( $self->{column_names} );
my $cNum = scalar( @{ $self->{column_names} } ) if ( $self->{column_names} );
my $param_num = 0;
$cNum or
croak "Bad col names in INSERT";
my $maxCol = $#$all_columns;
for ( $i = 0; $i < $cNum; $i++ )
{
$col = $self->{column_names}->[$i];
$array->[ $self->column_nums( $table, $col ) ] = $self->row_values($i);
}
# Extend row to put values in ALL fields
$#$array < $maxCol and $array->[$maxCol] = undef;
$table->can('insert_new_row') ? $table->insert_new_row( $data, $array ) : $table->push_row( $data, $array );
return ( 1, 0 );
}
sub DELETE ($$$)
{
my ( $self, $data, $params ) = @_;
my $table = $self->open_tables( $data, 0, 1 );
$self->verify_columns($table);
my ($affected) = 0;
my ( @rows, $array );
my $can_dor = $table->can('delete_one_row');
while ( $array = $table->fetch_row($data) )
{
if ( $self->eval_where( $table, $array ) )
{
++$affected;
if ( $self->{fetched_from_key} )
{
$array = $self->{fetched_value};
$table->delete_one_row( $data, $array );
return ( $affected, 0 );
}
push( @rows, $array ) if ($can_dor);
}
else
{
push( @rows, $array ) unless ($can_dor);
}
}
if ($can_dor)
{
foreach $array (@rows)
{
$table->delete_one_row( $data, $array );
}
}
else
{
$table->seek( $data, 0, 0 );
foreach $array (@rows)
{
$table->push_row( $data, $array );
}
$table->truncate($data);
}
return ( $affected, 0 );
}
sub _anycmp($$;$)
{
my ( $a, $b, $case_fold ) = @_;
if ( !defined($a) || !defined($b) )
{
return defined($a) - defined($b);
}
elsif ( DBI::looks_like_number($a) && DBI::looks_like_number($b) )
{
return $a <=> $b;
}
else
{
return $case_fold ? lc($a) cmp lc($b) || $a cmp $b : $a cmp $b;
}
}
sub SELECT ($$$)
{
my ( $self, $data, $params ) = @_;
my $table = $self->open_tables( $data, 0, 0 );
$self->verify_columns($table);
my $tname = $self->{table_name};
my ($affected) = 0;
my ( @rows, %cols, $array, $val, $col, $i );
while ( $array = $table->fetch_row($data) )
{
if ( $self->eval_where( $table, $array ) )
{
$array = $self->{fetched_value} if ( $self->{fetched_from_key} );
unless ( keys %cols )
{
my $col_nums = $self->column_nums($table);
%cols = reverse %{$col_nums};
}
my $rowhash;
for ( sort keys %cols )
{
$rowhash->{ $cols{$_} } = $array->[$_];
}
my @newarray;
for ( $i = 0; $i < @{ $self->{column_names} }; $i++ )
{
$col = $self->{column_names}->[$i];
push @newarray, $rowhash->{$col};
}
push( @rows, \@newarray );
return ( scalar(@rows), scalar @{ $self->{column_names} }, \@rows )
if ( $self->{fetched_from_key} );
}
}
if ( $self->{order_clause} )
{
my ( $sort_col, $desc ) = each %{ $self->{order_clause} };
my @sortCols = ( $self->column_nums( $table, $sort_col, 1 ) );
$sortCols[1] = uc $desc eq 'DESC' ? 1 : 0;
@rows = sort {
my ( $result, $colNum, $desc );
my $i = 0;
do
{
$colNum = $sortCols[ $i++ ];
$desc = $sortCols[ $i++ ];
$result = _anycmp( $a->[$colNum], $b->[$colNum] );
$result = -$result if ($desc);
} while ( !$result && $i < @sortCols );
$result;
} @rows;
}
( scalar(@rows), scalar @{ $self->{column_names} }, \@rows );
}
sub UPDATE ($$$)
{
my ( $self, $data, $params ) = @_;
my $table = $self->open_tables( $data, 0, 1 );
$self->verify_columns($table);
return undef unless $table;
my $affected = 0;
my $can_usr = $table->can('update_specific_row');
my $can_uor = $table->can('update_one_row');
my $can_rwu = $can_usr || $can_uor;
my ( @rows, $array, $f_array, $val, $col, $i );
while ( $array = $table->fetch_row($data) )
{
if ( $self->eval_where( $table, $array ) )
{
$array = $self->{fetched_value} if ( $self->{fetched_from_key} and $can_rwu );
my $orig_ary = clone($array) if ($can_usr);
for ( $i = 0; $i < @{ $self->{column_names} }; $i++ )
{
$col = $self->{column_names}->[$i];
$array->[ $self->column_nums( $table, $col ) ] = $self->row_values($i);
}
$affected++;
if ( $self->{fetched_value} )
{
if ($can_usr)
{
$table->update_specific_row( $data, $array, $orig_ary );
}
elsif ($can_uor)
{
$table->update_one_row( $data, $array );
}
return ( $affected, 0 );
}
push( @rows, $can_usr ? [ $array, $orig_ary ] : $array );
}
else
{
push( @rows, $array ) unless ($can_rwu);
}
}
if ($can_rwu)
{
foreach my $array (@rows)
{
if ($can_usr)
{
$table->update_specific_row( $data, @$array );
}
elsif ($can_uor)
{
$table->update_one_row( $data, $array );
}
}
}
else
{
$table->seek( $data, 0, 0 );
foreach my $array (@rows)
{
$table->push_row( $data, $array );
}
$table->truncate($data);
}
return ( $affected, 0 );
}
sub verify_columns
{
my ( $self, $table ) = @_;
my @cols = @{ $self->{column_names} };
if ( $self->{where_clause} )
{
if ( my $col = $self->{where_clause}->{arg1} )
{
push @cols, $col->{value} if $col->{type} eq 'column';
}
if ( my $col = $self->{where_clause}->{arg2} )
{
push @cols, $col->{value} if $col->{type} eq 'column';
}
}
for (@cols)
{
$self->column_nums( $table, $_ );
}
}
sub column_nums
{
my ( $self, $table, $stmt_col_name, $find_in_stmt ) = @_;
my %dbd_nums = %{ $table->col_nums() };
my @dbd_cols = @{ $table->col_names() };
my %stmt_nums;
if ( $stmt_col_name and !$find_in_stmt )
{
while ( my ( $k, $v ) = each %dbd_nums )
{
return $v if uc $k eq uc $stmt_col_name;
}
croak "No such column '$stmt_col_name'";
}
if ( $stmt_col_name and $find_in_stmt )
{
for my $i ( 0 .. @{ $self->{column_names} } )
{
return $i if uc $stmt_col_name eq uc $self->{column_names}->[$i];
}
croak "No such column '$stmt_col_name'";
}
for my $i ( 0 .. $#dbd_cols )
{
for my $stmt_col ( @{ $self->{column_names} } )
{
$stmt_nums{$stmt_col} = $i if uc $dbd_cols[$i] eq uc $stmt_col;
}
}
return \%stmt_nums;
}
sub eval_where
{
my ( $self, $table, $rowary ) = @_;
my $where = $self->{"where_clause"} || return 1;
my $col_nums = $table->col_nums();
my %cols = reverse %{$col_nums};
my $rowhash;
for ( sort keys %cols )
{
$rowhash->{ uc $cols{$_} } = $rowary->[$_];
}
return $self->process_predicate( $where, $table, $rowhash );
}
sub process_predicate
{
my ( $self, $pred, $table, $rowhash ) = @_;
my $val1 = $pred->{arg1};
if ( $val1->{type} eq 'column' )
{
$val1 = $rowhash->{ uc $val1->{value} };
}
else
{
$val1 = $val1->{value};
}
my $val2 = $pred->{arg2};
if ( $val2->{type} eq 'column' )
{
$val2 = $rowhash->{ uc $val2->{value} };
}
else
{
$val2 = $val2->{value};
}
my $op = $pred->{op};
my $neg = $pred->{neg};
if ( $op eq '=' and !$neg and $table->can('fetch_one_row') )
{
my $key_col = $table->fetch_one_row( 1, 1 );
if ( $pred->{arg1}->{value} =~ /^$key_col$/i )
{
$self->{fetched_from_key} = 1;
$self->{fetched_value} = $table->fetch_one_row( 0, $pred->{arg2}->{value} );
return 1;
}
}
my $match = $self->is_matched( $val1, $op, $val2 ) || 0;
if ($neg) { $match = $match ? 0 : 1; }
return $match;
}
sub is_matched
{
my ( $self, $val1, $op, $val2 ) = @_;
if ( $op eq 'IS' )
{
return 1 if ( !defined $val1 or $val1 eq '' );
return 0;
}
$val1 = '' unless ( defined $val1 );
$val2 = '' unless ( defined $val2 );
if ( $op =~ /LIKE|CLIKE/i )
{
$val2 = quotemeta($val2);
$val2 =~ s/\\%/.*/g;
$val2 =~ s/_/./g;
}
if ( $op eq 'LIKE' ) { return $val1 =~ /^$val2$/s; }
if ( $op eq 'CLIKE' ) { return $val1 =~ /^$val2$/si; }
if ( DBI::looks_like_number($val1) && DBI::looks_like_number($val2) )
{
if ( $op eq '<' ) { return $val1 < $val2; }
if ( $op eq '>' ) { return $val1 > $val2; }
if ( $op eq '=' ) { return $val1 == $val2; }
if ( $op eq '<>' ) { return $val1 != $val2; }
if ( $op eq '<=' ) { return $val1 <= $val2; }
if ( $op eq '>=' ) { return $val1 >= $val2; }
}
else
{
if ( $op eq '<' ) { return $val1 lt $val2; }
if ( $op eq '>' ) { return $val1 gt $val2; }
if ( $op eq '=' ) { return $val1 eq $val2; }
if ( $op eq '<>' ) { return $val1 ne $val2; }
if ( $op eq '<=' ) { return $val1 ge $val2; }
if ( $op eq '>=' ) { return $val1 le $val2; }
}
}
sub params
{
my ( $self, $val_num ) = @_;
if ( !$self->{"params"} ) { return 0; }
if ( defined $val_num )
{
return $self->{"params"}->[$val_num];
}
return wantarray ? @{ $self->{"params"} } : scalar @{ $self->{"params"} };
}
sub open_tables
{
my ( $self, $data, $createMode, $lockMode ) = @_;
my $table_name = $self->{table_name};
my $table;
eval { $table = $self->open_table( $data, $table_name, $createMode, $lockMode ) };
if ($@)
{
chomp $@;
croak $@;
}
croak "Couldn't open table '$table_name'" unless $table;
if ( !$self->{column_names} or $self->{column_names}->[0] eq '*' )
{
$self->{column_names} = $table->col_names();
}
return $table;
}
sub row_values
{
my ( $self, $val_num ) = @_;
if ( !$self->{"values"} ) { return 0; }
if ( defined $val_num )
{
return $self->{"values"}->[$val_num]->{value};
}
if (wantarray)
{
return map { $_->{"value"} } @{ $self->{"values"} };
}
else
{
return scalar @{ $self->{"values"} };
}
}
sub column_names
{
my ($self) = @_;
my @col_names;
if ( $self->{column_names} and $self->{column_names}->[0] ne '*' )
{
@col_names = @{ $self->{column_names} };
}
return @col_names;
}
###############################
package DBI::SQL::Nano::Table_;
###############################
use Carp qw(croak);
sub new ($$)
{
my ( $proto, $attr ) = @_;
my ($self) = {%$attr};
defined( $self->{col_names} ) and "ARRAY" eq ref( $self->{col_names} )
or croak("attribute 'col_names' must be defined as an array");
exists( $self->{col_nums} ) or $self->{col_nums} = _map_colnums( $self->{col_names} );
defined( $self->{col_nums} ) and "HASH" eq ref( $self->{col_nums} )
or croak("attribute 'col_nums' must be defined as a hash");
bless( $self, ( ref($proto) || $proto ) );
return $self;
}
sub _map_colnums
{
my $col_names = $_[0];
my %col_nums;
for my $i ( 0 .. $#$col_names )
{
next unless $col_names->[$i];
$col_nums{ $col_names->[$i] } = $i;
}
return \%col_nums;
}
sub row() { return $_[0]->{row}; }
sub column($) { return $_[0]->{row}->[ $_[0]->column_num( $_[1] ) ]; }
sub column_num($) { $_[0]->{col_nums}->{ $_[1] }; }
sub col_nums() { $_[0]->{col_nums} }
sub col_names() { $_[0]->{col_names}; }
sub drop ($$) { croak "Abstract method " . ref( $_[0] ) . "::drop called" }
sub fetch_row ($$$) { croak "Abstract method " . ref( $_[0] ) . "::fetch_row called" }
sub push_row ($$$) { croak "Abstract method " . ref( $_[0] ) . "::push_row called" }
sub push_names ($$$) { croak "Abstract method " . ref( $_[0] ) . "::push_names called" }
sub truncate ($$) { croak "Abstract method " . ref( $_[0] ) . "::truncate called" }
sub seek ($$$$) { croak "Abstract method " . ref( $_[0] ) . "::seek called" }
1;
__END__
=pod
=head1 NAME
DBI::SQL::Nano - a very tiny SQL engine
=head1 SYNOPSIS
BEGIN { $ENV{DBI_SQL_NANO}=1 } # forces use of Nano rather than SQL::Statement
use DBI::SQL::Nano;
use Data::Dumper;
my $stmt = DBI::SQL::Nano::Statement->new(
"SELECT bar,baz FROM foo WHERE qux = 1"
) or die "Couldn't parse";
print Dumper $stmt;
=head1 DESCRIPTION
C<< DBI::SQL::Nano >> is meant as a I<very> minimal SQL engine for use in
situations where SQL::Statement is not available. In most situations you are
better off installing L<SQL::Statement> although DBI::SQL::Nano may be faster
for some B<very> simple tasks.
DBI::SQL::Nano, like SQL::Statement is primarily intended to provide a SQL
engine for use with some pure perl DBDs including L<DBD::DBM>, L<DBD::CSV>,
L<DBD::AnyData>, and L<DBD::Excel>. It is not of much use in and of itself.
You can dump out the structure of a parsed SQL statement, but that is about
it.
=head1 USAGE
=head2 Setting the DBI_SQL_NANO flag
By default, when a C<< DBD >> uses C<< DBI::SQL::Nano >>, the module will
look to see if C<< SQL::Statement >> is installed. If it is, SQL::Statement
objects are used. If SQL::Statement is not available, DBI::SQL::Nano
objects are used.
In some cases, you may wish to use DBI::SQL::Nano objects even if
SQL::Statement is available. To force usage of DBI::SQL::Nano objects
regardless of the availability of SQL::Statement, set the environment
variable DBI_SQL_NANO to 1.
You can set the environment variable in your shell prior to running your
script (with SET or EXPORT or whatever), or else you can set it in your
script by putting this at the top of the script:
BEGIN { $ENV{DBI_SQL_NANO} = 1 }
=head2 Supported SQL syntax
Here's a pseudo-BNF. Square brackets [] indicate optional items;
Angle brackets <> indicate items defined elsewhere in the BNF.
statement ::=
DROP TABLE [IF EXISTS] <table_name>
| CREATE TABLE <table_name> <col_def_list>
| INSERT INTO <table_name> [<insert_col_list>] VALUES <val_list>
| DELETE FROM <table_name> [<where_clause>]
| UPDATE <table_name> SET <set_clause> <where_clause>
| SELECT <select_col_list> FROM <table_name> [<where_clause>]
[<order_clause>]
the optional IF EXISTS clause ::=
* similar to MySQL - prevents errors when trying to drop
a table that doesn't exist
identifiers ::=
* table and column names should be valid SQL identifiers
* especially avoid using spaces and commas in identifiers
* note: there is no error checking for invalid names, some
will be accepted, others will cause parse failures
table_name ::=
* only one table (no multiple table operations)
* see identifier for valid table names
col_def_list ::=
* a parens delimited, comma-separated list of column names
* see identifier for valid column names
* column types and column constraints may be included but are ignored
e.g. these are all the same:
(id,phrase)
(id INT, phrase VARCHAR(40))
(id INT PRIMARY KEY, phrase VARCHAR(40) NOT NULL)
* you are *strongly* advised to put in column types even though
they are ignored ... it increases portability
insert_col_list ::=
* a parens delimited, comma-separated list of column names
* as in standard SQL, this is optional
select_col_list ::=
* a comma-separated list of column names
* or an asterisk denoting all columns
val_list ::=
* a parens delimited, comma-separated list of values which can be:
* placeholders (an unquoted question mark)
* numbers (unquoted numbers)
* column names (unquoted strings)
* nulls (unquoted word NULL)
* strings (delimited with single quote marks);
* note: leading and trailing percent mark (%) and underscore (_)
can be used as wildcards in quoted strings for use with
the LIKE and CLIKE operators
* note: escaped single quotation marks within strings are not
supported, neither are embedded commas, use placeholders instead
set_clause ::=
* a comma-separated list of column = value pairs
* see val_list for acceptable value formats
where_clause ::=
* a single "column/value <op> column/value" predicate, optionally
preceded by "NOT"
* note: multiple predicates combined with ORs or ANDs are not supported
* see val_list for acceptable value formats
* op may be one of:
< > >= <= = <> LIKE CLIKE IS
* CLIKE is a case insensitive LIKE
order_clause ::= column_name [ASC|DESC]
* a single column optional ORDER BY clause is supported
* as in standard SQL, if neither ASC (ascending) nor
DESC (descending) is specified, ASC becomes the default
=head1 TABLES
DBI::SQL::Nano::Statement operates on exactly one table. This table will be
opened by inherit from DBI::SQL::Nano::Statement and implements the
C<< open_table >> method.
sub open_table ($$$$$)
{
...
return Your::Table->new( \%attributes );
}
DBI::SQL::Nano::Statement_ expects a rudimentary interface is implemented by
the table object, as well as SQL::Statement expects.
package Your::Table;
use vars qw(@ISA);
@ISA = qw(DBI::SQL::Nano::Table);
sub drop ($$) { ... }
sub fetch_row ($$$) { ... }
sub push_row ($$$) { ... }
sub push_names ($$$) { ... }
sub truncate ($$) { ... }
sub seek ($$$$) { ... }
The base class interfaces are provided by DBI::SQL::Nano::Table_ in case of
relying on DBI::SQL::Nano or SQL::Eval::Table (see L<SQL::Eval> for details)
otherwise.
=head1 BUGS AND LIMITATIONS
There are no known bugs in DBI::SQL::Nano::Statement. If you find a one
and want to report, please see L<DBI> for how to report bugs.
DBI::SQL::Nano::Statement is designed to provide a minimal subset for
executing SQL statements.
The most important limitation might be the restriction on one table per
statement. This implies, that no JOINs are supported and there cannot be
any foreign key relation between tables.
The where clause evaluation of DBI::SQL::Nano::Statement is very slow
(SQL::Statement uses a precompiled evaluation).
INSERT can handle only one row per statement. To insert multiple rows,
use placeholders as explained in DBI.
The DBI::SQL::Nano parser is very limited and does not support any
additional syntax such as brackets, comments, functions, aggregations
etc.
In contrast to SQL::Statement, temporary tables are not supported.
=head1 ACKNOWLEDGEMENTS
Tim Bunce provided the original idea for this module, helped me out of the
tangled trap of namespaces, and provided help and advice all along the way.
Although I wrote it from the ground up, it is based on Jochen Wiedmann's
original design of SQL::Statement, so much of the credit for the API goes
to him.
=head1 AUTHOR AND COPYRIGHT
This module is originally written by Jeff Zucker < jzucker AT cpan.org >
This module is currently maintained by Jens Rehsack < jrehsack AT cpan.org >
Copyright (C) 2010 by Jens Rehsack, all rights reserved.
Copyright (C) 2004 by Jeff Zucker, all rights reserved.
You may freely distribute and/or modify this module under the terms of
either the GNU General Public License (GPL) or the Artistic License,
as specified in the Perl README file.
=cut
PK V`[d-� �
Profile.pmnu �[��� package DBI::Profile;
=head1 NAME
DBI::Profile - Performance profiling and benchmarking for the DBI
=head1 SYNOPSIS
The easiest way to enable DBI profiling is to set the DBI_PROFILE
environment variable to 2 and then run your code as usual:
DBI_PROFILE=2 prog.pl
This will profile your program and then output a textual summary
grouped by query when the program exits. You can also enable profiling by
setting the Profile attribute of any DBI handle:
$dbh->{Profile} = 2;
Then the summary will be printed when the handle is destroyed.
Many other values apart from are possible - see L<"ENABLING A PROFILE"> below.
=head1 DESCRIPTION
The DBI::Profile module provides a simple interface to collect and
report performance and benchmarking data from the DBI.
For a more elaborate interface, suitable for larger programs, see
L<DBI::ProfileDumper|DBI::ProfileDumper> and L<dbiprof|dbiprof>.
For Apache/mod_perl applications see
L<DBI::ProfileDumper::Apache|DBI::ProfileDumper::Apache>.
=head1 OVERVIEW
Performance data collection for the DBI is built around several
concepts which are important to understand clearly.
=over 4
=item Method Dispatch
Every method call on a DBI handle passes through a single 'dispatch'
function which manages all the common aspects of DBI method calls,
such as handling the RaiseError attribute.
=item Data Collection
If profiling is enabled for a handle then the dispatch code takes
a high-resolution timestamp soon after it is entered. Then, after
calling the appropriate method and just before returning, it takes
another high-resolution timestamp and calls a function to record
the information. That function is passed the two timestamps
plus the DBI handle and the name of the method that was called.
That data about a single DBI method call is called a I<profile sample>.
=item Data Filtering
If the method call was invoked by the DBI or by a driver then the call is
ignored for profiling because the time spent will be accounted for by the
original 'outermost' call for your code.
For example, the calls that the selectrow_arrayref() method makes
to prepare() and execute() etc. are not counted individually
because the time spent in those methods is going to be allocated
to the selectrow_arrayref() method when it returns. If this was not
done then it would be very easy to double count time spent inside
the DBI.
=item Data Storage Tree
The profile data is accumulated as 'leaves on a tree'. The 'path' through the
branches of the tree to a particular leaf is determined dynamically for each sample.
This is a key feature of DBI profiling.
For each profiled method call the DBI walks along the Path and uses each value
in the Path to step into and grow the Data tree.
For example, if the Path is
[ 'foo', 'bar', 'baz' ]
then the new profile sample data will be I<merged> into the tree at
$h->{Profile}->{Data}->{foo}->{bar}->{baz}
But it's not very useful to merge all the call data into one leaf node (except
to get an overall 'time spent inside the DBI' total). It's more common to want
the Path to include dynamic values such as the current statement text and/or
the name of the method called to show what the time spent inside the DBI was for.
The Path can contain some 'magic cookie' values that are automatically replaced
by corresponding dynamic values when they're used. These magic cookies always
start with a punctuation character.
For example a value of 'C<!MethodName>' in the Path causes the corresponding
entry in the Data to be the name of the method that was called.
For example, if the Path was:
[ 'foo', '!MethodName', 'bar' ]
and the selectall_arrayref() method was called, then the profile sample data
for that call will be merged into the tree at:
$h->{Profile}->{Data}->{foo}->{selectall_arrayref}->{bar}
=item Profile Data
Profile data is stored at the 'leaves' of the tree as references
to an array of numeric values. For example:
[
106, # 0: count of samples at this node
0.0312958955764771, # 1: total duration
0.000490069389343262, # 2: first duration
0.000176072120666504, # 3: shortest duration
0.00140702724456787, # 4: longest duration
1023115819.83019, # 5: time of first sample
1023115819.86576, # 6: time of last sample
]
After the first sample, later samples always update elements 0, 1, and 6, and
may update 3 or 4 depending on the duration of the sampled call.
=back
=head1 ENABLING A PROFILE
Profiling is enabled for a handle by assigning to the Profile
attribute. For example:
$h->{Profile} = DBI::Profile->new();
The Profile attribute holds a blessed reference to a hash object
that contains the profile data and attributes relating to it.
The class the Profile object is blessed into is expected to
provide at least a DESTROY method which will dump the profile data
to the DBI trace file handle (STDERR by default).
All these examples have the same effect as each other:
$h->{Profile} = 0;
$h->{Profile} = "/DBI::Profile";
$h->{Profile} = DBI::Profile->new();
$h->{Profile} = {};
$h->{Profile} = { Path => [] };
Similarly, these examples have the same effect as each other:
$h->{Profile} = 6;
$h->{Profile} = "6/DBI::Profile";
$h->{Profile} = "!Statement:!MethodName/DBI::Profile";
$h->{Profile} = { Path => [ '!Statement', '!MethodName' ] };
If a non-blessed hash reference is given then the DBI::Profile
module is automatically C<require>'d and the reference is blessed
into that class.
If a string is given then it is processed like this:
($path, $module, $args) = split /\//, $string, 3
@path = split /:/, $path
@args = split /:/, $args
eval "require $module" if $module
$module ||= "DBI::Profile"
$module->new( Path => \@Path, @args )
So the first value is used to select the Path to be used (see below).
The second value, if present, is used as the name of a module which
will be loaded and it's C<new> method called. If not present it
defaults to DBI::Profile. Any other values are passed as arguments
to the C<new> method. For example: "C<2/DBIx::OtherProfile/Foo:42>".
Numbers can be used as a shorthand way to enable common Path values.
The simplest way to explain how the values are interpreted is to show the code:
push @Path, "DBI" if $path_elem & 0x01;
push @Path, "!Statement" if $path_elem & 0x02;
push @Path, "!MethodName" if $path_elem & 0x04;
push @Path, "!MethodClass" if $path_elem & 0x08;
push @Path, "!Caller2" if $path_elem & 0x10;
So "2" is the same as "!Statement" and "6" (2+4) is the same as
"!Statement:!Method". Those are the two most commonly used values. Using a
negative number will reverse the path. Thus "-6" will group by method name then
statement.
The splitting and parsing of string values assigned to the Profile
attribute may seem a little odd, but there's a good reason for it.
Remember that attributes can be embedded in the Data Source Name
string which can be passed in to a script as a parameter. For
example:
dbi:DriverName(Profile=>2):dbname
dbi:DriverName(Profile=>{Username}:!Statement/MyProfiler/Foo:42):dbname
And also, if the C<DBI_PROFILE> environment variable is set then
The DBI arranges for every driver handle to share the same profile
object. When perl exits a single profile summary will be generated
that reflects (as nearly as practical) the total use of the DBI by
the application.
=head1 THE PROFILE OBJECT
The DBI core expects the Profile attribute value to be a hash
reference and if the following values don't exist it will create
them as needed:
=head2 Data
A reference to a hash containing the collected profile data.
=head2 Path
The Path value is a reference to an array. Each element controls the
value to use at the corresponding level of the profile Data tree.
If the value of Path is anything other than an array reference,
it is treated as if it was:
[ '!Statement' ]
The elements of Path array can be one of the following types:
=head3 Special Constant
B<!Statement>
Use the current Statement text. Typically that's the value of the Statement
attribute for the handle the method was called with. Some methods, like
commit() and rollback(), are unrelated to a particular statement. For those
methods !Statement records an empty string.
For statement handles this is always simply the string that was
given to prepare() when the handle was created. For database handles
this is the statement that was last prepared or executed on that
database handle. That can lead to a little 'fuzzyness' because, for
example, calls to the quote() method to build a new statement will
typically be associated with the previous statement. In practice
this isn't a significant issue and the dynamic Path mechanism can
be used to setup your own rules.
B<!MethodName>
Use the name of the DBI method that the profile sample relates to.
B<!MethodClass>
Use the fully qualified name of the DBI method, including
the package, that the profile sample relates to. This shows you
where the method was implemented. For example:
'DBD::_::db::selectrow_arrayref' =>
0.022902s
'DBD::mysql::db::selectrow_arrayref' =>
2.244521s / 99 = 0.022445s avg (first 0.022813s, min 0.022051s, max 0.028932s)
The "DBD::_::db::selectrow_arrayref" shows that the driver has
inherited the selectrow_arrayref method provided by the DBI.
But you'll note that there is only one call to
DBD::_::db::selectrow_arrayref but another 99 to
DBD::mysql::db::selectrow_arrayref. Currently the first
call doesn't record the true location. That may change.
B<!Caller>
Use a string showing the filename and line number of the code calling the method.
B<!Caller2>
Use a string showing the filename and line number of the code calling the
method, as for !Caller, but also include filename and line number of the code
that called that. Calls from DBI:: and DBD:: packages are skipped.
B<!File>
Same as !Caller above except that only the filename is included, not the line number.
B<!File2>
Same as !Caller2 above except that only the filenames are included, not the line number.
B<!Time>
Use the current value of time(). Rarely used. See the more useful C<!Time~N> below.
B<!Time~N>
Where C<N> is an integer. Use the current value of time() but with reduced precision.
The value used is determined in this way:
int( time() / N ) * N
This is a useful way to segregate a profile into time slots. For example:
[ '!Time~60', '!Statement' ]
=head3 Code Reference
The subroutine is passed the handle it was called on and the DBI method name.
The current Statement is in $_. The statement string should not be modified,
so most subs start with C<local $_ = $_;>.
The list of values it returns is used at that point in the Profile Path.
Any undefined values are treated as the string "C<undef>".
The sub can 'veto' (reject) a profile sample by including a reference to undef
(C<\undef>) in the returned list. That can be useful when you want to only profile
statements that match a certain pattern, or only profile certain methods.
=head3 Subroutine Specifier
A Path element that begins with 'C<&>' is treated as the name of a subroutine
in the DBI::ProfileSubs namespace and replaced with the corresponding code reference.
Currently this only works when the Path is specified by the C<DBI_PROFILE>
environment variable.
Also, currently, the only subroutine in the DBI::ProfileSubs namespace is
C<'&norm_std_n3'>. That's a very handy subroutine when profiling code that
doesn't use placeholders. See L<DBI::ProfileSubs> for more information.
=head3 Attribute Specifier
A string enclosed in braces, such as 'C<{Username}>', specifies that the current
value of the corresponding database handle attribute should be used at that
point in the Path.
=head3 Reference to a Scalar
Specifies that the current value of the referenced scalar be used at that point
in the Path. This provides an efficient way to get 'contextual' values into
your profile.
=head3 Other Values
Any other values are stringified and used literally.
(References, and values that begin with punctuation characters are reserved.)
=head1 REPORTING
=head2 Report Format
The current accumulated profile data can be formatted and output using
print $h->{Profile}->format;
To discard the profile data and start collecting fresh data
you can do:
$h->{Profile}->{Data} = undef;
The default results format looks like this:
DBI::Profile: 0.001015s 42.7% (5 calls) programname @ YYYY-MM-DD HH:MM:SS
'' =>
0.000024s / 2 = 0.000012s avg (first 0.000015s, min 0.000009s, max 0.000015s)
'SELECT mode,size,name FROM table' =>
0.000991s / 3 = 0.000330s avg (first 0.000678s, min 0.000009s, max 0.000678s)
Which shows the total time spent inside the DBI, with a count of
the total number of method calls and the name of the script being
run, then a formatted version of the profile data tree.
If the results are being formatted when the perl process is exiting
(which is usually the case when the DBI_PROFILE environment variable
is used) then the percentage of time the process spent inside the
DBI is also shown. If the process is not exiting then the percentage is
calculated using the time between the first and last call to the DBI.
In the example above the paths in the tree are only one level deep and
use the Statement text as the value (that's the default behaviour).
The merged profile data at the 'leaves' of the tree are presented
as total time spent, count, average time spent (which is simply total
time divided by the count), then the time spent on the first call,
the time spent on the fastest call, and finally the time spent on
the slowest call.
The 'avg', 'first', 'min' and 'max' times are not particularly
useful when the profile data path only contains the statement text.
Here's an extract of a more detailed example using both statement
text and method name in the path:
'SELECT mode,size,name FROM table' =>
'FETCH' =>
0.000076s
'fetchrow_hashref' =>
0.036203s / 108 = 0.000335s avg (first 0.000490s, min 0.000152s, max 0.002786s)
Here you can see the 'avg', 'first', 'min' and 'max' for the
108 calls to fetchrow_hashref() become rather more interesting.
Also the data for FETCH just shows a time value because it was only
called once.
Currently the profile data is output sorted by branch names. That
may change in a later version so the leaf nodes are sorted by total
time per leaf node.
=head2 Report Destination
The default method of reporting is for the DESTROY method of the
Profile object to format the results and write them using:
DBI->trace_msg($results, 0); # see $ON_DESTROY_DUMP below
to write them to the DBI trace() filehandle (which defaults to
STDERR). To direct the DBI trace filehandle to write to a file
without enabling tracing the trace() method can be called with a
trace level of 0. For example:
DBI->trace(0, $filename);
The same effect can be achieved without changing the code by
setting the C<DBI_TRACE> environment variable to C<0=filename>.
The $DBI::Profile::ON_DESTROY_DUMP variable holds a code ref
that's called to perform the output of the formatted results.
The default value is:
$ON_DESTROY_DUMP = sub { DBI->trace_msg($results, 0) };
Apart from making it easy to send the dump elsewhere, it can also
be useful as a simple way to disable dumping results.
=head1 CHILD HANDLES
Child handles inherit a reference to the Profile attribute value
of their parent. So if profiling is enabled for a database handle
then by default the statement handles created from it all contribute
to the same merged profile data tree.
=head1 PROFILE OBJECT METHODS
=head2 format
See L</REPORTING>.
=head2 as_node_path_list
@ary = $dbh->{Profile}->as_node_path_list();
@ary = $dbh->{Profile}->as_node_path_list($node, $path);
Returns the collected data ($dbh->{Profile}{Data}) restructured into a list of
array refs, one for each leaf node in the Data tree. This 'flat' structure is
often much simpler for applications to work with.
The first element of each array ref is a reference to the leaf node.
The remaining elements are the 'path' through the data tree to that node.
For example, given a data tree like this:
{key1a}{key2a}[node1]
{key1a}{key2b}[node2]
{key1b}{key2a}{key3a}[node3]
The as_node_path_list() method will return this list:
[ [node1], 'key1a', 'key2a' ]
[ [node2], 'key1a', 'key2b' ]
[ [node3], 'key1b', 'key2a', 'key3a' ]
The nodes are ordered by key, depth-first.
The $node argument can be used to focus on a sub-tree.
If not specified it defaults to $dbh->{Profile}{Data}.
The $path argument can be used to specify a list of path elements that will be
added to each element of the returned list. If not specified it defaults to a
ref to an empty array.
=head2 as_text
@txt = $dbh->{Profile}->as_text();
$txt = $dbh->{Profile}->as_text({
node => undef,
path => [],
separator => " > ",
format => '%1$s: %11$fs / %10$d = %2$fs avg (first %12$fs, min %13$fs, max %14$fs)'."\n";
sortsub => sub { ... },
);
Returns the collected data ($dbh->{Profile}{Data}) reformatted into a list of formatted strings.
In scalar context the list is returned as a single concatenated string.
A hashref can be used to pass in arguments, the default values are shown in the example above.
The C<node> and <path> arguments are passed to as_node_path_list().
The C<separator> argument is used to join the elements of the path for each leaf node.
The C<sortsub> argument is used to pass in a ref to a sub that will order the list.
The subroutine will be passed a reference to the array returned by
as_node_path_list() and should sort the contents of the array in place.
The return value from the sub is ignored. For example, to sort the nodes by the
second level key you could use:
sortsub => sub { my $ary=shift; @$ary = sort { $a->[2] cmp $b->[2] } @$ary }
The C<format> argument is a C<sprintf> format string that specifies the format
to use for each leaf node. It uses the explicit format parameter index
mechanism to specify which of the arguments should appear where in the string.
The arguments to sprintf are:
1: path to node, joined with the separator
2: average duration (total duration/count)
(3 thru 9 are currently unused)
10: count
11: total duration
12: first duration
13: smallest duration
14: largest duration
15: time of first call
16: time of first call
=head1 CUSTOM DATA MANIPULATION
Recall that C<< $h->{Profile}->{Data} >> is a reference to the collected data.
Either to a 'leaf' array (when the Path is empty, i.e., DBI_PROFILE env var is 1),
or a reference to hash containing values that are either further hash
references or leaf array references.
Sometimes it's useful to be able to summarise some or all of the collected data.
The dbi_profile_merge_nodes() function can be used to merge leaf node values.
=head2 dbi_profile_merge_nodes
use DBI qw(dbi_profile_merge_nodes);
$time_in_dbi = dbi_profile_merge_nodes(my $totals=[], @$leaves);
Merges profile data node. Given a reference to a destination array, and zero or
more references to profile data, merges the profile data into the destination array.
For example:
$time_in_dbi = dbi_profile_merge_nodes(
my $totals=[],
[ 10, 0.51, 0.11, 0.01, 0.22, 1023110000, 1023110010 ],
[ 15, 0.42, 0.12, 0.02, 0.23, 1023110005, 1023110009 ],
);
$totals will then contain
[ 25, 0.93, 0.11, 0.01, 0.23, 1023110000, 1023110010 ]
and $time_in_dbi will be 0.93;
The second argument need not be just leaf nodes. If given a reference to a hash
then the hash is recursively searched for leaf nodes and all those found
are merged.
For example, to get the time spent 'inside' the DBI during an http request,
your logging code run at the end of the request (i.e. mod_perl LogHandler)
could use:
my $time_in_dbi = 0;
if (my $Profile = $dbh->{Profile}) { # if DBI profiling is enabled
$time_in_dbi = dbi_profile_merge_nodes(my $total=[], $Profile->{Data});
$Profile->{Data} = {}; # reset the profile data
}
If profiling has been enabled then $time_in_dbi will hold the time spent inside
the DBI for that handle (and any other handles that share the same profile data)
since the last request.
Prior to DBI 1.56 the dbi_profile_merge_nodes() function was called dbi_profile_merge().
That name still exists as an alias.
=head1 CUSTOM DATA COLLECTION
=head2 Using The Path Attribute
XXX example to be added later using a selectall_arrayref call
XXX nested inside a fetch loop where the first column of the
XXX outer loop is bound to the profile Path using
XXX bind_column(1, \${ $dbh->{Profile}->{Path}->[0] })
XXX so you end up with separate profiles for each loop
XXX (patches welcome to add this to the docs :)
=head2 Adding Your Own Samples
The dbi_profile() function can be used to add extra sample data
into the profile data tree. For example:
use DBI;
use DBI::Profile (dbi_profile dbi_time);
my $t1 = dbi_time(); # floating point high-resolution time
... execute code you want to profile here ...
my $t2 = dbi_time();
dbi_profile($h, $statement, $method, $t1, $t2);
The $h parameter is the handle the extra profile sample should be
associated with. The $statement parameter is the string to use where
the Path specifies !Statement. If $statement is undef
then $h->{Statement} will be used. Similarly $method is the string
to use if the Path specifies !MethodName. There is no
default value for $method.
The $h->{Profile}{Path} attribute is processed by dbi_profile() in
the usual way.
The $h parameter is usually a DBI handle but it can also be a reference to a
hash, in which case the dbi_profile() acts on each defined value in the hash.
This is an efficient way to update multiple profiles with a single sample,
and is used by the L<DashProfiler> module.
=head1 SUBCLASSING
Alternate profile modules must subclass DBI::Profile to help ensure
they work with future versions of the DBI.
=head1 CAVEATS
Applications which generate many different statement strings
(typically because they don't use placeholders) and profile with
!Statement in the Path (the default) will consume memory
in the Profile Data structure for each statement. Use a code ref
in the Path to return an edited (simplified) form of the statement.
If a method throws an exception itself (not via RaiseError) then
it won't be counted in the profile.
If a HandleError subroutine throws an exception (rather than returning
0 and letting RaiseError do it) then the method call won't be counted
in the profile.
Time spent in DESTROY is added to the profile of the parent handle.
Time spent in DBI->*() methods is not counted. The time spent in
the driver connect method, $drh->connect(), when it's called by
DBI->connect is counted if the DBI_PROFILE environment variable is set.
Time spent fetching tied variables, $DBI::errstr, is counted.
Time spent in FETCH for $h->{Profile} is not counted, so getting the profile
data doesn't alter it.
DBI::PurePerl does not support profiling (though it could in theory).
For asynchronous queries, time spent while the query is running on the
backend is not counted.
A few platforms don't support the gettimeofday() high resolution
time function used by the DBI (and available via the dbi_time() function).
In which case you'll get integer resolution time which is mostly useless.
On Windows platforms the dbi_time() function is limited to millisecond
resolution. Which isn't sufficiently fine for our needs, but still
much better than integer resolution. This limited resolution means
that fast method calls will often register as taking 0 time. And
timings in general will have much more 'jitter' depending on where
within the 'current millisecond' the start and end timing was taken.
This documentation could be more clear. Probably needs to be reordered
to start with several examples and build from there. Trying to
explain the concepts first seems painful and to lead to just as
many forward references. (Patches welcome!)
=cut
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $VERSION);
use Exporter ();
use UNIVERSAL ();
use Carp;
use DBI qw(dbi_time dbi_profile dbi_profile_merge_nodes dbi_profile_merge);
$VERSION = "2.015065";
@ISA = qw(Exporter);
@EXPORT = qw(
DBIprofile_Statement
DBIprofile_MethodName
DBIprofile_MethodClass
dbi_profile
dbi_profile_merge_nodes
dbi_profile_merge
dbi_time
);
@EXPORT_OK = qw(
format_profile_thingy
);
use constant DBIprofile_Statement => '!Statement';
use constant DBIprofile_MethodName => '!MethodName';
use constant DBIprofile_MethodClass => '!MethodClass';
our $ON_DESTROY_DUMP = sub { DBI->trace_msg(shift, 0) };
our $ON_FLUSH_DUMP = sub { DBI->trace_msg(shift, 0) };
sub new {
my $class = shift;
my $profile = { @_ };
return bless $profile => $class;
}
sub _auto_new {
my $class = shift;
my ($arg) = @_;
# This sub is called by DBI internals when a non-hash-ref is
# assigned to the Profile attribute. For example
# dbi:mysql(RaiseError=>1,Profile=>!Statement:!MethodName/DBIx::MyProfile/arg1:arg2):dbname
# This sub works out what to do and returns a suitable hash ref.
$arg =~ s/^DBI::/2\/DBI::/
and carp "Automatically changed old-style DBI::Profile specification to $arg";
# it's a path/module/k1:v1:k2:v2:... list
my ($path, $package, $args) = split /\//, $arg, 3;
my @args = (defined $args) ? split(/:/, $args, -1) : ();
my @Path;
for my $element (split /:/, $path) {
if (DBI::looks_like_number($element)) {
my $reverse = ($element < 0) ? ($element=-$element, 1) : 0;
my @p;
# a single "DBI" is special-cased in format()
push @p, "DBI" if $element & 0x01;
push @p, DBIprofile_Statement if $element & 0x02;
push @p, DBIprofile_MethodName if $element & 0x04;
push @p, DBIprofile_MethodClass if $element & 0x08;
push @p, '!Caller2' if $element & 0x10;
push @Path, ($reverse ? reverse @p : @p);
}
elsif ($element =~ m/^&(\w.*)/) {
my $name = "DBI::ProfileSubs::$1"; # capture $1 early
require DBI::ProfileSubs;
my $code = do { no strict; *{$name}{CODE} };
if (defined $code) {
push @Path, $code;
}
else {
warn "$name: subroutine not found\n";
push @Path, $element;
}
}
else {
push @Path, $element;
}
}
eval "require $package" if $package; # silently ignores errors
$package ||= $class;
return $package->new(Path => \@Path, @args);
}
sub empty { # empty out profile data
my $self = shift;
DBI->trace_msg("profile data discarded\n",0) if $self->{Trace};
$self->{Data} = undef;
}
sub filename { # baseclass method, see DBI::ProfileDumper
return undef;
}
sub flush_to_disk { # baseclass method, see DBI::ProfileDumper & DashProfiler::Core
my $self = shift;
return unless $ON_FLUSH_DUMP;
return unless $self->{Data};
my $detail = $self->format();
$ON_FLUSH_DUMP->($detail) if $detail;
}
sub as_node_path_list {
my ($self, $node, $path) = @_;
# convert the tree into an array of arrays
# from
# {key1a}{key2a}[node1]
# {key1a}{key2b}[node2]
# {key1b}{key2a}{key3a}[node3]
# to
# [ [node1], 'key1a', 'key2a' ]
# [ [node2], 'key1a', 'key2b' ]
# [ [node3], 'key1b', 'key2a', 'key3a' ]
$node ||= $self->{Data} or return;
$path ||= [];
if (ref $node eq 'HASH') { # recurse
$path = [ @$path, undef ];
return map {
$path->[-1] = $_;
($node->{$_}) ? $self->as_node_path_list($node->{$_}, $path) : ()
} sort keys %$node;
}
return [ $node, @$path ];
}
sub as_text {
my ($self, $args_ref) = @_;
my $separator = $args_ref->{separator} || " > ";
my $format_path_element = $args_ref->{format_path_element}
|| "%s"; # or e.g., " key%2$d='%s'"
my $format = $args_ref->{format}
|| '%1$s: %11$fs / %10$d = %2$fs avg (first %12$fs, min %13$fs, max %14$fs)'."\n";
my @node_path_list = $self->as_node_path_list(undef, $args_ref->{path});
$args_ref->{sortsub}->(\@node_path_list) if $args_ref->{sortsub};
my $eval = "qr/".quotemeta($separator)."/";
my $separator_re = eval($eval) || quotemeta($separator);
#warn "[$eval] = [$separator_re]";
my @text;
my @spare_slots = (undef) x 7;
for my $node_path (@node_path_list) {
my ($node, @path) = @$node_path;
my $idx = 0;
for (@path) {
s/[\r\n]+/ /g;
s/$separator_re/ /g;
++$idx;
if ($format_path_element eq "%s") {
$_ = sprintf $format_path_element, $_;
} else {
$_ = sprintf $format_path_element, $_, $idx;
}
}
push @text, sprintf $format,
join($separator, @path), # 1=path
($node->[0] ? $node->[1]/$node->[0] : 0), # 2=avg
@spare_slots,
@$node; # 10=count, 11=dur, 12=first_dur, 13=min, 14=max, 15=first_called, 16=last_called
}
return @text if wantarray;
return join "", @text;
}
sub format {
my $self = shift;
my $class = ref($self) || $self;
my $prologue = "$class: ";
my $detail = $self->format_profile_thingy(
$self->{Data}, 0, " ",
my $path = [],
my $leaves = [],
)."\n";
if (@$leaves) {
dbi_profile_merge_nodes(my $totals=[], @$leaves);
my ($count, $time_in_dbi, undef, undef, undef, $t1, $t2) = @$totals;
(my $progname = $0) =~ s:.*/::;
if ($count) {
$prologue .= sprintf "%fs ", $time_in_dbi;
my $perl_time = ($DBI::PERL_ENDING) ? time() - $^T : $t2-$t1;
$prologue .= sprintf "%.2f%% ", $time_in_dbi/$perl_time*100 if $perl_time;
my @lt = localtime(time);
my $ts = sprintf "%d-%02d-%02d %02d:%02d:%02d",
1900+$lt[5], $lt[4]+1, @lt[3,2,1,0];
$prologue .= sprintf "(%d calls) $progname \@ $ts\n", $count;
}
if (@$leaves == 1 && ref($self->{Data}) eq 'HASH' && $self->{Data}->{DBI}) {
$detail = ""; # hide the "DBI" from DBI_PROFILE=1
}
}
return ($prologue, $detail) if wantarray;
return $prologue.$detail;
}
sub format_profile_leaf {
my ($self, $thingy, $depth, $pad, $path, $leaves) = @_;
croak "format_profile_leaf called on non-leaf ($thingy)"
unless UNIVERSAL::isa($thingy,'ARRAY');
push @$leaves, $thingy if $leaves;
my ($count, $total_time, $first_time, $min, $max, $first_called, $last_called) = @$thingy;
return sprintf "%s%fs\n", ($pad x $depth), $total_time
if $count <= 1;
return sprintf "%s%fs / %d = %fs avg (first %fs, min %fs, max %fs)\n",
($pad x $depth), $total_time, $count, $count ? $total_time/$count : 0,
$first_time, $min, $max;
}
sub format_profile_branch {
my ($self, $thingy, $depth, $pad, $path, $leaves) = @_;
croak "format_profile_branch called on non-branch ($thingy)"
unless UNIVERSAL::isa($thingy,'HASH');
my @chunk;
my @keys = sort keys %$thingy;
while ( @keys ) {
my $k = shift @keys;
my $v = $thingy->{$k};
push @$path, $k;
push @chunk, sprintf "%s'%s' =>\n%s",
($pad x $depth), $k,
$self->format_profile_thingy($v, $depth+1, $pad, $path, $leaves);
pop @$path;
}
return join "", @chunk;
}
sub format_profile_thingy {
my ($self, $thingy, $depth, $pad, $path, $leaves) = @_;
return "undef" if not defined $thingy;
return $self->format_profile_leaf( $thingy, $depth, $pad, $path, $leaves)
if UNIVERSAL::isa($thingy,'ARRAY');
return $self->format_profile_branch($thingy, $depth, $pad, $path, $leaves)
if UNIVERSAL::isa($thingy,'HASH');
return "$thingy\n";
}
sub on_destroy {
my $self = shift;
return unless $ON_DESTROY_DUMP;
return unless $self->{Data};
my $detail = $self->format();
$ON_DESTROY_DUMP->($detail) if $detail;
$self->{Data} = undef;
}
sub DESTROY {
my $self = shift;
local $@;
DBI->trace_msg("profile data DESTROY\n",0)
if (($self->{Trace}||0) >= 2);
eval { $self->on_destroy };
if ($@) {
chomp $@;
my $class = ref($self) || $self;
DBI->trace_msg("$class on_destroy failed: $@", 0);
}
}
1;
PK V`[h\:5�( �( ProfileDumper.pmnu �[��� package DBI::ProfileDumper;
use strict;
=head1 NAME
DBI::ProfileDumper - profile DBI usage and output data to a file
=head1 SYNOPSIS
To profile an existing program using DBI::ProfileDumper, set the
DBI_PROFILE environment variable and run your program as usual. For
example, using bash:
DBI_PROFILE=2/DBI::ProfileDumper program.pl
Then analyze the generated file (F<dbi.prof>) with L<dbiprof|dbiprof>:
dbiprof
You can also activate DBI::ProfileDumper from within your code:
use DBI;
# profile with default path (2) and output file (dbi.prof)
$dbh->{Profile} = "!Statement/DBI::ProfileDumper";
# same thing, spelled out
$dbh->{Profile} = "!Statement/DBI::ProfileDumper/File:dbi.prof";
# another way to say it
use DBI::ProfileDumper;
$dbh->{Profile} = DBI::ProfileDumper->new(
Path => [ '!Statement' ],
File => 'dbi.prof' );
# using a custom path
$dbh->{Profile} = DBI::ProfileDumper->new(
Path => [ "foo", "bar" ],
File => 'dbi.prof',
);
=head1 DESCRIPTION
DBI::ProfileDumper is a subclass of L<DBI::Profile|DBI::Profile> which
dumps profile data to disk instead of printing a summary to your
screen. You can then use L<dbiprof|dbiprof> to analyze the data in
a number of interesting ways, or you can roll your own analysis using
L<DBI::ProfileData|DBI::ProfileData>.
B<NOTE:> For Apache/mod_perl applications, use
L<DBI::ProfileDumper::Apache|DBI::ProfileDumper::Apache>.
=head1 USAGE
One way to use this module is just to enable it in your C<$dbh>:
$dbh->{Profile} = "1/DBI::ProfileDumper";
This will write out profile data by statement into a file called
F<dbi.prof>. If you want to modify either of these properties, you
can construct the DBI::ProfileDumper object yourself:
use DBI::ProfileDumper;
$dbh->{Profile} = DBI::ProfileDumper->new(
Path => [ '!Statement' ],
File => 'dbi.prof'
);
The C<Path> option takes the same values as in
L<DBI::Profile>. The C<File> option gives the name of the
file where results will be collected. If it already exists it will be
overwritten.
You can also activate this module by setting the DBI_PROFILE
environment variable:
$ENV{DBI_PROFILE} = "!Statement/DBI::ProfileDumper";
This will cause all DBI handles to share the same profiling object.
=head1 METHODS
The following methods are available to be called using the profile
object. You can get access to the profile object from the Profile key
in any DBI handle:
my $profile = $dbh->{Profile};
=head2 flush_to_disk
$profile->flush_to_disk()
Flushes all collected profile data to disk and empties the Data hash. Returns
the filename written to. If no profile data has been collected then the file is
not written and flush_to_disk() returns undef.
The file is locked while it's being written. A process 'consuming' the files
while they're being written to, should rename the file first, then lock it,
then read it, then close and delete it. The C<DeleteFiles> option to
L<DBI::ProfileData> does the right thing.
This method may be called multiple times during a program run.
=head2 empty
$profile->empty()
Clears the Data hash without writing to disk.
=head2 filename
$filename = $profile->filename();
Get or set the filename.
The filename can be specified as a CODE reference, in which case the referenced
code should return the filename to be used. The code will be called with the
profile object as its first argument.
=head1 DATA FORMAT
The data format written by DBI::ProfileDumper starts with a header
containing the version number of the module used to generate it. Then
a block of variable declarations describes the profile. After two
newlines, the profile data forms the body of the file. For example:
DBI::ProfileDumper 2.003762
Path = [ '!Statement', '!MethodName' ]
Program = t/42profile_data.t
+ 1 SELECT name FROM users WHERE id = ?
+ 2 prepare
= 1 0.0312958955764771 0.000490069389343262 0.000176072120666504 0.00140702724456787 1023115819.83019 1023115819.86576
+ 2 execute
1 0.0312958955764771 0.000490069389343262 0.000176072120666504 0.00140702724456787 1023115819.83019 1023115819.86576
+ 2 fetchrow_hashref
= 1 0.0312958955764771 0.000490069389343262 0.000176072120666504 0.00140702724456787 1023115819.83019 1023115819.86576
+ 1 UPDATE users SET name = ? WHERE id = ?
+ 2 prepare
= 1 0.0312958955764771 0.000490069389343262 0.000176072120666504 0.00140702724456787 1023115819.83019 1023115819.86576
+ 2 execute
= 1 0.0312958955764771 0.000490069389343262 0.000176072120666504 0.00140702724456787 1023115819.83019 1023115819.86576
The lines beginning with C<+> signs signify keys. The number after
the C<+> sign shows the nesting level of the key. Lines beginning
with C<=> are the actual profile data, in the same order as
in DBI::Profile.
Note that the same path may be present multiple times in the data file
since C<format()> may be called more than once. When read by
DBI::ProfileData the data points will be merged to produce a single
data set for each distinct path.
The key strings are transformed in three ways. First, all backslashes
are doubled. Then all newlines and carriage-returns are transformed
into C<\n> and C<\r> respectively. Finally, any NULL bytes (C<\0>)
are entirely removed. When DBI::ProfileData reads the file the first
two transformations will be reversed, but NULL bytes will not be
restored.
=head1 AUTHOR
Sam Tregar <sam@tregar.com>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2002 Sam Tregar
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl 5 itself.
=cut
# inherit from DBI::Profile
use DBI::Profile;
our @ISA = ("DBI::Profile");
our $VERSION = "2.015325";
use Carp qw(croak);
use Fcntl qw(:flock);
use Symbol;
my $HAS_FLOCK = (defined $ENV{DBI_PROFILE_FLOCK})
? $ENV{DBI_PROFILE_FLOCK}
: do { local $@; eval { flock STDOUT, 0; 1 } };
my $program_header;
# validate params and setup default
sub new {
my $pkg = shift;
my $self = $pkg->SUPER::new(
LockFile => $HAS_FLOCK,
@_,
);
# provide a default filename
$self->filename("dbi.prof") unless $self->filename;
DBI->trace_msg("$self: @{[ %$self ]}\n",0)
if $self->{Trace} && $self->{Trace} >= 2;
return $self;
}
# get/set filename to use
sub filename {
my $self = shift;
$self->{File} = shift if @_;
my $filename = $self->{File};
$filename = $filename->($self) if ref($filename) eq 'CODE';
return $filename;
}
# flush available data to disk
sub flush_to_disk {
my $self = shift;
my $class = ref $self;
my $filename = $self->filename;
my $data = $self->{Data};
if (1) { # make an option
if (not $data or ref $data eq 'HASH' && !%$data) {
DBI->trace_msg("flush_to_disk skipped for empty profile\n",0) if $self->{Trace};
return undef;
}
}
my $fh = gensym;
if (($self->{_wrote_header}||'') eq $filename) {
# append more data to the file
# XXX assumes that Path hasn't changed
open($fh, ">>", $filename)
or croak("Unable to open '$filename' for $class output: $!");
} else {
# create new file (or overwrite existing)
if (-f $filename) {
my $bak = $filename.'.prev';
unlink($bak);
rename($filename, $bak)
or warn "Error renaming $filename to $bak: $!\n";
}
open($fh, ">", $filename)
or croak("Unable to open '$filename' for $class output: $!");
}
# lock the file (before checking size and writing the header)
flock($fh, LOCK_EX) if $self->{LockFile};
# write header if file is empty - typically because we just opened it
# in '>' mode, or perhaps we used '>>' but the file had been truncated externally.
if (-s $fh == 0) {
DBI->trace_msg("flush_to_disk wrote header to $filename\n",0) if $self->{Trace};
$self->write_header($fh);
$self->{_wrote_header} = $filename;
}
my $lines = $self->write_data($fh, $self->{Data}, 1);
DBI->trace_msg("flush_to_disk wrote $lines lines to $filename\n",0) if $self->{Trace};
close($fh) # unlocks the file
or croak("Error closing '$filename': $!");
$self->empty();
return $filename;
}
# write header to a filehandle
sub write_header {
my ($self, $fh) = @_;
# isolate us against globals which effect print
local($\, $,);
# $self->VERSION can return undef during global destruction
my $version = $self->VERSION || $VERSION;
# module name and version number
print $fh ref($self)." $version\n";
# print out Path (may contain CODE refs etc)
my @path_words = map { escape_key($_) } @{ $self->{Path} || [] };
print $fh "Path = [ ", join(', ', @path_words), " ]\n";
# print out $0 and @ARGV
if (!$program_header) {
# XXX should really quote as well as escape
$program_header = "Program = "
. join(" ", map { escape_key($_) } $0, @ARGV)
. "\n";
}
print $fh $program_header;
# all done
print $fh "\n";
}
# write data in the proscribed format
sub write_data {
my ($self, $fh, $data, $level) = @_;
# XXX it's valid for $data to be an ARRAY ref, i.e., Path is empty.
# produce an empty profile for invalid $data
return 0 unless $data and UNIVERSAL::isa($data,'HASH');
# isolate us against globals which affect print
local ($\, $,);
my $lines = 0;
while (my ($key, $value) = each(%$data)) {
# output a key
print $fh "+ $level ". escape_key($key). "\n";
if (UNIVERSAL::isa($value,'ARRAY')) {
# output a data set for a leaf node
print $fh "= ".join(' ', @$value)."\n";
$lines += 1;
} else {
# recurse through keys - this could be rewritten to use a
# stack for some small performance gain
$lines += $self->write_data($fh, $value, $level + 1);
}
}
return $lines;
}
# escape a key for output
sub escape_key {
my $key = shift;
$key =~ s!\\!\\\\!g;
$key =~ s!\n!\\n!g;
$key =~ s!\r!\\r!g;
$key =~ s!\0!!g;
return $key;
}
# flush data to disk when profile object goes out of scope
sub on_destroy {
shift->flush_to_disk();
}
1;
PK V`[��~� � Const/GetInfoType.pmnu �[��� # $Id: GetInfoType.pm 8696 2007-01-24 23:12:38Z Tim $
#
# Copyright (c) 2002 Tim Bunce Ireland
#
# Constant data describing info type codes for the DBI getinfo function.
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
package DBI::Const::GetInfoType;
use strict;
use Exporter ();
use vars qw(@ISA @EXPORT @EXPORT_OK %GetInfoType);
@ISA = qw(Exporter);
@EXPORT = qw(%GetInfoType);
my
$VERSION = "2.008697";
=head1 NAME
DBI::Const::GetInfoType - Data describing GetInfo type codes
=head1 SYNOPSIS
use DBI::Const::GetInfoType;
=head1 DESCRIPTION
Imports a %GetInfoType hash which maps names for GetInfo Type Codes
into their corresponding numeric values. For example:
$database_version = $dbh->get_info( $GetInfoType{SQL_DBMS_VER} );
The interface to this module is new and nothing beyond what is
written here is guaranteed.
=cut
use DBI::Const::GetInfo::ANSI (); # liable to change
use DBI::Const::GetInfo::ODBC (); # liable to change
%GetInfoType =
(
%DBI::Const::GetInfo::ANSI::InfoTypes # liable to change
, %DBI::Const::GetInfo::ODBC::InfoTypes # liable to change
);
1;
PK V`[�st�I I Const/GetInfo/ODBC.pmnu �[��� # $Id: ODBC.pm 11373 2008-06-02 19:01:33Z Tim $
#
# Copyright (c) 2002 Tim Bunce Ireland
#
# Constant data describing Microsoft ODBC info types and return values
# for the SQLGetInfo() method of ODBC.
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
package DBI::Const::GetInfo::ODBC;
our (%InfoTypes,%ReturnTypes,%ReturnValues,);
=head1 NAME
DBI::Const::GetInfo::ODBC - ODBC Constants for GetInfo
=head1 SYNOPSIS
The API for this module is private and subject to change.
=head1 DESCRIPTION
Information requested by GetInfo().
The API for this module is private and subject to change.
=head1 REFERENCES
MDAC SDK 2.6
ODBC version number (0x0351)
sql.h
sqlext.h
=cut
my
$VERSION = "2.011374";
%InfoTypes =
(
SQL_ACCESSIBLE_PROCEDURES => 20
, SQL_ACCESSIBLE_TABLES => 19
, SQL_ACTIVE_CONNECTIONS => 0
, SQL_ACTIVE_ENVIRONMENTS => 116
, SQL_ACTIVE_STATEMENTS => 1
, SQL_AGGREGATE_FUNCTIONS => 169
, SQL_ALTER_DOMAIN => 117
, SQL_ALTER_TABLE => 86
, SQL_ASYNC_MODE => 10021
, SQL_BATCH_ROW_COUNT => 120
, SQL_BATCH_SUPPORT => 121
, SQL_BOOKMARK_PERSISTENCE => 82
, SQL_CATALOG_LOCATION => 114 # SQL_QUALIFIER_LOCATION
, SQL_CATALOG_NAME => 10003
, SQL_CATALOG_NAME_SEPARATOR => 41 # SQL_QUALIFIER_NAME_SEPARATOR
, SQL_CATALOG_TERM => 42 # SQL_QUALIFIER_TERM
, SQL_CATALOG_USAGE => 92 # SQL_QUALIFIER_USAGE
, SQL_COLLATION_SEQ => 10004
, SQL_COLUMN_ALIAS => 87
, SQL_CONCAT_NULL_BEHAVIOR => 22
, SQL_CONVERT_BIGINT => 53
, SQL_CONVERT_BINARY => 54
, SQL_CONVERT_BIT => 55
, SQL_CONVERT_CHAR => 56
, SQL_CONVERT_DATE => 57
, SQL_CONVERT_DECIMAL => 58
, SQL_CONVERT_DOUBLE => 59
, SQL_CONVERT_FLOAT => 60
, SQL_CONVERT_FUNCTIONS => 48
, SQL_CONVERT_GUID => 173
, SQL_CONVERT_INTEGER => 61
, SQL_CONVERT_INTERVAL_DAY_TIME => 123
, SQL_CONVERT_INTERVAL_YEAR_MONTH => 124
, SQL_CONVERT_LONGVARBINARY => 71
, SQL_CONVERT_LONGVARCHAR => 62
, SQL_CONVERT_NUMERIC => 63
, SQL_CONVERT_REAL => 64
, SQL_CONVERT_SMALLINT => 65
, SQL_CONVERT_TIME => 66
, SQL_CONVERT_TIMESTAMP => 67
, SQL_CONVERT_TINYINT => 68
, SQL_CONVERT_VARBINARY => 69
, SQL_CONVERT_VARCHAR => 70
, SQL_CONVERT_WCHAR => 122
, SQL_CONVERT_WLONGVARCHAR => 125
, SQL_CONVERT_WVARCHAR => 126
, SQL_CORRELATION_NAME => 74
, SQL_CREATE_ASSERTION => 127
, SQL_CREATE_CHARACTER_SET => 128
, SQL_CREATE_COLLATION => 129
, SQL_CREATE_DOMAIN => 130
, SQL_CREATE_SCHEMA => 131
, SQL_CREATE_TABLE => 132
, SQL_CREATE_TRANSLATION => 133
, SQL_CREATE_VIEW => 134
, SQL_CURSOR_COMMIT_BEHAVIOR => 23
, SQL_CURSOR_ROLLBACK_BEHAVIOR => 24
, SQL_CURSOR_SENSITIVITY => 10001
, SQL_DATA_SOURCE_NAME => 2
, SQL_DATA_SOURCE_READ_ONLY => 25
, SQL_DATABASE_NAME => 16
, SQL_DATETIME_LITERALS => 119
, SQL_DBMS_NAME => 17
, SQL_DBMS_VER => 18
, SQL_DDL_INDEX => 170
, SQL_DEFAULT_TXN_ISOLATION => 26
, SQL_DESCRIBE_PARAMETER => 10002
, SQL_DM_VER => 171
, SQL_DRIVER_HDBC => 3
, SQL_DRIVER_HDESC => 135
, SQL_DRIVER_HENV => 4
, SQL_DRIVER_HLIB => 76
, SQL_DRIVER_HSTMT => 5
, SQL_DRIVER_NAME => 6
, SQL_DRIVER_ODBC_VER => 77
, SQL_DRIVER_VER => 7
, SQL_DROP_ASSERTION => 136
, SQL_DROP_CHARACTER_SET => 137
, SQL_DROP_COLLATION => 138
, SQL_DROP_DOMAIN => 139
, SQL_DROP_SCHEMA => 140
, SQL_DROP_TABLE => 141
, SQL_DROP_TRANSLATION => 142
, SQL_DROP_VIEW => 143
, SQL_DYNAMIC_CURSOR_ATTRIBUTES1 => 144
, SQL_DYNAMIC_CURSOR_ATTRIBUTES2 => 145
, SQL_EXPRESSIONS_IN_ORDERBY => 27
, SQL_FETCH_DIRECTION => 8
, SQL_FILE_USAGE => 84
, SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES1 => 146
, SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES2 => 147
, SQL_GETDATA_EXTENSIONS => 81
, SQL_GROUP_BY => 88
, SQL_IDENTIFIER_CASE => 28
, SQL_IDENTIFIER_QUOTE_CHAR => 29
, SQL_INDEX_KEYWORDS => 148
# SQL_INFO_DRIVER_START => 1000
# SQL_INFO_FIRST => 0
# SQL_INFO_LAST => 114 # SQL_QUALIFIER_LOCATION
, SQL_INFO_SCHEMA_VIEWS => 149
, SQL_INSERT_STATEMENT => 172
, SQL_INTEGRITY => 73
, SQL_KEYSET_CURSOR_ATTRIBUTES1 => 150
, SQL_KEYSET_CURSOR_ATTRIBUTES2 => 151
, SQL_KEYWORDS => 89
, SQL_LIKE_ESCAPE_CLAUSE => 113
, SQL_LOCK_TYPES => 78
, SQL_MAXIMUM_CATALOG_NAME_LENGTH => 34 # SQL_MAX_CATALOG_NAME_LEN
, SQL_MAXIMUM_COLUMNS_IN_GROUP_BY => 97 # SQL_MAX_COLUMNS_IN_GROUP_BY
, SQL_MAXIMUM_COLUMNS_IN_INDEX => 98 # SQL_MAX_COLUMNS_IN_INDEX
, SQL_MAXIMUM_COLUMNS_IN_ORDER_BY => 99 # SQL_MAX_COLUMNS_IN_ORDER_BY
, SQL_MAXIMUM_COLUMNS_IN_SELECT => 100 # SQL_MAX_COLUMNS_IN_SELECT
, SQL_MAXIMUM_COLUMN_NAME_LENGTH => 30 # SQL_MAX_COLUMN_NAME_LEN
, SQL_MAXIMUM_CONCURRENT_ACTIVITIES => 1 # SQL_MAX_CONCURRENT_ACTIVITIES
, SQL_MAXIMUM_CURSOR_NAME_LENGTH => 31 # SQL_MAX_CURSOR_NAME_LEN
, SQL_MAXIMUM_DRIVER_CONNECTIONS => 0 # SQL_MAX_DRIVER_CONNECTIONS
, SQL_MAXIMUM_IDENTIFIER_LENGTH => 10005 # SQL_MAX_IDENTIFIER_LEN
, SQL_MAXIMUM_INDEX_SIZE => 102 # SQL_MAX_INDEX_SIZE
, SQL_MAXIMUM_ROW_SIZE => 104 # SQL_MAX_ROW_SIZE
, SQL_MAXIMUM_SCHEMA_NAME_LENGTH => 32 # SQL_MAX_SCHEMA_NAME_LEN
, SQL_MAXIMUM_STATEMENT_LENGTH => 105 # SQL_MAX_STATEMENT_LEN
, SQL_MAXIMUM_TABLES_IN_SELECT => 106 # SQL_MAX_TABLES_IN_SELECT
, SQL_MAXIMUM_USER_NAME_LENGTH => 107 # SQL_MAX_USER_NAME_LEN
, SQL_MAX_ASYNC_CONCURRENT_STATEMENTS => 10022
, SQL_MAX_BINARY_LITERAL_LEN => 112
, SQL_MAX_CATALOG_NAME_LEN => 34
, SQL_MAX_CHAR_LITERAL_LEN => 108
, SQL_MAX_COLUMNS_IN_GROUP_BY => 97
, SQL_MAX_COLUMNS_IN_INDEX => 98
, SQL_MAX_COLUMNS_IN_ORDER_BY => 99
, SQL_MAX_COLUMNS_IN_SELECT => 100
, SQL_MAX_COLUMNS_IN_TABLE => 101
, SQL_MAX_COLUMN_NAME_LEN => 30
, SQL_MAX_CONCURRENT_ACTIVITIES => 1
, SQL_MAX_CURSOR_NAME_LEN => 31
, SQL_MAX_DRIVER_CONNECTIONS => 0
, SQL_MAX_IDENTIFIER_LEN => 10005
, SQL_MAX_INDEX_SIZE => 102
, SQL_MAX_OWNER_NAME_LEN => 32
, SQL_MAX_PROCEDURE_NAME_LEN => 33
, SQL_MAX_QUALIFIER_NAME_LEN => 34
, SQL_MAX_ROW_SIZE => 104
, SQL_MAX_ROW_SIZE_INCLUDES_LONG => 103
, SQL_MAX_SCHEMA_NAME_LEN => 32
, SQL_MAX_STATEMENT_LEN => 105
, SQL_MAX_TABLES_IN_SELECT => 106
, SQL_MAX_TABLE_NAME_LEN => 35
, SQL_MAX_USER_NAME_LEN => 107
, SQL_MULTIPLE_ACTIVE_TXN => 37
, SQL_MULT_RESULT_SETS => 36
, SQL_NEED_LONG_DATA_LEN => 111
, SQL_NON_NULLABLE_COLUMNS => 75
, SQL_NULL_COLLATION => 85
, SQL_NUMERIC_FUNCTIONS => 49
, SQL_ODBC_API_CONFORMANCE => 9
, SQL_ODBC_INTERFACE_CONFORMANCE => 152
, SQL_ODBC_SAG_CLI_CONFORMANCE => 12
, SQL_ODBC_SQL_CONFORMANCE => 15
, SQL_ODBC_SQL_OPT_IEF => 73
, SQL_ODBC_VER => 10
, SQL_OJ_CAPABILITIES => 115
, SQL_ORDER_BY_COLUMNS_IN_SELECT => 90
, SQL_OUTER_JOINS => 38
, SQL_OUTER_JOIN_CAPABILITIES => 115 # SQL_OJ_CAPABILITIES
, SQL_OWNER_TERM => 39
, SQL_OWNER_USAGE => 91
, SQL_PARAM_ARRAY_ROW_COUNTS => 153
, SQL_PARAM_ARRAY_SELECTS => 154
, SQL_POSITIONED_STATEMENTS => 80
, SQL_POS_OPERATIONS => 79
, SQL_PROCEDURES => 21
, SQL_PROCEDURE_TERM => 40
, SQL_QUALIFIER_LOCATION => 114
, SQL_QUALIFIER_NAME_SEPARATOR => 41
, SQL_QUALIFIER_TERM => 42
, SQL_QUALIFIER_USAGE => 92
, SQL_QUOTED_IDENTIFIER_CASE => 93
, SQL_ROW_UPDATES => 11
, SQL_SCHEMA_TERM => 39 # SQL_OWNER_TERM
, SQL_SCHEMA_USAGE => 91 # SQL_OWNER_USAGE
, SQL_SCROLL_CONCURRENCY => 43
, SQL_SCROLL_OPTIONS => 44
, SQL_SEARCH_PATTERN_ESCAPE => 14
, SQL_SERVER_NAME => 13
, SQL_SPECIAL_CHARACTERS => 94
, SQL_SQL92_DATETIME_FUNCTIONS => 155
, SQL_SQL92_FOREIGN_KEY_DELETE_RULE => 156
, SQL_SQL92_FOREIGN_KEY_UPDATE_RULE => 157
, SQL_SQL92_GRANT => 158
, SQL_SQL92_NUMERIC_VALUE_FUNCTIONS => 159
, SQL_SQL92_PREDICATES => 160
, SQL_SQL92_RELATIONAL_JOIN_OPERATORS => 161
, SQL_SQL92_REVOKE => 162
, SQL_SQL92_ROW_VALUE_CONSTRUCTOR => 163
, SQL_SQL92_STRING_FUNCTIONS => 164
, SQL_SQL92_VALUE_EXPRESSIONS => 165
, SQL_SQL_CONFORMANCE => 118
, SQL_STANDARD_CLI_CONFORMANCE => 166
, SQL_STATIC_CURSOR_ATTRIBUTES1 => 167
, SQL_STATIC_CURSOR_ATTRIBUTES2 => 168
, SQL_STATIC_SENSITIVITY => 83
, SQL_STRING_FUNCTIONS => 50
, SQL_SUBQUERIES => 95
, SQL_SYSTEM_FUNCTIONS => 51
, SQL_TABLE_TERM => 45
, SQL_TIMEDATE_ADD_INTERVALS => 109
, SQL_TIMEDATE_DIFF_INTERVALS => 110
, SQL_TIMEDATE_FUNCTIONS => 52
, SQL_TRANSACTION_CAPABLE => 46 # SQL_TXN_CAPABLE
, SQL_TRANSACTION_ISOLATION_OPTION => 72 # SQL_TXN_ISOLATION_OPTION
, SQL_TXN_CAPABLE => 46
, SQL_TXN_ISOLATION_OPTION => 72
, SQL_UNION => 96
, SQL_UNION_STATEMENT => 96 # SQL_UNION
, SQL_USER_NAME => 47
, SQL_XOPEN_CLI_YEAR => 10000
);
=head2 %ReturnTypes
See: mk:@MSITStore:X:\dm\cli\mdac\sdk26\Docs\odbc.chm::/htm/odbcsqlgetinfo.htm
=> : alias
=> !!! : edited
=cut
%ReturnTypes =
(
SQL_ACCESSIBLE_PROCEDURES => 'SQLCHAR' # 20
, SQL_ACCESSIBLE_TABLES => 'SQLCHAR' # 19
, SQL_ACTIVE_CONNECTIONS => 'SQLUSMALLINT' # 0 =>
, SQL_ACTIVE_ENVIRONMENTS => 'SQLUSMALLINT' # 116
, SQL_ACTIVE_STATEMENTS => 'SQLUSMALLINT' # 1 =>
, SQL_AGGREGATE_FUNCTIONS => 'SQLUINTEGER bitmask' # 169
, SQL_ALTER_DOMAIN => 'SQLUINTEGER bitmask' # 117
, SQL_ALTER_TABLE => 'SQLUINTEGER bitmask' # 86
, SQL_ASYNC_MODE => 'SQLUINTEGER' # 10021
, SQL_BATCH_ROW_COUNT => 'SQLUINTEGER bitmask' # 120
, SQL_BATCH_SUPPORT => 'SQLUINTEGER bitmask' # 121
, SQL_BOOKMARK_PERSISTENCE => 'SQLUINTEGER bitmask' # 82
, SQL_CATALOG_LOCATION => 'SQLUSMALLINT' # 114
, SQL_CATALOG_NAME => 'SQLCHAR' # 10003
, SQL_CATALOG_NAME_SEPARATOR => 'SQLCHAR' # 41
, SQL_CATALOG_TERM => 'SQLCHAR' # 42
, SQL_CATALOG_USAGE => 'SQLUINTEGER bitmask' # 92
, SQL_COLLATION_SEQ => 'SQLCHAR' # 10004
, SQL_COLUMN_ALIAS => 'SQLCHAR' # 87
, SQL_CONCAT_NULL_BEHAVIOR => 'SQLUSMALLINT' # 22
, SQL_CONVERT_BIGINT => 'SQLUINTEGER bitmask' # 53
, SQL_CONVERT_BINARY => 'SQLUINTEGER bitmask' # 54
, SQL_CONVERT_BIT => 'SQLUINTEGER bitmask' # 55
, SQL_CONVERT_CHAR => 'SQLUINTEGER bitmask' # 56
, SQL_CONVERT_DATE => 'SQLUINTEGER bitmask' # 57
, SQL_CONVERT_DECIMAL => 'SQLUINTEGER bitmask' # 58
, SQL_CONVERT_DOUBLE => 'SQLUINTEGER bitmask' # 59
, SQL_CONVERT_FLOAT => 'SQLUINTEGER bitmask' # 60
, SQL_CONVERT_FUNCTIONS => 'SQLUINTEGER bitmask' # 48
, SQL_CONVERT_GUID => 'SQLUINTEGER bitmask' # 173
, SQL_CONVERT_INTEGER => 'SQLUINTEGER bitmask' # 61
, SQL_CONVERT_INTERVAL_DAY_TIME => 'SQLUINTEGER bitmask' # 123
, SQL_CONVERT_INTERVAL_YEAR_MONTH => 'SQLUINTEGER bitmask' # 124
, SQL_CONVERT_LONGVARBINARY => 'SQLUINTEGER bitmask' # 71
, SQL_CONVERT_LONGVARCHAR => 'SQLUINTEGER bitmask' # 62
, SQL_CONVERT_NUMERIC => 'SQLUINTEGER bitmask' # 63
, SQL_CONVERT_REAL => 'SQLUINTEGER bitmask' # 64
, SQL_CONVERT_SMALLINT => 'SQLUINTEGER bitmask' # 65
, SQL_CONVERT_TIME => 'SQLUINTEGER bitmask' # 66
, SQL_CONVERT_TIMESTAMP => 'SQLUINTEGER bitmask' # 67
, SQL_CONVERT_TINYINT => 'SQLUINTEGER bitmask' # 68
, SQL_CONVERT_VARBINARY => 'SQLUINTEGER bitmask' # 69
, SQL_CONVERT_VARCHAR => 'SQLUINTEGER bitmask' # 70
, SQL_CONVERT_WCHAR => 'SQLUINTEGER bitmask' # 122 => !!!
, SQL_CONVERT_WLONGVARCHAR => 'SQLUINTEGER bitmask' # 125 => !!!
, SQL_CONVERT_WVARCHAR => 'SQLUINTEGER bitmask' # 126 => !!!
, SQL_CORRELATION_NAME => 'SQLUSMALLINT' # 74
, SQL_CREATE_ASSERTION => 'SQLUINTEGER bitmask' # 127
, SQL_CREATE_CHARACTER_SET => 'SQLUINTEGER bitmask' # 128
, SQL_CREATE_COLLATION => 'SQLUINTEGER bitmask' # 129
, SQL_CREATE_DOMAIN => 'SQLUINTEGER bitmask' # 130
, SQL_CREATE_SCHEMA => 'SQLUINTEGER bitmask' # 131
, SQL_CREATE_TABLE => 'SQLUINTEGER bitmask' # 132
, SQL_CREATE_TRANSLATION => 'SQLUINTEGER bitmask' # 133
, SQL_CREATE_VIEW => 'SQLUINTEGER bitmask' # 134
, SQL_CURSOR_COMMIT_BEHAVIOR => 'SQLUSMALLINT' # 23
, SQL_CURSOR_ROLLBACK_BEHAVIOR => 'SQLUSMALLINT' # 24
, SQL_CURSOR_SENSITIVITY => 'SQLUINTEGER' # 10001
, SQL_DATA_SOURCE_NAME => 'SQLCHAR' # 2
, SQL_DATA_SOURCE_READ_ONLY => 'SQLCHAR' # 25
, SQL_DATABASE_NAME => 'SQLCHAR' # 16
, SQL_DATETIME_LITERALS => 'SQLUINTEGER bitmask' # 119
, SQL_DBMS_NAME => 'SQLCHAR' # 17
, SQL_DBMS_VER => 'SQLCHAR' # 18
, SQL_DDL_INDEX => 'SQLUINTEGER bitmask' # 170
, SQL_DEFAULT_TXN_ISOLATION => 'SQLUINTEGER' # 26
, SQL_DESCRIBE_PARAMETER => 'SQLCHAR' # 10002
, SQL_DM_VER => 'SQLCHAR' # 171
, SQL_DRIVER_HDBC => 'SQLUINTEGER' # 3
, SQL_DRIVER_HDESC => 'SQLUINTEGER' # 135
, SQL_DRIVER_HENV => 'SQLUINTEGER' # 4
, SQL_DRIVER_HLIB => 'SQLUINTEGER' # 76
, SQL_DRIVER_HSTMT => 'SQLUINTEGER' # 5
, SQL_DRIVER_NAME => 'SQLCHAR' # 6
, SQL_DRIVER_ODBC_VER => 'SQLCHAR' # 77
, SQL_DRIVER_VER => 'SQLCHAR' # 7
, SQL_DROP_ASSERTION => 'SQLUINTEGER bitmask' # 136
, SQL_DROP_CHARACTER_SET => 'SQLUINTEGER bitmask' # 137
, SQL_DROP_COLLATION => 'SQLUINTEGER bitmask' # 138
, SQL_DROP_DOMAIN => 'SQLUINTEGER bitmask' # 139
, SQL_DROP_SCHEMA => 'SQLUINTEGER bitmask' # 140
, SQL_DROP_TABLE => 'SQLUINTEGER bitmask' # 141
, SQL_DROP_TRANSLATION => 'SQLUINTEGER bitmask' # 142
, SQL_DROP_VIEW => 'SQLUINTEGER bitmask' # 143
, SQL_DYNAMIC_CURSOR_ATTRIBUTES1 => 'SQLUINTEGER bitmask' # 144
, SQL_DYNAMIC_CURSOR_ATTRIBUTES2 => 'SQLUINTEGER bitmask' # 145
, SQL_EXPRESSIONS_IN_ORDERBY => 'SQLCHAR' # 27
, SQL_FETCH_DIRECTION => 'SQLUINTEGER bitmask' # 8 => !!!
, SQL_FILE_USAGE => 'SQLUSMALLINT' # 84
, SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES1 => 'SQLUINTEGER bitmask' # 146
, SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES2 => 'SQLUINTEGER bitmask' # 147
, SQL_GETDATA_EXTENSIONS => 'SQLUINTEGER bitmask' # 81
, SQL_GROUP_BY => 'SQLUSMALLINT' # 88
, SQL_IDENTIFIER_CASE => 'SQLUSMALLINT' # 28
, SQL_IDENTIFIER_QUOTE_CHAR => 'SQLCHAR' # 29
, SQL_INDEX_KEYWORDS => 'SQLUINTEGER bitmask' # 148
# SQL_INFO_DRIVER_START => '' # 1000 =>
# SQL_INFO_FIRST => 'SQLUSMALLINT' # 0 =>
# SQL_INFO_LAST => 'SQLUSMALLINT' # 114 =>
, SQL_INFO_SCHEMA_VIEWS => 'SQLUINTEGER bitmask' # 149
, SQL_INSERT_STATEMENT => 'SQLUINTEGER bitmask' # 172
, SQL_INTEGRITY => 'SQLCHAR' # 73
, SQL_KEYSET_CURSOR_ATTRIBUTES1 => 'SQLUINTEGER bitmask' # 150
, SQL_KEYSET_CURSOR_ATTRIBUTES2 => 'SQLUINTEGER bitmask' # 151
, SQL_KEYWORDS => 'SQLCHAR' # 89
, SQL_LIKE_ESCAPE_CLAUSE => 'SQLCHAR' # 113
, SQL_LOCK_TYPES => 'SQLUINTEGER bitmask' # 78 => !!!
, SQL_MAXIMUM_CATALOG_NAME_LENGTH => 'SQLUSMALLINT' # 34 =>
, SQL_MAXIMUM_COLUMNS_IN_GROUP_BY => 'SQLUSMALLINT' # 97 =>
, SQL_MAXIMUM_COLUMNS_IN_INDEX => 'SQLUSMALLINT' # 98 =>
, SQL_MAXIMUM_COLUMNS_IN_ORDER_BY => 'SQLUSMALLINT' # 99 =>
, SQL_MAXIMUM_COLUMNS_IN_SELECT => 'SQLUSMALLINT' # 100 =>
, SQL_MAXIMUM_COLUMN_NAME_LENGTH => 'SQLUSMALLINT' # 30 =>
, SQL_MAXIMUM_CONCURRENT_ACTIVITIES => 'SQLUSMALLINT' # 1 =>
, SQL_MAXIMUM_CURSOR_NAME_LENGTH => 'SQLUSMALLINT' # 31 =>
, SQL_MAXIMUM_DRIVER_CONNECTIONS => 'SQLUSMALLINT' # 0 =>
, SQL_MAXIMUM_IDENTIFIER_LENGTH => 'SQLUSMALLINT' # 10005 =>
, SQL_MAXIMUM_INDEX_SIZE => 'SQLUINTEGER' # 102 =>
, SQL_MAXIMUM_ROW_SIZE => 'SQLUINTEGER' # 104 =>
, SQL_MAXIMUM_SCHEMA_NAME_LENGTH => 'SQLUSMALLINT' # 32 =>
, SQL_MAXIMUM_STATEMENT_LENGTH => 'SQLUINTEGER' # 105 =>
, SQL_MAXIMUM_TABLES_IN_SELECT => 'SQLUSMALLINT' # 106 =>
, SQL_MAXIMUM_USER_NAME_LENGTH => 'SQLUSMALLINT' # 107 =>
, SQL_MAX_ASYNC_CONCURRENT_STATEMENTS => 'SQLUINTEGER' # 10022
, SQL_MAX_BINARY_LITERAL_LEN => 'SQLUINTEGER' # 112
, SQL_MAX_CATALOG_NAME_LEN => 'SQLUSMALLINT' # 34
, SQL_MAX_CHAR_LITERAL_LEN => 'SQLUINTEGER' # 108
, SQL_MAX_COLUMNS_IN_GROUP_BY => 'SQLUSMALLINT' # 97
, SQL_MAX_COLUMNS_IN_INDEX => 'SQLUSMALLINT' # 98
, SQL_MAX_COLUMNS_IN_ORDER_BY => 'SQLUSMALLINT' # 99
, SQL_MAX_COLUMNS_IN_SELECT => 'SQLUSMALLINT' # 100
, SQL_MAX_COLUMNS_IN_TABLE => 'SQLUSMALLINT' # 101
, SQL_MAX_COLUMN_NAME_LEN => 'SQLUSMALLINT' # 30
, SQL_MAX_CONCURRENT_ACTIVITIES => 'SQLUSMALLINT' # 1
, SQL_MAX_CURSOR_NAME_LEN => 'SQLUSMALLINT' # 31
, SQL_MAX_DRIVER_CONNECTIONS => 'SQLUSMALLINT' # 0
, SQL_MAX_IDENTIFIER_LEN => 'SQLUSMALLINT' # 10005
, SQL_MAX_INDEX_SIZE => 'SQLUINTEGER' # 102
, SQL_MAX_OWNER_NAME_LEN => 'SQLUSMALLINT' # 32 =>
, SQL_MAX_PROCEDURE_NAME_LEN => 'SQLUSMALLINT' # 33
, SQL_MAX_QUALIFIER_NAME_LEN => 'SQLUSMALLINT' # 34 =>
, SQL_MAX_ROW_SIZE => 'SQLUINTEGER' # 104
, SQL_MAX_ROW_SIZE_INCLUDES_LONG => 'SQLCHAR' # 103
, SQL_MAX_SCHEMA_NAME_LEN => 'SQLUSMALLINT' # 32
, SQL_MAX_STATEMENT_LEN => 'SQLUINTEGER' # 105
, SQL_MAX_TABLES_IN_SELECT => 'SQLUSMALLINT' # 106
, SQL_MAX_TABLE_NAME_LEN => 'SQLUSMALLINT' # 35
, SQL_MAX_USER_NAME_LEN => 'SQLUSMALLINT' # 107
, SQL_MULTIPLE_ACTIVE_TXN => 'SQLCHAR' # 37
, SQL_MULT_RESULT_SETS => 'SQLCHAR' # 36
, SQL_NEED_LONG_DATA_LEN => 'SQLCHAR' # 111
, SQL_NON_NULLABLE_COLUMNS => 'SQLUSMALLINT' # 75
, SQL_NULL_COLLATION => 'SQLUSMALLINT' # 85
, SQL_NUMERIC_FUNCTIONS => 'SQLUINTEGER bitmask' # 49
, SQL_ODBC_API_CONFORMANCE => 'SQLUSMALLINT' # 9 => !!!
, SQL_ODBC_INTERFACE_CONFORMANCE => 'SQLUINTEGER' # 152
, SQL_ODBC_SAG_CLI_CONFORMANCE => 'SQLUSMALLINT' # 12 => !!!
, SQL_ODBC_SQL_CONFORMANCE => 'SQLUSMALLINT' # 15 => !!!
, SQL_ODBC_SQL_OPT_IEF => 'SQLCHAR' # 73 =>
, SQL_ODBC_VER => 'SQLCHAR' # 10
, SQL_OJ_CAPABILITIES => 'SQLUINTEGER bitmask' # 115
, SQL_ORDER_BY_COLUMNS_IN_SELECT => 'SQLCHAR' # 90
, SQL_OUTER_JOINS => 'SQLCHAR' # 38 => !!!
, SQL_OUTER_JOIN_CAPABILITIES => 'SQLUINTEGER bitmask' # 115 =>
, SQL_OWNER_TERM => 'SQLCHAR' # 39 =>
, SQL_OWNER_USAGE => 'SQLUINTEGER bitmask' # 91 =>
, SQL_PARAM_ARRAY_ROW_COUNTS => 'SQLUINTEGER' # 153
, SQL_PARAM_ARRAY_SELECTS => 'SQLUINTEGER' # 154
, SQL_POSITIONED_STATEMENTS => 'SQLUINTEGER bitmask' # 80 => !!!
, SQL_POS_OPERATIONS => 'SQLINTEGER bitmask' # 79
, SQL_PROCEDURES => 'SQLCHAR' # 21
, SQL_PROCEDURE_TERM => 'SQLCHAR' # 40
, SQL_QUALIFIER_LOCATION => 'SQLUSMALLINT' # 114 =>
, SQL_QUALIFIER_NAME_SEPARATOR => 'SQLCHAR' # 41 =>
, SQL_QUALIFIER_TERM => 'SQLCHAR' # 42 =>
, SQL_QUALIFIER_USAGE => 'SQLUINTEGER bitmask' # 92 =>
, SQL_QUOTED_IDENTIFIER_CASE => 'SQLUSMALLINT' # 93
, SQL_ROW_UPDATES => 'SQLCHAR' # 11
, SQL_SCHEMA_TERM => 'SQLCHAR' # 39
, SQL_SCHEMA_USAGE => 'SQLUINTEGER bitmask' # 91
, SQL_SCROLL_CONCURRENCY => 'SQLUINTEGER bitmask' # 43 => !!!
, SQL_SCROLL_OPTIONS => 'SQLUINTEGER bitmask' # 44
, SQL_SEARCH_PATTERN_ESCAPE => 'SQLCHAR' # 14
, SQL_SERVER_NAME => 'SQLCHAR' # 13
, SQL_SPECIAL_CHARACTERS => 'SQLCHAR' # 94
, SQL_SQL92_DATETIME_FUNCTIONS => 'SQLUINTEGER bitmask' # 155
, SQL_SQL92_FOREIGN_KEY_DELETE_RULE => 'SQLUINTEGER bitmask' # 156
, SQL_SQL92_FOREIGN_KEY_UPDATE_RULE => 'SQLUINTEGER bitmask' # 157
, SQL_SQL92_GRANT => 'SQLUINTEGER bitmask' # 158
, SQL_SQL92_NUMERIC_VALUE_FUNCTIONS => 'SQLUINTEGER bitmask' # 159
, SQL_SQL92_PREDICATES => 'SQLUINTEGER bitmask' # 160
, SQL_SQL92_RELATIONAL_JOIN_OPERATORS => 'SQLUINTEGER bitmask' # 161
, SQL_SQL92_REVOKE => 'SQLUINTEGER bitmask' # 162
, SQL_SQL92_ROW_VALUE_CONSTRUCTOR => 'SQLUINTEGER bitmask' # 163
, SQL_SQL92_STRING_FUNCTIONS => 'SQLUINTEGER bitmask' # 164
, SQL_SQL92_VALUE_EXPRESSIONS => 'SQLUINTEGER bitmask' # 165
, SQL_SQL_CONFORMANCE => 'SQLUINTEGER' # 118
, SQL_STANDARD_CLI_CONFORMANCE => 'SQLUINTEGER bitmask' # 166
, SQL_STATIC_CURSOR_ATTRIBUTES1 => 'SQLUINTEGER bitmask' # 167
, SQL_STATIC_CURSOR_ATTRIBUTES2 => 'SQLUINTEGER bitmask' # 168
, SQL_STATIC_SENSITIVITY => 'SQLUINTEGER bitmask' # 83 => !!!
, SQL_STRING_FUNCTIONS => 'SQLUINTEGER bitmask' # 50
, SQL_SUBQUERIES => 'SQLUINTEGER bitmask' # 95
, SQL_SYSTEM_FUNCTIONS => 'SQLUINTEGER bitmask' # 51
, SQL_TABLE_TERM => 'SQLCHAR' # 45
, SQL_TIMEDATE_ADD_INTERVALS => 'SQLUINTEGER bitmask' # 109
, SQL_TIMEDATE_DIFF_INTERVALS => 'SQLUINTEGER bitmask' # 110
, SQL_TIMEDATE_FUNCTIONS => 'SQLUINTEGER bitmask' # 52
, SQL_TRANSACTION_CAPABLE => 'SQLUSMALLINT' # 46 =>
, SQL_TRANSACTION_ISOLATION_OPTION => 'SQLUINTEGER bitmask' # 72 =>
, SQL_TXN_CAPABLE => 'SQLUSMALLINT' # 46
, SQL_TXN_ISOLATION_OPTION => 'SQLUINTEGER bitmask' # 72
, SQL_UNION => 'SQLUINTEGER bitmask' # 96
, SQL_UNION_STATEMENT => 'SQLUINTEGER bitmask' # 96 =>
, SQL_USER_NAME => 'SQLCHAR' # 47
, SQL_XOPEN_CLI_YEAR => 'SQLCHAR' # 10000
);
=head2 %ReturnValues
See: sql.h, sqlext.h
Edited:
SQL_TXN_ISOLATION_OPTION
=cut
$ReturnValues{SQL_AGGREGATE_FUNCTIONS} =
{
SQL_AF_AVG => 0x00000001
, SQL_AF_COUNT => 0x00000002
, SQL_AF_MAX => 0x00000004
, SQL_AF_MIN => 0x00000008
, SQL_AF_SUM => 0x00000010
, SQL_AF_DISTINCT => 0x00000020
, SQL_AF_ALL => 0x00000040
};
$ReturnValues{SQL_ALTER_DOMAIN} =
{
SQL_AD_CONSTRAINT_NAME_DEFINITION => 0x00000001
, SQL_AD_ADD_DOMAIN_CONSTRAINT => 0x00000002
, SQL_AD_DROP_DOMAIN_CONSTRAINT => 0x00000004
, SQL_AD_ADD_DOMAIN_DEFAULT => 0x00000008
, SQL_AD_DROP_DOMAIN_DEFAULT => 0x00000010
, SQL_AD_ADD_CONSTRAINT_INITIALLY_DEFERRED => 0x00000020
, SQL_AD_ADD_CONSTRAINT_INITIALLY_IMMEDIATE => 0x00000040
, SQL_AD_ADD_CONSTRAINT_DEFERRABLE => 0x00000080
, SQL_AD_ADD_CONSTRAINT_NON_DEFERRABLE => 0x00000100
};
$ReturnValues{SQL_ALTER_TABLE} =
{
SQL_AT_ADD_COLUMN => 0x00000001
, SQL_AT_DROP_COLUMN => 0x00000002
, SQL_AT_ADD_CONSTRAINT => 0x00000008
, SQL_AT_ADD_COLUMN_SINGLE => 0x00000020
, SQL_AT_ADD_COLUMN_DEFAULT => 0x00000040
, SQL_AT_ADD_COLUMN_COLLATION => 0x00000080
, SQL_AT_SET_COLUMN_DEFAULT => 0x00000100
, SQL_AT_DROP_COLUMN_DEFAULT => 0x00000200
, SQL_AT_DROP_COLUMN_CASCADE => 0x00000400
, SQL_AT_DROP_COLUMN_RESTRICT => 0x00000800
, SQL_AT_ADD_TABLE_CONSTRAINT => 0x00001000
, SQL_AT_DROP_TABLE_CONSTRAINT_CASCADE => 0x00002000
, SQL_AT_DROP_TABLE_CONSTRAINT_RESTRICT => 0x00004000
, SQL_AT_CONSTRAINT_NAME_DEFINITION => 0x00008000
, SQL_AT_CONSTRAINT_INITIALLY_DEFERRED => 0x00010000
, SQL_AT_CONSTRAINT_INITIALLY_IMMEDIATE => 0x00020000
, SQL_AT_CONSTRAINT_DEFERRABLE => 0x00040000
, SQL_AT_CONSTRAINT_NON_DEFERRABLE => 0x00080000
};
$ReturnValues{SQL_ASYNC_MODE} =
{
SQL_AM_NONE => 0
, SQL_AM_CONNECTION => 1
, SQL_AM_STATEMENT => 2
};
$ReturnValues{SQL_ATTR_MAX_ROWS} =
{
SQL_CA2_MAX_ROWS_SELECT => 0x00000080
, SQL_CA2_MAX_ROWS_INSERT => 0x00000100
, SQL_CA2_MAX_ROWS_DELETE => 0x00000200
, SQL_CA2_MAX_ROWS_UPDATE => 0x00000400
, SQL_CA2_MAX_ROWS_CATALOG => 0x00000800
# SQL_CA2_MAX_ROWS_AFFECTS_ALL =>
};
$ReturnValues{SQL_ATTR_SCROLL_CONCURRENCY} =
{
SQL_CA2_READ_ONLY_CONCURRENCY => 0x00000001
, SQL_CA2_LOCK_CONCURRENCY => 0x00000002
, SQL_CA2_OPT_ROWVER_CONCURRENCY => 0x00000004
, SQL_CA2_OPT_VALUES_CONCURRENCY => 0x00000008
, SQL_CA2_SENSITIVITY_ADDITIONS => 0x00000010
, SQL_CA2_SENSITIVITY_DELETIONS => 0x00000020
, SQL_CA2_SENSITIVITY_UPDATES => 0x00000040
};
$ReturnValues{SQL_BATCH_ROW_COUNT} =
{
SQL_BRC_PROCEDURES => 0x0000001
, SQL_BRC_EXPLICIT => 0x0000002
, SQL_BRC_ROLLED_UP => 0x0000004
};
$ReturnValues{SQL_BATCH_SUPPORT} =
{
SQL_BS_SELECT_EXPLICIT => 0x00000001
, SQL_BS_ROW_COUNT_EXPLICIT => 0x00000002
, SQL_BS_SELECT_PROC => 0x00000004
, SQL_BS_ROW_COUNT_PROC => 0x00000008
};
$ReturnValues{SQL_BOOKMARK_PERSISTENCE} =
{
SQL_BP_CLOSE => 0x00000001
, SQL_BP_DELETE => 0x00000002
, SQL_BP_DROP => 0x00000004
, SQL_BP_TRANSACTION => 0x00000008
, SQL_BP_UPDATE => 0x00000010
, SQL_BP_OTHER_HSTMT => 0x00000020
, SQL_BP_SCROLL => 0x00000040
};
$ReturnValues{SQL_CATALOG_LOCATION} =
{
SQL_CL_START => 0x0001 # SQL_QL_START
, SQL_CL_END => 0x0002 # SQL_QL_END
};
$ReturnValues{SQL_CATALOG_USAGE} =
{
SQL_CU_DML_STATEMENTS => 0x00000001 # SQL_QU_DML_STATEMENTS
, SQL_CU_PROCEDURE_INVOCATION => 0x00000002 # SQL_QU_PROCEDURE_INVOCATION
, SQL_CU_TABLE_DEFINITION => 0x00000004 # SQL_QU_TABLE_DEFINITION
, SQL_CU_INDEX_DEFINITION => 0x00000008 # SQL_QU_INDEX_DEFINITION
, SQL_CU_PRIVILEGE_DEFINITION => 0x00000010 # SQL_QU_PRIVILEGE_DEFINITION
};
$ReturnValues{SQL_CONCAT_NULL_BEHAVIOR} =
{
SQL_CB_NULL => 0x0000
, SQL_CB_NON_NULL => 0x0001
};
$ReturnValues{SQL_CONVERT_} =
{
SQL_CVT_CHAR => 0x00000001
, SQL_CVT_NUMERIC => 0x00000002
, SQL_CVT_DECIMAL => 0x00000004
, SQL_CVT_INTEGER => 0x00000008
, SQL_CVT_SMALLINT => 0x00000010
, SQL_CVT_FLOAT => 0x00000020
, SQL_CVT_REAL => 0x00000040
, SQL_CVT_DOUBLE => 0x00000080
, SQL_CVT_VARCHAR => 0x00000100
, SQL_CVT_LONGVARCHAR => 0x00000200
, SQL_CVT_BINARY => 0x00000400
, SQL_CVT_VARBINARY => 0x00000800
, SQL_CVT_BIT => 0x00001000
, SQL_CVT_TINYINT => 0x00002000
, SQL_CVT_BIGINT => 0x00004000
, SQL_CVT_DATE => 0x00008000
, SQL_CVT_TIME => 0x00010000
, SQL_CVT_TIMESTAMP => 0x00020000
, SQL_CVT_LONGVARBINARY => 0x00040000
, SQL_CVT_INTERVAL_YEAR_MONTH => 0x00080000
, SQL_CVT_INTERVAL_DAY_TIME => 0x00100000
, SQL_CVT_WCHAR => 0x00200000
, SQL_CVT_WLONGVARCHAR => 0x00400000
, SQL_CVT_WVARCHAR => 0x00800000
, SQL_CVT_GUID => 0x01000000
};
$ReturnValues{SQL_CONVERT_BIGINT } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_BINARY } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_BIT } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_CHAR } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_DATE } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_DECIMAL } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_DOUBLE } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_FLOAT } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_GUID } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_INTEGER } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_INTERVAL_DAY_TIME } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_INTERVAL_YEAR_MONTH} = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_LONGVARBINARY } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_LONGVARCHAR } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_NUMERIC } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_REAL } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_SMALLINT } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_TIME } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_TIMESTAMP } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_TINYINT } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_VARBINARY } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_VARCHAR } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_WCHAR } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_WLONGVARCHAR } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_WVARCHAR } = $ReturnValues{SQL_CONVERT_};
$ReturnValues{SQL_CONVERT_FUNCTIONS} =
{
SQL_FN_CVT_CONVERT => 0x00000001
, SQL_FN_CVT_CAST => 0x00000002
};
$ReturnValues{SQL_CORRELATION_NAME} =
{
SQL_CN_NONE => 0x0000
, SQL_CN_DIFFERENT => 0x0001
, SQL_CN_ANY => 0x0002
};
$ReturnValues{SQL_CREATE_ASSERTION} =
{
SQL_CA_CREATE_ASSERTION => 0x00000001
, SQL_CA_CONSTRAINT_INITIALLY_DEFERRED => 0x00000010
, SQL_CA_CONSTRAINT_INITIALLY_IMMEDIATE => 0x00000020
, SQL_CA_CONSTRAINT_DEFERRABLE => 0x00000040
, SQL_CA_CONSTRAINT_NON_DEFERRABLE => 0x00000080
};
$ReturnValues{SQL_CREATE_CHARACTER_SET} =
{
SQL_CCS_CREATE_CHARACTER_SET => 0x00000001
, SQL_CCS_COLLATE_CLAUSE => 0x00000002
, SQL_CCS_LIMITED_COLLATION => 0x00000004
};
$ReturnValues{SQL_CREATE_COLLATION} =
{
SQL_CCOL_CREATE_COLLATION => 0x00000001
};
$ReturnValues{SQL_CREATE_DOMAIN} =
{
SQL_CDO_CREATE_DOMAIN => 0x00000001
, SQL_CDO_DEFAULT => 0x00000002
, SQL_CDO_CONSTRAINT => 0x00000004
, SQL_CDO_COLLATION => 0x00000008
, SQL_CDO_CONSTRAINT_NAME_DEFINITION => 0x00000010
, SQL_CDO_CONSTRAINT_INITIALLY_DEFERRED => 0x00000020
, SQL_CDO_CONSTRAINT_INITIALLY_IMMEDIATE => 0x00000040
, SQL_CDO_CONSTRAINT_DEFERRABLE => 0x00000080
, SQL_CDO_CONSTRAINT_NON_DEFERRABLE => 0x00000100
};
$ReturnValues{SQL_CREATE_SCHEMA} =
{
SQL_CS_CREATE_SCHEMA => 0x00000001
, SQL_CS_AUTHORIZATION => 0x00000002
, SQL_CS_DEFAULT_CHARACTER_SET => 0x00000004
};
$ReturnValues{SQL_CREATE_TABLE} =
{
SQL_CT_CREATE_TABLE => 0x00000001
, SQL_CT_COMMIT_PRESERVE => 0x00000002
, SQL_CT_COMMIT_DELETE => 0x00000004
, SQL_CT_GLOBAL_TEMPORARY => 0x00000008
, SQL_CT_LOCAL_TEMPORARY => 0x00000010
, SQL_CT_CONSTRAINT_INITIALLY_DEFERRED => 0x00000020
, SQL_CT_CONSTRAINT_INITIALLY_IMMEDIATE => 0x00000040
, SQL_CT_CONSTRAINT_DEFERRABLE => 0x00000080
, SQL_CT_CONSTRAINT_NON_DEFERRABLE => 0x00000100
, SQL_CT_COLUMN_CONSTRAINT => 0x00000200
, SQL_CT_COLUMN_DEFAULT => 0x00000400
, SQL_CT_COLUMN_COLLATION => 0x00000800
, SQL_CT_TABLE_CONSTRAINT => 0x00001000
, SQL_CT_CONSTRAINT_NAME_DEFINITION => 0x00002000
};
$ReturnValues{SQL_CREATE_TRANSLATION} =
{
SQL_CTR_CREATE_TRANSLATION => 0x00000001
};
$ReturnValues{SQL_CREATE_VIEW} =
{
SQL_CV_CREATE_VIEW => 0x00000001
, SQL_CV_CHECK_OPTION => 0x00000002
, SQL_CV_CASCADED => 0x00000004
, SQL_CV_LOCAL => 0x00000008
};
$ReturnValues{SQL_CURSOR_COMMIT_BEHAVIOR} =
{
SQL_CB_DELETE => 0
, SQL_CB_CLOSE => 1
, SQL_CB_PRESERVE => 2
};
$ReturnValues{SQL_CURSOR_ROLLBACK_BEHAVIOR} = $ReturnValues{SQL_CURSOR_COMMIT_BEHAVIOR};
$ReturnValues{SQL_CURSOR_SENSITIVITY} =
{
SQL_UNSPECIFIED => 0
, SQL_INSENSITIVE => 1
, SQL_SENSITIVE => 2
};
$ReturnValues{SQL_DATETIME_LITERALS} =
{
SQL_DL_SQL92_DATE => 0x00000001
, SQL_DL_SQL92_TIME => 0x00000002
, SQL_DL_SQL92_TIMESTAMP => 0x00000004
, SQL_DL_SQL92_INTERVAL_YEAR => 0x00000008
, SQL_DL_SQL92_INTERVAL_MONTH => 0x00000010
, SQL_DL_SQL92_INTERVAL_DAY => 0x00000020
, SQL_DL_SQL92_INTERVAL_HOUR => 0x00000040
, SQL_DL_SQL92_INTERVAL_MINUTE => 0x00000080
, SQL_DL_SQL92_INTERVAL_SECOND => 0x00000100
, SQL_DL_SQL92_INTERVAL_YEAR_TO_MONTH => 0x00000200
, SQL_DL_SQL92_INTERVAL_DAY_TO_HOUR => 0x00000400
, SQL_DL_SQL92_INTERVAL_DAY_TO_MINUTE => 0x00000800
, SQL_DL_SQL92_INTERVAL_DAY_TO_SECOND => 0x00001000
, SQL_DL_SQL92_INTERVAL_HOUR_TO_MINUTE => 0x00002000
, SQL_DL_SQL92_INTERVAL_HOUR_TO_SECOND => 0x00004000
, SQL_DL_SQL92_INTERVAL_MINUTE_TO_SECOND => 0x00008000
};
$ReturnValues{SQL_DDL_INDEX} =
{
SQL_DI_CREATE_INDEX => 0x00000001
, SQL_DI_DROP_INDEX => 0x00000002
};
$ReturnValues{SQL_DIAG_CURSOR_ROW_COUNT} =
{
SQL_CA2_CRC_EXACT => 0x00001000
, SQL_CA2_CRC_APPROXIMATE => 0x00002000
, SQL_CA2_SIMULATE_NON_UNIQUE => 0x00004000
, SQL_CA2_SIMULATE_TRY_UNIQUE => 0x00008000
, SQL_CA2_SIMULATE_UNIQUE => 0x00010000
};
$ReturnValues{SQL_DROP_ASSERTION} =
{
SQL_DA_DROP_ASSERTION => 0x00000001
};
$ReturnValues{SQL_DROP_CHARACTER_SET} =
{
SQL_DCS_DROP_CHARACTER_SET => 0x00000001
};
$ReturnValues{SQL_DROP_COLLATION} =
{
SQL_DC_DROP_COLLATION => 0x00000001
};
$ReturnValues{SQL_DROP_DOMAIN} =
{
SQL_DD_DROP_DOMAIN => 0x00000001
, SQL_DD_RESTRICT => 0x00000002
, SQL_DD_CASCADE => 0x00000004
};
$ReturnValues{SQL_DROP_SCHEMA} =
{
SQL_DS_DROP_SCHEMA => 0x00000001
, SQL_DS_RESTRICT => 0x00000002
, SQL_DS_CASCADE => 0x00000004
};
$ReturnValues{SQL_DROP_TABLE} =
{
SQL_DT_DROP_TABLE => 0x00000001
, SQL_DT_RESTRICT => 0x00000002
, SQL_DT_CASCADE => 0x00000004
};
$ReturnValues{SQL_DROP_TRANSLATION} =
{
SQL_DTR_DROP_TRANSLATION => 0x00000001
};
$ReturnValues{SQL_DROP_VIEW} =
{
SQL_DV_DROP_VIEW => 0x00000001
, SQL_DV_RESTRICT => 0x00000002
, SQL_DV_CASCADE => 0x00000004
};
$ReturnValues{SQL_CURSOR_ATTRIBUTES1} =
{
SQL_CA1_NEXT => 0x00000001
, SQL_CA1_ABSOLUTE => 0x00000002
, SQL_CA1_RELATIVE => 0x00000004
, SQL_CA1_BOOKMARK => 0x00000008
, SQL_CA1_LOCK_NO_CHANGE => 0x00000040
, SQL_CA1_LOCK_EXCLUSIVE => 0x00000080
, SQL_CA1_LOCK_UNLOCK => 0x00000100
, SQL_CA1_POS_POSITION => 0x00000200
, SQL_CA1_POS_UPDATE => 0x00000400
, SQL_CA1_POS_DELETE => 0x00000800
, SQL_CA1_POS_REFRESH => 0x00001000
, SQL_CA1_POSITIONED_UPDATE => 0x00002000
, SQL_CA1_POSITIONED_DELETE => 0x00004000
, SQL_CA1_SELECT_FOR_UPDATE => 0x00008000
, SQL_CA1_BULK_ADD => 0x00010000
, SQL_CA1_BULK_UPDATE_BY_BOOKMARK => 0x00020000
, SQL_CA1_BULK_DELETE_BY_BOOKMARK => 0x00040000
, SQL_CA1_BULK_FETCH_BY_BOOKMARK => 0x00080000
};
$ReturnValues{ SQL_DYNAMIC_CURSOR_ATTRIBUTES1} = $ReturnValues{SQL_CURSOR_ATTRIBUTES1};
$ReturnValues{SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES1} = $ReturnValues{SQL_CURSOR_ATTRIBUTES1};
$ReturnValues{ SQL_KEYSET_CURSOR_ATTRIBUTES1} = $ReturnValues{SQL_CURSOR_ATTRIBUTES1};
$ReturnValues{ SQL_STATIC_CURSOR_ATTRIBUTES1} = $ReturnValues{SQL_CURSOR_ATTRIBUTES1};
$ReturnValues{SQL_CURSOR_ATTRIBUTES2} =
{
SQL_CA2_READ_ONLY_CONCURRENCY => 0x00000001
, SQL_CA2_LOCK_CONCURRENCY => 0x00000002
, SQL_CA2_OPT_ROWVER_CONCURRENCY => 0x00000004
, SQL_CA2_OPT_VALUES_CONCURRENCY => 0x00000008
, SQL_CA2_SENSITIVITY_ADDITIONS => 0x00000010
, SQL_CA2_SENSITIVITY_DELETIONS => 0x00000020
, SQL_CA2_SENSITIVITY_UPDATES => 0x00000040
, SQL_CA2_MAX_ROWS_SELECT => 0x00000080
, SQL_CA2_MAX_ROWS_INSERT => 0x00000100
, SQL_CA2_MAX_ROWS_DELETE => 0x00000200
, SQL_CA2_MAX_ROWS_UPDATE => 0x00000400
, SQL_CA2_MAX_ROWS_CATALOG => 0x00000800
, SQL_CA2_CRC_EXACT => 0x00001000
, SQL_CA2_CRC_APPROXIMATE => 0x00002000
, SQL_CA2_SIMULATE_NON_UNIQUE => 0x00004000
, SQL_CA2_SIMULATE_TRY_UNIQUE => 0x00008000
, SQL_CA2_SIMULATE_UNIQUE => 0x00010000
};
$ReturnValues{ SQL_DYNAMIC_CURSOR_ATTRIBUTES2} = $ReturnValues{SQL_CURSOR_ATTRIBUTES2};
$ReturnValues{SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES2} = $ReturnValues{SQL_CURSOR_ATTRIBUTES2};
$ReturnValues{ SQL_KEYSET_CURSOR_ATTRIBUTES2} = $ReturnValues{SQL_CURSOR_ATTRIBUTES2};
$ReturnValues{ SQL_STATIC_CURSOR_ATTRIBUTES2} = $ReturnValues{SQL_CURSOR_ATTRIBUTES2};
$ReturnValues{SQL_FETCH_DIRECTION} =
{
SQL_FD_FETCH_NEXT => 0x00000001
, SQL_FD_FETCH_FIRST => 0x00000002
, SQL_FD_FETCH_LAST => 0x00000004
, SQL_FD_FETCH_PRIOR => 0x00000008
, SQL_FD_FETCH_ABSOLUTE => 0x00000010
, SQL_FD_FETCH_RELATIVE => 0x00000020
, SQL_FD_FETCH_RESUME => 0x00000040
, SQL_FD_FETCH_BOOKMARK => 0x00000080
};
$ReturnValues{SQL_FILE_USAGE} =
{
SQL_FILE_NOT_SUPPORTED => 0x0000
, SQL_FILE_TABLE => 0x0001
, SQL_FILE_QUALIFIER => 0x0002
, SQL_FILE_CATALOG => 0x0002 # SQL_FILE_QUALIFIER
};
$ReturnValues{SQL_GETDATA_EXTENSIONS} =
{
SQL_GD_ANY_COLUMN => 0x00000001
, SQL_GD_ANY_ORDER => 0x00000002
, SQL_GD_BLOCK => 0x00000004
, SQL_GD_BOUND => 0x00000008
};
$ReturnValues{SQL_GROUP_BY} =
{
SQL_GB_NOT_SUPPORTED => 0x0000
, SQL_GB_GROUP_BY_EQUALS_SELECT => 0x0001
, SQL_GB_GROUP_BY_CONTAINS_SELECT => 0x0002
, SQL_GB_NO_RELATION => 0x0003
, SQL_GB_COLLATE => 0x0004
};
$ReturnValues{SQL_IDENTIFIER_CASE} =
{
SQL_IC_UPPER => 1
, SQL_IC_LOWER => 2
, SQL_IC_SENSITIVE => 3
, SQL_IC_MIXED => 4
};
$ReturnValues{SQL_INDEX_KEYWORDS} =
{
SQL_IK_NONE => 0x00000000
, SQL_IK_ASC => 0x00000001
, SQL_IK_DESC => 0x00000002
# SQL_IK_ALL =>
};
$ReturnValues{SQL_INFO_SCHEMA_VIEWS} =
{
SQL_ISV_ASSERTIONS => 0x00000001
, SQL_ISV_CHARACTER_SETS => 0x00000002
, SQL_ISV_CHECK_CONSTRAINTS => 0x00000004
, SQL_ISV_COLLATIONS => 0x00000008
, SQL_ISV_COLUMN_DOMAIN_USAGE => 0x00000010
, SQL_ISV_COLUMN_PRIVILEGES => 0x00000020
, SQL_ISV_COLUMNS => 0x00000040
, SQL_ISV_CONSTRAINT_COLUMN_USAGE => 0x00000080
, SQL_ISV_CONSTRAINT_TABLE_USAGE => 0x00000100
, SQL_ISV_DOMAIN_CONSTRAINTS => 0x00000200
, SQL_ISV_DOMAINS => 0x00000400
, SQL_ISV_KEY_COLUMN_USAGE => 0x00000800
, SQL_ISV_REFERENTIAL_CONSTRAINTS => 0x00001000
, SQL_ISV_SCHEMATA => 0x00002000
, SQL_ISV_SQL_LANGUAGES => 0x00004000
, SQL_ISV_TABLE_CONSTRAINTS => 0x00008000
, SQL_ISV_TABLE_PRIVILEGES => 0x00010000
, SQL_ISV_TABLES => 0x00020000
, SQL_ISV_TRANSLATIONS => 0x00040000
, SQL_ISV_USAGE_PRIVILEGES => 0x00080000
, SQL_ISV_VIEW_COLUMN_USAGE => 0x00100000
, SQL_ISV_VIEW_TABLE_USAGE => 0x00200000
, SQL_ISV_VIEWS => 0x00400000
};
$ReturnValues{SQL_INSERT_STATEMENT} =
{
SQL_IS_INSERT_LITERALS => 0x00000001
, SQL_IS_INSERT_SEARCHED => 0x00000002
, SQL_IS_SELECT_INTO => 0x00000004
};
$ReturnValues{SQL_LOCK_TYPES} =
{
SQL_LCK_NO_CHANGE => 0x00000001
, SQL_LCK_EXCLUSIVE => 0x00000002
, SQL_LCK_UNLOCK => 0x00000004
};
$ReturnValues{SQL_NON_NULLABLE_COLUMNS} =
{
SQL_NNC_NULL => 0x0000
, SQL_NNC_NON_NULL => 0x0001
};
$ReturnValues{SQL_NULL_COLLATION} =
{
SQL_NC_HIGH => 0
, SQL_NC_LOW => 1
, SQL_NC_START => 0x0002
, SQL_NC_END => 0x0004
};
$ReturnValues{SQL_NUMERIC_FUNCTIONS} =
{
SQL_FN_NUM_ABS => 0x00000001
, SQL_FN_NUM_ACOS => 0x00000002
, SQL_FN_NUM_ASIN => 0x00000004
, SQL_FN_NUM_ATAN => 0x00000008
, SQL_FN_NUM_ATAN2 => 0x00000010
, SQL_FN_NUM_CEILING => 0x00000020
, SQL_FN_NUM_COS => 0x00000040
, SQL_FN_NUM_COT => 0x00000080
, SQL_FN_NUM_EXP => 0x00000100
, SQL_FN_NUM_FLOOR => 0x00000200
, SQL_FN_NUM_LOG => 0x00000400
, SQL_FN_NUM_MOD => 0x00000800
, SQL_FN_NUM_SIGN => 0x00001000
, SQL_FN_NUM_SIN => 0x00002000
, SQL_FN_NUM_SQRT => 0x00004000
, SQL_FN_NUM_TAN => 0x00008000
, SQL_FN_NUM_PI => 0x00010000
, SQL_FN_NUM_RAND => 0x00020000
, SQL_FN_NUM_DEGREES => 0x00040000
, SQL_FN_NUM_LOG10 => 0x00080000
, SQL_FN_NUM_POWER => 0x00100000
, SQL_FN_NUM_RADIANS => 0x00200000
, SQL_FN_NUM_ROUND => 0x00400000
, SQL_FN_NUM_TRUNCATE => 0x00800000
};
$ReturnValues{SQL_ODBC_API_CONFORMANCE} =
{
SQL_OAC_NONE => 0x0000
, SQL_OAC_LEVEL1 => 0x0001
, SQL_OAC_LEVEL2 => 0x0002
};
$ReturnValues{SQL_ODBC_INTERFACE_CONFORMANCE} =
{
SQL_OIC_CORE => 1
, SQL_OIC_LEVEL1 => 2
, SQL_OIC_LEVEL2 => 3
};
$ReturnValues{SQL_ODBC_SAG_CLI_CONFORMANCE} =
{
SQL_OSCC_NOT_COMPLIANT => 0x0000
, SQL_OSCC_COMPLIANT => 0x0001
};
$ReturnValues{SQL_ODBC_SQL_CONFORMANCE} =
{
SQL_OSC_MINIMUM => 0x0000
, SQL_OSC_CORE => 0x0001
, SQL_OSC_EXTENDED => 0x0002
};
$ReturnValues{SQL_OJ_CAPABILITIES} =
{
SQL_OJ_LEFT => 0x00000001
, SQL_OJ_RIGHT => 0x00000002
, SQL_OJ_FULL => 0x00000004
, SQL_OJ_NESTED => 0x00000008
, SQL_OJ_NOT_ORDERED => 0x00000010
, SQL_OJ_INNER => 0x00000020
, SQL_OJ_ALL_COMPARISON_OPS => 0x00000040
};
$ReturnValues{SQL_OWNER_USAGE} =
{
SQL_OU_DML_STATEMENTS => 0x00000001
, SQL_OU_PROCEDURE_INVOCATION => 0x00000002
, SQL_OU_TABLE_DEFINITION => 0x00000004
, SQL_OU_INDEX_DEFINITION => 0x00000008
, SQL_OU_PRIVILEGE_DEFINITION => 0x00000010
};
$ReturnValues{SQL_PARAM_ARRAY_ROW_COUNTS} =
{
SQL_PARC_BATCH => 1
, SQL_PARC_NO_BATCH => 2
};
$ReturnValues{SQL_PARAM_ARRAY_SELECTS} =
{
SQL_PAS_BATCH => 1
, SQL_PAS_NO_BATCH => 2
, SQL_PAS_NO_SELECT => 3
};
$ReturnValues{SQL_POSITIONED_STATEMENTS} =
{
SQL_PS_POSITIONED_DELETE => 0x00000001
, SQL_PS_POSITIONED_UPDATE => 0x00000002
, SQL_PS_SELECT_FOR_UPDATE => 0x00000004
};
$ReturnValues{SQL_POS_OPERATIONS} =
{
SQL_POS_POSITION => 0x00000001
, SQL_POS_REFRESH => 0x00000002
, SQL_POS_UPDATE => 0x00000004
, SQL_POS_DELETE => 0x00000008
, SQL_POS_ADD => 0x00000010
};
$ReturnValues{SQL_QUALIFIER_LOCATION} =
{
SQL_QL_START => 0x0001
, SQL_QL_END => 0x0002
};
$ReturnValues{SQL_QUALIFIER_USAGE} =
{
SQL_QU_DML_STATEMENTS => 0x00000001
, SQL_QU_PROCEDURE_INVOCATION => 0x00000002
, SQL_QU_TABLE_DEFINITION => 0x00000004
, SQL_QU_INDEX_DEFINITION => 0x00000008
, SQL_QU_PRIVILEGE_DEFINITION => 0x00000010
};
$ReturnValues{SQL_QUOTED_IDENTIFIER_CASE} = $ReturnValues{SQL_IDENTIFIER_CASE};
$ReturnValues{SQL_SCHEMA_USAGE} =
{
SQL_SU_DML_STATEMENTS => 0x00000001 # SQL_OU_DML_STATEMENTS
, SQL_SU_PROCEDURE_INVOCATION => 0x00000002 # SQL_OU_PROCEDURE_INVOCATION
, SQL_SU_TABLE_DEFINITION => 0x00000004 # SQL_OU_TABLE_DEFINITION
, SQL_SU_INDEX_DEFINITION => 0x00000008 # SQL_OU_INDEX_DEFINITION
, SQL_SU_PRIVILEGE_DEFINITION => 0x00000010 # SQL_OU_PRIVILEGE_DEFINITION
};
$ReturnValues{SQL_SCROLL_CONCURRENCY} =
{
SQL_SCCO_READ_ONLY => 0x00000001
, SQL_SCCO_LOCK => 0x00000002
, SQL_SCCO_OPT_ROWVER => 0x00000004
, SQL_SCCO_OPT_VALUES => 0x00000008
};
$ReturnValues{SQL_SCROLL_OPTIONS} =
{
SQL_SO_FORWARD_ONLY => 0x00000001
, SQL_SO_KEYSET_DRIVEN => 0x00000002
, SQL_SO_DYNAMIC => 0x00000004
, SQL_SO_MIXED => 0x00000008
, SQL_SO_STATIC => 0x00000010
};
$ReturnValues{SQL_SQL92_DATETIME_FUNCTIONS} =
{
SQL_SDF_CURRENT_DATE => 0x00000001
, SQL_SDF_CURRENT_TIME => 0x00000002
, SQL_SDF_CURRENT_TIMESTAMP => 0x00000004
};
$ReturnValues{SQL_SQL92_FOREIGN_KEY_DELETE_RULE} =
{
SQL_SFKD_CASCADE => 0x00000001
, SQL_SFKD_NO_ACTION => 0x00000002
, SQL_SFKD_SET_DEFAULT => 0x00000004
, SQL_SFKD_SET_NULL => 0x00000008
};
$ReturnValues{SQL_SQL92_FOREIGN_KEY_UPDATE_RULE} =
{
SQL_SFKU_CASCADE => 0x00000001
, SQL_SFKU_NO_ACTION => 0x00000002
, SQL_SFKU_SET_DEFAULT => 0x00000004
, SQL_SFKU_SET_NULL => 0x00000008
};
$ReturnValues{SQL_SQL92_GRANT} =
{
SQL_SG_USAGE_ON_DOMAIN => 0x00000001
, SQL_SG_USAGE_ON_CHARACTER_SET => 0x00000002
, SQL_SG_USAGE_ON_COLLATION => 0x00000004
, SQL_SG_USAGE_ON_TRANSLATION => 0x00000008
, SQL_SG_WITH_GRANT_OPTION => 0x00000010
, SQL_SG_DELETE_TABLE => 0x00000020
, SQL_SG_INSERT_TABLE => 0x00000040
, SQL_SG_INSERT_COLUMN => 0x00000080
, SQL_SG_REFERENCES_TABLE => 0x00000100
, SQL_SG_REFERENCES_COLUMN => 0x00000200
, SQL_SG_SELECT_TABLE => 0x00000400
, SQL_SG_UPDATE_TABLE => 0x00000800
, SQL_SG_UPDATE_COLUMN => 0x00001000
};
$ReturnValues{SQL_SQL92_NUMERIC_VALUE_FUNCTIONS} =
{
SQL_SNVF_BIT_LENGTH => 0x00000001
, SQL_SNVF_CHAR_LENGTH => 0x00000002
, SQL_SNVF_CHARACTER_LENGTH => 0x00000004
, SQL_SNVF_EXTRACT => 0x00000008
, SQL_SNVF_OCTET_LENGTH => 0x00000010
, SQL_SNVF_POSITION => 0x00000020
};
$ReturnValues{SQL_SQL92_PREDICATES} =
{
SQL_SP_EXISTS => 0x00000001
, SQL_SP_ISNOTNULL => 0x00000002
, SQL_SP_ISNULL => 0x00000004
, SQL_SP_MATCH_FULL => 0x00000008
, SQL_SP_MATCH_PARTIAL => 0x00000010
, SQL_SP_MATCH_UNIQUE_FULL => 0x00000020
, SQL_SP_MATCH_UNIQUE_PARTIAL => 0x00000040
, SQL_SP_OVERLAPS => 0x00000080
, SQL_SP_UNIQUE => 0x00000100
, SQL_SP_LIKE => 0x00000200
, SQL_SP_IN => 0x00000400
, SQL_SP_BETWEEN => 0x00000800
, SQL_SP_COMPARISON => 0x00001000
, SQL_SP_QUANTIFIED_COMPARISON => 0x00002000
};
$ReturnValues{SQL_SQL92_RELATIONAL_JOIN_OPERATORS} =
{
SQL_SRJO_CORRESPONDING_CLAUSE => 0x00000001
, SQL_SRJO_CROSS_JOIN => 0x00000002
, SQL_SRJO_EXCEPT_JOIN => 0x00000004
, SQL_SRJO_FULL_OUTER_JOIN => 0x00000008
, SQL_SRJO_INNER_JOIN => 0x00000010
, SQL_SRJO_INTERSECT_JOIN => 0x00000020
, SQL_SRJO_LEFT_OUTER_JOIN => 0x00000040
, SQL_SRJO_NATURAL_JOIN => 0x00000080
, SQL_SRJO_RIGHT_OUTER_JOIN => 0x00000100
, SQL_SRJO_UNION_JOIN => 0x00000200
};
$ReturnValues{SQL_SQL92_REVOKE} =
{
SQL_SR_USAGE_ON_DOMAIN => 0x00000001
, SQL_SR_USAGE_ON_CHARACTER_SET => 0x00000002
, SQL_SR_USAGE_ON_COLLATION => 0x00000004
, SQL_SR_USAGE_ON_TRANSLATION => 0x00000008
, SQL_SR_GRANT_OPTION_FOR => 0x00000010
, SQL_SR_CASCADE => 0x00000020
, SQL_SR_RESTRICT => 0x00000040
, SQL_SR_DELETE_TABLE => 0x00000080
, SQL_SR_INSERT_TABLE => 0x00000100
, SQL_SR_INSERT_COLUMN => 0x00000200
, SQL_SR_REFERENCES_TABLE => 0x00000400
, SQL_SR_REFERENCES_COLUMN => 0x00000800
, SQL_SR_SELECT_TABLE => 0x00001000
, SQL_SR_UPDATE_TABLE => 0x00002000
, SQL_SR_UPDATE_COLUMN => 0x00004000
};
$ReturnValues{SQL_SQL92_ROW_VALUE_CONSTRUCTOR} =
{
SQL_SRVC_VALUE_EXPRESSION => 0x00000001
, SQL_SRVC_NULL => 0x00000002
, SQL_SRVC_DEFAULT => 0x00000004
, SQL_SRVC_ROW_SUBQUERY => 0x00000008
};
$ReturnValues{SQL_SQL92_STRING_FUNCTIONS} =
{
SQL_SSF_CONVERT => 0x00000001
, SQL_SSF_LOWER => 0x00000002
, SQL_SSF_UPPER => 0x00000004
, SQL_SSF_SUBSTRING => 0x00000008
, SQL_SSF_TRANSLATE => 0x00000010
, SQL_SSF_TRIM_BOTH => 0x00000020
, SQL_SSF_TRIM_LEADING => 0x00000040
, SQL_SSF_TRIM_TRAILING => 0x00000080
};
$ReturnValues{SQL_SQL92_VALUE_EXPRESSIONS} =
{
SQL_SVE_CASE => 0x00000001
, SQL_SVE_CAST => 0x00000002
, SQL_SVE_COALESCE => 0x00000004
, SQL_SVE_NULLIF => 0x00000008
};
$ReturnValues{SQL_SQL_CONFORMANCE} =
{
SQL_SC_SQL92_ENTRY => 0x00000001
, SQL_SC_FIPS127_2_TRANSITIONAL => 0x00000002
, SQL_SC_SQL92_INTERMEDIATE => 0x00000004
, SQL_SC_SQL92_FULL => 0x00000008
};
$ReturnValues{SQL_STANDARD_CLI_CONFORMANCE} =
{
SQL_SCC_XOPEN_CLI_VERSION1 => 0x00000001
, SQL_SCC_ISO92_CLI => 0x00000002
};
$ReturnValues{SQL_STATIC_SENSITIVITY} =
{
SQL_SS_ADDITIONS => 0x00000001
, SQL_SS_DELETIONS => 0x00000002
, SQL_SS_UPDATES => 0x00000004
};
$ReturnValues{SQL_STRING_FUNCTIONS} =
{
SQL_FN_STR_CONCAT => 0x00000001
, SQL_FN_STR_INSERT => 0x00000002
, SQL_FN_STR_LEFT => 0x00000004
, SQL_FN_STR_LTRIM => 0x00000008
, SQL_FN_STR_LENGTH => 0x00000010
, SQL_FN_STR_LOCATE => 0x00000020
, SQL_FN_STR_LCASE => 0x00000040
, SQL_FN_STR_REPEAT => 0x00000080
, SQL_FN_STR_REPLACE => 0x00000100
, SQL_FN_STR_RIGHT => 0x00000200
, SQL_FN_STR_RTRIM => 0x00000400
, SQL_FN_STR_SUBSTRING => 0x00000800
, SQL_FN_STR_UCASE => 0x00001000
, SQL_FN_STR_ASCII => 0x00002000
, SQL_FN_STR_CHAR => 0x00004000
, SQL_FN_STR_DIFFERENCE => 0x00008000
, SQL_FN_STR_LOCATE_2 => 0x00010000
, SQL_FN_STR_SOUNDEX => 0x00020000
, SQL_FN_STR_SPACE => 0x00040000
, SQL_FN_STR_BIT_LENGTH => 0x00080000
, SQL_FN_STR_CHAR_LENGTH => 0x00100000
, SQL_FN_STR_CHARACTER_LENGTH => 0x00200000
, SQL_FN_STR_OCTET_LENGTH => 0x00400000
, SQL_FN_STR_POSITION => 0x00800000
};
$ReturnValues{SQL_SUBQUERIES} =
{
SQL_SQ_COMPARISON => 0x00000001
, SQL_SQ_EXISTS => 0x00000002
, SQL_SQ_IN => 0x00000004
, SQL_SQ_QUANTIFIED => 0x00000008
, SQL_SQ_CORRELATED_SUBQUERIES => 0x00000010
};
$ReturnValues{SQL_SYSTEM_FUNCTIONS} =
{
SQL_FN_SYS_USERNAME => 0x00000001
, SQL_FN_SYS_DBNAME => 0x00000002
, SQL_FN_SYS_IFNULL => 0x00000004
};
$ReturnValues{SQL_TIMEDATE_ADD_INTERVALS} =
{
SQL_FN_TSI_FRAC_SECOND => 0x00000001
, SQL_FN_TSI_SECOND => 0x00000002
, SQL_FN_TSI_MINUTE => 0x00000004
, SQL_FN_TSI_HOUR => 0x00000008
, SQL_FN_TSI_DAY => 0x00000010
, SQL_FN_TSI_WEEK => 0x00000020
, SQL_FN_TSI_MONTH => 0x00000040
, SQL_FN_TSI_QUARTER => 0x00000080
, SQL_FN_TSI_YEAR => 0x00000100
};
$ReturnValues{SQL_TIMEDATE_FUNCTIONS} =
{
SQL_FN_TD_NOW => 0x00000001
, SQL_FN_TD_CURDATE => 0x00000002
, SQL_FN_TD_DAYOFMONTH => 0x00000004
, SQL_FN_TD_DAYOFWEEK => 0x00000008
, SQL_FN_TD_DAYOFYEAR => 0x00000010
, SQL_FN_TD_MONTH => 0x00000020
, SQL_FN_TD_QUARTER => 0x00000040
, SQL_FN_TD_WEEK => 0x00000080
, SQL_FN_TD_YEAR => 0x00000100
, SQL_FN_TD_CURTIME => 0x00000200
, SQL_FN_TD_HOUR => 0x00000400
, SQL_FN_TD_MINUTE => 0x00000800
, SQL_FN_TD_SECOND => 0x00001000
, SQL_FN_TD_TIMESTAMPADD => 0x00002000
, SQL_FN_TD_TIMESTAMPDIFF => 0x00004000
, SQL_FN_TD_DAYNAME => 0x00008000
, SQL_FN_TD_MONTHNAME => 0x00010000
, SQL_FN_TD_CURRENT_DATE => 0x00020000
, SQL_FN_TD_CURRENT_TIME => 0x00040000
, SQL_FN_TD_CURRENT_TIMESTAMP => 0x00080000
, SQL_FN_TD_EXTRACT => 0x00100000
};
$ReturnValues{SQL_TXN_CAPABLE} =
{
SQL_TC_NONE => 0
, SQL_TC_DML => 1
, SQL_TC_ALL => 2
, SQL_TC_DDL_COMMIT => 3
, SQL_TC_DDL_IGNORE => 4
};
$ReturnValues{SQL_TRANSACTION_ISOLATION_OPTION} =
{
SQL_TRANSACTION_READ_UNCOMMITTED => 0x00000001 # SQL_TXN_READ_UNCOMMITTED
, SQL_TRANSACTION_READ_COMMITTED => 0x00000002 # SQL_TXN_READ_COMMITTED
, SQL_TRANSACTION_REPEATABLE_READ => 0x00000004 # SQL_TXN_REPEATABLE_READ
, SQL_TRANSACTION_SERIALIZABLE => 0x00000008 # SQL_TXN_SERIALIZABLE
};
$ReturnValues{SQL_DEFAULT_TRANSACTION_ISOLATION} = $ReturnValues{SQL_TRANSACTION_ISOLATION_OPTION};
$ReturnValues{SQL_TXN_ISOLATION_OPTION} =
{
SQL_TXN_READ_UNCOMMITTED => 0x00000001
, SQL_TXN_READ_COMMITTED => 0x00000002
, SQL_TXN_REPEATABLE_READ => 0x00000004
, SQL_TXN_SERIALIZABLE => 0x00000008
};
$ReturnValues{SQL_DEFAULT_TXN_ISOLATION} = $ReturnValues{SQL_TXN_ISOLATION_OPTION};
$ReturnValues{SQL_TXN_VERSIONING} =
{
SQL_TXN_VERSIONING => 0x00000010
};
$ReturnValues{SQL_UNION} =
{
SQL_U_UNION => 0x00000001
, SQL_U_UNION_ALL => 0x00000002
};
$ReturnValues{SQL_UNION_STATEMENT} =
{
SQL_US_UNION => 0x00000001 # SQL_U_UNION
, SQL_US_UNION_ALL => 0x00000002 # SQL_U_UNION_ALL
};
1;
=head1 TODO
Corrections?
SQL_NULL_COLLATION: ODBC vs ANSI
Unique values for $ReturnValues{...}?, e.g. SQL_FILE_USAGE
=cut
PK V`[�ב��% �% Const/GetInfo/ANSI.pmnu �[��� # $Id: ANSI.pm 8696 2007-01-24 23:12:38Z Tim $
#
# Copyright (c) 2002 Tim Bunce Ireland
#
# Constant data describing ANSI CLI info types and return values for the
# SQLGetInfo() method of ODBC.
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
package DBI::Const::GetInfo::ANSI;
our (%InfoTypes,%ReturnTypes,%ReturnValues,);
=head1 NAME
DBI::Const::GetInfo::ANSI - ISO/IEC SQL/CLI Constants for GetInfo
=head1 SYNOPSIS
The API for this module is private and subject to change.
=head1 DESCRIPTION
Information requested by GetInfo().
See: A.1 C header file SQLCLI.H, Page 316, 317.
The API for this module is private and subject to change.
=head1 REFERENCES
ISO/IEC FCD 9075-3:200x Information technology - Database Languages -
SQL - Part 3: Call-Level Interface (SQL/CLI)
SC32 N00744 = WG3:VIE-005 = H2-2002-007
Date: 2002-01-15
=cut
my
$VERSION = "2.008697";
%InfoTypes =
(
SQL_ALTER_TABLE => 86
, SQL_CATALOG_NAME => 10003
, SQL_COLLATING_SEQUENCE => 10004
, SQL_CURSOR_COMMIT_BEHAVIOR => 23
, SQL_CURSOR_SENSITIVITY => 10001
, SQL_DATA_SOURCE_NAME => 2
, SQL_DATA_SOURCE_READ_ONLY => 25
, SQL_DBMS_NAME => 17
, SQL_DBMS_VERSION => 18
, SQL_DEFAULT_TRANSACTION_ISOLATION => 26
, SQL_DESCRIBE_PARAMETER => 10002
, SQL_FETCH_DIRECTION => 8
, SQL_GETDATA_EXTENSIONS => 81
, SQL_IDENTIFIER_CASE => 28
, SQL_INTEGRITY => 73
, SQL_MAXIMUM_CATALOG_NAME_LENGTH => 34
, SQL_MAXIMUM_COLUMNS_IN_GROUP_BY => 97
, SQL_MAXIMUM_COLUMNS_IN_ORDER_BY => 99
, SQL_MAXIMUM_COLUMNS_IN_SELECT => 100
, SQL_MAXIMUM_COLUMNS_IN_TABLE => 101
, SQL_MAXIMUM_COLUMN_NAME_LENGTH => 30
, SQL_MAXIMUM_CONCURRENT_ACTIVITIES => 1
, SQL_MAXIMUM_CURSOR_NAME_LENGTH => 31
, SQL_MAXIMUM_DRIVER_CONNECTIONS => 0
, SQL_MAXIMUM_IDENTIFIER_LENGTH => 10005
, SQL_MAXIMUM_SCHEMA_NAME_LENGTH => 32
, SQL_MAXIMUM_STMT_OCTETS => 20000
, SQL_MAXIMUM_STMT_OCTETS_DATA => 20001
, SQL_MAXIMUM_STMT_OCTETS_SCHEMA => 20002
, SQL_MAXIMUM_TABLES_IN_SELECT => 106
, SQL_MAXIMUM_TABLE_NAME_LENGTH => 35
, SQL_MAXIMUM_USER_NAME_LENGTH => 107
, SQL_NULL_COLLATION => 85
, SQL_ORDER_BY_COLUMNS_IN_SELECT => 90
, SQL_OUTER_JOIN_CAPABILITIES => 115
, SQL_SCROLL_CONCURRENCY => 43
, SQL_SEARCH_PATTERN_ESCAPE => 14
, SQL_SERVER_NAME => 13
, SQL_SPECIAL_CHARACTERS => 94
, SQL_TRANSACTION_CAPABLE => 46
, SQL_TRANSACTION_ISOLATION_OPTION => 72
, SQL_USER_NAME => 47
);
=head2 %ReturnTypes
See: Codes and data types for implementation information (Table 28), Page 85, 86.
Mapped to ODBC datatype names.
=cut
%ReturnTypes = # maxlen
(
SQL_ALTER_TABLE => 'SQLUINTEGER bitmask' # INTEGER
, SQL_CATALOG_NAME => 'SQLCHAR' # CHARACTER (1)
, SQL_COLLATING_SEQUENCE => 'SQLCHAR' # CHARACTER (254)
, SQL_CURSOR_COMMIT_BEHAVIOR => 'SQLUSMALLINT' # SMALLINT
, SQL_CURSOR_SENSITIVITY => 'SQLUINTEGER' # INTEGER
, SQL_DATA_SOURCE_NAME => 'SQLCHAR' # CHARACTER (128)
, SQL_DATA_SOURCE_READ_ONLY => 'SQLCHAR' # CHARACTER (1)
, SQL_DBMS_NAME => 'SQLCHAR' # CHARACTER (254)
, SQL_DBMS_VERSION => 'SQLCHAR' # CHARACTER (254)
, SQL_DEFAULT_TRANSACTION_ISOLATION => 'SQLUINTEGER' # INTEGER
, SQL_DESCRIBE_PARAMETER => 'SQLCHAR' # CHARACTER (1)
, SQL_FETCH_DIRECTION => 'SQLUINTEGER bitmask' # INTEGER
, SQL_GETDATA_EXTENSIONS => 'SQLUINTEGER bitmask' # INTEGER
, SQL_IDENTIFIER_CASE => 'SQLUSMALLINT' # SMALLINT
, SQL_INTEGRITY => 'SQLCHAR' # CHARACTER (1)
, SQL_MAXIMUM_CATALOG_NAME_LENGTH => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_COLUMNS_IN_GROUP_BY => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_COLUMNS_IN_ORDER_BY => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_COLUMNS_IN_SELECT => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_COLUMNS_IN_TABLE => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_COLUMN_NAME_LENGTH => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_CONCURRENT_ACTIVITIES => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_CURSOR_NAME_LENGTH => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_DRIVER_CONNECTIONS => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_IDENTIFIER_LENGTH => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_SCHEMA_NAME_LENGTH => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_STMT_OCTETS => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_STMT_OCTETS_DATA => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_STMT_OCTETS_SCHEMA => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_TABLES_IN_SELECT => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_TABLE_NAME_LENGTH => 'SQLUSMALLINT' # SMALLINT
, SQL_MAXIMUM_USER_NAME_LENGTH => 'SQLUSMALLINT' # SMALLINT
, SQL_NULL_COLLATION => 'SQLUSMALLINT' # SMALLINT
, SQL_ORDER_BY_COLUMNS_IN_SELECT => 'SQLCHAR' # CHARACTER (1)
, SQL_OUTER_JOIN_CAPABILITIES => 'SQLUINTEGER bitmask' # INTEGER
, SQL_SCROLL_CONCURRENCY => 'SQLUINTEGER bitmask' # INTEGER
, SQL_SEARCH_PATTERN_ESCAPE => 'SQLCHAR' # CHARACTER (1)
, SQL_SERVER_NAME => 'SQLCHAR' # CHARACTER (128)
, SQL_SPECIAL_CHARACTERS => 'SQLCHAR' # CHARACTER (254)
, SQL_TRANSACTION_CAPABLE => 'SQLUSMALLINT' # SMALLINT
, SQL_TRANSACTION_ISOLATION_OPTION => 'SQLUINTEGER bitmask' # INTEGER
, SQL_USER_NAME => 'SQLCHAR' # CHARACTER (128)
);
=head2 %ReturnValues
See: A.1 C header file SQLCLI.H, Page 317, 318.
=cut
$ReturnValues{SQL_ALTER_TABLE} =
{
SQL_AT_ADD_COLUMN => 0x00000001
, SQL_AT_DROP_COLUMN => 0x00000002
, SQL_AT_ALTER_COLUMN => 0x00000004
, SQL_AT_ADD_CONSTRAINT => 0x00000008
, SQL_AT_DROP_CONSTRAINT => 0x00000010
};
$ReturnValues{SQL_CURSOR_COMMIT_BEHAVIOR} =
{
SQL_CB_DELETE => 0
, SQL_CB_CLOSE => 1
, SQL_CB_PRESERVE => 2
};
$ReturnValues{SQL_FETCH_DIRECTION} =
{
SQL_FD_FETCH_NEXT => 0x00000001
, SQL_FD_FETCH_FIRST => 0x00000002
, SQL_FD_FETCH_LAST => 0x00000004
, SQL_FD_FETCH_PRIOR => 0x00000008
, SQL_FD_FETCH_ABSOLUTE => 0x00000010
, SQL_FD_FETCH_RELATIVE => 0x00000020
};
$ReturnValues{SQL_GETDATA_EXTENSIONS} =
{
SQL_GD_ANY_COLUMN => 0x00000001
, SQL_GD_ANY_ORDER => 0x00000002
};
$ReturnValues{SQL_IDENTIFIER_CASE} =
{
SQL_IC_UPPER => 1
, SQL_IC_LOWER => 2
, SQL_IC_SENSITIVE => 3
, SQL_IC_MIXED => 4
};
$ReturnValues{SQL_NULL_COLLATION} =
{
SQL_NC_HIGH => 1
, SQL_NC_LOW => 2
};
$ReturnValues{SQL_OUTER_JOIN_CAPABILITIES} =
{
SQL_OUTER_JOIN_LEFT => 0x00000001
, SQL_OUTER_JOIN_RIGHT => 0x00000002
, SQL_OUTER_JOIN_FULL => 0x00000004
, SQL_OUTER_JOIN_NESTED => 0x00000008
, SQL_OUTER_JOIN_NOT_ORDERED => 0x00000010
, SQL_OUTER_JOIN_INNER => 0x00000020
, SQL_OUTER_JOIN_ALL_COMPARISON_OPS => 0x00000040
};
$ReturnValues{SQL_SCROLL_CONCURRENCY} =
{
SQL_SCCO_READ_ONLY => 0x00000001
, SQL_SCCO_LOCK => 0x00000002
, SQL_SCCO_OPT_ROWVER => 0x00000004
, SQL_SCCO_OPT_VALUES => 0x00000008
};
$ReturnValues{SQL_TRANSACTION_ACCESS_MODE} =
{
SQL_TRANSACTION_READ_ONLY => 0x00000001
, SQL_TRANSACTION_READ_WRITE => 0x00000002
};
$ReturnValues{SQL_TRANSACTION_CAPABLE} =
{
SQL_TC_NONE => 0
, SQL_TC_DML => 1
, SQL_TC_ALL => 2
, SQL_TC_DDL_COMMIT => 3
, SQL_TC_DDL_IGNORE => 4
};
$ReturnValues{SQL_TRANSACTION_ISOLATION} =
{
SQL_TRANSACTION_READ_UNCOMMITTED => 0x00000001
, SQL_TRANSACTION_READ_COMMITTED => 0x00000002
, SQL_TRANSACTION_REPEATABLE_READ => 0x00000004
, SQL_TRANSACTION_SERIALIZABLE => 0x00000008
};
1;
=head1 TODO
Corrections, e.g.:
SQL_TRANSACTION_ISOLATION_OPTION vs. SQL_TRANSACTION_ISOLATION
=cut
PK V`[]� � � Const/GetInfoReturn.pmnu �[��� # $Id: GetInfoReturn.pm 8696 2007-01-24 23:12:38Z Tim $
#
# Copyright (c) 2002 Tim Bunce Ireland
#
# Constant data describing return values from the DBI getinfo function.
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
package DBI::Const::GetInfoReturn;
use strict;
use Exporter ();
use vars qw(@ISA @EXPORT @EXPORT_OK %GetInfoReturnTypes %GetInfoReturnValues);
@ISA = qw(Exporter);
@EXPORT = qw(%GetInfoReturnTypes %GetInfoReturnValues);
my
$VERSION = "2.008697";
=head1 NAME
DBI::Const::GetInfoReturn - Data and functions for describing GetInfo results
=head1 SYNOPSIS
The interface to this module is undocumented and liable to change.
=head1 DESCRIPTION
Data and functions for describing GetInfo results
=cut
use DBI::Const::GetInfoType;
use DBI::Const::GetInfo::ANSI ();
use DBI::Const::GetInfo::ODBC ();
%GetInfoReturnTypes =
(
%DBI::Const::GetInfo::ANSI::ReturnTypes
, %DBI::Const::GetInfo::ODBC::ReturnTypes
);
%GetInfoReturnValues = ();
{
my $A = \%DBI::Const::GetInfo::ANSI::ReturnValues;
my $O = \%DBI::Const::GetInfo::ODBC::ReturnValues;
while ( my ($k, $v) = each %$A ) {
my %h = ( exists $O->{$k} ) ? ( %$v, %{$O->{$k}} ) : %$v;
$GetInfoReturnValues{$k} = \%h;
}
while ( my ($k, $v) = each %$O ) {
next if exists $A->{$k};
my %h = %$v;
$GetInfoReturnValues{$k} = \%h;
}
}
# -----------------------------------------------------------------------------
sub Format {
my $InfoType = shift;
my $Value = shift;
return '' unless defined $Value;
my $ReturnType = $GetInfoReturnTypes{$InfoType};
return sprintf '0x%08X', $Value if $ReturnType eq 'SQLUINTEGER bitmask';
return sprintf '0x%08X', $Value if $ReturnType eq 'SQLINTEGER bitmask';
# return '"' . $Value . '"' if $ReturnType eq 'SQLCHAR';
return $Value;
}
sub Explain {
my $InfoType = shift;
my $Value = shift;
return '' unless defined $Value;
return '' unless exists $GetInfoReturnValues{$InfoType};
$Value = int $Value;
my $ReturnType = $GetInfoReturnTypes{$InfoType};
my %h = reverse %{$GetInfoReturnValues{$InfoType}};
if ( $ReturnType eq 'SQLUINTEGER bitmask'|| $ReturnType eq 'SQLINTEGER bitmask') {
my @a = ();
for my $k ( sort { $a <=> $b } keys %h ) {
push @a, $h{$k} if $Value & $k;
}
return wantarray ? @a : join(' ', @a );
}
else {
return $h{$Value} ||'?';
}
}
1;
PK V`[3�/�Ɩ Ɩ PurePerl.pmnu �[��� ########################################################################
package # hide from PAUSE
DBI;
# vim: ts=8:sw=4
########################################################################
#
# Copyright (c) 2002,2003 Tim Bunce Ireland.
#
# See COPYRIGHT section in DBI.pm for usage and distribution rights.
#
########################################################################
#
# Please send patches and bug reports to
#
# Jeff Zucker <jeff@vpservices.com> with cc to <dbi-dev@perl.org>
#
########################################################################
use strict;
use Carp;
require Symbol;
require utf8;
*utf8::is_utf8 = sub { # hack for perl 5.6
require bytes;
return unless defined $_[0];
return !(length($_[0]) == bytes::length($_[0]))
} unless defined &utf8::is_utf8;
$DBI::PurePerl = $ENV{DBI_PUREPERL} || 1;
$DBI::PurePerl::VERSION = "2.014286";
$DBI::neat_maxlen ||= 400;
$DBI::tfh = Symbol::gensym();
open $DBI::tfh, ">&STDERR" or warn "Can't dup STDERR: $!";
select( (select($DBI::tfh), $| = 1)[0] ); # autoflush
# check for weaken support, used by ChildHandles
my $HAS_WEAKEN = eval {
require Scalar::Util;
# this will croak() if this Scalar::Util doesn't have a working weaken().
Scalar::Util::weaken( my $test = [] );
1;
};
%DBI::last_method_except = map { $_=>1 } qw(DESTROY _set_fbav set_err);
use constant SQL_ALL_TYPES => 0;
use constant SQL_ARRAY => 50;
use constant SQL_ARRAY_LOCATOR => 51;
use constant SQL_BIGINT => (-5);
use constant SQL_BINARY => (-2);
use constant SQL_BIT => (-7);
use constant SQL_BLOB => 30;
use constant SQL_BLOB_LOCATOR => 31;
use constant SQL_BOOLEAN => 16;
use constant SQL_CHAR => 1;
use constant SQL_CLOB => 40;
use constant SQL_CLOB_LOCATOR => 41;
use constant SQL_DATE => 9;
use constant SQL_DATETIME => 9;
use constant SQL_DECIMAL => 3;
use constant SQL_DOUBLE => 8;
use constant SQL_FLOAT => 6;
use constant SQL_GUID => (-11);
use constant SQL_INTEGER => 4;
use constant SQL_INTERVAL => 10;
use constant SQL_INTERVAL_DAY => 103;
use constant SQL_INTERVAL_DAY_TO_HOUR => 108;
use constant SQL_INTERVAL_DAY_TO_MINUTE => 109;
use constant SQL_INTERVAL_DAY_TO_SECOND => 110;
use constant SQL_INTERVAL_HOUR => 104;
use constant SQL_INTERVAL_HOUR_TO_MINUTE => 111;
use constant SQL_INTERVAL_HOUR_TO_SECOND => 112;
use constant SQL_INTERVAL_MINUTE => 105;
use constant SQL_INTERVAL_MINUTE_TO_SECOND => 113;
use constant SQL_INTERVAL_MONTH => 102;
use constant SQL_INTERVAL_SECOND => 106;
use constant SQL_INTERVAL_YEAR => 101;
use constant SQL_INTERVAL_YEAR_TO_MONTH => 107;
use constant SQL_LONGVARBINARY => (-4);
use constant SQL_LONGVARCHAR => (-1);
use constant SQL_MULTISET => 55;
use constant SQL_MULTISET_LOCATOR => 56;
use constant SQL_NUMERIC => 2;
use constant SQL_REAL => 7;
use constant SQL_REF => 20;
use constant SQL_ROW => 19;
use constant SQL_SMALLINT => 5;
use constant SQL_TIME => 10;
use constant SQL_TIMESTAMP => 11;
use constant SQL_TINYINT => (-6);
use constant SQL_TYPE_DATE => 91;
use constant SQL_TYPE_TIME => 92;
use constant SQL_TYPE_TIMESTAMP => 93;
use constant SQL_TYPE_TIMESTAMP_WITH_TIMEZONE => 95;
use constant SQL_TYPE_TIME_WITH_TIMEZONE => 94;
use constant SQL_UDT => 17;
use constant SQL_UDT_LOCATOR => 18;
use constant SQL_UNKNOWN_TYPE => 0;
use constant SQL_VARBINARY => (-3);
use constant SQL_VARCHAR => 12;
use constant SQL_WCHAR => (-8);
use constant SQL_WLONGVARCHAR => (-10);
use constant SQL_WVARCHAR => (-9);
# for Cursor types
use constant SQL_CURSOR_FORWARD_ONLY => 0;
use constant SQL_CURSOR_KEYSET_DRIVEN => 1;
use constant SQL_CURSOR_DYNAMIC => 2;
use constant SQL_CURSOR_STATIC => 3;
use constant SQL_CURSOR_TYPE_DEFAULT => SQL_CURSOR_FORWARD_ONLY;
use constant IMA_HAS_USAGE => 0x0001; #/* check parameter usage */
use constant IMA_FUNC_REDIRECT => 0x0002; #/* is $h->func(..., "method")*/
use constant IMA_KEEP_ERR => 0x0004; #/* don't reset err & errstr */
use constant IMA_KEEP_ERR_SUB => 0x0008; #/* '' if in nested call */
use constant IMA_NO_TAINT_IN => 0x0010; #/* don't check for tainted args*/
use constant IMA_NO_TAINT_OUT => 0x0020; #/* don't taint results */
use constant IMA_COPY_UP_STMT => 0x0040; #/* copy sth Statement to dbh */
use constant IMA_END_WORK => 0x0080; #/* set on commit & rollback */
use constant IMA_STUB => 0x0100; #/* do nothing eg $dbh->connected */
use constant IMA_CLEAR_STMT => 0x0200; #/* clear Statement before call */
use constant IMA_UNRELATED_TO_STMT=> 0x0400; #/* profile as empty Statement */
use constant IMA_NOT_FOUND_OKAY => 0x0800; #/* not error if not found */
use constant IMA_EXECUTE => 0x1000; #/* do/execute: DBIcf_Executed */
use constant IMA_SHOW_ERR_STMT => 0x2000; #/* dbh meth relates to Statement*/
use constant IMA_HIDE_ERR_PARAMVALUES => 0x4000; #/* ParamValues are not relevant */
use constant IMA_IS_FACTORY => 0x8000; #/* new h ie connect & prepare */
use constant IMA_CLEAR_CACHED_KIDS => 0x10000; #/* clear CachedKids before call */
use constant DBIstcf_STRICT => 0x0001;
use constant DBIstcf_DISCARD_STRING => 0x0002;
my %is_flag_attribute = map {$_ =>1 } qw(
Active
AutoCommit
ChopBlanks
CompatMode
Executed
Taint
TaintIn
TaintOut
InactiveDestroy
AutoInactiveDestroy
LongTruncOk
MultiThread
PrintError
PrintWarn
RaiseError
ShowErrorStatement
Warn
);
my %is_valid_attribute = map {$_ =>1 } (keys %is_flag_attribute, qw(
ActiveKids
Attribution
BegunWork
CachedKids
Callbacks
ChildHandles
CursorName
Database
DebugDispatch
Driver
Err
Errstr
ErrCount
FetchHashKeyName
HandleError
HandleSetErr
ImplementorClass
Kids
LongReadLen
NAME NAME_uc NAME_lc NAME_uc_hash NAME_lc_hash
NULLABLE
NUM_OF_FIELDS
NUM_OF_PARAMS
Name
PRECISION
ParamValues
Profile
Provider
ReadOnly
RootClass
RowCacheSize
RowsInCache
SCALE
State
Statement
TYPE
Type
TraceLevel
Username
Version
));
sub valid_attribute {
my $attr = shift;
return 1 if $is_valid_attribute{$attr};
return 1 if $attr =~ m/^[a-z]/; # starts with lowercase letter
return 0
}
my $initial_setup;
sub initial_setup {
$initial_setup = 1;
print $DBI::tfh __FILE__ . " version " . $DBI::PurePerl::VERSION . "\n"
if $DBI::dbi_debug & 0xF;
untie $DBI::err;
untie $DBI::errstr;
untie $DBI::state;
untie $DBI::rows;
#tie $DBI::lasth, 'DBI::var', '!lasth'; # special case: return boolean
}
sub _install_method {
my ( $caller, $method, $from, $param_hash ) = @_;
initial_setup() unless $initial_setup;
my ($class, $method_name) = $method =~ /^[^:]+::(.+)::(.+)$/;
my $bitmask = $param_hash->{'O'} || 0;
my @pre_call_frag;
return if $method_name eq 'can';
push @pre_call_frag, q{
delete $h->{CachedKids};
# ignore DESTROY for outer handle (DESTROY for inner likely to follow soon)
return if $h_inner;
# handle AutoInactiveDestroy and InactiveDestroy
$h->{InactiveDestroy} = 1
if $h->{AutoInactiveDestroy} and $$ != $h->{dbi_pp_pid};
$h->{Active} = 0
if $h->{InactiveDestroy};
# copy err/errstr/state up to driver so $DBI::err etc still work
if ($h->{err} and my $drh = $h->{Driver}) {
$drh->{$_} = $h->{$_} for ('err','errstr','state');
}
} if $method_name eq 'DESTROY';
push @pre_call_frag, q{
return $h->{$_[0]} if exists $h->{$_[0]};
} if $method_name eq 'FETCH' && !exists $ENV{DBI_TRACE}; # XXX ?
push @pre_call_frag, "return;"
if IMA_STUB & $bitmask;
push @pre_call_frag, q{
$method_name = pop @_;
} if IMA_FUNC_REDIRECT & $bitmask;
push @pre_call_frag, q{
my $parent_dbh = $h->{Database};
} if (IMA_COPY_UP_STMT|IMA_EXECUTE) & $bitmask;
push @pre_call_frag, q{
warn "No Database set for $h on $method_name!" unless $parent_dbh; # eg proxy problems
$parent_dbh->{Statement} = $h->{Statement} if $parent_dbh;
} if IMA_COPY_UP_STMT & $bitmask;
push @pre_call_frag, q{
$h->{Executed} = 1;
$parent_dbh->{Executed} = 1 if $parent_dbh;
} if IMA_EXECUTE & $bitmask;
push @pre_call_frag, q{
%{ $h->{CachedKids} } = () if $h->{CachedKids};
} if IMA_CLEAR_CACHED_KIDS & $bitmask;
if (IMA_KEEP_ERR & $bitmask) {
push @pre_call_frag, q{
my $keep_error = DBI::_err_hash($h);
};
}
else {
my $ke_init = (IMA_KEEP_ERR_SUB & $bitmask)
? q{= ($h->{dbi_pp_parent}->{dbi_pp_call_depth} && DBI::_err_hash($h)) }
: "";
push @pre_call_frag, qq{
my \$keep_error $ke_init;
};
my $clear_error_code = q{
#warn "$method_name cleared err";
$h->{err} = $DBI::err = undef;
$h->{errstr} = $DBI::errstr = undef;
$h->{state} = $DBI::state = '';
};
$clear_error_code = q{
printf $DBI::tfh " !! %s: %s CLEARED by call to }.$method_name.q{ method\n".
$h->{err}, $h->{err}
if defined $h->{err} && $DBI::dbi_debug & 0xF;
}. $clear_error_code
if exists $ENV{DBI_TRACE};
push @pre_call_frag, ($ke_init)
? qq{ unless (\$keep_error) { $clear_error_code }}
: $clear_error_code
unless $method_name eq 'set_err';
}
push @pre_call_frag, q{
my $ErrCount = $h->{ErrCount};
};
push @pre_call_frag, q{
if (($DBI::dbi_debug & 0xF) >= 2) {
local $^W;
my $args = join " ", map { DBI::neat($_) } ($h, @_);
printf $DBI::tfh " > $method_name in $imp ($args) [$@]\n";
}
} if exists $ENV{DBI_TRACE}; # note use of 'exists'
push @pre_call_frag, q{
$h->{'dbi_pp_last_method'} = $method_name;
} unless exists $DBI::last_method_except{$method_name};
# --- post method call code fragments ---
my @post_call_frag;
push @post_call_frag, q{
if (my $trace_level = ($DBI::dbi_debug & 0xF)) {
if ($h->{err}) {
printf $DBI::tfh " !! ERROR: %s %s\n", $h->{err}, $h->{errstr};
}
my $ret = join " ", map { DBI::neat($_) } @ret;
my $msg = " < $method_name= $ret";
$msg = ($trace_level >= 2) ? Carp::shortmess($msg) : "$msg\n";
print $DBI::tfh $msg;
}
} if exists $ENV{DBI_TRACE}; # note use of exists
push @post_call_frag, q{
$h->{Executed} = 0;
if ($h->{BegunWork}) {
$h->{BegunWork} = 0;
$h->{AutoCommit} = 1;
}
} if IMA_END_WORK & $bitmask;
push @post_call_frag, q{
if ( ref $ret[0] and
UNIVERSAL::isa($ret[0], 'DBI::_::common') and
defined( (my $h_new = tied(%{$ret[0]})||$ret[0])->{err} )
) {
# copy up info/warn to drh so PrintWarn on connect is triggered
$h->set_err($h_new->{err}, $h_new->{errstr}, $h_new->{state})
}
} if IMA_IS_FACTORY & $bitmask;
push @post_call_frag, q{
if ($keep_error) {
$keep_error = 0
if $h->{ErrCount} > $ErrCount
or DBI::_err_hash($h) ne $keep_error;
}
$DBI::err = $h->{err};
$DBI::errstr = $h->{errstr};
$DBI::state = $h->{state};
if ( !$keep_error
&& defined(my $err = $h->{err})
&& ($call_depth <= 1 && !$h->{dbi_pp_parent}{dbi_pp_call_depth})
) {
my($pe,$pw,$re,$he) = @{$h}{qw(PrintError PrintWarn RaiseError HandleError)};
my $msg;
if ($err && ($pe || $re || $he) # error
or (!$err && length($err) && $pw) # warning
) {
my $last = ($DBI::last_method_except{$method_name})
? ($h->{'dbi_pp_last_method'}||$method_name) : $method_name;
my $errstr = $h->{errstr} || $DBI::errstr || $err || '';
my $msg = sprintf "%s %s %s: %s", $imp, $last,
($err eq "0") ? "warning" : "failed", $errstr;
if ($h->{'ShowErrorStatement'} and my $Statement = $h->{Statement}) {
$msg .= ' [for Statement "' . $Statement;
if (my $ParamValues = $h->FETCH('ParamValues')) {
$msg .= '" with ParamValues: ';
$msg .= DBI::_concat_hash_sorted($ParamValues, "=", ", ", 1, undef);
$msg .= "]";
}
else {
$msg .= '"]';
}
}
if ($err eq "0") { # is 'warning' (not info)
carp $msg if $pw;
}
else {
my $do_croak = 1;
if (my $subsub = $h->{'HandleError'}) {
$do_croak = 0 if &$subsub($msg,$h,$ret[0]);
}
if ($do_croak) {
printf $DBI::tfh " $method_name has failed ($h->{PrintError},$h->{RaiseError})\n"
if ($DBI::dbi_debug & 0xF) >= 4;
carp $msg if $pe;
die $msg if $h->{RaiseError};
}
}
}
}
};
my $method_code = q[
sub {
my $h = shift;
my $h_inner = tied(%$h);
$h = $h_inner if $h_inner;
my $imp;
if ($method_name eq 'DESTROY') {
# during global destruction, $h->{...} can trigger "Can't call FETCH on an undef value"
# implying that tied() above lied to us, so we need to use eval
local $@; # protect $@
$imp = eval { $h->{"ImplementorClass"} } or return; # probably global destruction
}
else {
$imp = $h->{"ImplementorClass"} or do {
warn "Can't call $method_name method on handle $h after take_imp_data()\n"
if not exists $h->{Active};
return; # or, more likely, global destruction
};
}
] . join("\n", '', @pre_call_frag, '') . q[
my $call_depth = $h->{'dbi_pp_call_depth'} + 1;
local ($h->{'dbi_pp_call_depth'}) = $call_depth;
my @ret;
my $sub = $imp->can($method_name);
if (!$sub and IMA_FUNC_REDIRECT & $bitmask and $sub = $imp->can('func')) {
push @_, $method_name;
}
if ($sub) {
(wantarray) ? (@ret = &$sub($h,@_)) : (@ret = scalar &$sub($h,@_));
}
else {
# XXX could try explicit fallback to $imp->can('AUTOLOAD') etc
# which would then let Multiplex pass PurePerl tests, but some
# hook into install_method may be better.
croak "Can't locate DBI object method \"$method_name\" via package \"$imp\""
if ] . ((IMA_NOT_FOUND_OKAY & $bitmask) ? 0 : 1) . q[;
}
] . join("\n", '', @post_call_frag, '') . q[
return (wantarray) ? @ret : $ret[0];
}
];
no strict qw(refs);
my $code_ref = eval qq{#line 1 "DBI::PurePerl $method"\n$method_code};
warn "$@\n$method_code\n" if $@;
die "$@\n$method_code\n" if $@;
*$method = $code_ref;
if (0 && $method =~ /\b(connect|FETCH)\b/) { # debuging tool
my $l=0; # show line-numbered code for method
warn "*$method code:\n".join("\n", map { ++$l.": $_" } split/\n/,$method_code);
}
}
sub _new_handle {
my ($class, $parent, $attr, $imp_data, $imp_class) = @_;
DBI->trace_msg(" New $class (for $imp_class, parent=$parent, id=".($imp_data||'').")\n")
if $DBI::dbi_debug >= 3;
$attr->{ImplementorClass} = $imp_class
or Carp::croak("_new_handle($class): 'ImplementorClass' attribute not given");
# This is how we create a DBI style Object:
# %outer gets tied to %$attr (which becomes the 'inner' handle)
my (%outer, $i, $h);
$i = tie %outer, $class, $attr; # ref to inner hash (for driver)
$h = bless \%outer, $class; # ref to outer hash (for application)
# The above tie and bless may migrate down into _setup_handle()...
# Now add magic so DBI method dispatch works
DBI::_setup_handle($h, $imp_class, $parent, $imp_data);
return $h unless wantarray;
return ($h, $i);
}
sub _setup_handle {
my($h, $imp_class, $parent, $imp_data) = @_;
my $h_inner = tied(%$h) || $h;
if (($DBI::dbi_debug & 0xF) >= 4) {
local $^W;
print $DBI::tfh " _setup_handle(@_)\n";
}
$h_inner->{"imp_data"} = $imp_data;
$h_inner->{"ImplementorClass"} = $imp_class;
$h_inner->{"Kids"} = $h_inner->{"ActiveKids"} = 0; # XXX not maintained
if ($parent) {
foreach (qw(
RaiseError PrintError PrintWarn HandleError HandleSetErr
Warn LongTruncOk ChopBlanks AutoCommit ReadOnly
ShowErrorStatement FetchHashKeyName LongReadLen CompatMode
)) {
$h_inner->{$_} = $parent->{$_}
if exists $parent->{$_} && !exists $h_inner->{$_};
}
if (ref($parent) =~ /::db$/) { # is sth
$h_inner->{Database} = $parent;
$parent->{Statement} = $h_inner->{Statement};
$h_inner->{NUM_OF_PARAMS} = 0;
$h_inner->{Active} = 0; # driver sets true when there's data to fetch
}
elsif (ref($parent) =~ /::dr$/){ # is dbh
$h_inner->{Driver} = $parent;
$h_inner->{Active} = 0;
}
else {
warn "panic: ".ref($parent); # should never happen
}
$h_inner->{dbi_pp_parent} = $parent;
# add to the parent's ChildHandles
if ($HAS_WEAKEN) {
my $handles = $parent->{ChildHandles} ||= [];
push @$handles, $h;
Scalar::Util::weaken($handles->[-1]);
# purge destroyed handles occasionally
if (@$handles % 120 == 0) {
@$handles = grep { defined } @$handles;
Scalar::Util::weaken($_) for @$handles; # re-weaken after grep
}
}
}
else { # setting up a driver handle
$h_inner->{Warn} = 1;
$h_inner->{PrintWarn} = 1;
$h_inner->{AutoCommit} = 1;
$h_inner->{TraceLevel} = 0;
$h_inner->{CompatMode} = (1==0);
$h_inner->{FetchHashKeyName} ||= 'NAME';
$h_inner->{LongReadLen} ||= 80;
$h_inner->{ChildHandles} ||= [] if $HAS_WEAKEN;
$h_inner->{Type} ||= 'dr';
$h_inner->{Active} = 1;
}
$h_inner->{"dbi_pp_call_depth"} = 0;
$h_inner->{"dbi_pp_pid"} = $$;
$h_inner->{ErrCount} = 0;
}
sub constant {
warn "constant(@_) called unexpectedly"; return undef;
}
sub trace {
my ($h, $level, $file) = @_;
$level = $h->parse_trace_flags($level)
if defined $level and !DBI::looks_like_number($level);
my $old_level = $DBI::dbi_debug;
_set_trace_file($file) if $level;
if (defined $level) {
$DBI::dbi_debug = $level;
print $DBI::tfh " DBI $DBI::VERSION (PurePerl) "
. "dispatch trace level set to $DBI::dbi_debug\n"
if $DBI::dbi_debug & 0xF;
}
_set_trace_file($file) if !$level;
return $old_level;
}
sub _set_trace_file {
my ($file) = @_;
#
# DAA add support for filehandle inputs
#
# DAA required to avoid closing a prior fh trace()
$DBI::tfh = undef unless $DBI::tfh_needs_close;
if (ref $file eq 'GLOB') {
$DBI::tfh = $file;
select((select($DBI::tfh), $| = 1)[0]);
$DBI::tfh_needs_close = 0;
return 1;
}
if ($file && ref \$file eq 'GLOB') {
$DBI::tfh = *{$file}{IO};
select((select($DBI::tfh), $| = 1)[0]);
$DBI::tfh_needs_close = 0;
return 1;
}
$DBI::tfh_needs_close = 1;
if (!$file || $file eq 'STDERR') {
open $DBI::tfh, ">&STDERR" or carp "Can't dup STDERR: $!";
}
elsif ($file eq 'STDOUT') {
open $DBI::tfh, ">&STDOUT" or carp "Can't dup STDOUT: $!";
}
else {
open $DBI::tfh, ">>$file" or carp "Can't open $file: $!";
}
select((select($DBI::tfh), $| = 1)[0]);
return 1;
}
sub _get_imp_data { shift->{"imp_data"}; }
sub _svdump { }
sub dump_handle {
my ($h,$msg,$level) = @_;
$msg||="dump_handle $h";
print $DBI::tfh "$msg:\n";
for my $attrib (sort keys %$h) {
print $DBI::tfh "\t$attrib => ".DBI::neat($h->{$attrib})."\n";
}
}
sub _handles {
my $h = shift;
my $h_inner = tied %$h;
if ($h_inner) { # this is okay
return $h unless wantarray;
return ($h, $h_inner);
}
# XXX this isn't okay... we have an inner handle but
# currently have no way to get at its outer handle,
# so we just warn and return the inner one for both...
Carp::carp("Can't return outer handle from inner handle using DBI::PurePerl");
return $h unless wantarray;
return ($h,$h);
}
sub hash {
my ($key, $type) = @_;
my ($hash);
if (!$type) {
$hash = 0;
# XXX The C version uses the "char" type, which could be either
# signed or unsigned. I use signed because so do the two
# compilers on my system.
for my $char (unpack ("c*", $key)) {
$hash = $hash * 33 + $char;
}
$hash &= 0x7FFFFFFF; # limit to 31 bits
$hash |= 0x40000000; # set bit 31
return -$hash; # return negative int
}
elsif ($type == 1) { # Fowler/Noll/Vo hash
# see http://www.isthe.com/chongo/tech/comp/fnv/
require Math::BigInt; # feel free to reimplement w/o BigInt!
(my $version = $Math::BigInt::VERSION || 0) =~ s/_.*//; # eg "1.70_01"
if ($version >= 1.56) {
$hash = Math::BigInt->new(0x811c9dc5);
for my $uchar (unpack ("C*", $key)) {
# multiply by the 32 bit FNV magic prime mod 2^64
$hash = ($hash * 0x01000193) & 0xffffffff;
# xor the bottom with the current octet
$hash ^= $uchar;
}
# cast to int
return unpack "i", pack "i", $hash;
}
croak("DBI::PurePerl doesn't support hash type 1 without Math::BigInt >= 1.56 (available on CPAN)");
}
else {
croak("bad hash type $type");
}
}
sub looks_like_number {
my @new = ();
for my $thing(@_) {
if (!defined $thing or $thing eq '') {
push @new, undef;
}
else {
push @new, ($thing =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/) ? 1 : 0;
}
}
return (@_ >1) ? @new : $new[0];
}
sub neat {
my $v = shift;
return "undef" unless defined $v;
my $quote = q{"};
if (not utf8::is_utf8($v)) {
return $v if (($v & ~ $v) eq "0"); # is SvNIOK
$quote = q{'};
}
my $maxlen = shift || $DBI::neat_maxlen;
if ($maxlen && $maxlen < length($v) + 2) {
$v = substr($v,0,$maxlen-5);
$v .= '...';
}
$v =~ s/[^[:print:]]/./g;
return "$quote$v$quote";
}
sub sql_type_cast {
my (undef, $sql_type, $flags) = @_;
return -1 unless defined $_[0];
my $cast_ok = 1;
my $evalret = eval {
use warnings FATAL => qw(numeric);
if ($sql_type == SQL_INTEGER) {
my $dummy = $_[0] + 0;
return 1;
}
elsif ($sql_type == SQL_DOUBLE) {
my $dummy = $_[0] + 0.0;
return 1;
}
elsif ($sql_type == SQL_NUMERIC) {
my $dummy = $_[0] + 0.0;
return 1;
}
else {
return -2;
}
} or $^W && warn $@; # XXX warnings::warnif("numeric", $@) ?
return $evalret if defined($evalret) && ($evalret == -2);
$cast_ok = 0 unless $evalret;
# DBIstcf_DISCARD_STRING not supported for PurePerl currently
return 2 if $cast_ok;
return 0 if $flags & DBIstcf_STRICT;
return 1;
}
sub dbi_time {
return time();
}
sub DBI::st::TIEHASH { bless $_[1] => $_[0] };
sub _concat_hash_sorted {
my ( $hash_ref, $kv_separator, $pair_separator, $use_neat, $num_sort ) = @_;
# $num_sort: 0=lexical, 1=numeric, undef=try to guess
return undef unless defined $hash_ref;
die "hash is not a hash reference" unless ref $hash_ref eq 'HASH';
my $keys = _get_sorted_hash_keys($hash_ref, $num_sort);
my $string = '';
for my $key (@$keys) {
$string .= $pair_separator if length $string > 0;
my $value = $hash_ref->{$key};
if ($use_neat) {
$value = DBI::neat($value, 0);
}
else {
$value = (defined $value) ? "'$value'" : 'undef';
}
$string .= $key . $kv_separator . $value;
}
return $string;
}
sub _get_sorted_hash_keys {
my ($hash_ref, $num_sort) = @_;
if (not defined $num_sort) {
my $sort_guess = 1;
$sort_guess = (not looks_like_number($_)) ? 0 : $sort_guess
for keys %$hash_ref;
$num_sort = $sort_guess;
}
my @keys = keys %$hash_ref;
no warnings 'numeric';
my @sorted = ($num_sort)
? sort { $a <=> $b or $a cmp $b } @keys
: sort @keys;
return \@sorted;
}
sub _err_hash {
return 1 unless defined $_[0]->{err};
return "$_[0]->{err} $_[0]->{errstr}"
}
package
DBI::var;
sub FETCH {
my($key)=shift;
return $DBI::err if $$key eq '*err';
return $DBI::errstr if $$key eq '&errstr';
Carp::confess("FETCH $key not supported when using DBI::PurePerl");
}
package
DBD::_::common;
sub swap_inner_handle {
my ($h1, $h2) = @_;
# can't make this work till we can get the outer handle from the inner one
# probably via a WeakRef
return $h1->set_err($DBI::stderr, "swap_inner_handle not currently supported by DBI::PurePerl");
}
sub trace { # XXX should set per-handle level, not global
my ($h, $level, $file) = @_;
$level = $h->parse_trace_flags($level)
if defined $level and !DBI::looks_like_number($level);
my $old_level = $DBI::dbi_debug;
DBI::_set_trace_file($file) if defined $file;
if (defined $level) {
$DBI::dbi_debug = $level;
if ($DBI::dbi_debug) {
printf $DBI::tfh
" %s trace level set to %d in DBI $DBI::VERSION (PurePerl)\n",
$h, $DBI::dbi_debug;
print $DBI::tfh " Full trace not available because DBI_TRACE is not in environment\n"
unless exists $ENV{DBI_TRACE};
}
}
return $old_level;
}
*debug = \&trace; *debug = \&trace; # twice to avoid typo warning
sub FETCH {
my($h,$key)= @_;
my $v = $h->{$key};
#warn ((exists $h->{$key}) ? "$key=$v\n" : "$key NONEXISTANT\n");
return $v if defined $v;
if ($key =~ /^NAME_.c$/) {
my $cols = $h->FETCH('NAME');
return undef unless $cols;
my @lcols = map { lc $_ } @$cols;
$h->{NAME_lc} = \@lcols;
my @ucols = map { uc $_ } @$cols;
$h->{NAME_uc} = \@ucols;
return $h->FETCH($key);
}
if ($key =~ /^NAME.*_hash$/) {
my $i=0;
for my $c(@{$h->FETCH('NAME')||[]}) {
$h->{'NAME_hash'}->{$c} = $i;
$h->{'NAME_lc_hash'}->{"\L$c"} = $i;
$h->{'NAME_uc_hash'}->{"\U$c"} = $i;
$i++;
}
return $h->{$key};
}
if (!defined $v && !exists $h->{$key}) {
return ($h->FETCH('TaintIn') && $h->FETCH('TaintOut')) if $key eq'Taint';
return (1==0) if $is_flag_attribute{$key}; # return perl-style sv_no, not undef
return $DBI::dbi_debug if $key eq 'TraceLevel';
return [] if $key eq 'ChildHandles' && $HAS_WEAKEN;
if ($key eq 'Type') {
return "dr" if $h->isa('DBI::dr');
return "db" if $h->isa('DBI::db');
return "st" if $h->isa('DBI::st');
Carp::carp( sprintf "Can't determine Type for %s",$h );
}
if (!$is_valid_attribute{$key} and $key =~ m/^[A-Z]/) {
local $^W; # hide undef warnings
Carp::carp( sprintf "Can't get %s->{%s}: unrecognised attribute (@{[ %$h ]})",$h,$key )
}
}
return $v;
}
sub STORE {
my ($h,$key,$value) = @_;
if ($key eq 'AutoCommit') {
Carp::croak("DBD driver has not implemented the AutoCommit attribute")
unless $value == -900 || $value == -901;
$value = ($value == -901);
}
elsif ($key =~ /^Taint/ ) {
Carp::croak(sprintf "Can't set %s->{%s}: Taint mode not supported by DBI::PurePerl",$h,$key)
if $value;
}
elsif ($key eq 'TraceLevel') {
$h->trace($value);
return 1;
}
elsif ($key eq 'NUM_OF_FIELDS') {
$h->{$key} = $value;
if ($value) {
my $fbav = DBD::_::st::dbih_setup_fbav($h);
@$fbav = (undef) x $value if @$fbav != $value;
}
return 1;
}
elsif (!$is_valid_attribute{$key} && $key =~ /^[A-Z]/ && !exists $h->{$key}) {
Carp::carp(sprintf "Can't set %s->{%s}: unrecognised attribute or invalid value %s",
$h,$key,$value);
}
$h->{$key} = $is_flag_attribute{$key} ? !!$value : $value;
Scalar::Util::weaken($h->{$key}) if $key eq 'CachedKids';
return 1;
}
sub DELETE {
my ($h, $key) = @_;
return $h->FETCH($key) unless $key =~ /^private_/;
return delete $h->{$key};
}
sub err { return shift->{err} }
sub errstr { return shift->{errstr} }
sub state { return shift->{state} }
sub set_err {
my ($h, $errnum,$msg,$state, $method, $rv) = @_;
$h = tied(%$h) || $h;
if (my $hss = $h->{HandleSetErr}) {
return if $hss->($h, $errnum, $msg, $state, $method);
}
if (!defined $errnum) {
$h->{err} = $DBI::err = undef;
$h->{errstr} = $DBI::errstr = undef;
$h->{state} = $DBI::state = '';
return;
}
if ($h->{errstr}) {
$h->{errstr} .= sprintf " [err was %s now %s]", $h->{err}, $errnum
if $h->{err} && $errnum && $h->{err} ne $errnum;
$h->{errstr} .= sprintf " [state was %s now %s]", $h->{state}, $state
if $h->{state} and $h->{state} ne "S1000" && $state && $h->{state} ne $state;
$h->{errstr} .= "\n$msg" if $h->{errstr} ne $msg;
$DBI::errstr = $h->{errstr};
}
else {
$h->{errstr} = $DBI::errstr = $msg;
}
# assign if higher priority: err > "0" > "" > undef
my $err_changed;
if ($errnum # new error: so assign
or !defined $h->{err} # no existing warn/info: so assign
# new warn ("0" len 1) > info ("" len 0): so assign
or defined $errnum && length($errnum) > length($h->{err})
) {
$h->{err} = $DBI::err = $errnum;
++$h->{ErrCount} if $errnum;
++$err_changed;
}
if ($err_changed) {
$state ||= "S1000" if $DBI::err;
$h->{state} = $DBI::state = ($state eq "00000") ? "" : $state
if $state;
}
if (my $p = $h->{Database}) { # just sth->dbh, not dbh->drh (see ::db::DESTROY)
$p->{err} = $DBI::err;
$p->{errstr} = $DBI::errstr;
$p->{state} = $DBI::state;
}
$h->{'dbi_pp_last_method'} = $method;
return $rv; # usually undef
}
sub trace_msg {
my ($h, $msg, $minlevel)=@_;
$minlevel = 1 unless defined $minlevel;
return unless $minlevel <= ($DBI::dbi_debug & 0xF);
print $DBI::tfh $msg;
return 1;
}
sub private_data {
warn "private_data @_";
}
sub take_imp_data {
my $dbh = shift;
# A reasonable default implementation based on the one in DBI.xs.
# Typically a pure-perl driver would have their own take_imp_data method
# that would delete all but the essential items in the hash before ending with:
# return $dbh->SUPER::take_imp_data();
# Of course it's useless if the driver doesn't also implement support for
# the dbi_imp_data attribute to the connect() method.
require Storable;
croak("Can't take_imp_data from handle that's not Active")
unless $dbh->{Active};
for my $sth (@{ $dbh->{ChildHandles} || [] }) {
next unless $sth;
$sth->finish if $sth->{Active};
bless $sth, 'DBI::zombie';
}
delete $dbh->{$_} for (keys %is_valid_attribute);
delete $dbh->{$_} for grep { m/^dbi_/ } keys %$dbh;
# warn "@{[ %$dbh ]}";
local $Storable::forgive_me = 1; # in case there are some CODE refs
my $imp_data = Storable::freeze($dbh);
# XXX um, should probably untie here - need to check dispatch behaviour
return $imp_data;
}
sub rows {
return -1; # always returns -1 here, see DBD::_::st::rows below
}
sub DESTROY {
}
package
DBD::_::dr;
sub dbixs_revision {
return 0;
}
package
DBD::_::db;
sub connected {
}
package
DBD::_::st;
sub fetchrow_arrayref {
my $h = shift;
# if we're here then driver hasn't implemented fetch/fetchrow_arrayref
# so we assume they've implemented fetchrow_array and call that instead
my @row = $h->fetchrow_array or return;
return $h->_set_fbav(\@row);
}
# twice to avoid typo warning
*fetch = \&fetchrow_arrayref; *fetch = \&fetchrow_arrayref;
sub fetchrow_array {
my $h = shift;
# if we're here then driver hasn't implemented fetchrow_array
# so we assume they've implemented fetch/fetchrow_arrayref
my $row = $h->fetch or return;
return @$row;
}
*fetchrow = \&fetchrow_array; *fetchrow = \&fetchrow_array;
sub fetchrow_hashref {
my $h = shift;
my $row = $h->fetch or return;
my $FetchCase = shift;
my $FetchHashKeyName = $FetchCase || $h->{'FetchHashKeyName'} || 'NAME';
my $FetchHashKeys = $h->FETCH($FetchHashKeyName);
my %rowhash;
@rowhash{ @$FetchHashKeys } = @$row;
return \%rowhash;
}
sub dbih_setup_fbav {
my $h = shift;
return $h->{'_fbav'} || do {
$DBI::rows = $h->{'_rows'} = 0;
my $fields = $h->{'NUM_OF_FIELDS'}
or DBI::croak("NUM_OF_FIELDS not set");
my @row = (undef) x $fields;
\@row;
};
}
sub _get_fbav {
my $h = shift;
my $av = $h->{'_fbav'} ||= dbih_setup_fbav($h);
$DBI::rows = ++$h->{'_rows'};
return $av;
}
sub _set_fbav {
my $h = shift;
my $fbav = $h->{'_fbav'};
if ($fbav) {
$DBI::rows = ++$h->{'_rows'};
}
else {
$fbav = $h->_get_fbav;
}
my $row = shift;
if (my $bc = $h->{'_bound_cols'}) {
for my $i (0..@$row-1) {
my $bound = $bc->[$i];
$fbav->[$i] = ($bound) ? ($$bound = $row->[$i]) : $row->[$i];
}
}
else {
@$fbav = @$row;
}
return $fbav;
}
sub bind_col {
my ($h, $col, $value_ref,$from_bind_columns) = @_;
my $fbav = $h->{'_fbav'} ||= dbih_setup_fbav($h); # from _get_fbav()
my $num_of_fields = @$fbav;
DBI::croak("bind_col: column $col is not a valid column (1..$num_of_fields)")
if $col < 1 or $col > $num_of_fields;
return 1 if not defined $value_ref; # ie caller is just trying to set TYPE
DBI::croak("bind_col($col,$value_ref) needs a reference to a scalar")
unless ref $value_ref eq 'SCALAR';
$h->{'_bound_cols'}->[$col-1] = $value_ref;
return 1;
}
sub finish {
my $h = shift;
$h->{'_fbav'} = undef;
$h->{'Active'} = 0;
return 1;
}
sub rows {
my $h = shift;
my $rows = $h->{'_rows'};
return -1 unless defined $rows;
return $rows;
}
1;
__END__
=pod
=head1 NAME
DBI::PurePerl -- a DBI emulation using pure perl (no C/XS compilation required)
=head1 SYNOPSIS
BEGIN { $ENV{DBI_PUREPERL} = 2 }
use DBI;
=head1 DESCRIPTION
This is a pure perl emulation of the DBI internals. In almost all
cases you will be better off using standard DBI since the portions
of the standard version written in C make it *much* faster.
However, if you are in a situation where it isn't possible to install
a compiled version of standard DBI, and you're using pure-perl DBD
drivers, then this module allows you to use most common features
of DBI without needing any changes in your scripts.
=head1 EXPERIMENTAL STATUS
DBI::PurePerl is new so please treat it as experimental pending
more extensive testing. So far it has passed all tests with DBD::CSV,
DBD::AnyData, DBD::XBase, DBD::Sprite, DBD::mysqlPP. Please send
bug reports to Jeff Zucker at <jeff@vpservices.com> with a cc to
<dbi-dev@perl.org>.
=head1 USAGE
The usage is the same as for standard DBI with the exception
that you need to set the environment variable DBI_PUREPERL if
you want to use the PurePerl version.
DBI_PUREPERL == 0 (the default) Always use compiled DBI, die
if it isn't properly compiled & installed
DBI_PUREPERL == 1 Use compiled DBI if it is properly compiled
& installed, otherwise use PurePerl
DBI_PUREPERL == 2 Always use PurePerl
You may set the environment variable in your shell (e.g. with
set or setenv or export, etc) or else set it in your script like
this:
BEGIN { $ENV{DBI_PUREPERL}=2 }
before you C<use DBI;>.
=head1 INSTALLATION
In most situations simply install DBI (see the DBI pod for details).
In the situation in which you can not install DBI itself, you
may manually copy DBI.pm and PurePerl.pm into the appropriate
directories.
For example:
cp DBI.pm /usr/jdoe/mylibs/.
cp PurePerl.pm /usr/jdoe/mylibs/DBI/.
Then add this to the top of scripts:
BEGIN {
$ENV{DBI_PUREPERL} = 1; # or =2
unshift @INC, '/usr/jdoe/mylibs';
}
(Or should we perhaps patch Makefile.PL so that if DBI_PUREPERL
is set to 2 prior to make, the normal compile process is skipped
and the files are installed automatically?)
=head1 DIFFERENCES BETWEEN DBI AND DBI::PurePerl
=head2 Attributes
Boolean attributes still return boolean values but the actual values
used may be different, i.e., 0 or undef instead of an empty string.
Some handle attributes are either not supported or have very limited
functionality:
ActiveKids
InactiveDestroy
AutoInactiveDestroy
Kids
Taint
TaintIn
TaintOut
(and probably others)
=head2 Tracing
Trace functionality is more limited and the code to handle tracing is
only embedded into DBI:PurePerl if the DBI_TRACE environment variable
is defined. To enable total tracing you can set the DBI_TRACE
environment variable as usual. But to enable individual handle
tracing using the trace() method you also need to set the DBI_TRACE
environment variable, but set it to 0.
=head2 Parameter Usage Checking
The DBI does some basic parameter count checking on method calls.
DBI::PurePerl doesn't.
=head2 Speed
DBI::PurePerl is slower. Although, with some drivers in some
contexts this may not be very significant for you.
By way of example... the test.pl script in the DBI source
distribution has a simple benchmark that just does:
my $null_dbh = DBI->connect('dbi:NullP:','','');
my $i = 10_000;
$null_dbh->prepare('') while $i--;
In other words just prepares a statement, creating and destroying
a statement handle, over and over again. Using the real DBI this
runs at ~4550 handles per second whereas DBI::PurePerl manages
~2800 per second on the same machine (not too bad really).
=head2 May not fully support hash()
If you want to use type 1 hash, i.e., C<hash($string,1)> with
DBI::PurePerl, you'll need version 1.56 or higher of Math::BigInt
(available on CPAN).
=head2 Doesn't support preparse()
The DBI->preparse() method isn't supported in DBI::PurePerl.
=head2 Doesn't support DBD::Proxy
There's a subtle problem somewhere I've not been able to identify.
DBI::ProxyServer seem to work fine with DBI::PurePerl but DBD::Proxy
does not work 100% (which is sad because that would be far more useful :)
Try re-enabling t/80proxy.t for DBI::PurePerl to see if the problem
that remains will affect you're usage.
=head2 Others
can() - doesn't have any special behaviour
Please let us know if you find any other differences between DBI
and DBI::PurePerl.
=head1 AUTHORS
Tim Bunce and Jeff Zucker.
Tim provided the direction and basis for the code. The original
idea for the module and most of the brute force porting from C to
Perl was by Jeff. Tim then reworked some core parts to boost the
performance and accuracy of the emulation. Thanks also to Randal
Schwartz and John Tobey for patches.
=head1 COPYRIGHT
Copyright (c) 2002 Tim Bunce Ireland.
See COPYRIGHT section in DBI.pm for usage and distribution rights.
=cut
PK V`[��)K� K� DBD.pmnu �[��� package DBI::DBD;
# vim:ts=8:sw=4
use strict;
use vars qw($VERSION); # set $VERSION early so we don't confuse PAUSE/CPAN etc
# don't use Revision here because that's not in svn:keywords so that the
# examples that use it below won't be messed up
$VERSION = "12.015129";
# $Id: DBD.pm 15128 2012-02-04 20:51:39Z Tim $
#
# Copyright (c) 1997-2006 Jonathan Leffler, Jochen Wiedmann, Steffen
# Goeldner and Tim Bunce
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
=head1 NAME
DBI::DBD - Perl DBI Database Driver Writer's Guide
=head1 SYNOPSIS
perldoc DBI::DBD
=head2 Version and volatility
This document is I<still> a minimal draft which is in need of further work.
Please read the B<DBI> documentation first and fully. Then look at the
implementation of some high-profile and regularly maintained drivers like
DBD::Oracle, DBD::ODBC, DBD::Pg etc. (Those are no no particular order.)
Then reread the B<DBI> specification and the code of those drivers again as
you're reading this. It'll help. Where this document and the driver code
differ it's likely that the driver code is more correct, especially if multiple
drivers do the same thing.
This document is a patchwork of contributions from various authors.
More contributions (preferably as patches) are very welcome.
=head1 DESCRIPTION
This document is primarily intended to help people writing new
database drivers for the Perl Database Interface (Perl DBI).
It may also help others interested in discovering why the internals of
a B<DBD> driver are written the way they are.
This is a guide. Few (if any) of the statements in it are completely
authoritative under all possible circumstances. This means you will
need to use judgement in applying the guidelines in this document.
If in I<any> doubt at all, please do contact the I<dbi-dev> mailing list
(details given below) where Tim Bunce and other driver authors can help.
=head1 CREATING A NEW DRIVER
The first rule for creating a new database driver for the Perl DBI is
very simple: B<DON'T!>
There is usually a driver already available for the database you want
to use, almost regardless of which database you choose. Very often, the
database will provide an ODBC driver interface, so you can often use
B<DBD::ODBC> to access the database. This is typically less convenient
on a Unix box than on a Microsoft Windows box, but there are numerous
options for ODBC driver managers on Unix too, and very often the ODBC
driver is provided by the database supplier.
Before deciding that you need to write a driver, do your homework to
ensure that you are not wasting your energies.
[As of December 2002, the consensus is that if you need an ODBC driver
manager on Unix, then the unixODBC driver (available from
L<http://www.unixodbc.org/>) is the way to go.]
The second rule for creating a new database driver for the Perl DBI is
also very simple: B<Don't -- get someone else to do it for you!>
Nevertheless, there are occasions when it is necessary to write a new
driver, often to use a proprietary language or API to access the
database more swiftly, or more comprehensively, than an ODBC driver can.
Then you should read this document very carefully, but with a suitably
sceptical eye.
If there is something in here that does not make any sense, question it.
You might be right that the information is bogus, but don't come to that
conclusion too quickly.
=head2 URLs and mailing lists
The primary web-site for locating B<DBI> software and information is
http://dbi.perl.org/
There are two main and one auxiliary mailing lists for people working
with B<DBI>. The primary lists are I<dbi-users@perl.org> for general users
of B<DBI> and B<DBD> drivers, and I<dbi-dev@perl.org> mainly for B<DBD> driver
writers (don't join the I<dbi-dev> list unless you have a good reason).
The auxiliary list is I<dbi-announce@perl.org> for announcing new
releases of B<DBI> or B<DBD> drivers.
You can join these lists by accessing the web-site L<http://dbi.perl.org/>.
The lists are closed so you cannot send email to any of the lists
unless you join the list first.
You should also consider monitoring the I<comp.lang.perl.*> newsgroups,
especially I<comp.lang.perl.modules>.
=head2 The Cheetah book
The definitive book on Perl DBI is the Cheetah book, so called because
of the picture on the cover. Its proper title is 'I<Programming the
Perl DBI: Database programming with Perl>' by Alligator Descartes
and Tim Bunce, published by O'Reilly Associates, February 2000, ISBN
1-56592-699-4. Buy it now if you have not already done so, and read it.
=head2 Locating drivers
Before writing a new driver, it is in your interests to find out
whether there already is a driver for your database. If there is such
a driver, it would be much easier to make use of it than to write your
own!
The primary web-site for locating Perl software is
L<http://search.cpan.org/>. You should look under the various
modules listings for the software you are after. For example:
http://search.cpan.org/modlist/Database_Interfaces
Follow the B<DBD::> and B<DBIx::> links at the top to see those subsets.
See the B<DBI> docs for information on B<DBI> web sites and mailing lists.
=head2 Registering a new driver
Before going through any official registration process, you will need
to establish that there is no driver already in the works. You'll do
that by asking the B<DBI> mailing lists whether there is such a driver
available, or whether anybody is working on one.
When you get the go ahead, you will need to establish the name of the
driver and a prefix for the driver. Typically, the name is based on the
name of the database software it uses, and the prefix is a contraction
of that. Hence, B<DBD::Oracle> has the name I<Oracle> and the prefix
'I<ora_>'. The prefix must be lowercase and contain no underscores other
than the one at the end.
This information will be recorded in the B<DBI> module. Apart from
documentation purposes, registration is a prerequisite for
L<installing private methods|DBI/install_method>.
If you are writing a driver which will not be distributed on CPAN, then
you should choose a prefix beginning with 'I<x_>', to avoid potential
prefix collisions with drivers registered in the future. Thus, if you
wrote a non-CPAN distributed driver called B<DBD::CustomDB>, the prefix
might be 'I<x_cdb_>'.
This document assumes you are writing a driver called B<DBD::Driver>, and
that the prefix 'I<drv_>' is assigned to the driver.
=head2 Two styles of database driver
There are two distinct styles of database driver that can be written to
work with the Perl DBI.
Your driver can be written in pure Perl, requiring no C compiler.
When feasible, this is the best solution, but most databases are not
written in such a way that this can be done. Some examples of pure
Perl drivers are B<DBD::File> and B<DBD::CSV>.
Alternatively, and most commonly, your driver will need to use some C
code to gain access to the database. This will be classified as a C/XS
driver.
=head2 What code will you write?
There are a number of files that need to be written for either a pure
Perl driver or a C/XS driver. There are no extra files needed only by
a pure Perl driver, but there are several extra files needed only by a
C/XS driver.
=head3 Files common to pure Perl and C/XS drivers
Assuming that your driver is called B<DBD::Driver>, these files are:
=over 4
=item * F<Makefile.PL>
=item * F<META.yml>
=item * F<README>
=item * F<MANIFEST>
=item * F<Driver.pm>
=item * F<lib/Bundle/DBD/Driver.pm>
=item * F<lib/DBD/Driver/Summary.pm>
=item * F<t/*.t>
=back
The first four files are mandatory. F<Makefile.PL> is used to control
how the driver is built and installed. The F<README> file tells people
who download the file about how to build the module and any prerequisite
software that must be installed. The F<MANIFEST> file is used by the
standard Perl module distribution mechanism. It lists all the source
files that need to be distributed with your module. F<Driver.pm> is what
is loaded by the B<DBI> code; it contains the methods peculiar to your
driver.
Although the F<META.yml> file is not B<required> you are advised to
create one. Of particular importance are the I<build_requires> and
I<configure_requires> attributes which newer CPAN modules understand.
You use these to tell the CPAN module (and CPANPLUS) that your build
and configure mechanisms require DBI. The best reference for META.yml
(at the time of writing) is
L<http://module-build.sourceforge.net/META-spec-v1.4.html>. You can find
a reasonable example of a F<META.yml> in DBD::ODBC.
The F<lib/Bundle/DBD/Driver.pm> file allows you to specify other Perl
modules on which yours depends in a format that allows someone to type a
simple command and ensure that all the pre-requisites are in place as
well as building your driver.
The F<lib/DBD/Driver/Summary.pm> file contains (an updated version of) the
information that was included - or that would have been included - in
the appendices of the Cheetah book as a summary of the abilities of your
driver and the associated database.
The files in the F<t> subdirectory are unit tests for your driver.
You should write your tests as stringently as possible, while taking
into account the diversity of installations that you can encounter:
=over 4
=item *
Your tests should not casually modify operational databases.
=item *
You should never damage existing tables in a database.
=item *
You should code your tests to use a constrained name space within the
database. For example, the tables (and all other named objects) that are
created could all begin with 'I<dbd_drv_>'.
=item *
At the end of a test run, there should be no testing objects left behind
in the database.
=item *
If you create any databases, you should remove them.
=item *
If your database supports temporary tables that are automatically
removed at the end of a session, then exploit them as often as possible.
=item *
Try to make your tests independent of each other. If you have a
test F<t/t11dowhat.t> that depends upon the successful running
of F<t/t10thingamy.t>, people cannot run the single test case
F<t/t11dowhat.t>. Further, running F<t/t11dowhat.t> twice in a row is
likely to fail (at least, if F<t/t11dowhat.t> modifies the database at
all) because the database at the start of the second run is not what you
saw at the start of the first run.
=item *
Document in your F<README> file what you do, and what privileges people
need to do it.
=item *
You can, and probably should, sequence your tests by including a test
number before an abbreviated version of the test name; the tests are run
in the order in which the names are expanded by shell-style globbing.
=item *
It is in your interests to ensure that your tests work as widely
as possible.
=back
Many drivers also install sub-modules B<DBD::Driver::SubModule>
for any of a variety of different reasons, such as to support
the metadata methods (see the discussion of L</METADATA METHODS>
below). Such sub-modules are conventionally stored in the directory
F<lib/DBD/Driver>. The module itself would usually be in a file
F<SubModule.pm>. All such sub-modules should themselves be version
stamped (see the discussions far below).
=head3 Extra files needed by C/XS drivers
The software for a C/XS driver will typically contain at least four
extra files that are not relevant to a pure Perl driver.
=over 4
=item * F<Driver.xs>
=item * F<Driver.h>
=item * F<dbdimp.h>
=item * F<dbdimp.c>
=back
The F<Driver.xs> file is used to generate C code that Perl can call to gain
access to the C functions you write that will, in turn, call down onto
your database software.
The F<Driver.h> header is a stylized header that ensures you can access the
necessary Perl and B<DBI> macros, types, and function declarations.
The F<dbdimp.h> is used to specify which functions have been implemented by
your driver.
The F<dbdimp.c> file is where you write the C code that does the real work
of translating between Perl-ish data types and what the database expects
to use and return.
There are some (mainly small, but very important) differences between
the contents of F<Makefile.PL> and F<Driver.pm> for pure Perl and C/XS
drivers, so those files are described both in the section on creating a
pure Perl driver and in the section on creating a C/XS driver.
Obviously, you can add extra source code files to the list.
=head2 Requirements on a driver and driver writer
To be remotely useful, your driver must be implemented in a format that
allows it to be distributed via CPAN, the Comprehensive Perl Archive
Network (L<http://www.cpan.org/> and L<http://search.cpan.org>).
Of course, it is easier if you do not have to meet this criterion, but
you will not be able to ask for much help if you do not do so, and
no-one is likely to want to install your module if they have to learn a
new installation mechanism.
=head1 CREATING A PURE PERL DRIVER
Writing a pure Perl driver is surprisingly simple. However, there are
some problems you should be aware of. The best option is of course
picking up an existing driver and carefully modifying one method
after the other.
Also look carefully at B<DBD::AnyData> and B<DBD::Template>.
As an example we take a look at the B<DBD::File> driver, a driver for
accessing plain files as tables, which is part of the B<DBD::CSV> package.
The minimal set of files we have to implement are F<Makefile.PL>,
F<README>, F<MANIFEST> and F<Driver.pm>.
=head2 Pure Perl version of Makefile.PL
You typically start with writing F<Makefile.PL>, a Makefile
generator. The contents of this file are described in detail in
the L<ExtUtils::MakeMaker> man pages. It is definitely a good idea
if you start reading them. At least you should know about the
variables I<CONFIGURE>, I<DEFINED>, I<PM>, I<DIR>, I<EXE_FILES>,
I<INC>, I<LIBS>, I<LINKTYPE>, I<NAME>, I<OPTIMIZE>, I<PL_FILES>,
I<VERSION>, I<VERSION_FROM>, I<clean>, I<depend>, I<realclean> from
the L<ExtUtils::MakeMaker> man page: these are used in almost any
F<Makefile.PL>.
Additionally read the section on I<Overriding MakeMaker Methods> and the
descriptions of the I<distcheck>, I<disttest> and I<dist> targets: They
will definitely be useful for you.
Of special importance for B<DBI> drivers is the I<postamble> method from
the L<ExtUtils::MM_Unix> man page.
For Emacs users, I recommend the I<libscan> method, which removes
Emacs backup files (file names which end with a tilde '~') from lists of
files.
Now an example, I use the word C<Driver> wherever you should insert
your driver's name:
# -*- perl -*-
use ExtUtils::MakeMaker;
WriteMakefile(
dbd_edit_mm_attribs( {
'NAME' => 'DBD::Driver',
'VERSION_FROM' => 'Driver.pm',
'INC' => '',
'dist' => { 'SUFFIX' => '.gz',
'COMPRESS' => 'gzip -9f' },
'realclean' => { FILES => '*.xsi' },
'PREREQ_PM' => '1.03',
'CONFIGURE' => sub {
eval {require DBI::DBD;};
if ($@) {
warn $@;
exit 0;
}
my $dbi_arch_dir = dbd_dbi_arch_dir();
if (exists($opts{INC})) {
return {INC => "$opts{INC} -I$dbi_arch_dir"};
} else {
return {INC => "-I$dbi_arch_dir"};
}
}
},
{ create_pp_tests => 1})
);
package MY;
sub postamble { return main::dbd_postamble(@_); }
sub libscan {
my ($self, $path) = @_;
($path =~ m/\~$/) ? undef : $path;
}
Note the calls to C<dbd_edit_mm_attribs()> and C<dbd_postamble()>.
The second hash reference in the call to C<dbd_edit_mm_attribs()>
(containing C<create_pp_tests()>) is optional; you should not use it
unless your driver is a pure Perl driver (that is, it does not use C and
XS code). Therefore, the call to C<dbd_edit_mm_attribs()> is not
relevant for C/XS drivers and may be omitted; simply use the (single)
hash reference containing NAME etc as the only argument to C<WriteMakefile()>.
Note that the C<dbd_edit_mm_attribs()> code will fail if you do not have a
F<t> sub-directory containing at least one test case.
I<PREREQ_PM> tells MakeMaker that DBI (version 1.03 in this case) is
required for this module. This will issue a warning that DBI 1.03 is
missing if someone attempts to install your DBD without DBI 1.03. See
I<CONFIGURE> below for why this does not work reliably in stopping cpan
testers failing your module if DBI is not installed.
I<CONFIGURE> is a subroutine called by MakeMaker during
C<WriteMakefile>. By putting the C<require DBI::DBD> in this section
we can attempt to load DBI::DBD but if it is missing we exit with
success. As we exit successfully without creating a Makefile when
DBI::DBD is missing cpan testers will not report a failure. This may
seem at odds with I<PREREQ_PM> but I<PREREQ_PM> does not cause
C<WriteMakefile> to fail (unless you also specify PREREQ_FATAL which
is strongly discouraged by MakeMaker) so C<WriteMakefile> would
continue to call C<dbd_dbi_arch_dir> and fail.
All drivers must use C<dbd_postamble()> or risk running into problems.
Note the specification of I<VERSION_FROM>; the named file
(F<Driver.pm>) will be scanned for the first line that looks like an
assignment to I<$VERSION>, and the subsequent text will be used to
determine the version number. Note the commentary in
L<ExtUtils::MakeMaker> on the subject of correctly formatted version
numbers.
If your driver depends upon external software (it usually will), you
will need to add code to ensure that your environment is workable
before the call to C<WriteMakefile()>. If you need to check for the
existence of an external library and perhaps modify I<INC> to include
the paths to where the external library header files are located and
you cannot find the library or header files make sure you output a
message saying they cannot be found but C<exit 0> (success) B<before>
calling C<WriteMakefile> or CPAN testers will fail your module if the
external library is not found.
A full-fledged I<Makefile.PL> can be quite large (for example, the
files for B<DBD::Oracle> and B<DBD::Informix> are both over 1000 lines
long, and the Informix one uses - and creates - auxiliary modules
too).
See also L<ExtUtils::MakeMaker> and L<ExtUtils::MM_Unix>. Consider using
L<CPAN::MakeMaker> in place of I<ExtUtils::MakeMaker>.
=head2 README
The L<README> file should describe what the driver is for, the
pre-requisites for the build process, the actual build process, how to
report errors, and who to report them to.
Users will find ways of breaking the driver build and test process
which you would never even have dreamed to be possible in your worst
nightmares. Therefore, you need to write this document defensively,
precisely and concisely.
As always, use the F<README> from one of the established drivers as a basis
for your own; the version in B<DBD::Informix> is worth a look as it has
been quite successful in heading off problems.
=over 4
=item *
Note that users will have versions of Perl and B<DBI> that are both older
and newer than you expected, but this will seldom cause much trouble.
When it does, it will be because you are using features of B<DBI> that are
not supported in the version they are using.
=item *
Note that users will have versions of the database software that are
both older and newer than you expected. You will save yourself time in
the long run if you can identify the range of versions which have been
tested and warn about versions which are not known to be OK.
=item *
Note that many people trying to install your driver will not be experts
in the database software.
=item *
Note that many people trying to install your driver will not be experts
in C or Perl.
=back
=head2 MANIFEST
The F<MANIFEST> will be used by the Makefile's dist target to build the
distribution tar file that is uploaded to CPAN. It should list every
file that you want to include in your distribution, one per line.
=head2 lib/Bundle/DBD/Driver.pm
The CPAN module provides an extremely powerful bundle mechanism that
allows you to specify pre-requisites for your driver.
The primary pre-requisite is B<Bundle::DBI>; you may want or need to add
some more. With the bundle set up correctly, the user can type:
perl -MCPAN -e 'install Bundle::DBD::Driver'
and Perl will download, compile, test and install all the Perl modules
needed to build your driver.
The prerequisite modules are listed in the C<CONTENTS> section, with the
official name of the module followed by a dash and an informal name or
description.
=over 4
=item *
Listing B<Bundle::DBI> as the main pre-requisite simplifies life.
=item *
Don't forget to list your driver.
=item *
Note that unless the DBMS is itself a Perl module, you cannot list it as
a pre-requisite in this file.
=item *
You should keep the version of the bundle the same as the version of
your driver.
=item *
You should add configuration management, copyright, and licencing
information at the top.
=back
A suitable skeleton for this file is shown below.
package Bundle::DBD::Driver;
$VERSION = '0.01';
1;
__END__
=head1 NAME
Bundle::DBD::Driver - A bundle to install all DBD::Driver related modules
=head1 SYNOPSIS
C<perl -MCPAN -e 'install Bundle::DBD::Driver'>
=head1 CONTENTS
Bundle::DBI - Bundle for DBI by TIMB (Tim Bunce)
DBD::Driver - DBD::Driver by YOU (Your Name)
=head1 DESCRIPTION
This bundle includes all the modules used by the Perl Database
Interface (DBI) driver for Driver (DBD::Driver), assuming the
use of DBI version 1.13 or later, created by Tim Bunce.
If you've not previously used the CPAN module to install any
bundles, you will be interrogated during its setup phase.
But when you've done it once, it remembers what you told it.
You could start by running:
C<perl -MCPAN -e 'install Bundle::CPAN'>
=head1 SEE ALSO
Bundle::DBI
=head1 AUTHOR
Your Name E<lt>F<you@yourdomain.com>E<gt>
=head1 THANKS
This bundle was created by ripping off Bundle::libnet created by
Graham Barr E<lt>F<gbarr@ti.com>E<gt>, and radically simplified
with some information from Jochen Wiedmann E<lt>F<joe@ispsoft.de>E<gt>.
The template was then included in the DBI::DBD documentation by
Jonathan Leffler E<lt>F<jleffler@informix.com>E<gt>.
=cut
=head2 lib/DBD/Driver/Summary.pm
There is no substitute for taking the summary file from a driver that
was documented in the Perl book (such as B<DBD::Oracle> or B<DBD::Informix> or
B<DBD::ODBC>, to name but three), and adapting it to describe the
facilities available via B<DBD::Driver> when accessing the Driver database.
=head2 Pure Perl version of Driver.pm
The F<Driver.pm> file defines the Perl module B<DBD::Driver> for your driver.
It will define a package B<DBD::Driver> along with some version information,
some variable definitions, and a function C<driver()> which will have a more
or less standard structure.
It will also define three sub-packages of B<DBD::Driver>:
=over 4
=item DBD::Driver::dr
with methods C<connect()>, C<data_sources()> and C<disconnect_all()>;
=item DBD::Driver::db
with methods such as C<prepare()>;
=item DBD::Driver::st
with methods such as C<execute()> and C<fetch()>.
=back
The F<Driver.pm> file will also contain the documentation specific to
B<DBD::Driver> in the format used by perldoc.
In a pure Perl driver, the F<Driver.pm> file is the core of the
implementation. You will need to provide all the key methods needed by B<DBI>.
Now let's take a closer look at an excerpt of F<File.pm> as an example.
We ignore things that are common to any module (even non-DBI modules)
or really specific to the B<DBD::File> package.
=head3 The DBD::Driver package
=head4 The header
package DBD::File;
use strict;
use vars qw($VERSION $drh);
$VERSION = "1.23.00" # Version number of DBD::File
This is where the version number of your driver is specified, and is
where F<Makefile.PL> looks for this information. Please ensure that any
other modules added with your driver are also version stamped so that
CPAN does not get confused.
It is recommended that you use a two-part (1.23) or three-part (1.23.45)
version number. Also consider the CPAN system, which gets confused and
considers version 1.10 to precede version 1.9, so that using a raw CVS,
RCS or SCCS version number is probably not appropriate (despite being
very common).
For Subversion you could use:
$VERSION = "12.012346";
(use lots of leading zeros on the second portion so if you move the code to a
shared repository like svn.perl.org the much larger revision numbers won't
cause a problem, at least not for a few years). For RCS or CVS you can use:
$VERSION = "11.22";
which pads out the fractional part with leading zeros so all is well
(so long as you don't go past x.99)
$drh = undef; # holds driver handle once initialized
This is where the driver handle will be stored, once created.
Note that you may assume there is only one handle for your driver.
=head4 The driver constructor
The C<driver()> method is the driver handle constructor. Note that
the C<driver()> method is in the B<DBD::Driver> package, not in
one of the sub-packages B<DBD::Driver::dr>, B<DBD::Driver::db>, or
B<DBD::Driver::db>.
sub driver
{
return $drh if $drh; # already created - return same one
my ($class, $attr) = @_;
$class .= "::dr";
DBD::Driver::db->install_method('drv_example_dbh_method');
DBD::Driver::st->install_method('drv_example_sth_method');
# not a 'my' since we use it above to prevent multiple drivers
$drh = DBI::_new_drh($class, {
'Name' => 'File',
'Version' => $VERSION,
'Attribution' => 'DBD::File by Jochen Wiedmann',
})
or return undef;
return $drh;
}
This is a reasonable example of how B<DBI> implements its handles. There
are three kinds: B<driver handles> (typically stored in I<$drh>; from
now on called I<drh> or I<$drh>), B<database handles> (from now on
called I<dbh> or I<$dbh>) and B<statement handles> (from now on called
I<sth> or I<$sth>).
The prototype of C<DBI::_new_drh()> is
$drh = DBI::_new_drh($class, $public_attrs, $private_attrs);
with the following arguments:
=over 4
=item I<$class>
is typically the class for your driver, (for example, "DBD::File::dr"),
passed as the first argument to the C<driver()> method.
=item I<$public_attrs>
is a hash ref to attributes like I<Name>, I<Version>, and I<Attribution>.
These are processed and used by B<DBI>. You had better not make any
assumptions about them nor should you add private attributes here.
=item I<$private_attrs>
This is another (optional) hash ref with your private attributes.
B<DBI> will store them and otherwise leave them alone.
=back
The C<DBI::_new_drh()> method and the C<driver()> method both return C<undef>
for failure (in which case you must look at I<$DBI::err> and I<$DBI::errstr>
for the failure information, because you have no driver handle to use).
=head4 Using install_method() to expose driver-private methods
DBD::Foo::db->install_method($method_name, \%attr);
Installs the driver-private method named by $method_name into the
DBI method dispatcher so it can be called directly, avoiding the
need to use the func() method.
It is called as a static method on the driver class to which the
method belongs. The method name must begin with the corresponding
registered driver-private prefix. For example, for DBD::Oracle
$method_name must being with 'C<ora_>', and for DBD::AnyData it
must begin with 'C<ad_>'.
The C<\%attr> attributes can be used to provide fine control over how the DBI
dispatcher handles the dispatching of the method. However it's undocumented
at the moment. See the IMA_* #define's in DBI.xs and the O=>0x000x values in
the initialization of %DBI::DBI_methods in DBI.pm. (Volunteers to polish up
and document the interface are very welcome to get in touch via dbi-dev@perl.org).
Methods installed using install_method default to the standard error
handling behaviour for DBI methods: clearing err and errstr before
calling the method, and checking for errors to trigger RaiseError
etc. on return. This differs from the default behaviour of func().
Note for driver authors: The DBD::Foo::xx->install_method call won't
work until the class-hierarchy has been setup. Normally the DBI
looks after that just after the driver is loaded. This means
install_method() can't be called at the time the driver is loaded
unless the class-hierarchy is set up first. The way to do that is
to call the setup_driver() method:
DBI->setup_driver('DBD::Foo');
before using install_method().
=head4 The CLONE special subroutine
Also needed here, in the B<DBD::Driver> package, is a C<CLONE()> method
that will be called by perl when an interpreter is cloned. All your
C<CLONE()> method needs to do, currently, is clear the cached I<$drh> so
the new interpreter won't start using the cached I<$drh> from the old
interpreter:
sub CLONE {
undef $drh;
}
See L<http://search.cpan.org/dist/perl/pod/perlmod.pod#Making_your_module_threadsafe>
for details.
=head3 The DBD::Driver::dr package
The next lines of code look as follows:
package DBD::Driver::dr; # ====== DRIVER ======
$DBD::Driver::dr::imp_data_size = 0;
Note that no I<@ISA> is needed here, or for the other B<DBD::Driver::*>
classes, because the B<DBI> takes care of that for you when the driver is
loaded.
*FIX ME* Explain what the imp_data_size is, so that implementors aren't
practicing cargo-cult programming.
=head4 The database handle constructor
The database handle constructor is the driver's (hence the changed
namespace) C<connect()> method:
sub connect
{
my ($drh, $dr_dsn, $user, $auth, $attr) = @_;
# Some database specific verifications, default settings
# and the like can go here. This should only include
# syntax checks or similar stuff where it's legal to
# 'die' in case of errors.
# For example, many database packages requires specific
# environment variables to be set; this could be where you
# validate that they are set, or default them if they are not set.
my $driver_prefix = "drv_"; # the assigned prefix for this driver
# Process attributes from the DSN; we assume ODBC syntax
# here, that is, the DSN looks like var1=val1;...;varN=valN
foreach my $var ( split /;/, $dr_dsn ) {
my ($attr_name, $attr_value) = split '=', $var, 2;
return $drh->set_err($DBI::stderr, "Can't parse DSN part '$var'")
unless defined $attr_value;
# add driver prefix to attribute name if it doesn't have it already
$attr_name = $driver_prefix.$attr_name
unless $attr_name =~ /^$driver_prefix/o;
# Store attribute into %$attr, replacing any existing value.
# The DBI will STORE() these into $dbh after we've connected
$attr->{$attr_name} = $attr_value;
}
# Get the attributes we'll use to connect.
# We use delete here because these no need to STORE them
my $db = delete $attr->{drv_database} || delete $attr->{drv_db}
or return $drh->set_err($DBI::stderr, "No database name given in DSN '$dr_dsn'");
my $host = delete $attr->{drv_host} || 'localhost';
my $port = delete $attr->{drv_port} || 123456;
# Assume you can attach to your database via drv_connect:
my $connection = drv_connect($db, $host, $port, $user, $auth)
or return $drh->set_err($DBI::stderr, "Can't connect to $dr_dsn: ...");
# create a 'blank' dbh (call superclass constructor)
my ($outer, $dbh) = DBI::_new_dbh($drh, { Name => $dr_dsn });
$dbh->STORE('Active', 1 );
$dbh->{drv_connection} = $connection;
return $outer;
}
This is mostly the same as in the I<driver handle constructor> above.
The arguments are described in L<DBI>.
The constructor C<DBI::_new_dbh()> is called, returning a database handle.
The constructor's prototype is:
($outer, $inner) = DBI::_new_dbh($drh, $public_attr, $private_attr);
with similar arguments to those in the I<driver handle constructor>,
except that the I<$class> is replaced by I<$drh>. The I<Name> attribute
is a standard B<DBI> attribute (see L<DBI/Database Handle Attributes>).
In scalar context, only the outer handle is returned.
Note the use of the C<STORE()> method for setting the I<dbh> attributes.
That's because within the driver code, the handle object you have is
the 'inner' handle of a tied hash, not the outer handle that the
users of your driver have.
Because you have the inner handle, tie magic doesn't get invoked
when you get or set values in the hash. This is often very handy for
speed when you want to get or set simple non-special driver-specific
attributes.
However, some attribute values, such as those handled by the B<DBI> like
I<PrintError>, don't actually exist in the hash and must be read via
C<$h-E<gt>FETCH($attrib)> and set via C<$h-E<gt>STORE($attrib, $value)>.
If in any doubt, use these methods.
=head4 The data_sources() method
The C<data_sources()> method must populate and return a list of valid data
sources, prefixed with the "I<dbi:Driver>" incantation that allows them to
be used in the first argument of the C<DBI-E<gt>connect()> method.
An example of this might be scanning the F<$HOME/.odbcini> file on Unix
for ODBC data sources (DSNs).
As a trivial example, consider a fixed list of data sources:
sub data_sources
{
my($drh, $attr) = @_;
my(@list) = ();
# You need more sophisticated code than this to set @list...
push @list, "dbi:Driver:abc";
push @list, "dbi:Driver:def";
push @list, "dbi:Driver:ghi";
# End of code to set @list
return @list;
}
=head4 The disconnect_all() method
If you need to release any resources when the driver is unloaded, you
can provide a disconnect_all method.
=head4 Other driver handle methods
If you need any other driver handle methods, they can follow here.
=head4 Error handling
It is quite likely that something fails in the connect method.
With B<DBD::File> for example, you might catch an error when setting the
current directory to something not existent by using the
(driver-specific) I<f_dir> attribute.
To report an error, you use the C<set_err()> method:
$h->set_err($err, $errmsg, $state);
This will ensure that the error is recorded correctly and that
I<RaiseError> and I<PrintError> etc are handled correctly.
Typically you'll always use the method instance, aka your method's first
argument.
As C<set_err()> always returns C<undef> your error handling code can
usually be simplified to something like this:
return $h->set_err($err, $errmsg, $state) if ...;
=head3 The DBD::Driver::db package
package DBD::Driver::db; # ====== DATABASE ======
$DBD::Driver::db::imp_data_size = 0;
=head4 The statement handle constructor
There's nothing much new in the statement handle constructor, which
is the C<prepare()> method:
sub prepare
{
my ($dbh, $statement, @attribs) = @_;
# create a 'blank' sth
my ($outer, $sth) = DBI::_new_sth($dbh, { Statement => $statement });
$sth->STORE('NUM_OF_PARAMS', ($statement =~ tr/?//));
$sth->{drv_params} = [];
return $outer;
}
This is still the same -- check the arguments and call the super class
constructor C<DBI::_new_sth()>. Again, in scalar context, only the outer
handle is returned. The I<Statement> attribute should be cached as
shown.
Note the prefix I<drv_> in the attribute names: it is required that
all your private attributes use a lowercase prefix unique to your driver.
As mentioned earlier in this document, the B<DBI> contains a registry of
known driver prefixes and may one day warn about unknown attributes
that don't have a registered prefix.
Note that we parse the statement here in order to set the attribute
I<NUM_OF_PARAMS>. The technique illustrated is not very reliable; it can
be confused by question marks appearing in quoted strings, delimited
identifiers or in SQL comments that are part of the SQL statement. We
could set I<NUM_OF_PARAMS> in the C<execute()> method instead because
the B<DBI> specification explicitly allows a driver to defer this, but then
the user could not call C<bind_param()>.
=head4 Transaction handling
Pure Perl drivers will rarely support transactions. Thus your C<commit()>
and C<rollback()> methods will typically be quite simple:
sub commit
{
my ($dbh) = @_;
if ($dbh->FETCH('Warn')) {
warn("Commit ineffective while AutoCommit is on");
}
0;
}
sub rollback {
my ($dbh) = @_;
if ($dbh->FETCH('Warn')) {
warn("Rollback ineffective while AutoCommit is on");
}
0;
}
Or even simpler, just use the default methods provided by the B<DBI> that
do nothing except return C<undef>.
The B<DBI>'s default C<begin_work()> method can be used by inheritance.
=head4 The STORE() and FETCH() methods
These methods (that we have already used, see above) are called for
you, whenever the user does a:
$dbh->{$attr} = $val;
or, respectively,
$val = $dbh->{$attr};
See L<perltie> for details on tied hash refs to understand why these
methods are required.
The B<DBI> will handle most attributes for you, in particular attributes
like I<RaiseError> or I<PrintError>. All you have to do is handle your
driver's private attributes and any attributes, like I<AutoCommit> and
I<ChopBlanks>, that the B<DBI> can't handle for you.
A good example might look like this:
sub STORE
{
my ($dbh, $attr, $val) = @_;
if ($attr eq 'AutoCommit') {
# AutoCommit is currently the only standard attribute we have
# to consider.
if (!$val) { die "Can't disable AutoCommit"; }
return 1;
}
if ($attr =~ m/^drv_/) {
# Handle only our private attributes here
# Note that we could trigger arbitrary actions.
# Ideally we should warn about unknown attributes.
$dbh->{$attr} = $val; # Yes, we are allowed to do this,
return 1; # but only for our private attributes
}
# Else pass up to DBI to handle for us
$dbh->SUPER::STORE($attr, $val);
}
sub FETCH
{
my ($dbh, $attr) = @_;
if ($attr eq 'AutoCommit') { return 1; }
if ($attr =~ m/^drv_/) {
# Handle only our private attributes here
# Note that we could trigger arbitrary actions.
return $dbh->{$attr}; # Yes, we are allowed to do this,
# but only for our private attributes
}
# Else pass up to DBI to handle
$dbh->SUPER::FETCH($attr);
}
The B<DBI> will actually store and fetch driver-specific attributes (with all
lowercase names) without warning or error, so there's actually no need to
implement driver-specific any code in your C<FETCH()> and C<STORE()>
methods unless you need extra logic/checks, beyond getting or setting
the value.
Unless your driver documentation indicates otherwise, the return value of
the C<STORE()> method is unspecified and the caller shouldn't use that value.
=head4 Other database handle methods
As with the driver package, other database handle methods may follow here.
In particular you should consider a (possibly empty) C<disconnect()>
method and possibly a C<quote()> method if B<DBI>'s default isn't correct for
you. You may also need the C<type_info_all()> and C<get_info()> methods,
as described elsewhere in this document.
Where reasonable use C<$h-E<gt>SUPER::foo()> to call the B<DBI>'s method in
some or all cases and just wrap your custom behavior around that.
If you want to use private trace flags you'll probably want to be
able to set them by name. To do that you'll need to define a
C<parse_trace_flag()> method (note that's "parse_trace_flag", singular,
not "parse_trace_flags", plural).
sub parse_trace_flag {
my ($h, $name) = @_;
return 0x01000000 if $name eq 'foo';
return 0x02000000 if $name eq 'bar';
return 0x04000000 if $name eq 'baz';
return 0x08000000 if $name eq 'boo';
return 0x10000000 if $name eq 'bop';
return $h->SUPER::parse_trace_flag($name);
}
All private flag names must be lowercase, and all private flags
must be in the top 8 of the 32 bits.
=head3 The DBD::Driver::st package
This package follows the same pattern the others do:
package DBD::Driver::st;
$DBD::Driver::st::imp_data_size = 0;
=head4 The execute() and bind_param() methods
This is perhaps the most difficult method because we have to consider
parameter bindings here. In addition to that, there are a number of
statement attributes which must be set for inherited B<DBI> methods to
function correctly (see L</Statement attributes> below).
We present a simplified implementation by using the I<drv_params>
attribute from above:
sub bind_param
{
my ($sth, $pNum, $val, $attr) = @_;
my $type = (ref $attr) ? $attr->{TYPE} : $attr;
if ($type) {
my $dbh = $sth->{Database};
$val = $dbh->quote($sth, $type);
}
my $params = $sth->{drv_params};
$params->[$pNum-1] = $val;
1;
}
sub execute
{
my ($sth, @bind_values) = @_;
# start of by finishing any previous execution if still active
$sth->finish if $sth->FETCH('Active');
my $params = (@bind_values) ?
\@bind_values : $sth->{drv_params};
my $numParam = $sth->FETCH('NUM_OF_PARAMS');
return $sth->set_err($DBI::stderr, "Wrong number of parameters")
if @$params != $numParam;
my $statement = $sth->{'Statement'};
for (my $i = 0; $i < $numParam; $i++) {
$statement =~ s/?/$params->[$i]/; # XXX doesn't deal with quoting etc!
}
# Do anything ... we assume that an array ref of rows is
# created and store it:
$sth->{'drv_data'} = $data;
$sth->{'drv_rows'} = @$data; # number of rows
$sth->STORE('NUM_OF_FIELDS') = $numFields;
$sth->{Active} = 1;
@$data || '0E0';
}
There are a number of things you should note here.
We initialize the I<NUM_OF_FIELDS> and I<Active> attributes here,
because they are essential for C<bind_columns()> to work.
We use attribute C<$sth-E<gt>{Statement}> which we created
within C<prepare()>. The attribute C<$sth-E<gt>{Database}>, which is
nothing else than the I<dbh>, was automatically created by B<DBI>.
Finally, note that (as specified in the B<DBI> specification) we return the
string C<'0E0'> instead of the number 0, so that the result tests true but
equal to zero.
$sth->execute() or die $sth->errstr;
=head4 The execute_array(), execute_for_fetch() and bind_param_array() methods
In general, DBD's only need to implement C<execute_for_fetch()> and
C<bind_param_array>. DBI's default C<execute_array()> will invoke the
DBD's C<execute_for_fetch()> as needed.
The following sequence describes the interaction between
DBI C<execute_array> and a DBD's C<execute_for_fetch>:
=over
=item 1
App calls C<$sth-E<gt>execute_array(\%attrs, @array_of_arrays)>
=item 2
If C<@array_of_arrays> was specified, DBI processes C<@array_of_arrays> by calling
DBD's C<bind_param_array()>. Alternately, App may have directly called
C<bind_param_array()>
=item 3
DBD validates and binds each array
=item 4
DBI retrieves the validated param arrays from DBD's ParamArray attribute
=item 5
DBI calls DBD's C<execute_for_fetch($fetch_tuple_sub, \@tuple_status)>,
where C<&$fetch_tuple_sub> is a closure to iterate over the
returned ParamArray values, and C<\@tuple_status> is an array to receive
the disposition status of each tuple.
=item 6
DBD iteratively calls C<&$fetch_tuple_sub> to retrieve parameter tuples
to be added to its bulk database operation/request.
=item 7
when DBD reaches the limit of tuples it can handle in a single database
operation/request, or the C<&$fetch_tuple_sub> indicates no more
tuples by returning undef, the DBD executes the bulk operation, and
reports the disposition of each tuple in \@tuple_status.
=item 8
DBD repeats steps 6 and 7 until all tuples are processed.
=back
E.g., here's the essence of L<DBD::Oracle>'s execute_for_fetch:
while (1) {
my @tuple_batch;
for (my $i = 0; $i < $batch_size; $i++) {
push @tuple_batch, [ @{$fetch_tuple_sub->() || last} ];
}
last unless @tuple_batch;
my $res = ora_execute_array($sth, \@tuple_batch,
scalar(@tuple_batch), $tuple_batch_status);
push @$tuple_status, @$tuple_batch_status;
}
Note that DBI's default execute_array()/execute_for_fetch() implementation
requires the use of positional (i.e., '?') placeholders. Drivers
which B<require> named placeholders must either emulate positional
placeholders (e.g., see L<DBD::Oracle>), or must implement their own
execute_array()/execute_for_fetch() methods to properly sequence bound
parameter arrays.
=head4 Fetching data
Only one method needs to be written for fetching data, C<fetchrow_arrayref()>.
The other methods, C<fetchrow_array()>, C<fetchall_arrayref()>, etc, as well
as the database handle's C<select*> methods are part of B<DBI>, and call
C<fetchrow_arrayref()> as necessary.
sub fetchrow_arrayref
{
my ($sth) = @_;
my $data = $sth->{drv_data};
my $row = shift @$data;
if (!$row) {
$sth->STORE(Active => 0); # mark as no longer active
return undef;
}
if ($sth->FETCH('ChopBlanks')) {
map { $_ =~ s/\s+$//; } @$row;
}
return $sth->_set_fbav($row);
}
*fetch = \&fetchrow_arrayref; # required alias for fetchrow_arrayref
Note the use of the method C<_set_fbav()> -- this is required so that
C<bind_col()> and C<bind_columns()> work.
If an error occurs which leaves the I<$sth> in a state where remaining rows
can't be fetched then I<Active> should be turned off before the method returns.
The C<rows()> method for this driver can be implemented like this:
sub rows { shift->{drv_rows} }
because it knows in advance how many rows it has fetched.
Alternatively you could delete that method and so fallback
to the B<DBI>'s own method which does the right thing based
on the number of calls to C<_set_fbav()>.
=head4 The more_results method
If your driver doesn't support multiple result sets, then don't even implement this method.
Otherwise, this method needs to get the statement handle ready to fetch results
from the next result set, if there is one. Typically you'd start with:
$sth->finish;
then you should delete all the attributes from the attribute cache that may no
longer be relevant for the new result set:
delete $sth->{$_}
for qw(NAME TYPE PRECISION SCALE ...);
for drivers written in C use:
hv_delete((HV*)SvRV(sth), "NAME", 4, G_DISCARD);
hv_delete((HV*)SvRV(sth), "NULLABLE", 8, G_DISCARD);
hv_delete((HV*)SvRV(sth), "NUM_OF_FIELDS", 13, G_DISCARD);
hv_delete((HV*)SvRV(sth), "PRECISION", 9, G_DISCARD);
hv_delete((HV*)SvRV(sth), "SCALE", 5, G_DISCARD);
hv_delete((HV*)SvRV(sth), "TYPE", 4, G_DISCARD);
Don't forget to also delete, or update, any driver-private attributes that may
not be correct for the next resultset.
The NUM_OF_FIELDS attribute is a special case. It should be set using STORE:
$sth->STORE(NUM_OF_FIELDS => 0); /* for DBI <= 1.53 */
$sth->STORE(NUM_OF_FIELDS => $new_value);
for drivers written in C use this incantation:
/* Adjust NUM_OF_FIELDS - which also adjusts the row buffer size */
DBIc_NUM_FIELDS(imp_sth) = 0; /* for DBI <= 1.53 */
DBIc_STATE(imp_xxh)->set_attr_k(sth, sv_2mortal(newSVpvn("NUM_OF_FIELDS",13)), 0,
sv_2mortal(newSViv(mysql_num_fields(imp_sth->result)))
);
For DBI versions prior to 1.54 you'll also need to explicitly adjust the
number of elements in the row buffer array (C<DBIc_FIELDS_AV(imp_sth)>)
to match the new result set. Fill any new values with newSV(0) not &sv_undef.
Alternatively you could free DBIc_FIELDS_AV(imp_sth) and set it to null,
but that would mean bind_columns() wouldn't work across result sets.
=head4 Statement attributes
The main difference between I<dbh> and I<sth> attributes is, that you
should implement a lot of attributes here that are required by
the B<DBI>, such as I<NAME>, I<NULLABLE>, I<TYPE>, etc. See
L<DBI/Statement Handle Attributes> for a complete list.
Pay attention to attributes which are marked as read only, such as
I<NUM_OF_PARAMS>. These attributes can only be set the first time
a statement is executed. If a statement is prepared, then executed
multiple times, warnings may be generated.
You can protect against these warnings, and prevent the recalculation
of attributes which might be expensive to calculate (such as the
I<NAME> and I<NAME_*> attributes):
my $storedNumParams = $sth->FETCH('NUM_OF_PARAMS');
if (!defined $storedNumParams or $storedNumFields < 0) {
$sth->STORE('NUM_OF_PARAMS') = $numParams;
# Set other useful attributes that only need to be set once
# for a statement, like $sth->{NAME} and $sth->{TYPE}
}
One particularly important attribute to set correctly (mentioned in
L<DBI/ATTRIBUTES COMMON TO ALL HANDLES> is I<Active>. Many B<DBI> methods,
including C<bind_columns()>, depend on this attribute.
Besides that the C<STORE()> and C<FETCH()> methods are mainly the same
as above for I<dbh>'s.
=head4 Other statement methods
A trivial C<finish()> method to discard stored data, reset any attributes
(such as I<Active>) and do C<$sth-E<gt>SUPER::finish()>.
If you've defined a C<parse_trace_flag()> method in B<::db> you'll also want
it in B<::st>, so just alias it in:
*parse_trace_flag = \&DBD::foo:db::parse_trace_flag;
And perhaps some other methods that are not part of the B<DBI>
specification, in particular to make metadata available.
Remember that they must have names that begin with your drivers
registered prefix so they can be installed using C<install_method()>.
If C<DESTROY()> is called on a statement handle that's still active
(C<$sth-E<gt>{Active}> is true) then it should effectively call C<finish()>.
sub DESTROY {
my $sth = shift;
$sth->finish if $sth->FETCH('Active');
}
=head2 Tests
The test process should conform as closely as possibly to the Perl
standard test harness.
In particular, most (all) of the tests should be run in the F<t> sub-directory,
and should simply produce an C<ok> when run under C<make test>.
For details on how this is done, see the Camel book and the section in
Chapter 7, "The Standard Perl Library" on L<Test::Harness>.
The tests may need to adapt to the type of database which is being used
for testing, and to the privileges of the user testing the driver. For
example, the B<DBD::Informix> test code has to adapt in a number of
places to the type of database to which it is connected as different
Informix databases have different capabilities: some of the tests are
for databases without transaction logs; others are for databases with a
transaction log; some versions of the server have support for blobs, or
stored procedures, or user-defined data types, and others do not.
When a complete file of tests must be skipped, you can provide a reason
in a pseudo-comment:
if ($no_transactions_available)
{
print "1..0 # Skip: No transactions available\n";
exit 0;
}
Consider downloading the B<DBD::Informix> code and look at the code in
F<DBD/Informix/TestHarness.pm> which is used throughout the
B<DBD::Informix> tests in the F<t> sub-directory.
=head1 CREATING A C/XS DRIVER
Please also see the section under L<CREATING A PURE PERL DRIVER>
regarding the creation of the F<Makefile.PL>.
Creating a new C/XS driver from scratch will always be a daunting task.
You can and should greatly simplify your task by taking a good
reference driver implementation and modifying that to match the
database product for which you are writing a driver.
The de facto reference driver has been the one for B<DBD::Oracle> written
by Tim Bunce, who is also the author of the B<DBI> package. The B<DBD::Oracle>
module is a good example of a driver implemented around a C-level API.
Nowadays it it seems better to base on B<DBD::ODBC>, another driver
maintained by Tim and Jeff Urlwin, because it offers a lot of metadata
and seems to become the guideline for the future development. (Also as
B<DBD::Oracle> digs deeper into the Oracle 8 OCI interface it'll get even
more hairy than it is now.)
The B<DBD::Informix> driver is one driver implemented using embedded SQL
instead of a function-based API.
B<DBD::Ingres> may also be worth a look.
=head2 C/XS version of Driver.pm
A lot of the code in the F<Driver.pm> file is very similar to the code for pure Perl modules
- see above. However,
there are also some subtle (and not so subtle) differences, including:
=over 8
=item *
The variables I<$DBD::Driver::{dr|db|st}::imp_data_size> are not defined
here, but in the XS code, because they declare the size of certain
C structures.
=item *
Some methods are typically moved to the XS code, in particular
C<prepare()>, C<execute()>, C<disconnect()>, C<disconnect_all()> and the
C<STORE()> and C<FETCH()> methods.
=item *
Other methods are still part of F<Driver.pm>, but have callbacks to
the XS code.
=item *
If the driver-specific parts of the I<imp_drh_t> structure need to be
formally initialized (which does not seem to be a common requirement),
then you need to add a call to an appropriate XS function in the driver
method of C<DBD::Driver::driver()>, and you define the corresponding function
in F<Driver.xs>, and you define the C code in F<dbdimp.c> and the prototype in
F<dbdimp.h>.
For example, B<DBD::Informix> has such a requirement, and adds the
following call after the call to C<_new_drh()> in F<Informix.pm>:
DBD::Informix::dr::driver_init($drh);
and the following code in F<Informix.xs>:
# Initialize the DBD::Informix driver data structure
void
driver_init(drh)
SV *drh
CODE:
ST(0) = dbd_ix_dr_driver_init(drh) ? &sv_yes : &sv_no;
and the code in F<dbdimp.h> declares:
extern int dbd_ix_dr_driver_init(SV *drh);
and the code in F<dbdimp.ec> (equivalent to F<dbdimp.c>) defines:
/* Formally initialize the DBD::Informix driver structure */
int
dbd_ix_dr_driver(SV *drh)
{
D_imp_drh(drh);
imp_drh->n_connections = 0; /* No active connections */
imp_drh->current_connection = 0; /* No current connection */
imp_drh->multipleconnections = (ESQLC_VERSION >= 600) ? True : False;
dbd_ix_link_newhead(&imp_drh->head); /* Empty linked list of connections */
return 1;
}
B<DBD::Oracle> has a similar requirement but gets around it by checking
whether the private data part of the driver handle is all zeroed out,
rather than add extra functions.
=back
Now let's take a closer look at an excerpt from F<Oracle.pm> (revised
heavily to remove idiosyncrasies) as an example, ignoring things that
were already discussed for pure Perl drivers.
=head3 The connect method
The connect method is the database handle constructor.
You could write either of two versions of this method: either one which
takes connection attributes (new code) and one which ignores them (old
code only).
If you ignore the connection attributes, then you omit all mention of
the I<$auth> variable (which is a reference to a hash of attributes), and
the XS system manages the differences for you.
sub connect
{
my ($drh, $dbname, $user, $auth, $attr) = @_;
# Some database specific verifications, default settings
# and the like following here. This should only include
# syntax checks or similar stuff where it's legal to
# 'die' in case of errors.
my $dbh = DBI::_new_dbh($drh, {
'Name' => $dbname,
})
or return undef;
# Call the driver-specific function _login in Driver.xs file which
# calls the DBMS-specific function(s) to connect to the database,
# and populate internal handle data.
DBD::Driver::db::_login($dbh, $dbname, $user, $auth, $attr)
or return undef;
$dbh;
}
This is mostly the same as in the pure Perl case, the exception being
the use of the private C<_login()> callback, which is the function
that will really connect to the database. It is implemented in
F<Driver.xst> (you should not implement it) and calls
C<dbd_db_login6()> or C<dbd_db_login6_sv> from F<dbdimp.c>. See below
for details.
If your driver has driver-specific attributes which may be passed in the
connect method and hence end up in C<$attr> in C<dbd_db_login6> then it
is best to delete any you process so DBI does not send them again
via STORE after connect. You can do this in C like this:
DBD_ATTRIB_DELETE(attr, "my_attribute_name",
strlen("my_attribute_name"));
However, prior to DBI subversion version 11605 (and fixed post 1.607)
DBD_ATTRIB_DELETE segfaulted so if you cannot guarantee the DBI version
will be post 1.607 you need to use:
hv_delete((HV*)SvRV(attr), "my_attribute_name",
strlen("my_attribute_name"), G_DISCARD);
*FIX ME* Discuss removing attributes in Perl code.
=head3 The disconnect_all method
*FIX ME* T.B.S
=head3 The data_sources method
If your C<data_sources()> method can be implemented in pure Perl, then do
so because it is easier than doing it in XS code (see the section above
for pure Perl drivers).
If your C<data_sources()> method must call onto compiled functions, then
you will need to define I<dbd_dr_data_sources> in your F<dbdimp.h> file, which
will trigger F<Driver.xst> (in B<DBI> v1.33 or greater) to generate the XS
code that calls your actual C function (see the discussion below for
details) and you do not code anything in F<Driver.pm> to handle it.
=head3 The prepare method
The prepare method is the statement handle constructor, and most of it
is not new. Like the C<connect()> method, it now has a C callback:
package DBD::Driver::db; # ====== DATABASE ======
use strict;
sub prepare
{
my ($dbh, $statement, $attribs) = @_;
# create a 'blank' sth
my $sth = DBI::_new_sth($dbh, {
'Statement' => $statement,
})
or return undef;
# Call the driver-specific function _prepare in Driver.xs file
# which calls the DBMS-specific function(s) to prepare a statement
# and populate internal handle data.
DBD::Driver::st::_prepare($sth, $statement, $attribs)
or return undef;
$sth;
}
=head3 The execute method
*FIX ME* T.B.S
=head3 The fetchrow_arrayref method
*FIX ME* T.B.S
=head3 Other methods?
*FIX ME* T.B.S
=head2 Driver.xs
F<Driver.xs> should look something like this:
#include "Driver.h"
DBISTATE_DECLARE;
INCLUDE: Driver.xsi
MODULE = DBD::Driver PACKAGE = DBD::Driver::dr
/* Non-standard drh XS methods following here, if any. */
/* If none (the usual case), omit the MODULE line above too. */
MODULE = DBD::Driver PACKAGE = DBD::Driver::db
/* Non-standard dbh XS methods following here, if any. */
/* Currently this includes things like _list_tables from */
/* DBD::mSQL and DBD::mysql. */
MODULE = DBD::Driver PACKAGE = DBD::Driver::st
/* Non-standard sth XS methods following here, if any. */
/* In particular this includes things like _list_fields from */
/* DBD::mSQL and DBD::mysql for accessing metadata. */
Note especially the include of F<Driver.xsi> here: B<DBI> inserts stub
functions for almost all private methods here which will typically do
much work for you.
Wherever you really have to implement something, it will call a private
function in F<dbdimp.c>, and this is what you have to implement.
You need to set up an extra routine if your driver needs to export
constants of its own, analogous to the SQL types available when you say:
use DBI qw(:sql_types);
*FIX ME* T.B.S
=head2 Driver.h
F<Driver.h> is very simple and the operational contents should look like this:
#ifndef DRIVER_H_INCLUDED
#define DRIVER_H_INCLUDED
#define NEED_DBIXS_VERSION 93 /* 93 for DBI versions 1.00 to 1.51+ */
#define PERL_NO_GET_CONTEXT /* if used require DBI 1.51+ */
#include <DBIXS.h> /* installed by the DBI module */
#include "dbdimp.h"
#include "dbivport.h" /* see below */
#include <dbd_xsh.h> /* installed by the DBI module */
#endif /* DRIVER_H_INCLUDED */
The F<DBIXS.h> header defines most of the interesting information that
the writer of a driver needs.
The file F<dbd_xsh.h> header provides prototype declarations for the C
functions that you might decide to implement. Note that you should
normally only define one of C<dbd_db_login()>, C<dbd_db_login6()> or
C<dbd_db_login6_sv> unless you are intent on supporting really old
versions of B<DBI> (prior to B<DBI> 1.06) as well as modern
versions. The only standard, B<DBI>-mandated functions that you need
write are those specified in the F<dbd_xsh.h> header. You might also
add extra driver-specific functions in F<Driver.xs>.
The F<dbivport.h> file should be I<copied> from the latest B<DBI> release
into your distribution each time you modify your driver. Its job is to
allow you to enhance your code to work with the latest B<DBI> API while
still allowing your driver to be compiled and used with older versions
of the B<DBI> (for example, when the C<DBIh_SET_ERR_CHAR()> macro was added
to B<DBI> 1.41, an emulation of it was added to F<dbivport.h>). This makes
users happy and your life easier. Always read the notes in F<dbivport.h>
to check for any limitations in the emulation that you should be aware
of.
With B<DBI> v1.51 or better I recommend that the driver defines
I<PERL_NO_GET_CONTEXT> before F<DBIXS.h> is included. This can significantly
improve efficiency when running under a thread enabled perl. (Remember that
the standard perl in most Linux distributions is built with threads enabled.
So is ActiveState perl for Windows, and perl built for Apache mod_perl2.)
If you do this there are some things to keep in mind:
=over 4
=item *
If I<PERL_NO_GET_CONTEXT> is defined, then every function that calls the Perl
API will need to start out with a C<dTHX;> declaration.
=item *
You'll know which functions need this, because the C compiler will
complain that the undeclared identifier C<my_perl> is used if I<and only if>
the perl you are using to develop and test your driver has threads enabled.
=item *
If you don't remember to test with a thread-enabled perl before making
a release it's likely that you'll get failure reports from users who are.
=item *
For driver private functions it is possible to gain even more
efficiency by replacing C<dTHX;> with C<pTHX_> prepended to the
parameter list and then C<aTHX_> prepended to the argument list where
the function is called.
=back
See L<perlguts/How multiple interpreters and concurrency are supported> for
additional information about I<PERL_NO_GET_CONTEXT>.
=head2 Implementation header dbdimp.h
This header file has two jobs:
First it defines data structures for your private part of the handles.
Note that the DBI provides many common fields for you. For example
the statement handle (imp_sth) already has a row_count field with an IV type
that accessed via the DBIc_ROW_COUNT(imp_sth) macro. Using this is strongly
recommended as it's built in to some DBI internals so the DBI can 'just work'
in more cases and you'll have less driver-specific code to write.
Study DBIXS.h to see what's included with each type of handle.
Second it defines macros that rename the generic names like
C<dbd_db_login()> to database specific names like C<ora_db_login()>. This
avoids name clashes and enables use of different drivers when you work
with a statically linked perl.
It also will have the important task of disabling XS methods that you
don't want to implement.
Finally, the macros will also be used to select alternate
implementations of some functions. For example, the C<dbd_db_login()>
function is not passed the attribute hash.
Since B<DBI> v1.06, if a C<dbd_db_login6()> macro is defined (for a function
with 6 arguments), it will be used instead with the attribute hash
passed as the sixth argument.
Since B<DBI> post v1.607, if a C<dbd_db_login6_sv()> macro is defined (for
a function like dbd_db_login6 but with scalar pointers for the dbname,
username and password), it will be used instead. This will allow your
login6 function to see if there are any Unicode characters in the
dbname.
Similarly defining dbd_db_do4_iv is preferred over dbd_db_do4, dbd_st_rows_iv
over dbd_st_rows, and dbd_st_execute_iv over dbd_st_execute. The *_iv forms are
declared to return the IV type instead of an int.
People used to just pick Oracle's F<dbdimp.c> and use the same names,
structures and types. I strongly recommend against that. At first glance
this saves time, but your implementation will be less readable. It was
just hell when I had to separate B<DBI> specific parts, Oracle specific
parts, mSQL specific parts and mysql specific parts in B<DBD::mysql>'s
I<dbdimp.h> and I<dbdimp.c>. (B<DBD::mysql> was a port of B<DBD::mSQL>
which was based on B<DBD::Oracle>.) [Seconded, based on the experience
taking B<DBD::Informix> apart, even though the version inherited in 1996
was only based on B<DBD::Oracle>.]
This part of the driver is I<your exclusive part>. Rewrite it from
scratch, so it will be clean and short: in other words, a better piece
of code. (Of course keep an eye on other people's work.)
struct imp_drh_st {
dbih_drc_t com; /* MUST be first element in structure */
/* Insert your driver handle attributes here */
};
struct imp_dbh_st {
dbih_dbc_t com; /* MUST be first element in structure */
/* Insert your database handle attributes here */
};
struct imp_sth_st {
dbih_stc_t com; /* MUST be first element in structure */
/* Insert your statement handle attributes here */
};
/* Rename functions for avoiding name clashes; prototypes are */
/* in dbd_xsh.h */
#define dbd_init drv_dr_init
#define dbd_db_login6_sv drv_db_login_sv
#define dbd_db_do drv_db_do
... many more here ...
These structures implement your private part of the handles.
You I<have> to use the name C<imp_dbh_{dr|db|st}> and the first field
I<must> be of type I<dbih_drc_t|_dbc_t|_stc_t> and I<must> be called
C<com>.
You should never access these fields directly, except by using the
I<DBIc_xxx()> macros below.
=head2 Implementation source dbdimp.c
Conventionally, F<dbdimp.c> is the main implementation file (but
B<DBD::Informix> calls the file F<dbdimp.ec>). This section includes a
short note on each function that is used in the F<Driver.xsi> template
and thus I<has> to be implemented.
Of course, you will probably also need to implement other support
functions, which should usually be file static if they are placed in
F<dbdimp.c>. If they are placed in other files, you need to list those
files in F<Makefile.PL> (and F<MANIFEST>) to handle them correctly.
It is wise to adhere to a namespace convention for your functions to
avoid conflicts. For example, for a driver with prefix I<drv_>, you
might call externally visible functions I<dbd_drv_xxxx>. You should also
avoid non-constant global variables as much as possible to improve the
support for threading.
Since Perl requires support for function prototypes (ANSI or ISO or
Standard C), you should write your code using function prototypes too.
It is possible to use either the unmapped names such as C<dbd_init()> or
the mapped names such as C<dbd_ix_dr_init()> in the F<dbdimp.c> file.
B<DBD::Informix> uses the mapped names which makes it easier to identify
where to look for linkage problems at runtime (which will report errors
using the mapped names).
Most other drivers, and in particular B<DBD::Oracle>, use the unmapped
names in the source code which makes it a little easier to compare code
between drivers and eases discussions on the I<dbi-dev> mailing list.
The majority of the code fragments here will use the unmapped names.
Ultimately, you should provide implementations for most of the
functions listed in the F<dbd_xsh.h> header. The exceptions are
optional functions (such as C<dbd_st_rows()>) and those functions with
alternative signatures, such as C<dbd_db_login6_sv>,
C<dbd_db_login6()> and I<dbd_db_login()>. Then you should only
implement one of the alternatives, and generally the newer one of the
alternatives.
=head3 The dbd_init method
#include "Driver.h"
DBISTATE_DECLARE;
void dbd_init(dbistate_t* dbistate)
{
DBISTATE_INIT; /* Initialize the DBI macros */
}
The C<dbd_init()> function will be called when your driver is first
loaded; the bootstrap command in C<DBD::Driver::dr::driver()> triggers this,
and the call is generated in the I<BOOT> section of F<Driver.xst>.
These statements are needed to allow your driver to use the B<DBI> macros.
They will include your private header file F<dbdimp.h> in turn.
Note that I<DBISTATE_INIT> requires the name of the argument to C<dbd_init()>
to be called C<dbistate()>.
=head3 The dbd_drv_error method
You need a function to record errors so B<DBI> can access them properly.
You can call it whatever you like, but we'll call it C<dbd_drv_error()>
here.
The argument list depends on your database software; different systems
provide different ways to get at error information.
static void dbd_drv_error(SV *h, int rc, const char *what)
{
Note that I<h> is a generic handle, may it be a driver handle, a
database or a statement handle.
D_imp_xxh(h);
This macro will declare and initialize a variable I<imp_xxh> with
a pointer to your private handle pointer. You may cast this to
to I<imp_drh_t>, I<imp_dbh_t> or I<imp_sth_t>.
To record the error correctly, equivalent to the C<set_err()> method,
use one of the C<DBIh_SET_ERR_CHAR(...)> or C<DBIh_SET_ERR_SV(...)> macros,
which were added in B<DBI> 1.41:
DBIh_SET_ERR_SV(h, imp_xxh, err, errstr, state, method);
DBIh_SET_ERR_CHAR(h, imp_xxh, err_c, err_i, errstr, state, method);
For C<DBIh_SET_ERR_SV> the I<err>, I<errstr>, I<state>, and I<method>
parameters are C<SV*> (use &sv_undef instead of NULL).
For C<DBIh_SET_ERR_CHAR> the I<err_c>, I<errstr>, I<state>, I<method>
parameters are C<char*>.
The I<err_i> parameter is an C<IV> that's used instead of I<err_c> if
I<err_c> is C<Null>.
The I<method> parameter can be ignored.
The C<DBIh_SET_ERR_CHAR> macro is usually the simplest to use when you
just have an integer error code and an error message string:
DBIh_SET_ERR_CHAR(h, imp_xxh, Nullch, rc, what, Nullch, Nullch);
As you can see, any parameters that aren't relevant to you can be C<Null>.
To make drivers compatible with B<DBI> < 1.41 you should be using F<dbivport.h>
as described in L</Driver.h> above.
The (obsolete) macros such as C<DBIh_EVENT2> should be removed from drivers.
The names C<dbis> and C<DBIS>, which were used in previous versions of
this document, should be replaced with the C<DBIc_DBISTATE(imp_xxh)> macro.
The name C<DBILOGFP>, which was also used in previous versions of this
document, should be replaced by C<DBIc_LOGPIO(imp_xxh)>.
Your code should not call the C C<E<lt>stdio.hE<gt>> I/O functions; you
should use C<PerlIO_printf()> as shown:
if (DBIc_TRACE_LEVEL(imp_xxh) >= 2)
PerlIO_printf(DBIc_LOGPIO(imp_xxh), "foobar %s: %s\n",
foo, neatsvpv(errstr,0));
That's the first time we see how tracing works within a B<DBI> driver. Make
use of this as often as you can, but don't output anything at a trace
level less than 3. Levels 1 and 2 are reserved for the B<DBI>.
You can define up to 8 private trace flags using the top 8 bits
of C<DBIc_TRACE_FLAGS(imp)>, that is: C<0xFF000000>. See the
C<parse_trace_flag()> method elsewhere in this document.
=head3 The dbd_dr_data_sources method
This method is optional; the support for it was added in B<DBI> v1.33.
As noted in the discussion of F<Driver.pm>, if the data sources
can be determined by pure Perl code, do it that way. If, as in
B<DBD::Informix>, the information is obtained by a C function call, then
you need to define a function that matches the prototype:
extern AV *dbd_dr_data_sources(SV *drh, imp_drh_t *imp_drh, SV *attrs);
An outline implementation for B<DBD::Informix> follows, assuming that the
C<sqgetdbs()> function call shown will return up to 100 databases names,
with the pointers to each name in the array dbsname and the name strings
themselves being stores in dbsarea.
AV *dbd_dr_data_sources(SV *drh, imp_drh_t *imp_drh, SV *attr)
{
int ndbs;
int i;
char *dbsname[100];
char dbsarea[10000];
AV *av = Nullav;
if (sqgetdbs(&ndbs, dbsname, 100, dbsarea, sizeof(dbsarea)) == 0)
{
av = NewAV();
av_extend(av, (I32)ndbs);
sv_2mortal((SV *)av);
for (i = 0; i < ndbs; i++)
av_store(av, i, newSVpvf("dbi:Informix:%s", dbsname[i]));
}
return(av);
}
The actual B<DBD::Informix> implementation has a number of extra lines of
code, logs function entry and exit, reports the error from C<sqgetdbs()>,
and uses C<#define>'d constants for the array sizes.
=head3 The dbd_db_login6 method
int dbd_db_login6_sv(SV* dbh, imp_dbh_t* imp_dbh, SV* dbname,
SV* user, SV* auth, SV *attr);
or
int dbd_db_login6(SV* dbh, imp_dbh_t* imp_dbh, char* dbname,
char* user, char* auth, SV *attr);
This function will really connect to the database. The argument I<dbh>
is the database handle. I<imp_dbh> is the pointer to the handles private
data, as is I<imp_xxx> in C<dbd_drv_error()> above. The arguments
I<dbname>, I<user>, I<auth> and I<attr> correspond to the arguments of
the driver handle's C<connect()> method.
You will quite often use database specific attributes here, that are
specified in the DSN. I recommend you parse the DSN (using Perl) within
the C<connect()> method and pass the segments of the DSN via the
attributes parameter through C<_login()> to C<dbd_db_login6()>.
Here's how you fetch them; as an example we use I<hostname> attribute,
which can be up to 12 characters long excluding null terminator:
SV** svp;
STRLEN len;
char* hostname;
if ( (svp = DBD_ATTRIB_GET_SVP(attr, "drv_hostname", 12)) && SvTRUE(*svp)) {
hostname = SvPV(*svp, len);
DBD_ATTRIB_DELETE(attr, "drv_hostname", 12); /* avoid later STORE */
} else {
hostname = "localhost";
}
If you handle any driver specific attributes in the dbd_db_login6
method you probably want to delete them from C<attr> (as above with
DBD_ATTRIB_DELETE). If you don't delete your handled attributes DBI
will call C<STORE> for each attribute after the connect/login and this
is at best redundant for attributes you have already processed.
B<Note: Until revision 11605 (post DBI 1.607), there was a problem with
DBD_ATTRIBUTE_DELETE so unless you require a DBI version after 1.607
you need to replace each DBD_ATTRIBUTE_DELETE call with:>
hv_delete((HV*)SvRV(attr), key, key_len, G_DISCARD)
Note that you can also obtain standard attributes such as I<AutoCommit> and
I<ChopBlanks> from the attributes parameter, using C<DBD_ATTRIB_GET_IV> for
integer attributes.
If, for example, your database does not support transactions but
I<AutoCommit> is set off (requesting transaction support), then you can
emulate a 'failure to connect'.
Now you should really connect to the database. In general, if the
connection fails, it is best to ensure that all allocated resources are
released so that the handle does not need to be destroyed separately. If
you are successful (and possibly even if you fail but you have allocated
some resources), you should use the following macros:
DBIc_IMPSET_on(imp_dbh);
This indicates that the driver (implementor) has allocated resources in
the I<imp_dbh> structure and that the implementors private C<dbd_db_destroy()>
function should be called when the handle is destroyed.
DBIc_ACTIVE_on(imp_dbh);
This indicates that the handle has an active connection to the server
and that the C<dbd_db_disconnect()> function should be called before the
handle is destroyed.
Note that if you do need to fail, you should report errors via the I<drh>
or I<imp_drh> rather than via I<dbh> or I<imp_dbh> because I<imp_dbh> will be
destroyed by the failure, so errors recorded in that handle will not be
visible to B<DBI>, and hence not the user either.
Note too, that the function is passed I<dbh> and I<imp_dbh>, and there
is a macro C<D_imp_drh_from_dbh> which can recover the I<imp_drh> from
the I<imp_dbh>. However, there is no B<DBI> macro to provide you with the
I<drh> given either the I<imp_dbh> or the I<dbh> or the I<imp_drh> (and
there's no way to recover the I<dbh> given just the I<imp_dbh>).
This suggests that, despite the above notes about C<dbd_drv_error()>
taking an C<SV *>, it may be better to have two error routines, one
taking I<imp_dbh> and one taking I<imp_drh> instead. With care, you can
factor most of the formatting code out so that these are small routines
calling a common error formatter. See the code in B<DBD::Informix>
1.05.00 for more information.
The C<dbd_db_login6()> function should return I<TRUE> for success,
I<FALSE> otherwise.
Drivers implemented long ago may define the five-argument function
C<dbd_db_login()> instead of C<dbd_db_login6()>. The missing argument is
the attributes. There are ways to work around the missing attributes,
but they are ungainly; it is much better to use the 6-argument form.
Even later drivers will use C<dbd_db_login6_sv()> which provides the
dbname, username and password as SVs.
=head3 The dbd_db_commit and dbd_db_rollback methods
int dbd_db_commit(SV *dbh, imp_dbh_t *imp_dbh);
int dbd_db_rollback(SV* dbh, imp_dbh_t* imp_dbh);
These are used for commit and rollback. They should return I<TRUE> for
success, I<FALSE> for error.
The arguments I<dbh> and I<imp_dbh> are the same as for C<dbd_db_login6()>
above; I will omit describing them in what follows, as they appear
always.
These functions should return I<TRUE> for success, I<FALSE> otherwise.
=head3 The dbd_db_disconnect method
This is your private part of the C<disconnect()> method. Any I<dbh> with
the I<ACTIVE> flag on must be disconnected. (Note that you have to set
it in C<dbd_db_connect()> above.)
int dbd_db_disconnect(SV* dbh, imp_dbh_t* imp_dbh);
The database handle will return I<TRUE> for success, I<FALSE> otherwise.
In any case it should do a:
DBIc_ACTIVE_off(imp_dbh);
before returning so B<DBI> knows that C<dbd_db_disconnect()> was executed.
Note that there's nothing to stop a I<dbh> being I<disconnected> while
it still have active children. If your database API reacts badly to
trying to use an I<sth> in this situation then you'll need to add code
like this to all I<sth> methods:
if (!DBIc_ACTIVE(DBIc_PARENT_COM(imp_sth)))
return 0;
Alternatively, you can add code to your driver to keep explicit track of
the statement handles that exist for each database handle and arrange
to destroy those handles before disconnecting from the database. There
is code to do this in B<DBD::Informix>. Similar comments apply to the
driver handle keeping track of all the database handles.
Note that the code which destroys the subordinate handles should only
release the associated database resources and mark the handles inactive;
it does not attempt to free the actual handle structures.
This function should return I<TRUE> for success, I<FALSE> otherwise, but
it is not clear what anything can do about a failure.
=head3 The dbd_db_discon_all method
int dbd_discon_all (SV *drh, imp_drh_t *imp_drh);
This function may be called at shutdown time. It should make
best-efforts to disconnect all database handles - if possible. Some
databases don't support that, in which case you can do nothing
but return 'success'.
This function should return I<TRUE> for success, I<FALSE> otherwise, but
it is not clear what anything can do about a failure.
=head3 The dbd_db_destroy method
This is your private part of the database handle destructor. Any I<dbh> with
the I<IMPSET> flag on must be destroyed, so that you can safely free
resources. (Note that you have to set it in C<dbd_db_connect()> above.)
void dbd_db_destroy(SV* dbh, imp_dbh_t* imp_dbh)
{
DBIc_IMPSET_off(imp_dbh);
}
The B<DBI> F<Driver.xst> code will have called C<dbd_db_disconnect()> for you,
if the handle is still 'active', before calling C<dbd_db_destroy()>.
Before returning the function must switch I<IMPSET> to off, so B<DBI> knows
that the destructor was called.
A B<DBI> handle doesn't keep references to its children. But children
do keep references to their parents. So a database handle won't be
C<DESTROY>'d until all its children have been C<DESTROY>'d.
=head3 The dbd_db_STORE_attrib method
This function handles
$dbh->{$key} = $value;
Its prototype is:
int dbd_db_STORE_attrib(SV* dbh, imp_dbh_t* imp_dbh, SV* keysv,
SV* valuesv);
You do not handle all attributes; on the contrary, you should not handle
B<DBI> attributes here: leave this to B<DBI>. (There are two exceptions,
I<AutoCommit> and I<ChopBlanks>, which you should care about.)
The return value is I<TRUE> if you have handled the attribute or I<FALSE>
otherwise. If you are handling an attribute and something fails, you
should call C<dbd_drv_error()>, so B<DBI> can raise exceptions, if desired.
If C<dbd_drv_error()> returns, however, you have a problem: the user will
never know about the error, because he typically will not check
C<$dbh-E<gt>errstr()>.
I cannot recommend a general way of going on, if C<dbd_drv_error()> returns,
but there are examples where even the B<DBI> specification expects that
you C<croak()>. (See the I<AutoCommit> method in L<DBI>.)
If you have to store attributes, you should either use your private
data structure I<imp_xxx>, the handle hash (via C<(HV*)SvRV(dbh)>), or use
the private I<imp_data>.
The first is best for internal C values like integers or pointers and
where speed is important within the driver. The handle hash is best for
values the user may want to get/set via driver-specific attributes.
The private I<imp_data> is an additional C<SV> attached to the handle. You
could think of it as an unnamed handle attribute. It's not normally used.
=head3 The dbd_db_FETCH_attrib method
This is the counterpart of C<dbd_db_STORE_attrib()>, needed for:
$value = $dbh->{$key};
Its prototype is:
SV* dbd_db_FETCH_attrib(SV* dbh, imp_dbh_t* imp_dbh, SV* keysv);
Unlike all previous methods this returns an C<SV> with the value. Note
that you should normally execute C<sv_2mortal()>, if you return a nonconstant
value. (Constant values are C<&sv_undef>, C<&sv_no> and C<&sv_yes>.)
Note, that B<DBI> implements a caching algorithm for attribute values.
If you think, that an attribute may be fetched, you store it in the
I<dbh> itself:
if (cacheit) /* cache value for later DBI 'quick' fetch? */
hv_store((HV*)SvRV(dbh), key, kl, cachesv, 0);
=head3 The dbd_st_prepare method
This is the private part of the C<prepare()> method. Note that you
B<must not> really execute the statement here. You may, however,
preparse and validate the statement, or do similar things.
int dbd_st_prepare(SV* sth, imp_sth_t* imp_sth, char* statement,
SV* attribs);
A typical, simple, possibility is to do nothing and rely on the perl
C<prepare()> code that set the I<Statement> attribute on the handle. This
attribute can then be used by C<dbd_st_execute()>.
If the driver supports placeholders then the I<NUM_OF_PARAMS> attribute
must be set correctly by C<dbd_st_prepare()>:
DBIc_NUM_PARAMS(imp_sth) = ...
If you can, you should also setup attributes like I<NUM_OF_FIELDS>, I<NAME>,
etc. here, but B<DBI> doesn't require that - they can be deferred until
execute() is called. However, if you do, document it.
In any case you should set the I<IMPSET> flag, as you did in
C<dbd_db_connect()> above:
DBIc_IMPSET_on(imp_sth);
=head3 The dbd_st_execute method
This is where a statement will really be executed.
int dbd_st_execute(SV* sth, imp_sth_t* imp_sth);
C<dbd_st_execute> should return -2 for any error, -1 if the number of
rows affected is unknown else it should be the number of affected
(updated, inserted) rows.
Note that you must be aware a statement may be executed repeatedly.
Also, you should not expect that C<finish()> will be called between two
executions, so you might need code, like the following, near the start
of the function:
if (DBIc_ACTIVE(imp_sth))
dbd_st_finish(h, imp_sth);
If your driver supports the binding of parameters (it should!), but the
database doesn't, you must do it here. This can be done as follows:
SV *svp;
char* statement = DBD_ATTRIB_GET_PV(h, "Statement", 9, svp, "");
int numParam = DBIc_NUM_PARAMS(imp_sth);
int i;
for (i = 0; i < numParam; i++)
{
char* value = dbd_db_get_param(sth, imp_sth, i);
/* It is your drivers task to implement dbd_db_get_param, */
/* it must be setup as a counterpart of dbd_bind_ph. */
/* Look for '?' and replace it with 'value'. Difficult */
/* task, note that you may have question marks inside */
/* quotes and comments the like ... :-( */
/* See DBD::mysql for an example. (Don't look too deep into */
/* the example, you will notice where I was lazy ...) */
}
The next thing is to really execute the statement.
Note that you must set the attributes I<NUM_OF_FIELDS>, I<NAME>, etc
when the statement is successfully executed if the driver has not
already done so: they may be used even before a potential C<fetchrow()>.
In particular you have to tell B<DBI> the number of fields that the
statement has, because it will be used by B<DBI> internally. Thus the
function will typically ends with:
if (isSelectStatement) {
DBIc_NUM_FIELDS(imp_sth) = numFields;
DBIc_ACTIVE_on(imp_sth);
}
It is important that the I<ACTIVE> flag only be set for C<SELECT>
statements (or any other statements that can return many
values from the database using a cursor-like mechanism). See
C<dbd_db_connect()> above for more explanations.
There plans for a preparse function to be provided by B<DBI>, but this has
not reached fruition yet.
Meantime, if you want to know how ugly it can get, try looking at the
C<dbd_ix_preparse()> in B<DBD::Informix> F<dbdimp.ec> and the related
functions in F<iustoken.c> and F<sqltoken.c>.
=head3 The dbd_st_fetch method
This function fetches a row of data. The row is stored in in an array,
of C<SV>'s that B<DBI> prepares for you. This has two advantages: it is fast
(you even reuse the C<SV>'s, so they don't have to be created after the
first C<fetchrow()>), and it guarantees that B<DBI> handles C<bind_cols()> for
you.
What you do is the following:
AV* av;
int numFields = DBIc_NUM_FIELDS(imp_sth); /* Correct, if NUM_FIELDS
is constant for this statement. There are drivers where this is
not the case! */
int chopBlanks = DBIc_is(imp_sth, DBIcf_ChopBlanks);
int i;
if (!fetch_new_row_of_data(...)) {
... /* check for error or end-of-data */
DBIc_ACTIVE_off(imp_sth); /* turn off Active flag automatically */
return Nullav;
}
/* get the fbav (field buffer array value) for this row */
/* it is very important to only call this after you know */
/* that you have a row of data to return. */
av = DBIc_DBISTATE(imp_sth)->get_fbav(imp_sth);
for (i = 0; i < numFields; i++) {
SV* sv = fetch_a_field(..., i);
if (chopBlanks && SvOK(sv) && type_is_blank_padded(field_type[i])) {
/* Remove white space from end (only) of sv */
}
sv_setsv(AvARRAY(av)[i], sv); /* Note: (re)use! */
}
return av;
There's no need to use a C<fetch_a_field()> function returning an C<SV*>.
It's more common to use your database API functions to fetch the
data as character strings and use code like this:
sv_setpvn(AvARRAY(av)[i], char_ptr, char_count);
C<NULL> values must be returned as C<undef>. You can use code like this:
SvOK_off(AvARRAY(av)[i]);
The function returns the C<AV> prepared by B<DBI> for success or C<Nullav>
otherwise.
*FIX ME* Discuss what happens when there's no more data to fetch.
Are errors permitted if another fetch occurs after the first fetch
that reports no more data. (Permitted, not required.)
If an error occurs which leaves the I<$sth> in a state where remaining
rows can't be fetched then I<Active> should be turned off before the
method returns.
=head3 The dbd_st_finish3 method
The C<$sth-E<gt>finish()> method can be called if the user wishes to
indicate that no more rows will be fetched even if the database has more
rows to offer, and the B<DBI> code can call the function when handles are
being destroyed. See the B<DBI> specification for more background details.
In both circumstances, the B<DBI> code ends up calling the
C<dbd_st_finish3()> method (if you provide a mapping for
C<dbd_st_finish3()> in F<dbdimp.h>), or C<dbd_st_finish()> otherwise.
The difference is that C<dbd_st_finish3()> takes a third argument which
is an C<int> with the value 1 if it is being called from a C<destroy()>
method and 0 otherwise.
Note that B<DBI> v1.32 and earlier test on C<dbd_db_finish3()> to call
C<dbd_st_finish3()>; if you provide C<dbd_st_finish3()>, either define
C<dbd_db_finish3()> too, or insist on B<DBI> v1.33 or later.
All it I<needs> to do is turn off the I<Active> flag for the I<sth>.
It will only be called by F<Driver.xst> code, if the driver has set I<ACTIVE>
to on for the I<sth>.
Outline example:
int dbd_st_finish3(SV* sth, imp_sth_t* imp_sth, int from_destroy) {
if (DBIc_ACTIVE(imp_sth))
{
/* close cursor or equivalent action */
DBIc_ACTIVE_off(imp_sth);
}
return 1;
}
The from_destroy parameter is true if C<dbd_st_finish3()> is being called
from C<DESTROY()> - and so the statement is about to be destroyed.
For many drivers there is no point in doing anything more than turning off
the I<Active> flag in this case.
The function returns I<TRUE> for success, I<FALSE> otherwise, but there isn't
a lot anyone can do to recover if there is an error.
=head3 The dbd_st_destroy method
This function is the private part of the statement handle destructor.
void dbd_st_destroy(SV* sth, imp_sth_t* imp_sth) {
... /* any clean-up that's needed */
DBIc_IMPSET_off(imp_sth); /* let DBI know we've done it */
}
The B<DBI> F<Driver.xst> code will call C<dbd_st_finish()> for you, if the
I<sth> has the I<ACTIVE> flag set, before calling C<dbd_st_destroy()>.
=head3 The dbd_st_STORE_attrib and dbd_st_FETCH_attrib methods
These functions correspond to C<dbd_db_STORE()> and C<dbd_db_FETCH()> attrib
above, except that they are for statement handles.
See above.
int dbd_st_STORE_attrib(SV* sth, imp_sth_t* imp_sth, SV* keysv,
SV* valuesv);
SV* dbd_st_FETCH_attrib(SV* sth, imp_sth_t* imp_sth, SV* keysv);
=head3 The dbd_bind_ph method
This function is internally used by the C<bind_param()> method, the
C<bind_param_inout()> method and by the B<DBI> F<Driver.xst> code if
C<execute()> is called with any bind parameters.
int dbd_bind_ph (SV *sth, imp_sth_t *imp_sth, SV *param,
SV *value, IV sql_type, SV *attribs,
int is_inout, IV maxlen);
The I<param> argument holds an C<IV> with the parameter number (1, 2, ...).
The I<value> argument is the parameter value and I<sql_type> is its type.
If your driver does not support C<bind_param_inout()> then you should
ignore I<maxlen> and croak if I<is_inout> is I<TRUE>.
If your driver I<does> support C<bind_param_inout()> then you should
note that I<value> is the C<SV> I<after> dereferencing the reference
passed to C<bind_param_inout()>.
In drivers of simple databases the function will, for example, store
the value in a parameter array and use it later in C<dbd_st_execute()>.
See the B<DBD::mysql> driver for an example.
=head3 Implementing bind_param_inout support
To provide support for parameters bound by reference rather than by
value, the driver must do a number of things. First, and most
importantly, it must note the references and stash them in its own
driver structure. Secondly, when a value is bound to a column, the
driver must discard any previous reference bound to the column. On
each execute, the driver must evaluate the references and internally
bind the values resulting from the references. This is only applicable
if the user writes:
$sth->execute;
If the user writes:
$sth->execute(@values);
then B<DBI> automatically calls the binding code for each element of
I<@values>. These calls are indistinguishable from explicit user calls to
C<bind_param()>.
=head2 C/XS version of Makefile.PL
The F<Makefile.PL> file for a C/XS driver is similar to the code needed
for a pure Perl driver, but there are a number of extra bits of
information needed by the build system.
For example, the attributes list passed to C<WriteMakefile()> needs
to specify the object files that need to be compiled and built into
the shared object (DLL). This is often, but not necessarily, just
F<dbdimp.o> (unless that should be F<dbdimp.obj> because you're building
on MS Windows).
Note that you can reliably determine the extension of the object files
from the I<$Config{obj_ext}> values, and there are many other useful pieces
of configuration information lurking in that hash.
You get access to it with:
use Config;
=head2 Methods which do not need to be written
The B<DBI> code implements the majority of the methods which are accessed
using the notation C<DBI-E<gt>function()>, the only exceptions being
C<DBI-E<gt>connect()> and C<DBI-E<gt>data_sources()> which require
support from the driver.
The B<DBI> code implements the following documented driver, database and
statement functions which do not need to be written by the B<DBD> driver
writer.
=over 4
=item $dbh->do()
The default implementation of this function prepares, executes and
destroys the statement. This can be replaced if there is a better
way to implement this, such as C<EXECUTE IMMEDIATE> which can
sometimes be used if there are no parameters.
=item $h->errstr()
=item $h->err()
=item $h->state()
=item $h->trace()
The B<DBD> driver does not need to worry about these routines at all.
=item $h->{ChopBlanks}
This attribute needs to be honored during C<fetch()> operations, but does
not need to be handled by the attribute handling code.
=item $h->{RaiseError}
The B<DBD> driver does not need to worry about this attribute at all.
=item $h->{PrintError}
The B<DBD> driver does not need to worry about this attribute at all.
=item $sth->bind_col()
Assuming the driver uses the C<DBIc_DBISTATE(imp_xxh)-E<gt>get_fbav()>
function (C drivers, see below), or the C<$sth-E<gt>_set_fbav($data)>
method (Perl drivers) the driver does not need to do anything about this
routine.
=item $sth->bind_columns()
Regardless of whether the driver uses
C<DBIc_DBISTATE(imp_xxh)-E<gt>get_fbav()>, the driver does not need
to do anything about this routine as it simply iteratively calls
C<$sth-E<gt>bind_col()>.
=back
The B<DBI> code implements a default implementation of the following
functions which do not need to be written by the B<DBD> driver writer
unless the default implementation is incorrect for the Driver.
=over 4
=item $dbh->quote()
This should only be written if the database does not accept the ANSI
SQL standard for quoting strings, with the string enclosed in single
quotes and any embedded single quotes replaced by two consecutive
single quotes.
For the two argument form of quote, you need to implement the
C<type_info()> method to provide the information that quote needs.
=item $dbh->ping()
This should be implemented as a simple efficient way to determine
whether the connection to the database is still alive. Typically
code like this:
sub ping {
my $dbh = shift;
$sth = $dbh->prepare_cached(q{
select * from A_TABLE_NAME where 1=0
}) or return 0;
$sth->execute or return 0;
$sth->finish;
return 1;
}
where I<A_TABLE_NAME> is the name of a table that always exists (such as a
database system catalogue).
=item $drh->default_user
The default implementation of default_user will get the database
username and password fields from C<$ENV{DBI_USER}> and
C<$ENV{DBI_PASS}>. You can override this method. It is called as
follows:
($user, $pass) = $drh->default_user($user, $pass, $attr)
=back
=head1 METADATA METHODS
The exposition above ignores the B<DBI> MetaData methods.
The metadata methods are all associated with a database handle.
=head2 Using DBI::DBD::Metadata
The B<DBI::DBD::Metadata> module is a good semi-automatic way for the
developer of a B<DBD> module to write the C<get_info()> and C<type_info()>
functions quickly and accurately.
=head3 Generating the get_info method
Prior to B<DBI> v1.33, this existed as the method C<write_getinfo_pm()>
in the B<DBI::DBD> module. From B<DBI> v1.33, it exists as the method
C<write_getinfo_pm()> in the B<DBI::DBD::Metadata> module. This
discussion assumes you have B<DBI> v1.33 or later.
You examine the documentation for C<write_getinfo_pm()> using:
perldoc DBI::DBD::Metadata
To use it, you need a Perl B<DBI> driver for your database which implements
the C<get_info()> method. In practice, this means you need to install
B<DBD::ODBC>, an ODBC driver manager, and an ODBC driver for your
database.
With the pre-requisites in place, you might type:
perl -MDBI::DBD::Metadata -we \
"write_getinfo_pm (qw{ dbi:ODBC:foo_db username password Driver })"
The procedure writes to standard output the code that should be added to
your F<Driver.pm> file and the code that should be written to
F<lib/DBD/Driver/GetInfo.pm>.
You should review the output to ensure that it is sensible.
=head3 Generating the type_info method
Given the idea of the C<write_getinfo_pm()> method, it was not hard
to devise a parallel method, C<write_typeinfo_pm()>, which does the
analogous job for the B<DBI> C<type_info_all()> metadata method. The
C<write_typeinfo_pm()> method was added to B<DBI> v1.33.
You examine the documentation for C<write_typeinfo_pm()> using:
perldoc DBI::DBD::Metadata
The setup is exactly analogous to the mechanism described in
L</Generating the get_info method>.
With the pre-requisites in place, you might type:
perl -MDBI::DBD::Metadata -we \
"write_typeinfo_pm (qw{ dbi:ODBC:foo_db username password Driver })"
The procedure writes to standard output the code that should be added to
your F<Driver.pm> file and the code that should be written to
F<lib/DBD/Driver/TypeInfo.pm>.
You should review the output to ensure that it is sensible.
=head2 Writing DBD::Driver::db::get_info
If you use the B<DBI::DBD::Metadata> module, then the code you need is
generated for you.
If you decide not to use the B<DBI::DBD::Metadata> module, you
should probably borrow the code from a driver that has done so (eg
B<DBD::Informix> from version 1.05 onwards) and crib the code from
there, or look at the code that generates that module and follow
that. The method in F<Driver.pm> will be very simple; the method in
F<lib/DBD/Driver/GetInfo.pm> is not very much more complex unless your
DBMS itself is much more complex.
Note that some of the B<DBI> utility methods rely on information from the
C<get_info()> method to perform their operations correctly. See, for
example, the C<quote_identifier()> and quote methods, discussed below.
=head2 Writing DBD::Driver::db::type_info_all
If you use the C<DBI::DBD::Metadata> module, then the code you need is
generated for you.
If you decide not to use the C<DBI::DBD::Metadata> module, you
should probably borrow the code from a driver that has done so (eg
C<DBD::Informix> from version 1.05 onwards) and crib the code from
there, or look at the code that generates that module and follow
that. The method in F<Driver.pm> will be very simple; the method in
F<lib/DBD/Driver/TypeInfo.pm> is not very much more complex unless your
DBMS itself is much more complex.
=head2 Writing DBD::Driver::db::type_info
The guidelines on writing this method are still not really clear.
No sample implementation is available.
=head2 Writing DBD::Driver::db::table_info
*FIX ME* The guidelines on writing this method have not been written yet.
No sample implementation is available.
=head2 Writing DBD::Driver::db::column_info
*FIX ME* The guidelines on writing this method have not been written yet.
No sample implementation is available.
=head2 Writing DBD::Driver::db::primary_key_info
*FIX ME* The guidelines on writing this method have not been written yet.
No sample implementation is available.
=head2 Writing DBD::Driver::db::primary_key
*FIX ME* The guidelines on writing this method have not been written yet.
No sample implementation is available.
=head2 Writing DBD::Driver::db::foreign_key_info
*FIX ME* The guidelines on writing this method have not been written yet.
No sample implementation is available.
=head2 Writing DBD::Driver::db::tables
This method generates an array of names in a format suitable for being
embedded in SQL statements in places where a table name is expected.
If your database hews close enough to the SQL standard or if you have
implemented an appropriate C<table_info()> function and and the appropriate
C<quote_identifier()> function, then the B<DBI> default version of this method
will work for your driver too.
Otherwise, you have to write a function yourself, such as:
sub tables
{
my($dbh, $cat, $sch, $tab, $typ) = @_;
my(@res);
my($sth) = $dbh->table_info($cat, $sch, $tab, $typ);
my(@arr);
while (@arr = $sth->fetchrow_array)
{
push @res, $dbh->quote_identifier($arr[0], $arr[1], $arr[2]);
}
return @res;
}
See also the default implementation in F<DBI.pm>.
=head2 Writing DBD::Driver::db::quote
This method takes a value and converts it into a string suitable for
embedding in an SQL statement as a string literal.
If your DBMS accepts the SQL standard notation for strings (single
quotes around the string as a whole with any embedded single quotes
doubled up), then you do not need to write this method as B<DBI> provides a
default method that does it for you.
If your DBMS uses an alternative notation or escape mechanism, then you
need to provide an equivalent function. For example, suppose your DBMS
used C notation with double quotes around the string and backslashes
escaping both double quotes and backslashes themselves. Then you might
write the function as:
sub quote
{
my($dbh, $str) = @_;
$str =~ s/["\\]/\\$&/gmo;
return qq{"$str"};
}
Handling newlines and other control characters is left as an exercise
for the reader.
This sample method ignores the I<$data_type> indicator which is the
optional second argument to the method.
=head2 Writing DBD::Driver::db::quote_identifier
This method is called to ensure that the name of the given table (or
other database object) can be embedded into an SQL statement without
danger of misinterpretation. The result string should be usable in the
text of an SQL statement as the identifier for a table.
If your DBMS accepts the SQL standard notation for quoted identifiers
(which uses double quotes around the identifier as a whole, with any
embedded double quotes doubled up) and accepts I<"schema"."identifier">
(and I<"catalog"."schema"."identifier"> when a catalog is specified), then
you do not need to write this method as B<DBI> provides a default method
that does it for you.
In fact, even if your DBMS does not handle exactly that notation but
you have implemented the C<get_info()> method and it gives the correct
responses, then it will work for you. If your database is fussier, then
you need to implement your own version of the function.
For example, B<DBD::Informix> has to deal with an environment variable
I<DELIMIDENT>. If it is not set, then the DBMS treats names enclosed in
double quotes as strings rather than names, which is usually a syntax
error. Additionally, the catalog portion of the name is separated from
the schema and table by a different delimiter (colon instead of dot),
and the catalog portion is never enclosed in quotes. (Fortunately,
valid strings for the catalog will never contain weird characters that
might need to be escaped, unless you count dots, dashes, slashes and
at-signs as weird.) Finally, an Informix database can contain objects
that cannot be accessed because they were created by a user with the
I<DELIMIDENT> environment variable set, but the current user does not
have it set. By design choice, the C<quote_identifier()> method encloses
those identifiers in double quotes anyway, which generally triggers a
syntax error, and the metadata methods which generate lists of tables
etc omit those identifiers from the result sets.
sub quote_identifier
{
my($dbh, $cat, $sch, $obj) = @_;
my($rv) = "";
my($qq) = (defined $ENV{DELIMIDENT}) ? '"' : '';
$rv .= qq{$cat:} if (defined $cat);
if (defined $sch)
{
if ($sch !~ m/^\w+$/o)
{
$qq = '"';
$sch =~ s/$qq/$qq$qq/gm;
}
$rv .= qq{$qq$sch$qq.};
}
if (defined $obj)
{
if ($obj !~ m/^\w+$/o)
{
$qq = '"';
$obj =~ s/$qq/$qq$qq/gm;
}
$rv .= qq{$qq$obj$qq};
}
return $rv;
}
Handling newlines and other control characters is left as an exercise
for the reader.
Note that there is an optional fourth parameter to this function which
is a reference to a hash of attributes; this sample implementation
ignores that.
This sample implementation also ignores the single-argument variant of
the method.
=head1 TRACING
Tracing in DBI is controlled with a combination of a trace level and a
set of flags which together are known as the trace settings. The trace
settings are stored in a single integer and divided into levels and
flags by a set of masks (C<DBIc_TRACE_LEVEL_MASK> and
C<DBIc_TRACE_FLAGS_MASK>).
Each handle has it's own trace settings and so does the DBI. When you
call a method the DBI merges the handles settings into its own for the
duration of the call: the trace flags of the handle are OR'd into the
trace flags of the DBI, and if the handle has a higher trace level
then the DBI trace level is raised to match it. The previous DBI trace
settings are restored when the called method returns.
=head2 Trace Level
The trace level is the first 4 bits of the trace settings (masked by
C<DBIc_TRACE_FLAGS_MASK>) and represents trace levels of 1 to 15. Do
not output anything at trace levels less than 3 as they are reserved
for DBI.
For advice on what to output at each level see "Trace Levels" in
L<DBI>.
To test for a trace level you can use the C<DBIc_TRACE_LEVEL> macro
like this:
if (DBIc_TRACE_LEVEL(imp_xxh) >= 2) {
PerlIO_printf(DBIc_LOGPIO(imp_xxh), "foobar");
}
Also B<note> the use of PerlIO_printf which you should always use for
tracing and never the C C<stdio.h> I/O functions.
=head2 Trace Flags
Trace flags are used to enable tracing of specific activities within
the DBI and drivers. The DBI defines some trace flags and drivers can
define others. DBI trace flag names begin with a capital letter and
driver specific names begin with a lowercase letter. For a list of DBI
defined trace flags see "Trace Flags" in L<DBI>.
If you want to use private trace flags you'll probably want to be able
to set them by name. Drivers are expected to override the
parse_trace_flag (note the singular) and check if $trace_flag_name is
a driver specific trace flags and, if not, then call the DBIs default
parse_trace_flag(). To do that you'll need to define a
parse_trace_flag() method like this:
sub parse_trace_flag {
my ($h, $name) = @_;
return 0x01000000 if $name eq 'foo';
return 0x02000000 if $name eq 'bar';
return 0x04000000 if $name eq 'baz';
return 0x08000000 if $name eq 'boo';
return 0x10000000 if $name eq 'bop';
return $h->SUPER::parse_trace_flag($name);
}
All private flag names must be lowercase, and all private flags must
be in the top 8 of the 32 bits of C<DBIc_TRACE_FLAGS(imp)> i.e.,
0xFF000000.
If you've defined a parse_trace_flag() method in ::db you'll also want
it in ::st, so just alias it in:
*parse_trace_flag = \&DBD::foo:db::parse_trace_flag;
You may want to act on the current 'SQL' trace flag that DBI defines
to output SQL prepared/executed as DBI currently does not do SQL
tracing.
=head2 Trace Macros
Access to the trace level and trace flags is via a set of macros.
DBIc_TRACE_SETTINGS(imp) returns the trace settings
DBIc_TRACE_LEVEL(imp) returns the trace level
DBIc_TRACE_FLAGS(imp) returns the trace flags
DBIc_TRACE(imp, flags, flaglevel, level)
e.g.,
DBIc_TRACE(imp, 0, 0, 4)
if level >= 4
DBIc_TRACE(imp, DBDtf_FOO, 2, 4)
if tracing DBDtf_FOO & level>=2 or level>=4
DBIc_TRACE(imp, DBDtf_FOO, 2, 0)
as above but never trace just due to level
=head1 WRITING AN EMULATION LAYER FOR AN OLD PERL INTERFACE
Study F<Oraperl.pm> (supplied with B<DBD::Oracle>) and F<Ingperl.pm> (supplied
with B<DBD::Ingres>) and the corresponding I<dbdimp.c> files for ideas.
Note that the emulation code sets C<$dbh-E<gt>{CompatMode} = 1;> for each
connection so that the internals of the driver can implement behaviour
compatible with the old interface when dealing with those handles.
=head2 Setting emulation perl variables
For example, ingperl has a I<$sql_rowcount> variable. Rather than try
to manually update this in F<Ingperl.pm> it can be done faster in C code.
In C<dbd_init()>:
sql_rowcount = perl_get_sv("Ingperl::sql_rowcount", GV_ADDMULTI);
In the relevant places do:
if (DBIc_COMPAT(imp_sth)) /* only do this for compatibility mode handles */
sv_setiv(sql_rowcount, the_row_count);
=head1 OTHER MISCELLANEOUS INFORMATION
=head2 The imp_xyz_t types
Any handle has a corresponding C structure filled with private data.
Some of this data is reserved for use by B<DBI> (except for using the
DBIc macros below), some is for you. See the description of the
F<dbdimp.h> file above for examples. Most functions in F<dbdimp.c>
are passed both the handle C<xyz> and a pointer to C<imp_xyz>. In
rare cases, however, you may use the following macros:
=over 4
=item D_imp_dbh(dbh)
Given a function argument I<dbh>, declare a variable I<imp_dbh> and
initialize it with a pointer to the handles private data. Note: This
must be a part of the function header, because it declares a variable.
=item D_imp_sth(sth)
Likewise for statement handles.
=item D_imp_xxx(h)
Given any handle, declare a variable I<imp_xxx> and initialize it
with a pointer to the handles private data. It is safe, for example,
to cast I<imp_xxx> to C<imp_dbh_t*>, if C<DBIc_TYPE(imp_xxx) == DBIt_DB>.
(You can also call C<sv_derived_from(h, "DBI::db")>, but that's much
slower.)
=item D_imp_dbh_from_sth
Given a I<imp_sth>, declare a variable I<imp_dbh> and initialize it with a
pointer to the parent database handle's implementors structure.
=back
=head2 Using DBIc_IMPSET_on
The driver code which initializes a handle should use C<DBIc_IMPSET_on()>
as soon as its state is such that the cleanup code must be called.
When this happens is determined by your driver code.
B<Failure to call this can lead to corruption of data structures.>
For example, B<DBD::Informix> maintains a linked list of database
handles in the driver, and within each handle, a linked list of
statements. Once a statement is added to the linked list, it is crucial
that it is cleaned up (removed from the list). When I<DBIc_IMPSET_on()>
was being called too late, it was able to cause all sorts of problems.
=head2 Using DBIc_is(), DBIc_has(), DBIc_on() and DBIc_off()
Once upon a long time ago, the only way of handling the internal B<DBI>
boolean flags/attributes was through macros such as:
DBIc_WARN DBIc_WARN_on DBIc_WARN_off
DBIc_COMPAT DBIc_COMPAT_on DBIc_COMPAT_off
Each of these took an I<imp_xxh> pointer as an argument.
Since then, new attributes have been added such as I<ChopBlanks>,
I<RaiseError> and I<PrintError>, and these do not have the full set of
macros. The approved method for handling these is now the four macros:
DBIc_is(imp, flag)
DBIc_has(imp, flag) an alias for DBIc_is
DBIc_on(imp, flag)
DBIc_off(imp, flag)
DBIc_set(imp, flag, on) set if on is true, else clear
Consequently, the C<DBIc_XXXXX> family of macros is now mostly deprecated
and new drivers should avoid using them, even though the older drivers
will probably continue to do so for quite a while yet. However...
There is an I<important exception> to that. The I<ACTIVE> and I<IMPSET>
flags should be set via the C<DBIc_ACTIVE_on()> and C<DBIc_IMPSET_on()> macros,
and unset via the C<DBIc_ACTIVE_off()> and C<DBIc_IMPSET_off()> macros.
=head2 Using the get_fbav() method
B<THIS IS CRITICAL for C/XS drivers>.
The C<$sth-E<gt>bind_col()> and C<$sth-E<gt>bind_columns()> documented
in the B<DBI> specification do not have to be implemented by the driver
writer because B<DBI> takes care of the details for you.
However, the key to ensuring that bound columns work is to call the
function C<DBIc_DBISTATE(imp_xxh)-E<gt>get_fbav()> in the code which
fetches a row of data.
This returns an C<AV>, and each element of the C<AV> contains the C<SV> which
should be set to contain the returned data.
The pure Perl equivalent is the C<$sth-E<gt>_set_fbav($data)> method, as
described in the part on pure Perl drivers.
=head2 Casting strings to Perl types based on a SQL type
DBI from 1.611 (and DBIXS_REVISION 13606) defines the
sql_type_cast_svpv method which may be used to cast a string
representation of a value to a more specific Perl type based on a SQL
type. You should consider using this method when processing bound
column data as it provides some support for the TYPE bind_col
attribute which is rarely used in drivers.
int sql_type_cast_svpv(pTHX_ SV *sv, int sql_type, U32 flags, void *v)
C<sv> is what you would like cast, C<sql_type> is one of the DBI defined
SQL types (e.g., C<SQL_INTEGER>) and C<flags> is a bitmask as follows:
=over
=item DBIstcf_STRICT
If set this indicates you want an error state returned if the cast
cannot be performed.
=item DBIstcf_DISCARD_STRING
If set and the pv portion of the C<sv> is cast then this will cause
sv's pv to be freed up.
=back
sql_type_cast_svpv returns the following states:
-2 sql_type is not handled - sv not changed
-1 sv is undef, sv not changed
0 sv could not be cast cleanly and DBIstcf_STRICT was specified
1 sv could not be case cleanly and DBIstcf_STRICT was not specified
2 sv was cast ok
The current implementation of sql_type_cast_svpv supports
C<SQL_INTEGER>, C<SQL_DOUBLE> and C<SQL_NUMERIC>. C<SQL_INTEGER> uses
sv_2iv and hence may set IV, UV or NV depending on the
number. C<SQL_DOUBLE> uses sv_2nv so may set NV and C<SQL_NUMERIC>
will set IV or UV or NV.
DBIstcf_STRICT should be implemented as the StrictlyTyped attribute
and DBIstcf_DISCARD_STRING implemented as the DiscardString attribute
to the bind_col method and both default to off.
See DBD::Oracle for an example of how this is used.
=head1 SUBCLASSING DBI DRIVERS
This is definitely an open subject. It can be done, as demonstrated by
the B<DBD::File> driver, but it is not as simple as one might think.
(Note that this topic is different from subclassing the B<DBI>. For an
example of that, see the F<t/subclass.t> file supplied with the B<DBI>.)
The main problem is that the I<dbh>'s and I<sth>'s that your C<connect()> and
C<prepare()> methods return are not instances of your B<DBD::Driver::db>
or B<DBD::Driver::st> packages, they are not even derived from it.
Instead they are instances of the B<DBI::db> or B<DBI::st> classes or
a derived subclass. Thus, if you write a method C<mymethod()> and do a
$dbh->mymethod()
then the autoloader will search for that method in the package B<DBI::db>.
Of course you can instead to a
$dbh->func('mymethod')
and that will indeed work, even if C<mymethod()> is inherited, but not
without additional work. Setting I<@ISA> is not sufficient.
=head2 Overwriting methods
The first problem is, that the C<connect()> method has no idea of
subclasses. For example, you cannot implement base class and subclass
in the same file: The C<install_driver()> method wants to do a
require DBD::Driver;
In particular, your subclass B<has> to be a separate driver, from
the view of B<DBI>, and you cannot share driver handles.
Of course that's not much of a problem. You should even be able
to inherit the base classes C<connect()> method. But you cannot
simply overwrite the method, unless you do something like this,
quoted from B<DBD::CSV>:
sub connect ($$;$$$) {
my ($drh, $dbname, $user, $auth, $attr) = @_;
my $this = $drh->DBD::File::dr::connect($dbname, $user, $auth, $attr);
if (!exists($this->{csv_tables})) {
$this->{csv_tables} = {};
}
$this;
}
Note that we cannot do a
$drh->SUPER::connect($dbname, $user, $auth, $attr);
as we would usually do in a an OO environment, because I<$drh> is an instance
of B<DBI::dr>. And note, that the C<connect()> method of B<DBD::File> is
able to handle subclass attributes. See the description of Pure Perl
drivers above.
It is essential that you always call superclass method in the above
manner. However, that should do.
=head2 Attribute handling
Fortunately the B<DBI> specifications allow a simple, but still
performant way of handling attributes. The idea is based on the
convention that any driver uses a prefix I<driver_> for its private
methods. Thus it's always clear whether to pass attributes to the super
class or not. For example, consider this C<STORE()> method from the
B<DBD::CSV> class:
sub STORE {
my ($dbh, $attr, $val) = @_;
if ($attr !~ /^driver_/) {
return $dbh->DBD::File::db::STORE($attr, $val);
}
if ($attr eq 'driver_foo') {
...
}
=cut
use Exporter ();
use Config qw(%Config);
use Carp;
use Cwd;
use File::Spec;
use strict;
use vars qw(
@ISA @EXPORT
$is_dbi
);
BEGIN {
if ($^O eq 'VMS') {
require vmsish;
import vmsish;
require VMS::Filespec;
import VMS::Filespec;
}
else {
*vmsify = sub { return $_[0] };
*unixify = sub { return $_[0] };
}
}
@ISA = qw(Exporter);
@EXPORT = qw(
dbd_dbi_dir
dbd_dbi_arch_dir
dbd_edit_mm_attribs
dbd_postamble
);
BEGIN {
$is_dbi = (-r 'DBI.pm' && -r 'DBI.xs' && -r 'DBIXS.h');
require DBI unless $is_dbi;
}
my $done_inst_checks;
sub _inst_checks {
return if $done_inst_checks++;
my $cwd = cwd();
if ($cwd =~ /\Q$Config{path_sep}/) {
warn "*** Warning: Path separator characters (`$Config{path_sep}') ",
"in the current directory path ($cwd) may cause problems\a\n\n";
sleep 2;
}
if ($cwd =~ /\s/) {
warn "*** Warning: whitespace characters ",
"in the current directory path ($cwd) may cause problems\a\n\n";
sleep 2;
}
if ( $^O eq 'MSWin32'
&& $Config{cc} eq 'cl'
&& !(exists $ENV{'LIB'} && exists $ENV{'INCLUDE'}))
{
die <<EOT;
*** You're using Microsoft Visual C++ compiler or similar but
the LIB and INCLUDE environment variables are not both set.
You need to run the VCVARS32.BAT batch file that was supplied
with the compiler before you can use it.
A copy of vcvars32.bat can typically be found in the following
directories under your Visual Studio install directory:
Visual C++ 6.0: vc98\\bin
Visual Studio .NET: vc7\\bin
Find it, run it, then retry this.
If you think this error is not correct then just set the LIB and
INCLUDE environment variables to some value to disable the check.
EOT
}
}
sub dbd_edit_mm_attribs {
# this both edits the attribs in-place and returns the flattened attribs
my $mm_attr = shift;
my $dbd_attr = shift || {};
croak "dbd_edit_mm_attribs( \%makemaker [, \%other ]): too many parameters"
if @_;
_inst_checks();
# what can be done
my %test_variants = (
p => { name => "DBI::PurePerl",
match => qr/^\d/,
add => [ '$ENV{DBI_PUREPERL} = 2',
'END { delete $ENV{DBI_PUREPERL}; }' ],
},
g => { name => "DBD::Gofer",
match => qr/^\d/,
add => [ q{$ENV{DBI_AUTOPROXY} = 'dbi:Gofer:transport=null;policy=pedantic'},
q|END { delete $ENV{DBI_AUTOPROXY}; }| ],
},
n => { name => "DBI::SQL::Nano",
match => qr/^(?:48dbi_dbd_sqlengine|49dbd_file|5\ddbm_\w+|85gofer)\.t$/,
add => [ q{$ENV{DBI_SQL_NANO} = 1},
q|END { delete $ENV{DBI_SQL_NANO}; }| ],
},
# mx => { name => "DBD::Multiplex",
# add => [ q{local $ENV{DBI_AUTOPROXY} = 'dbi:Multiplex:';} ],
# }
# px => { name => "DBD::Proxy",
# need mechanism for starting/stopping the proxy server
# add => [ q{local $ENV{DBI_AUTOPROXY} = 'dbi:Proxy:XXX';} ],
# }
);
# decide what needs doing
$dbd_attr->{create_pp_tests} or delete $test_variants{p};
$dbd_attr->{create_nano_tests} or delete $test_variants{n};
$dbd_attr->{create_gap_tests} or delete $test_variants{g};
# expand for all combinations
my @all_keys = my @tv_keys = sort keys %test_variants;
while( @tv_keys ) {
my $cur_key = shift @tv_keys;
last if( 1 < length $cur_key );
my @new_keys;
foreach my $remain (@tv_keys) {
push @new_keys, $cur_key . $remain unless $remain =~ /$cur_key/;
}
push @tv_keys, @new_keys;
push @all_keys, @new_keys;
}
my %uniq_keys;
foreach my $key (@all_keys) {
@tv_keys = sort split //, $key;
my $ordered = join( '', @tv_keys );
$uniq_keys{$ordered} = 1;
}
@all_keys = sort { length $a <=> length $b or $a cmp $b } keys %uniq_keys;
# do whatever needs doing
if( keys %test_variants ) {
# XXX need to convert this to work within the generated Makefile
# so 'make' creates them and 'make clean' deletes them
opendir DIR, 't' or die "Can't read 't' directory: $!";
my @tests = grep { /\.t$/ } readdir DIR;
closedir DIR;
foreach my $test_combo (@all_keys) {
@tv_keys = split //, $test_combo;
my @test_names = map { $test_variants{$_}->{name} } @tv_keys;
printf "Creating test wrappers for " . join( " + ", @test_names ) . ":\n";
my @test_matches = map { $test_variants{$_}->{match} } @tv_keys;
my @test_adds;
foreach my $test_add ( map { $test_variants{$_}->{add} } @tv_keys) {
push @test_adds, @$test_add;
}
my $v_type = $test_combo;
$v_type = 'x' . $v_type if length( $v_type ) > 1;
TEST:
foreach my $test (sort @tests) {
foreach my $match (@test_matches) {
next TEST if $test !~ $match;
}
my $usethr = ($test =~ /(\d+|\b)thr/ && $] >= 5.008 && $Config{useithreads});
my $v_test = "t/zv${v_type}_$test";
my $v_perl = ($test =~ /taint/) ? "perl -wT" : "perl -w";
printf "%s %s\n", $v_test, ($usethr) ? "(use threads)" : "";
open PPT, ">$v_test" or warn "Can't create $v_test: $!";
print PPT "#!$v_perl\n";
print PPT "use threads;\n" if $usethr;
print PPT "$_;\n" foreach @test_adds;
print PPT "require './t/$test'; # or warn \$!;\n";
close PPT or warn "Error writing $v_test: $!";
}
}
}
return %$mm_attr;
}
sub dbd_dbi_dir {
_inst_checks();
return '.' if $is_dbi;
my $dbidir = $INC{'DBI.pm'} || die "DBI.pm not in %INC!";
$dbidir =~ s:/DBI\.pm$::;
return $dbidir;
}
sub dbd_dbi_arch_dir {
_inst_checks();
return '$(INST_ARCHAUTODIR)' if $is_dbi;
my $dbidir = dbd_dbi_dir();
my %seen;
my @try = grep { not $seen{$_}++ } map { vmsify( unixify($_) . "/auto/DBI/" ) } @INC;
my @xst = grep { -f vmsify( unixify($_) . "/Driver.xst" ) } @try;
Carp::croak("Unable to locate Driver.xst in @try") unless @xst;
Carp::carp( "Multiple copies of Driver.xst found in: @xst") if @xst > 1;
print "Using DBI $DBI::VERSION (for perl $] on $Config{archname}) installed in $xst[0]\n";
return File::Spec->canonpath($xst[0]);
}
sub dbd_postamble {
my $self = shift;
_inst_checks();
my $dbi_instarch_dir = ($is_dbi) ? "." : dbd_dbi_arch_dir();
my $dbi_driver_xst= File::Spec->catfile($dbi_instarch_dir, 'Driver.xst');
my $xstf_h = File::Spec->catfile($dbi_instarch_dir, 'Driver_xst.h');
# we must be careful of quotes, especially for Win32 here.
return '
# --- This section was generated by DBI::DBD::dbd_postamble()
DBI_INSTARCH_DIR='.$dbi_instarch_dir.'
DBI_DRIVER_XST='.$dbi_driver_xst.'
# The main dependency (technically correct but probably not used)
$(BASEEXT).c: $(BASEEXT).xsi
# This dependency is needed since MakeMaker uses the .xs.o rule
$(BASEEXT)$(OBJ_EXT): $(BASEEXT).xsi
$(BASEEXT).xsi: $(DBI_DRIVER_XST) '.$xstf_h.'
$(PERL) -p -e "s/~DRIVER~/$(BASEEXT)/g" $(DBI_DRIVER_XST) > $(BASEEXT).xsi
# ---
';
}
package DBDI; # just to reserve it via PAUSE for the future
1;
__END__
=head1 AUTHORS
Jonathan Leffler <jleffler@us.ibm.com> (previously <jleffler@informix.com>),
Jochen Wiedmann <joe@ispsoft.de>,
Steffen Goeldner <sgoeldner@cpan.org>,
and Tim Bunce <dbi-users@perl.org>.
=cut
PK V`[ 0�� � Gofer/Serializer/Base.pmnu �[��� package DBI::Gofer::Serializer::Base;
# $Id: Base.pm 9949 2007-09-18 09:38:15Z Tim $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
=head1 NAME
DBI::Gofer::Serializer::Base - base class for Gofer serialization
=head1 SYNOPSIS
$serializer = $serializer_class->new();
$string = $serializer->serialize( $data );
($string, $deserializer_class) = $serializer->serialize( $data );
$data = $serializer->deserialize( $string );
=head1 DESCRIPTION
DBI::Gofer::Serializer::* classes implement a very minimal subset of the L<Data::Serializer> API.
Gofer serializers are expected to be very fast and are not required to deal
with anything other than non-blessed references to arrays and hashes, and plain scalars.
=cut
use strict;
use warnings;
use Carp qw(croak);
our $VERSION = "0.009950";
sub new {
my $class = shift;
my $deserializer_class = $class->deserializer_class;
return bless { deserializer_class => $deserializer_class } => $class;
}
sub deserializer_class {
my $self = shift;
my $class = ref($self) || $self;
$class =~ s/^DBI::Gofer::Serializer:://;
return $class;
}
sub serialize {
my $self = shift;
croak ref($self)." has not implemented the serialize method";
}
sub deserialize {
my $self = shift;
croak ref($self)." has not implemented the deserialize method";
}
1;
PK V`[��� Gofer/Serializer/DataDumper.pmnu �[��� package DBI::Gofer::Serializer::DataDumper;
use strict;
use warnings;
our $VERSION = "0.009950";
# $Id: DataDumper.pm 9949 2007-09-18 09:38:15Z Tim $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
=head1 NAME
DBI::Gofer::Serializer::DataDumper - Gofer serialization using DataDumper
=head1 SYNOPSIS
$serializer = DBI::Gofer::Serializer::DataDumper->new();
$string = $serializer->serialize( $data );
=head1 DESCRIPTION
Uses DataDumper to serialize. Deserialization is not supported.
The output of this class is only meant for human consumption.
See also L<DBI::Gofer::Serializer::Base>.
=cut
use Data::Dumper;
use base qw(DBI::Gofer::Serializer::Base);
sub serialize {
my $self = shift;
local $Data::Dumper::Indent = 1;
local $Data::Dumper::Terse = 1;
local $Data::Dumper::Useqq = 0; # enabling this disables xs
local $Data::Dumper::Sortkeys = 1;
local $Data::Dumper::Quotekeys = 0;
local $Data::Dumper::Deparse = 0;
local $Data::Dumper::Purity = 0;
my $frozen = Data::Dumper::Dumper(shift);
return $frozen unless wantarray;
return ($frozen, $self->{deserializer_class});
}
1;
PK V`[�GA�� � Gofer/Serializer/Storable.pmnu �[��� package DBI::Gofer::Serializer::Storable;
use strict;
use warnings;
use base qw(DBI::Gofer::Serializer::Base);
# $Id: Storable.pm 15585 2013-03-22 20:31:22Z Tim $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
=head1 NAME
DBI::Gofer::Serializer::Storable - Gofer serialization using Storable
=head1 SYNOPSIS
$serializer = DBI::Gofer::Serializer::Storable->new();
$string = $serializer->serialize( $data );
($string, $deserializer_class) = $serializer->serialize( $data );
$data = $serializer->deserialize( $string );
=head1 DESCRIPTION
Uses Storable::nfreeze() to serialize and Storable::thaw() to deserialize.
The serialize() method sets local $Storable::forgive_me = 1; so it doesn't
croak if it encounters any data types that can't be serialized, such as code refs.
See also L<DBI::Gofer::Serializer::Base>.
=cut
use Storable qw(nfreeze thaw);
our $VERSION = "0.015586";
use base qw(DBI::Gofer::Serializer::Base);
sub serialize {
my $self = shift;
local $Storable::forgive_me = 1; # for CODE refs etc
local $Storable::canonical = 1; # for go_cache
my $frozen = nfreeze(shift);
return $frozen unless wantarray;
return ($frozen, $self->{deserializer_class});
}
sub deserialize {
my $self = shift;
return thaw(shift);
}
1;
PK V`[[=��t t Gofer/Request.pmnu �[��� package DBI::Gofer::Request;
# $Id: Request.pm 12536 2009-02-24 22:37:09Z Tim $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
use DBI qw(neat neat_list);
use base qw(DBI::Util::_accessor);
our $VERSION = "0.012537";
use constant GOf_REQUEST_IDEMPOTENT => 0x0001;
use constant GOf_REQUEST_READONLY => 0x0002;
our @EXPORT = qw(GOf_REQUEST_IDEMPOTENT GOf_REQUEST_READONLY);
__PACKAGE__->mk_accessors(qw(
version
flags
dbh_connect_call
dbh_method_call
dbh_attributes
dbh_last_insert_id_args
sth_method_calls
sth_result_attr
));
__PACKAGE__->mk_accessors_using(make_accessor_autoviv_hashref => qw(
meta
));
sub new {
my ($self, $args) = @_;
$args->{version} ||= $VERSION;
return $self->SUPER::new($args);
}
sub reset {
my ($self, $flags) = @_;
# remove everything except connect and version
%$self = (
version => $self->{version},
dbh_connect_call => $self->{dbh_connect_call},
);
$self->{flags} = $flags if $flags;
}
sub init_request {
my ($self, $method_and_args, $dbh) = @_;
$self->reset( $dbh->{ReadOnly} ? GOf_REQUEST_READONLY : 0 );
$self->dbh_method_call($method_and_args);
}
sub is_sth_request {
return shift->{sth_result_attr};
}
sub statements {
my $self = shift;
my @statements;
if (my $dbh_method_call = $self->dbh_method_call) {
my $statement_method_regex = qr/^(?:do|prepare)$/;
my (undef, $method, $arg1) = @$dbh_method_call;
push @statements, $arg1 if $method && $method =~ $statement_method_regex;
}
return @statements;
}
sub is_idempotent {
my $self = shift;
if (my $flags = $self->flags) {
return 1 if $flags & (GOf_REQUEST_IDEMPOTENT|GOf_REQUEST_READONLY);
}
# else check if all statements are SELECT statement that don't include FOR UPDATE
my @statements = $self->statements;
# XXX this is very minimal for now, doesn't even allow comments before the select
# (and can't ever work for "exec stored_procedure_name" kinds of statements)
# XXX it also doesn't deal with multiple statements: prepare("select foo; update bar")
return 1 if @statements == grep {
m/^ \s* SELECT \b /xmsi && !m/ \b FOR \s+ UPDATE \b /xmsi
} @statements;
return 0;
}
sub summary_as_text {
my $self = shift;
my ($context) = @_;
my @s = '';
if ($context && %$context) {
my @keys = sort keys %$context;
push @s, join(", ", map { "$_=>".$context->{$_} } @keys);
}
my ($method, $dsn, $user, $pass, $attr) = @{ $self->dbh_connect_call };
$method ||= 'connect_cached';
$pass = '***' if defined $pass;
my $tmp = '';
if ($attr) {
$tmp = { %{$attr||{}} }; # copy so we can edit
$tmp->{Password} = '***' if exists $tmp->{Password};
$tmp = "{ ".neat_list([ %$tmp ])." }";
}
push @s, sprintf "dbh= $method(%s, %s)", neat_list([$dsn, $user, $pass]), $tmp;
if (my $flags = $self->flags) {
push @s, sprintf "flags: 0x%x", $flags;
}
if (my $dbh_attr = $self->dbh_attributes) {
push @s, sprintf "dbh->FETCH: %s", @$dbh_attr
if @$dbh_attr;
}
my ($wantarray, $meth, @args) = @{ $self->dbh_method_call };
my $args = neat_list(\@args);
$args =~ s/\n+/ /g;
push @s, sprintf "dbh->%s(%s)", $meth, $args;
if (my $lii_args = $self->dbh_last_insert_id_args) {
push @s, sprintf "dbh->last_insert_id(%s)", neat_list($lii_args);
}
for my $call (@{ $self->sth_method_calls || [] }) {
my ($meth, @args) = @$call;
($args = neat_list(\@args)) =~ s/\n+/ /g;
push @s, sprintf "sth->%s(%s)", $meth, $args;
}
if (my $sth_attr = $self->sth_result_attr) {
push @s, sprintf "sth->FETCH: %s", %$sth_attr
if %$sth_attr;
}
return join("\n\t", @s) . "\n";
}
sub outline_as_text { # one-line version of summary_as_text
my $self = shift;
my @s = '';
my $neatlen = 80;
if (my $flags = $self->flags) {
push @s, sprintf "flags=0x%x", $flags;
}
my (undef, $meth, @args) = @{ $self->dbh_method_call };
push @s, sprintf "%s(%s)", $meth, neat_list(\@args, $neatlen);
for my $call (@{ $self->sth_method_calls || [] }) {
my ($meth, @args) = @$call;
push @s, sprintf "%s(%s)", $meth, neat_list(\@args, $neatlen);
}
my ($method, $dsn) = @{ $self->dbh_connect_call };
push @s, "$method($dsn,...)"; # dsn last as it's usually less interesting
(my $outline = join("; ", @s)) =~ s/\s+/ /g; # squish whitespace, incl newlines
return $outline;
}
1;
=head1 NAME
DBI::Gofer::Request - Encapsulate a request from DBD::Gofer to DBI::Gofer::Execute
=head1 DESCRIPTION
This is an internal class.
=head1 AUTHOR
Tim Bunce, L<http://www.tim.bunce.name>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2007, Tim Bunce, Ireland. All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
=cut
PK V`[\}� � � Gofer/Transport/Base.pmnu �[��� package DBI::Gofer::Transport::Base;
# $Id: Base.pm 12536 2009-02-24 22:37:09Z Tim $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
use warnings;
use DBI;
use base qw(DBI::Util::_accessor);
use DBI::Gofer::Serializer::Storable;
use DBI::Gofer::Serializer::DataDumper;
our $VERSION = "0.012537";
__PACKAGE__->mk_accessors(qw(
trace
keep_meta_frozen
serializer_obj
));
# see also $ENV{DBI_GOFER_TRACE} in DBI::Gofer::Execute
sub _init_trace { (split(/=/,$ENV{DBI_GOFER_TRACE}||0))[0] }
sub new {
my ($class, $args) = @_;
$args->{trace} ||= $class->_init_trace;
$args->{serializer_obj} ||= DBI::Gofer::Serializer::Storable->new();
my $self = bless {}, $class;
$self->$_( $args->{$_} ) for keys %$args;
$self->trace_msg("$class->new({ @{[ %$args ]} })\n") if $self->trace;
return $self;
}
my $packet_header_text = "GoFER1:";
my $packet_header_regex = qr/^GoFER(\d+):/;
sub _freeze_data {
my ($self, $data, $serializer, $skip_trace) = @_;
my $frozen = eval {
$self->_dump("freezing $self->{trace} ".ref($data), $data)
if !$skip_trace and $self->trace;
local $data->{meta}; # don't include meta in serialization
$serializer ||= $self->{serializer_obj};
my ($data, $deserializer_class) = $serializer->serialize($data);
$packet_header_text . $data;
};
if ($@) {
chomp $@;
die "Error freezing ".ref($data)." object: $@";
}
# stash the frozen data into the data structure itself
# to make life easy for the client caching code in DBD::Gofer::Transport::Base
$data->{meta}{frozen} = $frozen if $self->keep_meta_frozen;
return $frozen;
}
# public aliases used by subclasses
*freeze_request = \&_freeze_data;
*freeze_response = \&_freeze_data;
sub _thaw_data {
my ($self, $frozen_data, $serializer, $skip_trace) = @_;
my $data;
eval {
# check for and extract our gofer header and the info it contains
(my $frozen = $frozen_data) =~ s/$packet_header_regex//o
or die "does not have gofer header\n";
my ($t_version) = $1;
$serializer ||= $self->{serializer_obj};
$data = $serializer->deserialize($frozen);
die ref($serializer)."->deserialize didn't return a reference"
unless ref $data;
$data->{_transport}{version} = $t_version;
$data->{meta}{frozen} = $frozen_data if $self->keep_meta_frozen;
};
if ($@) {
chomp(my $err = $@);
# remove extra noise from Storable
$err =~ s{ at \S+?/Storable.pm \(autosplit into \S+?/Storable/thaw.al\) line \d+(, \S+ line \d+)?}{};
my $msg = sprintf "Error thawing: %s (data=%s)", $err, DBI::neat($frozen_data,50);
Carp::cluck("$msg, pid $$ stack trace follows:"); # XXX if $self->trace;
die $msg;
}
$self->_dump("thawing $self->{trace} ".ref($data), $data)
if !$skip_trace and $self->trace;
return $data;
}
# public aliases used by subclasses
*thaw_request = \&_thaw_data;
*thaw_response = \&_thaw_data;
# this should probably live in the request and response classes
# and the tace level passed in
sub _dump {
my ($self, $label, $data) = @_;
# don't dump the binary
local $data->{meta}{frozen} if $data->{meta} && $data->{meta}{frozen};
my $trace_level = $self->trace;
my $summary;
if ($trace_level >= 4) {
require Data::Dumper;
local $Data::Dumper::Indent = 1;
local $Data::Dumper::Terse = 1;
local $Data::Dumper::Useqq = 0;
local $Data::Dumper::Sortkeys = 1;
local $Data::Dumper::Quotekeys = 0;
local $Data::Dumper::Deparse = 0;
local $Data::Dumper::Purity = 0;
$summary = Data::Dumper::Dumper($data);
}
elsif ($trace_level >= 2) {
$summary = eval { $data->summary_as_text } || $@ || "no summary available\n";
}
else {
$summary = eval { $data->outline_as_text."\n" } || $@ || "no summary available\n";
}
$self->trace_msg("$label: $summary");
}
sub trace_msg {
my ($self, $msg, $min_level) = @_;
$min_level = 1 unless defined $min_level;
# transport trace level can override DBI's trace level
$min_level = 0 if $self->trace >= $min_level;
return DBI->trace_msg("gofer ".$msg, $min_level);
}
1;
=head1 NAME
DBI::Gofer::Transport::Base - Base class for Gofer transports
=head1 DESCRIPTION
This is the base class for server-side Gofer transports.
It's also the base class for the client-side base class L<DBD::Gofer::Transport::Base>.
This is an internal class.
=head1 AUTHOR
Tim Bunce, L<http://www.tim.bunce.name>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2007, Tim Bunce, Ireland. All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
=cut
PK V`[�"� � Gofer/Transport/stream.pmnu �[��� package DBI::Gofer::Transport::stream;
# $Id: stream.pm 12536 2009-02-24 22:37:09Z Tim $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
use warnings;
use DBI qw(dbi_time);
use DBI::Gofer::Execute;
use base qw(DBI::Gofer::Transport::pipeone Exporter);
our $VERSION = "0.012537";
our @EXPORT = qw(run_stdio_hex);
my $executor = DBI::Gofer::Execute->new();
sub run_stdio_hex {
my $transport = DBI::Gofer::Transport::stream->new();
local $| = 1;
DBI->trace_msg("$0 started (pid $$)\n");
local $\; # OUTPUT_RECORD_SEPARATOR
local $/ = "\012"; # INPUT_RECORD_SEPARATOR
while ( defined( my $encoded_request = <STDIN> ) ) {
my $time_received = dbi_time();
$encoded_request =~ s/\015?\012$//;
my $frozen_request = pack "H*", $encoded_request;
my $request = $transport->thaw_request( $frozen_request );
my $response = $executor->execute_request( $request );
my $frozen_response = $transport->freeze_response($response);
my $encoded_response = unpack "H*", $frozen_response;
print $encoded_response, "\015\012"; # autoflushed due to $|=1
# there's no way to access the stats currently
# so this just serves as a basic test and illustration of update_stats()
$executor->update_stats($request, $response, $frozen_request, $frozen_response, $time_received, 1);
}
DBI->trace_msg("$0 ending (pid $$)\n");
}
1;
__END__
=head1 NAME
DBI::Gofer::Transport::stream - DBD::Gofer server-side transport for stream
=head1 SYNOPSIS
See L<DBD::Gofer::Transport::stream>.
=head1 AUTHOR
Tim Bunce, L<http://www.tim.bunce.name>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2007, Tim Bunce, Ireland. All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
=cut
PK V`[���S^ ^ Gofer/Transport/pipeone.pmnu �[��� package DBI::Gofer::Transport::pipeone;
# $Id: pipeone.pm 12536 2009-02-24 22:37:09Z Tim $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
use warnings;
use DBI::Gofer::Execute;
use base qw(DBI::Gofer::Transport::Base Exporter);
our $VERSION = "0.012537";
our @EXPORT = qw(run_one_stdio);
my $executor = DBI::Gofer::Execute->new();
sub run_one_stdio {
binmode STDIN;
binmode STDOUT;
my $transport = DBI::Gofer::Transport::pipeone->new();
my $frozen_request = do { local $/; <STDIN> };
my $response = $executor->execute_request( $transport->thaw_request($frozen_request) );
my $frozen_response = $transport->freeze_response($response);
print $frozen_response;
# no point calling $executor->update_stats(...) for pipeONE
}
1;
__END__
=head1 NAME
DBI::Gofer::Transport::pipeone - DBD::Gofer server-side transport for pipeone
=head1 SYNOPSIS
See L<DBD::Gofer::Transport::pipeone>.
=head1 AUTHOR
Tim Bunce, L<http://www.tim.bunce.name>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2007, Tim Bunce, Ireland. All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
=cut
PK V`[���y �y Gofer/Execute.pmnu �[��� package DBI::Gofer::Execute;
# $Id: Execute.pm 14282 2010-07-26 00:12:54Z David $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
use warnings;
use Carp;
use DBI qw(dbi_time);
use DBI::Gofer::Request;
use DBI::Gofer::Response;
use base qw(DBI::Util::_accessor);
our $VERSION = "0.014283";
our @all_dbh_methods = sort map { keys %$_ } $DBI::DBI_methods{db}, $DBI::DBI_methods{common};
our %all_dbh_methods = map { $_ => (DBD::_::db->can($_)||undef) } @all_dbh_methods;
our $local_log = $ENV{DBI_GOFER_LOCAL_LOG}; # do extra logging to stderr
our $current_dbh; # the dbh we're using for this request
# set trace for server-side gofer
# Could use DBI_TRACE env var when it's an unrelated separate process
# but using DBI_GOFER_TRACE makes testing easier for subprocesses (eg stream)
DBI->trace(split /=/, $ENV{DBI_GOFER_TRACE}, 2) if $ENV{DBI_GOFER_TRACE};
# define valid configuration attributes (args to new())
# the values here indicate the basic type of values allowed
my %configuration_attributes = (
gofer_execute_class => 1,
default_connect_dsn => 1,
forced_connect_dsn => 1,
default_connect_attributes => {},
forced_connect_attributes => {},
track_recent => 1,
check_request_sub => sub {},
check_response_sub => sub {},
forced_single_resultset => 1,
max_cached_dbh_per_drh => 1,
max_cached_sth_per_dbh => 1,
forced_response_attributes => {},
forced_gofer_random => 1,
stats => {},
);
__PACKAGE__->mk_accessors(
keys %configuration_attributes
);
sub new {
my ($self, $args) = @_;
$args->{default_connect_attributes} ||= {};
$args->{forced_connect_attributes} ||= {};
$args->{max_cached_sth_per_dbh} ||= 1000;
$args->{stats} ||= {};
return $self->SUPER::new($args);
}
sub valid_configuration_attributes {
my $self = shift;
return { %configuration_attributes };
}
my %extra_attr = (
# Only referenced if the driver doesn't support private_attribute_info method.
# What driver-specific attributes should be returned for the driver being used?
# keyed by $dbh->{Driver}{Name}
# XXX for sth should split into attr specific to resultsets (where NUM_OF_FIELDS > 0) and others
# which would reduce processing/traffic for non-select statements
mysql => {
dbh => [qw(
mysql_errno mysql_error mysql_hostinfo mysql_info mysql_insertid
mysql_protoinfo mysql_serverinfo mysql_stat mysql_thread_id
)],
sth => [qw(
mysql_is_blob mysql_is_key mysql_is_num mysql_is_pri_key mysql_is_auto_increment
mysql_length mysql_max_length mysql_table mysql_type mysql_type_name mysql_insertid
)],
# XXX this dbh_after_sth stuff is a temporary, but important, hack.
# should be done via hash instead of arrays where the hash value contains
# flags that can indicate which attributes need to be handled in this way
dbh_after_sth => [qw(
mysql_insertid
)],
},
Pg => {
dbh => [qw(
pg_protocol pg_lib_version pg_server_version
pg_db pg_host pg_port pg_default_port
pg_options pg_pid
)],
sth => [qw(
pg_size pg_type pg_oid_status pg_cmd_status
)],
},
Sybase => {
dbh => [qw(
syb_dynamic_supported syb_oc_version syb_server_version syb_server_version_string
)],
sth => [qw(
syb_types syb_proc_status syb_result_type
)],
},
SQLite => {
dbh => [qw(
sqlite_version
)],
sth => [qw(
)],
},
ExampleP => {
dbh => [qw(
examplep_private_dbh_attrib
)],
sth => [qw(
examplep_private_sth_attrib
)],
dbh_after_sth => [qw(
examplep_insertid
)],
},
);
sub _connect {
my ($self, $request) = @_;
my $stats = $self->{stats};
# discard CachedKids from time to time
if (++$stats->{_requests_served} % 1000 == 0 # XXX config?
and my $max_cached_dbh_per_drh = $self->{max_cached_dbh_per_drh}
) {
my %drivers = DBI->installed_drivers();
while ( my ($driver, $drh) = each %drivers ) {
next unless my $CK = $drh->{CachedKids};
next unless keys %$CK > $max_cached_dbh_per_drh;
next if $driver eq 'Gofer'; # ie transport=null when testing
DBI->trace_msg(sprintf "Clearing %d cached dbh from $driver",
scalar keys %$CK, $self->{max_cached_dbh_per_drh});
$_->{Active} && $_->disconnect for values %$CK;
%$CK = ();
}
}
# local $ENV{...} can leak, so only do it if required
local $ENV{DBI_AUTOPROXY} if $ENV{DBI_AUTOPROXY};
my ($connect_method, $dsn, $username, $password, $attr) = @{ $request->dbh_connect_call };
$connect_method ||= 'connect_cached';
$stats->{method_calls_dbh}->{$connect_method}++;
# delete attributes we don't want to affect the server-side
# (Could just do this on client-side and trust the client. DoS?)
delete @{$attr}{qw(Profile InactiveDestroy AutoInactiveDestroy HandleError HandleSetErr TraceLevel Taint TaintIn TaintOut)};
$dsn = $self->forced_connect_dsn || $dsn || $self->default_connect_dsn
or die "No forced_connect_dsn, requested dsn, or default_connect_dsn for request";
my $random = $self->{forced_gofer_random} || $ENV{DBI_GOFER_RANDOM} || '';
my $connect_attr = {
# the configured default attributes, if any
%{ $self->default_connect_attributes },
# pass username and password as attributes
# then they can be overridden by forced_connect_attributes
Username => $username,
Password => $password,
# the requested attributes
%$attr,
# force some attributes the way we'd like them
PrintWarn => $local_log,
PrintError => $local_log,
# the configured default attributes, if any
%{ $self->forced_connect_attributes },
# RaiseError must be enabled
RaiseError => 1,
# reset Executed flag (of the cached handle) so we can use it to tell
# if errors happened before the main part of the request was executed
Executed => 0,
# ensure this connect_cached doesn't have the same args as the client
# because that causes subtle issues if in the same process (ie transport=null)
# include pid to avoid problems with forking (ie null transport in mod_perl)
# include gofer-random to avoid random behaviour leaking to other handles
dbi_go_execute_unique => join("|", __PACKAGE__, $$, $random),
};
# XXX implement our own private connect_cached method? (with rate-limited ping)
my $dbh = DBI->$connect_method($dsn, undef, undef, $connect_attr);
$dbh->{ShowErrorStatement} = 1 if $local_log;
# XXX should probably just be a Callbacks => arg to connect_cached
# with a cache of pre-built callback hooks (memoized, without $self)
if (my $random = $self->{forced_gofer_random} || $ENV{DBI_GOFER_RANDOM}) {
$self->_install_rand_callbacks($dbh, $random);
}
my $CK = $dbh->{CachedKids};
if ($CK && keys %$CK > $self->{max_cached_sth_per_dbh}) {
%$CK = (); # clear all statement handles
}
#$dbh->trace(0);
$current_dbh = $dbh;
return $dbh;
}
sub reset_dbh {
my ($self, $dbh) = @_;
$dbh->set_err(undef, undef); # clear any error state
}
sub new_response_with_err {
my ($self, $rv, $eval_error, $dbh) = @_;
# this is the usual way to create a response for both success and failure
# capture err+errstr etc and merge in $eval_error ($@)
my ($err, $errstr, $state) = ($DBI::err, $DBI::errstr, $DBI::state);
if ($eval_error) {
$err ||= $DBI::stderr || 1; # ensure err is true
if ($errstr) {
$eval_error =~ s/(?: : \s)? \Q$errstr//x if $errstr;
chomp $errstr;
$errstr .= "; $eval_error";
}
else {
$errstr = $eval_error;
}
}
chomp $errstr if $errstr;
my $flags;
# (XXX if we ever add transaction support then we'll need to take extra
# steps because the commit/rollback would reset Executed before we get here)
$flags |= GOf_RESPONSE_EXECUTED if $dbh && $dbh->{Executed};
my $response = DBI::Gofer::Response->new({
rv => $rv,
err => $err,
errstr => $errstr,
state => $state,
flags => $flags,
});
return $response;
}
sub execute_request {
my ($self, $request) = @_;
# should never throw an exception
DBI->trace_msg("-----> execute_request\n");
my @warnings;
local $SIG{__WARN__} = sub {
push @warnings, @_;
warn @_ if $local_log;
};
my $response = eval {
if (my $check_request_sub = $self->check_request_sub) {
$request = $check_request_sub->($request, $self)
or die "check_request_sub failed";
}
my $version = $request->version || 0;
die ref($request)." version $version is not supported"
if $version < 0.009116 or $version >= 1;
($request->is_sth_request)
? $self->execute_sth_request($request)
: $self->execute_dbh_request($request);
};
$response ||= $self->new_response_with_err(undef, $@, $current_dbh);
if (my $check_response_sub = $self->check_response_sub) {
# not protected with an eval so it can choose to throw an exception
my $new = $check_response_sub->($response, $self, $request);
$response = $new if ref $new;
}
undef $current_dbh;
$response->warnings(\@warnings) if @warnings;
DBI->trace_msg("<----- execute_request\n");
return $response;
}
sub execute_dbh_request {
my ($self, $request) = @_;
my $stats = $self->{stats};
my $dbh;
my $rv_ref = eval {
$dbh = $self->_connect($request);
my $args = $request->dbh_method_call; # [ wantarray, 'method_name', @args ]
my $wantarray = shift @$args;
my $meth = shift @$args;
$stats->{method_calls_dbh}->{$meth}++;
my @rv = ($wantarray)
? $dbh->$meth(@$args)
: scalar $dbh->$meth(@$args);
\@rv;
} || [];
my $response = $self->new_response_with_err($rv_ref, $@, $dbh);
return $response if not $dbh;
# does this request also want any dbh attributes returned?
if (my $dbh_attributes = $request->dbh_attributes) {
$response->dbh_attributes( $self->gather_dbh_attributes($dbh, $dbh_attributes) );
}
if ($rv_ref and my $lid_args = $request->dbh_last_insert_id_args) {
$stats->{method_calls_dbh}->{last_insert_id}++;
my $id = $dbh->last_insert_id( @$lid_args );
$response->last_insert_id( $id );
}
if ($rv_ref and UNIVERSAL::isa($rv_ref->[0],'DBI::st')) {
# dbh_method_call was probably a metadata method like table_info
# that returns a statement handle, so turn the $sth into resultset
my $sth = $rv_ref->[0];
$response->sth_resultsets( $self->gather_sth_resultsets($sth, $request, $response) );
$response->rv("(sth)"); # don't try to return actual sth
}
# we're finished with this dbh for this request
$self->reset_dbh($dbh);
return $response;
}
sub gather_dbh_attributes {
my ($self, $dbh, $dbh_attributes) = @_;
my @req_attr_names = @$dbh_attributes;
if ($req_attr_names[0] eq '*') { # auto include std + private
shift @req_attr_names;
push @req_attr_names, @{ $self->_std_response_attribute_names($dbh) };
}
my %dbh_attr_values;
@dbh_attr_values{@req_attr_names} = $dbh->FETCH_many(@req_attr_names);
# XXX piggyback installed_methods onto dbh_attributes for now
$dbh_attr_values{dbi_installed_methods} = { DBI->installed_methods };
# XXX piggyback default_methods onto dbh_attributes for now
$dbh_attr_values{dbi_default_methods} = _get_default_methods($dbh);
return \%dbh_attr_values;
}
sub _std_response_attribute_names {
my ($self, $h) = @_;
$h = tied(%$h) || $h; # switch to inner handle
# cache the private_attribute_info data for each handle
# XXX might be better to cache it in the executor
# as it's unlikely to change
# or perhaps at least cache it in the dbh even for sth
# as the sth are typically very short lived
my ($dbh, $h_type, $driver_name, @attr_names);
if ($dbh = $h->{Database}) { # is an sth
# does the dbh already have the answer cached?
return $dbh->{private_gofer_std_attr_names_sth} if $dbh->{private_gofer_std_attr_names_sth};
($h_type, $driver_name) = ('sth', $dbh->{Driver}{Name});
push @attr_names, qw(NUM_OF_PARAMS NUM_OF_FIELDS NAME TYPE NULLABLE PRECISION SCALE);
}
else { # is a dbh
return $h->{private_gofer_std_attr_names_dbh} if $h->{private_gofer_std_attr_names_dbh};
($h_type, $driver_name, $dbh) = ('dbh', $h->{Driver}{Name}, $h);
# explicitly add these because drivers may have different defaults
# add Name so the client gets the real Name of the connection
push @attr_names, qw(ChopBlanks LongReadLen LongTruncOk ReadOnly Name);
}
if (my $pai = $h->private_attribute_info) {
push @attr_names, keys %$pai;
}
else {
push @attr_names, @{ $extra_attr{ $driver_name }{$h_type} || []};
}
if (my $fra = $self->{forced_response_attributes}) {
push @attr_names, @{ $fra->{ $driver_name }{$h_type} || []}
}
$dbh->trace_msg("_std_response_attribute_names for $driver_name $h_type: @attr_names\n");
# cache into the dbh even for sth, as the dbh is usually longer lived
return $dbh->{"private_gofer_std_attr_names_$h_type"} = \@attr_names;
}
sub execute_sth_request {
my ($self, $request) = @_;
my $dbh;
my $sth;
my $last_insert_id;
my $stats = $self->{stats};
my $rv = eval {
$dbh = $self->_connect($request);
my $args = $request->dbh_method_call; # [ wantarray, 'method_name', @args ]
shift @$args; # discard wantarray
my $meth = shift @$args;
$stats->{method_calls_sth}->{$meth}++;
$sth = $dbh->$meth(@$args);
my $last = '(sth)'; # a true value (don't try to return actual sth)
# execute methods on the sth, e.g., bind_param & execute
if (my $calls = $request->sth_method_calls) {
for my $meth_call (@$calls) {
my $method = shift @$meth_call;
$stats->{method_calls_sth}->{$method}++;
$last = $sth->$method(@$meth_call);
}
}
if (my $lid_args = $request->dbh_last_insert_id_args) {
$stats->{method_calls_sth}->{last_insert_id}++;
$last_insert_id = $dbh->last_insert_id( @$lid_args );
}
$last;
};
my $response = $self->new_response_with_err($rv, $@, $dbh);
return $response if not $dbh;
$response->last_insert_id( $last_insert_id )
if defined $last_insert_id;
# even if the eval failed we still want to try to gather attribute values
# (XXX would be nice to be able to support streaming of results.
# which would reduce memory usage and latency for large results)
if ($sth) {
$response->sth_resultsets( $self->gather_sth_resultsets($sth, $request, $response) );
$sth->finish;
}
# does this request also want any dbh attributes returned?
my $dbh_attr_set;
if (my $dbh_attributes = $request->dbh_attributes) {
$dbh_attr_set = $self->gather_dbh_attributes($dbh, $dbh_attributes);
}
# XXX needs to be integrated with private_attribute_info() etc
if (my $dbh_attr = $extra_attr{$dbh->{Driver}{Name}}{dbh_after_sth}) {
@{$dbh_attr_set}{@$dbh_attr} = $dbh->FETCH_many(@$dbh_attr);
}
$response->dbh_attributes($dbh_attr_set) if $dbh_attr_set && %$dbh_attr_set;
$self->reset_dbh($dbh);
return $response;
}
sub gather_sth_resultsets {
my ($self, $sth, $request, $response) = @_;
my $resultsets = eval {
my $attr_names = $self->_std_response_attribute_names($sth);
my $sth_attr = {};
$sth_attr->{$_} = 1 for @$attr_names;
# let the client add/remove sth attributes
if (my $sth_result_attr = $request->sth_result_attr) {
$sth_attr->{$_} = $sth_result_attr->{$_}
for keys %$sth_result_attr;
}
my @sth_attr = grep { $sth_attr->{$_} } keys %$sth_attr;
my $row_count = 0;
my $rs_list = [];
while (1) {
my $rs = $self->fetch_result_set($sth, \@sth_attr);
push @$rs_list, $rs;
if (my $rows = $rs->{rowset}) {
$row_count += @$rows;
}
last if $self->{forced_single_resultset};
last if !($sth->more_results || $sth->{syb_more_results});
}
my $stats = $self->{stats};
$stats->{rows_returned_total} += $row_count;
$stats->{rows_returned_max} = $row_count
if $row_count > ($stats->{rows_returned_max}||0);
$rs_list;
};
$response->add_err(1, $@) if $@;
return $resultsets;
}
sub fetch_result_set {
my ($self, $sth, $sth_attr) = @_;
my %meta;
eval {
@meta{ @$sth_attr } = $sth->FETCH_many(@$sth_attr);
# we assume @$sth_attr contains NUM_OF_FIELDS
$meta{rowset} = $sth->fetchall_arrayref()
if (($meta{NUM_OF_FIELDS}||0) > 0); # is SELECT
# the fetchall_arrayref may fail with a 'not executed' kind of error
# because gather_sth_resultsets/fetch_result_set are called even if
# execute() failed, or even if there was no execute() call at all.
# The corresponding error goes into the resultset err, not the top-level
# response err, so in most cases this resultset err is never noticed.
};
if ($@) {
chomp $@;
$meta{err} = $DBI::err || 1;
$meta{errstr} = $DBI::errstr || $@;
$meta{state} = $DBI::state;
}
return \%meta;
}
sub _get_default_methods {
my ($dbh) = @_;
# returns a ref to a hash of dbh method names for methods which the driver
# hasn't overridden i.e., quote(). These don't need to be forwarded via gofer.
my $ImplementorClass = $dbh->{ImplementorClass} or die;
my %default_methods;
for my $method (@all_dbh_methods) {
my $dbi_sub = $all_dbh_methods{$method} || 42;
my $imp_sub = $ImplementorClass->can($method) || 42;
next if $imp_sub != $dbi_sub;
#warn("default $method\n");
$default_methods{$method} = 1;
}
return \%default_methods;
}
# XXX would be nice to make this a generic DBI module
sub _install_rand_callbacks {
my ($self, $dbh, $dbi_gofer_random) = @_;
my $callbacks = $dbh->{Callbacks} || {};
my $prev = $dbh->{private_gofer_rand_fail_callbacks} || {};
# return if we've already setup this handle with callbacks for these specs
return if (($callbacks->{_dbi_gofer_random_spec}||'') eq $dbi_gofer_random);
#warn "$dbh # $callbacks->{_dbi_gofer_random_spec}";
$callbacks->{_dbi_gofer_random_spec} = $dbi_gofer_random;
my ($fail_percent, $fail_err, $delay_percent, $delay_duration, %spec_part, @spec_note);
my @specs = split /,/, $dbi_gofer_random;
for my $spec (@specs) {
if ($spec =~ m/^fail=(-?[.\d]+)%?$/) {
$fail_percent = $1;
$spec_part{fail} = $spec;
next;
}
if ($spec =~ m/^err=(-?\d+)$/) {
$fail_err = $1;
$spec_part{err} = $spec;
next;
}
if ($spec =~ m/^delay([.\d]+)=(-?[.\d]+)%?$/) {
$delay_duration = $1;
$delay_percent = $2;
$spec_part{delay} = $spec;
next;
}
elsif ($spec !~ m/^(\w+|\*)$/) {
warn "Ignored DBI_GOFER_RANDOM item '$spec' which isn't a config or a dbh method name";
next;
}
my $method = $spec;
if ($callbacks->{$method} && $prev->{$method} && $callbacks->{$method} != $prev->{$method}) {
warn "Callback for $method method already installed so DBI_GOFER_RANDOM callback not installed\n";
next;
}
unless (defined $fail_percent or defined $delay_percent) {
warn "Ignored DBI_GOFER_RANDOM item '$spec' because not preceded by 'fail=N' and/or 'delayN=N'";
next;
}
push @spec_note, join(",", values(%spec_part), $method);
$callbacks->{$method} = $self->_mk_rand_callback($method, $fail_percent, $delay_percent, $delay_duration, $fail_err);
}
warn "DBI_GOFER_RANDOM failures/delays enabled: @spec_note\n"
if @spec_note;
$dbh->{Callbacks} = $callbacks;
$dbh->{private_gofer_rand_fail_callbacks} = $callbacks;
}
my %_mk_rand_callback_seqn;
sub _mk_rand_callback {
my ($self, $method, $fail_percent, $delay_percent, $delay_duration, $fail_err) = @_;
my ($fail_modrate, $delay_modrate);
$fail_percent ||= 0; $fail_modrate = int(1/(-$fail_percent )*100) if $fail_percent;
$delay_percent ||= 0; $delay_modrate = int(1/(-$delay_percent)*100) if $delay_percent;
# note that $method may be "*" but that's not recommended or documented or wise
return sub {
my ($h) = @_;
my $seqn = ++$_mk_rand_callback_seqn{$method};
my $delay = ($delay_percent > 0) ? rand(100) < $delay_percent :
($delay_percent < 0) ? !($seqn % $delay_modrate): 0;
my $fail = ($fail_percent > 0) ? rand(100) < $fail_percent :
($fail_percent < 0) ? !($seqn % $fail_modrate) : 0;
#no warnings 'uninitialized';
#warn "_mk_rand_callback($fail_percent:$fail_modrate, $delay_percent:$delay_modrate): seqn=$seqn fail=$fail delay=$delay";
if ($delay) {
my $msg = "DBI_GOFER_RANDOM delaying execution of $method() by $delay_duration seconds\n";
# Note what's happening in a trace message. If the delay percent is an even
# number then use warn() instead so it's sent back to the client.
($delay_percent % 2 == 1) ? warn($msg) : $h->trace_msg($msg);
select undef, undef, undef, $delay_duration; # allows floating point value
}
if ($fail) {
undef $_; # tell DBI to not call the method
# the "induced by DBI_GOFER_RANDOM" is special and must be included in errstr
# as it's checked for in a few places, such as the gofer retry logic
return $h->set_err($fail_err || $DBI::stderr,
"fake error from $method method induced by DBI_GOFER_RANDOM env var ($fail_percent%)");
}
return;
}
}
sub update_stats {
my ($self,
$request, $response,
$frozen_request, $frozen_response,
$time_received,
$store_meta, $other_meta,
) = @_;
# should always have a response object here
carp("No response object provided") unless $request;
my $stats = $self->{stats};
$stats->{frozen_request_max_bytes} = length($frozen_request)
if $frozen_request
&& length($frozen_request) > ($stats->{frozen_request_max_bytes}||0);
$stats->{frozen_response_max_bytes} = length($frozen_response)
if $frozen_response
&& length($frozen_response) > ($stats->{frozen_response_max_bytes}||0);
my $recent;
if (my $track_recent = $self->{track_recent}) {
$recent = {
request => $frozen_request,
response => $frozen_response,
time_received => $time_received,
duration => dbi_time()-$time_received,
# for any other info
($store_meta) ? (meta => $store_meta) : (),
};
$recent->{request_object} = $request
if !$frozen_request && $request;
$recent->{response_object} = $response
if !$frozen_response;
my @queues = ($stats->{recent_requests} ||= []);
push @queues, ($stats->{recent_errors} ||= [])
if !$response or $response->err;
for my $queue (@queues) {
push @$queue, $recent;
shift @$queue if @$queue > $track_recent;
}
}
return $recent;
}
1;
__END__
=head1 NAME
DBI::Gofer::Execute - Executes Gofer requests and returns Gofer responses
=head1 SYNOPSIS
$executor = DBI::Gofer::Execute->new( { ...config... });
$response = $executor->execute_request( $request );
=head1 DESCRIPTION
Accepts a DBI::Gofer::Request object, executes the requested DBI method calls,
and returns a DBI::Gofer::Response object.
Any error, including any internal 'fatal' errors are caught and converted into
a DBI::Gofer::Response object.
This module is usually invoked by a 'server-side' Gofer transport module.
They usually have names in the "C<DBI::Gofer::Transport::*>" namespace.
Examples include: L<DBI::Gofer::Transport::stream> and L<DBI::Gofer::Transport::mod_perl>.
=head1 CONFIGURATION
=head2 check_request_sub
If defined, it must be a reference to a subroutine that will 'check' the request.
It is passed the request object and the executor as its only arguments.
The subroutine can either return the original request object or die with a
suitable error message (which will be turned into a Gofer response).
It can also construct and return a new request that should be executed instead
of the original request.
=head2 check_response_sub
If defined, it must be a reference to a subroutine that will 'check' the response.
It is passed the response object, the executor, and the request object.
The sub may alter the response object and return undef, or return a new response object.
This mechanism can be used to, for example, terminate the service if specific
database errors are seen.
=head2 forced_connect_dsn
If set, this DSN is always used instead of the one in the request.
=head2 default_connect_dsn
If set, this DSN is used if C<forced_connect_dsn> is not set and the request does not contain a DSN itself.
=head2 forced_connect_attributes
A reference to a hash of connect() attributes. Individual attributes in
C<forced_connect_attributes> will take precedence over corresponding attributes
in the request.
=head2 default_connect_attributes
A reference to a hash of connect() attributes. Individual attributes in the
request take precedence over corresponding attributes in C<default_connect_attributes>.
=head2 max_cached_dbh_per_drh
If set, the loaded drivers will be checked to ensure they don't have more than
this number of cached connections. There is no default value. This limit is not
enforced for every request.
=head2 max_cached_sth_per_dbh
If set, all the cached statement handles will be cleared once the number of
cached statement handles rises above this limit. The default is 1000.
=head2 forced_single_resultset
If true, then only the first result set will be fetched and returned in the response.
=head2 forced_response_attributes
A reference to a data structure that can specify extra attributes to be returned in responses.
forced_response_attributes => {
DriverName => {
dbh => [ qw(dbh_attrib_name) ],
sth => [ qw(sth_attrib_name) ],
},
},
This can be useful in cases where the driver has not implemented the
private_attribute_info() method and DBI::Gofer::Execute's own fallback list of
private attributes doesn't include the driver or attributes you need.
=head2 track_recent
If set, specifies the number of recent requests and responses that should be
kept by the update_stats() method for diagnostics. See L<DBI::Gofer::Transport::mod_perl>.
Note that this setting can significantly increase memory use. Use with caution.
=head2 forced_gofer_random
Enable forced random failures and/or delays for testing. See L</DBI_GOFER_RANDOM> below.
=head1 DRIVER-SPECIFIC ISSUES
Gofer needs to know about any driver-private attributes that should have their
values sent back to the client.
If the driver doesn't support private_attribute_info() method, and very few do,
then the module fallsback to using some hard-coded details, if available, for
the driver being used. Currently hard-coded details are available for the
mysql, Pg, Sybase, and SQLite drivers.
=head1 TESTING
DBD::Gofer, DBD::Execute and related packages are well tested by executing the
DBI test suite with DBI_AUTOPROXY configured to route all DBI calls via DBD::Gofer.
Because Gofer includes timeout and 'retry on error' mechanisms there is a need
for some way to trigger delays and/or errors. This can be done via the
C<forced_gofer_random> configuration item, or else the DBI_GOFER_RANDOM environment
variable.
=head2 DBI_GOFER_RANDOM
The value of the C<forced_gofer_random> configuration item (or else the
DBI_GOFER_RANDOM environment variable) is treated as a series of tokens
separated by commas.
The tokens can be one of three types:
=over 4
=item fail=R%
Set the current failure rate to R where R is a percentage.
The value R can be floating point, e.g., C<fail=0.05%>.
Negative values for R have special meaning, see below.
=item err=N
Sets the current failure err value to N (instead of the DBI's default 'standard
err value' of 2000000000). This is useful when you want to simulate a
specific error.
=item delayN=R%
Set the current random delay rate to R where R is a percentage, and set the
current delay duration to N seconds. The values of R and N can be floating point,
e.g., C<delay0.5=0.2%>. Negative values for R have special meaning, see below.
If R is an odd number (R % 2 == 1) then a message is logged via warn() which
will be returned to, and echoed at, the client.
=item methodname
Applies the current fail, err, and delay values to the named method.
If neither a fail nor delay have been set yet then a warning is generated.
=back
For example:
$executor = DBI::Gofer::Execute->new( {
forced_gofer_random => "fail=0.01%,do,delay60=1%,execute",
});
will cause the do() method to fail for 0.01% of calls, and the execute() method to
fail 0.01% of calls and be delayed by 60 seconds on 1% of calls.
If the percentage value (C<R>) is negative then instead of the failures being
triggered randomly (via the rand() function) they are triggered via a sequence
number. In other words "C<fail=-20%>" will mean every fifth call will fail.
Each method has a distinct sequence number.
=head1 AUTHOR
Tim Bunce, L<http://www.tim.bunce.name>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2007, Tim Bunce, Ireland. All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
=cut
PK V`[�x7�S S Gofer/Response.pmnu �[��� package DBI::Gofer::Response;
# $Id: Response.pm 11565 2008-07-22 20:17:33Z Tim $
#
# Copyright (c) 2007, Tim Bunce, Ireland
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
use strict;
use Carp;
use DBI qw(neat neat_list);
use base qw(DBI::Util::_accessor Exporter);
our $VERSION = "0.011566";
use constant GOf_RESPONSE_EXECUTED => 0x0001;
our @EXPORT = qw(GOf_RESPONSE_EXECUTED);
__PACKAGE__->mk_accessors(qw(
version
rv
err
errstr
state
flags
last_insert_id
dbh_attributes
sth_resultsets
warnings
));
__PACKAGE__->mk_accessors_using(make_accessor_autoviv_hashref => qw(
meta
));
sub new {
my ($self, $args) = @_;
$args->{version} ||= $VERSION;
chomp $args->{errstr} if $args->{errstr};
return $self->SUPER::new($args);
}
sub err_errstr_state {
my $self = shift;
return @{$self}{qw(err errstr state)};
}
sub executed_flag_set {
my $flags = shift->flags
or return 0;
return $flags & GOf_RESPONSE_EXECUTED;
}
sub add_err {
my ($self, $err, $errstr, $state, $trace) = @_;
# acts like the DBI's set_err method.
# this code copied from DBI::PurePerl's set_err method.
chomp $errstr if $errstr;
$state ||= '';
carp ref($self)."->add_err($err, $errstr, $state)"
if $trace and defined($err) || $errstr;
my ($r_err, $r_errstr, $r_state) = ($self->{err}, $self->{errstr}, $self->{state});
if ($r_errstr) {
$r_errstr .= sprintf " [err was %s now %s]", $r_err, $err
if $r_err && $err && $r_err ne $err;
$r_errstr .= sprintf " [state was %s now %s]", $r_state, $state
if $r_state and $r_state ne "S1000" && $state && $r_state ne $state;
$r_errstr .= "\n$errstr" if $r_errstr ne $errstr;
}
else {
$r_errstr = $errstr;
}
# assign if higher priority: err > "0" > "" > undef
my $err_changed;
if ($err # new error: so assign
or !defined $r_err # no existing warn/info: so assign
# new warn ("0" len 1) > info ("" len 0): so assign
or defined $err && length($err) > length($r_err)
) {
$r_err = $err;
++$err_changed;
}
$r_state = ($state eq "00000") ? "" : $state
if $state && $err_changed;
($self->{err}, $self->{errstr}, $self->{state}) = ($r_err, $r_errstr, $r_state);
return undef;
}
sub summary_as_text {
my $self = shift;
my ($context) = @_;
my ($rv, $err, $errstr, $state) = ($self->{rv}, $self->{err}, $self->{errstr}, $self->{state});
my @s = sprintf("\trv=%s", (ref $rv) ? "[".neat_list($rv)."]" : neat($rv));
$s[-1] .= sprintf(", err=%s, errstr=%s", $err, neat($errstr))
if defined $err;
$s[-1] .= sprintf(", flags=0x%x", $self->{flags})
if defined $self->{flags};
push @s, "last_insert_id=%s", $self->last_insert_id
if defined $self->last_insert_id;
if (my $dbh_attr = $self->dbh_attributes) {
my @keys = sort keys %$dbh_attr;
push @s, sprintf "dbh= { %s }", join(", ", map { "$_=>".neat($dbh_attr->{$_},100) } @keys)
if @keys;
}
for my $rs (@{$self->sth_resultsets || []}) {
my ($rowset, $err, $errstr, $state)
= @{$rs}{qw(rowset err errstr state)};
my $summary = "rowset: ";
my $NUM_OF_FIELDS = $rs->{NUM_OF_FIELDS} || 0;
my $rows = $rowset ? @$rowset : 0;
if ($rowset || $NUM_OF_FIELDS > 0) {
$summary .= sprintf "%d rows, %d columns", $rows, $NUM_OF_FIELDS;
}
$summary .= sprintf ", err=%s, errstr=%s", $err, neat($errstr) if defined $err;
if ($rows) {
my $NAME = $rs->{NAME};
# generate
my @colinfo = map { "$NAME->[$_]=".neat($rowset->[0][$_], 30) } 0..@{$NAME}-1;
$summary .= sprintf " [%s]", join ", ", @colinfo;
$summary .= ",..." if $rows > 1;
# we can be a little more helpful for Sybase/MSSQL user
$summary .= " syb_result_type=$rs->{syb_result_type}"
if $rs->{syb_result_type} and $rs->{syb_result_type} != 4040;
}
push @s, $summary;
}
for my $w (@{$self->warnings || []}) {
chomp $w;
push @s, "warning: $w";
}
if ($context && %$context) {
my @keys = sort keys %$context;
push @s, join(", ", map { "$_=>".$context->{$_} } @keys);
}
return join("\n\t", @s). "\n";
}
sub outline_as_text { # one-line version of summary_as_text
my $self = shift;
my ($context) = @_;
my ($rv, $err, $errstr, $state) = ($self->{rv}, $self->{err}, $self->{errstr}, $self->{state});
my $s = sprintf("rv=%s", (ref $rv) ? "[".neat_list($rv)."]" : neat($rv));
$s .= sprintf(", err=%s %s", $err, neat($errstr))
if defined $err;
$s .= sprintf(", flags=0x%x", $self->{flags})
if $self->{flags};
if (my $sth_resultsets = $self->sth_resultsets) {
$s .= sprintf(", %d resultsets ", scalar @$sth_resultsets);
my @rs;
for my $rs (@{$self->sth_resultsets || []}) {
my $summary = "";
my ($rowset, $err, $errstr)
= @{$rs}{qw(rowset err errstr)};
my $NUM_OF_FIELDS = $rs->{NUM_OF_FIELDS} || 0;
my $rows = $rowset ? @$rowset : 0;
if ($rowset || $NUM_OF_FIELDS > 0) {
$summary .= sprintf "%dr x %dc", $rows, $NUM_OF_FIELDS;
}
$summary .= sprintf "%serr %s %s", ($summary?", ":""), $err, neat($errstr)
if defined $err;
push @rs, $summary;
}
$s .= join "; ", map { "[$_]" } @rs;
}
return $s;
}
1;
=head1 NAME
DBI::Gofer::Response - Encapsulate a response from DBI::Gofer::Execute to DBD::Gofer
=head1 DESCRIPTION
This is an internal class.
=head1 AUTHOR
Tim Bunce, L<http://www.tim.bunce.name>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2007, Tim Bunce, Ireland. All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
=cut
PK V`[B�2� � ProfileDumper/Apache.pmnu �[��� PK V`[Q�G� G� � DBD/SqlEngine.pmnu �[��� PK V`[�ma��: �: g DBD/Metadata.pmnu �[��� PK V`[ `y �j �j kS DBD/SqlEngine/Developers.podnu �[��� PK V`[�S�K* K* �� DBD/SqlEngine/HowTo.podnu �[��� PK V`[E
� N N � ProfileData.pmnu �[��� PK V`[{q���� ��
m7 Changes.pmnu �[��� PK V`[^q�� 2 Util/CacheMemory.pmnu �[��� PK V`[!3т � �' Util/_accessor.pmnu �[��� PK V`[����� � M. ProfileSubs.pmnu �[��� PK V`[��Gf
v
v 3 SQL/Nano.pmnu �[��� PK V`[d-� �
`� Profile.pmnu �[��� PK V`[h\:5�( �( )) ProfileDumper.pmnu �[��� PK V`[��~� � �Q Const/GetInfoType.pmnu �[��� PK V`[�st�I I �V Const/GetInfo/ODBC.pmnu �[��� PK V`[�ב��% �% xY Const/GetInfo/ANSI.pmnu �[��� PK V`[]� � � = Const/GetInfoReturn.pmnu �[��� PK V`[3�/�Ɩ Ɩ .� PurePerl.pmnu �[��� PK V`[��)K� K� / DBD.pmnu �[��� PK V`[ 0�� � � Gofer/Serializer/Base.pmnu �[��� PK V`[��� � Gofer/Serializer/DataDumper.pmnu �[��� PK V`[�GA�� � B Gofer/Serializer/Storable.pmnu �[��� PK V`[[=��t t / Gofer/Request.pmnu �[��� PK V`[\}� � � �4 Gofer/Transport/Base.pmnu �[��� PK V`[�"� � �H Gofer/Transport/stream.pmnu �[��� PK V`[���S^ ^ Q Gofer/Transport/pipeone.pmnu �[��� PK V`[���y �y �V Gofer/Execute.pmnu �[��� PK V`[�x7�S S �� Gofer/Response.pmnu �[��� PK
-�