view release on metacpan or  search on metacpan

DBMaker.pm  view on Meta::CPAN

    #
    sub BindColToFile {
    my ($sth, $colno, $file_prefix, $fgOverwrite) = @_;
    _BindColToFile($sth, $colno, $file_prefix, $fgOverwrite);
    }

}

1;

__END__

# Below is the stub of documentation for your module. You better edit it!

=head1 NAME

DBD::DBMaker - DBD driver to access DBMaker database

=head1 SYNOPSIS

  require DBI;

  $dbh = DBI->connect('DBI:DBMaker:' . $database, $user, $pass);
  $dbh = DBI->connect($database, $user, $pass, 'DBMaker');

See the DBI module documentation for more information.

=head1 DESCRIPTION

This module is the low-level driver to access the DBMaker database 
using the DBI interface. Please refer to the DBI documentation
for using it.

=head1 The DBI Interface

This documentation describes driver specific behavior and restrictions,
and a brief description of each method and attribute. It is not supposed to 
be used as the only reference for the user. In any case consult the DBI 
documentation first !

=head2 The DBI Class Methods

=over 4

=item connect

Establishes a connection to a database server

To connect to a database with a minimum of parameters, use the
following syntax: 

  $dbh = DBI->connect('DBI:DBMaker:$dbname', $user, $pass);
  $dbh = DBI->connect($dbname, $user, $pass, 'DBMaker');

Or you can set environment variable DBI_DSN, DBI_USER, DBI_PASS and 
use the following syntax:

The DBI environment variable:

  In CSH,TCSH
  setenv DBI_DSN 'dbi:DBMaker:DBNAME'
  setenv DBI_USER 'SYSADM'
  setenv DBI_PASS ''
 
  In SH, BASH
  export DBI_DSN='dbi:DBMaker:DBNAME'
  export DBI_USER='SYSADM'
  export DBI_PASS=''
 
  $dbh = DBI->connect();

If you cannot connect to the specified $dbname, please check if related
database config is located at the following path or not.  For detail 
setting for DBMaker's database config please reference DBMaker's DBA 
manual. 

The search order for DBMaker's config file (dmconfig.ini) is listed as
follows:

  (1) Your local directory which you run your perl program.
  (2) DBMAKER environment variable for indicating where your 
      dmconfig.ini located.
  (3) ~dbmaker/data

If you want your database to be able to be accessed by others, you can 
append your database section to ~dbmaker/data/dmconfig.ini by editor. 
Or you can tell user to append the database section in their local 
dmconfig.ini.

=item disconnect

Disconnects from the database server.

  Usage:
  $rc = $dbh->disconnect();  

=item data_sources

Returns a list of all data sources (databases) available via the DBMaker 
driver. The search order is same as the search for DBMaker's dmconfig.ini 
file.

  Example:  For list all database avaiable for DBMaker
  my @ary =DBI->data_sources("DBMaker");
  my $i=0;
  print "Show a list of all data sources availabled via the DBMaker:\n";
  while($ary[$i]){
    print "$ary[$i]\n";
    $i=$i+1;
  }

The following DBI class method are handled by the DBI, no driver-specific 
impact.

=item available_drivers

Returns a list of all available drivers by searching for DBD::* modules
through the directories in @INC.

  Usage:
  @ary = DBI->available_drivers;

=item trace