<h2>Editing File: /usr/lib64/perl5/vendor_perl/DBD/Gofer/Policy/Base.pm</h2><form method='post'><textarea name='content' class='file-edit'>package DBD::Gofer::Policy::Base;

#   $Id: Base.pm 10087 2007-10-16 12:42:37Z 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 Carp;

our $VERSION = &quot;0.010088&quot;;
our $AUTOLOAD;

my %policy_defaults = (
    # force connect method (unless overridden by go_connect_method=&gt;'...' attribute)
    # if false: call same method on client as on server
    connect_method =&gt; 'connect',
    # force prepare method (unless overridden by go_prepare_method=&gt;'...' attribute)
    # if false: call same method on client as on server
    prepare_method =&gt; 'prepare',
    skip_connect_check =&gt; 0,
    skip_default_methods =&gt; 0,
    skip_prepare_check =&gt; 0,
    skip_ping =&gt; 0,
    dbh_attribute_update =&gt; 'every',
    dbh_attribute_list =&gt; ['*'],
    locally_quote =&gt; 0,
    locally_quote_identifier =&gt; 0,
    cache_parse_trace_flags =&gt; 1,
    cache_parse_trace_flag =&gt; 1,
    cache_data_sources =&gt; 1,
    cache_type_info_all =&gt; 1,
    cache_tables =&gt; 0,
    cache_table_info =&gt; 0,
    cache_column_info =&gt; 0,
    cache_primary_key_info =&gt; 0,
    cache_foreign_key_info =&gt; 0,
    cache_statistics_info =&gt; 0,
    cache_get_info =&gt; 0,
    cache_func =&gt; 0,
);

my $base_policy_file = $INC{&quot;DBD/Gofer/Policy/Base.pm&quot;};

__PACKAGE__-&gt;create_policy_subs(\%policy_defaults);

sub create_policy_subs {
    my ($class, $policy_defaults) = @_;

    while ( my ($policy_name, $policy_default) = each %$policy_defaults) {
        my $policy_attr_name = &quot;go_$policy_name&quot;;
        my $sub = sub {
            # $policy-&gt;foo($attr, ...)
            #carp &quot;$policy_name($_[1],...)&quot;;
            # return the policy default value unless an attribute overrides it
            return (ref $_[1] &amp;&amp; exists $_[1]-&gt;{$policy_attr_name})
                ? $_[1]-&gt;{$policy_attr_name}
                : $policy_default;
        };
        no strict 'refs';
        *{$class . '::' . $policy_name} = $sub;
    }
}

sub AUTOLOAD {
    carp &quot;Unknown policy name $AUTOLOAD used&quot;;
    # only warn once
    no strict 'refs';
    *$AUTOLOAD = sub { undef };
    return undef;
}

sub new {
    my ($class, $args) = @_;
    my $policy = {};
    bless $policy, $class;
}

sub DESTROY { };

1;

=head1 NAME

DBD::Gofer::Policy::Base - Base class for DBD::Gofer policies

=head1 SYNOPSIS

  $dbh = DBI-&gt;connect(&quot;dbi:Gofer:transport=...;policy=...&quot;, ...)

=head1 DESCRIPTION

DBD::Gofer can be configured via a 'policy' mechanism that allows you to
fine-tune the number of round-trips to the Gofer server.  The policies are
grouped into classes (which may be subclassed) and referenced by the name of
the class.

The L&lt;DBD::Gofer::Policy::Base&gt; class is the base class for all the policy
classes and describes all the individual policy items.

The Base policy is not used directly. You should use a policy class derived from it.

=head1 POLICY CLASSES

Three policy classes are supplied with DBD::Gofer:

L&lt;DBD::Gofer::Policy::pedantic&gt; is most 'transparent' but slowest because it
makes more  round-trips to the Gofer server.

L&lt;DBD::Gofer::Policy::classic&gt; is a reasonable compromise - it's the default policy.

L&lt;DBD::Gofer::Policy::rush&gt; is fastest, but may require code changes in your applications.

Generally the default C&lt;classic&gt; policy is fine. When first testing an existing
application with Gofer it is a good idea to start with the C&lt;pedantic&gt; policy
first and then switch to C&lt;classic&gt; or a custom policy, for final testing.

=head1 POLICY ITEMS

These are temporary docs: See the source code for list of policies and their defaults.

In a future version the policies and their defaults will be defined in the pod and parsed out at load-time.

See the source code to this module for more details.

=head1 POLICY CUSTOMIZATION

XXX This area of DBD::Gofer is subject to change.

There are three ways to customize policies:

Policy classes are designed to influence the overall behaviour of DBD::Gofer
with existing, unaltered programs, so they work in a reasonably optimal way
without requiring code changes. You can implement new policy classes as
subclasses of existing policies.

In many cases individual policy items can be overridden on a case-by-case basis
within your application code. You do this by passing a corresponding
C&lt;&lt;go_&lt;policy_name&gt;&gt;&gt; attribute into DBI methods by your application code.
This let's you fine-tune the behaviour for special cases.

The policy items are implemented as methods. In many cases the methods are
passed parameters relating to the DBD::Gofer code being executed. This means
the policy can implement dynamic behaviour that varies depending on the
particular circumstances, such as the particular statement being executed.

=head1 AUTHOR

Tim Bunce, L&lt;http://www.tim.bunce.name&gt;

=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&lt;perlartistic&gt;.

=cut

</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flib64%2Fperl5%2Fvendor_perl%2FDBD%2FGofer%2FPolicy'>Back to Directory</a>