Author: mjevans
Date: Tue Jun 15 09:41:30 2010
New Revision: 14153
Modified:
dbi/trunk/lib/DBD/File/Developers.pod
Log:
some grammatical fixes to Sno's last pod changes.
Modified: dbi/trunk/lib/DBD/File/Developers.pod
==============================================================================
--- dbi/trunk/lib/DBD/File/Developers.pod (original)
+++ dbi/trunk/lib/DBD/File/Developers.pod Tue Jun 15 09:41:30 2010
@@ -38,16 +38,15 @@
Pure Perl DBI drivers derived from DBD::File do not usually need to
override any of the methods provided through the DBD::XXX::dr package
-however if you need additional initialization in connect you may need
-to.
+however if you need additional initialization in the connect method
+you may need to.
=item DBD::File::db
Contains the methods which are called through DBI database handles
-(C<< $dbh >>).
+(C<< $dbh >>). e.g.,
- my $dbh = DBI->connect ('DBI:CSV:', unef, undef, { f_ext => '.csv/r' });
- $dbh->prepare ("select * from foo");
+ $sth = $dbh->prepare ("select * from foo");
# returns the f_encoding setting for table foo
$dbh->csv_get_meta ("foo", "f_encoding");
@@ -57,20 +56,18 @@
=item DBD::File::st
-Contains the methods to deal with prepared statement handles:
+Contains the methods to deal with prepared statement handles. e.g.,
- $dbh = DBI->connect ("DBI::AnyData:", undef, undef, {});
- $sth = $dbh->prepare ("select * from bar");
$sth->execute () or die $sth->errstr;
=back
=head2 DBD::File
-This is the main package containing the routines to initialize DBD::File
-based DBI drivers. Primarily the method C<< DBD::File::driver >> is invoked,
-either directly from DBI when the driver is initialized or from the derived
-class.
+This is the main package containing the routines to initialize
+DBD::File based DBI drivers. Primarily the C<< DBD::File::driver >>
+method is invoked, either directly from DBI when the driver is
+initialized or from the derived class.
package DBD::DBM;
@@ -92,7 +89,7 @@
=head2 DBD::File::dr
-Driver package, contains the methods DBI calls indirectly via DBI
+The driver package contains the methods DBI calls indirectly via the DBI
interface (see L<DBI/DBI Class Methods>).
DBD::File based DBI drivers usually do not need to implement anything here,
@@ -215,13 +212,13 @@
=item get_versions
-This method is called by the code injected to the instantiated driver to
+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 DBD::File implementation returns all version information known by
-DBD::File (e.g. DBI version, Perl version and of course, DBD::File version,
-used sql handler including it's version, too).
+DBD::File (e.g. DBI version, Perl version, DBD::File 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
@@ -245,11 +242,11 @@
=item get_file_meta
-Retrieve an attribute from table's meta information. Method signature is
+Retrieve an attribute from a table's meta information. Method signature is
C<< get_file_meta ($dbh, $table, $attr) >>. This method is called by the
injected db handle method C<< ${drv_prefix}get_meta >>.
-While get_file_meta allows C<$table> or C<$attr> being a list of tables or
+While get_file_meta allows C<$table> or C<$attr> to be a list of tables or
attributes to retrieve, get_single_table_meta allows only one table name
and only one attribute name. A table name of C<'.'> (single dot) is
interpreted as the default table. This will retrieve the appropriate
@@ -274,8 +271,8 @@
C<< set_file_meta ($dbh, $table, $attr, $value) >>. This method is called
by the injected db handle method C<< ${drv_prefix}set_meta >>.
-While set_file_meta allows C<$table> being a list of tables or C<$attr>
-being a hash of several attributes to set, set_single_table_meta allows
+While set_file_meta allows C<$table> to be a list of tables or C<$attr>
+to be a hash of several attributes to set, set_single_table_meta allows
only one table name and only one attribute name/value pair.
The wildcard characters for the table name are the same as for
@@ -299,8 +296,8 @@
=item disconnect
-Disconnects from a database. All local table information are discarded and
-the attribute C<< Active >> is set to 0.
+Disconnects from a database. All local table information is discarded and
+the C<< Active >> attribute is set to 0.
=item type_info_all
@@ -317,7 +314,7 @@
=item quote
-Quotes a string for use it in SQL statements.
+Quotes a string for use in SQL statements.
=item commit
@@ -369,9 +366,9 @@
Fetches statement handle attributes. Supported attributes (for full overview
see L<DBI/Statement Handle Attributes>) are C<< NAME >> and C<< NULLABLE >>.
Each column is returned being C<< NULLABLE >> which might be wrong depending
-on derived backend storage. If the statement handle has private attributes,
+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 to any table used in this statement.
+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.
@@ -440,17 +437,18 @@
=item bootstrap_table_meta
-Initializes a table meta structure. Can be safely overwritten in a
+Initializes a table meta structure. Can be safely overriden in a
derived class, as long as the C<< SUPER >> method is called at the end
of the overriden method.
-It copies following attributes from the database into the table meta data
+It copies the following attributes from the database into the table meta data
C<< f_dir >>, C<< f_ext >>, C<< f_encoding >>, C<< f_lock >>, C<< f_schema >>,
C<< f_lockfile >> and C<< sql_identifier_case >> 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 right directory, extension etc. is used.
+name and table name to ensure the correct directory, extension etc. are
+used.
=item init_table_meta
@@ -482,7 +480,7 @@
Is called to open the table's data file.
Depending on the attributes set in the table's meta data, the
-following steps are performed: unless C<< f_dontopen >> is set to a
+following steps are performed. Unless C<< f_dontopen >> is set to a
true value, C<< f_fqfn >> must contain the full qualified file name
for the table to work on (file2table ensures this). The encoding in
C<< f_encoding >> is applied if set and the file is opened. If
