From: Nuba Princigalli Date: Mon, 15 Feb 2010 15:11:52 +0000 (+0000) Subject: spelling fixes in the documaentation, sholud be gud now ;) X-Git-Tag: v0.08120~36 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class.git;a=commitdiff_plain;h=48580715af3072905f2c71dc27e7f70f21a11338 spelling fixes in the documaentation, sholud be gud now ;) --- diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index f6e9e73..86b4d5d 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -303,6 +303,8 @@ Nniuq: Ron "Quinn" Straight" norbi: Norbert Buchmuller +nuba: Nuba Princigalli + Numa: Dan Sully ovid: Curtis "Ovid" Poe @@ -371,7 +373,7 @@ zamolxes: Bogdan Lucaciu =head1 COPYRIGHT -Copyright (c) 2005 - 2009 the DBIx::Class L and L +Copyright (c) 2005 - 2010 the DBIx::Class L and L as listed above. =head1 LICENSE diff --git a/lib/DBIx/Class/CDBICompat.pm b/lib/DBIx/Class/CDBICompat.pm index 835adfe..41160c0 100644 --- a/lib/DBIx/Class/CDBICompat.pm +++ b/lib/DBIx/Class/CDBICompat.pm @@ -91,7 +91,7 @@ This plugin will work, but it is more efficiently done using DBIC's native searc =head2 Choosing Features -In fact, this class is just a receipe containing all the features emulated. +In fact, this class is just a recipe containing all the features emulated. If you like, you can choose which features to emulate by building your own class and loading it like this: @@ -145,7 +145,7 @@ The semi-documented Class::DBI::Relationship objects returned by Ccopy($new_id) =head1 SYNOPSIS -See DBIx::Class::CDBICompat for directions for use. +See DBIx::Class::CDBICompat for usage directions. =head1 DESCRIPTION diff --git a/lib/DBIx/Class/CDBICompat/Iterator.pm b/lib/DBIx/Class/CDBICompat/Iterator.pm index 3e93154..847b10b 100644 --- a/lib/DBIx/Class/CDBICompat/Iterator.pm +++ b/lib/DBIx/Class/CDBICompat/Iterator.pm @@ -10,7 +10,7 @@ DBIx::Class::CDBICompat::Iterator - Emulates the extra behaviors of the Class::D =head1 SYNOPSIS -See DBIx::Class::CDBICompat for directions for use. +See DBIx::Class::CDBICompat for usage directions. =head1 DESCRIPTION diff --git a/lib/DBIx/Class/InflateColumn.pm b/lib/DBIx/Class/InflateColumn.pm index 5dec97d..f5c2f8f 100644 --- a/lib/DBIx/Class/InflateColumn.pm +++ b/lib/DBIx/Class/InflateColumn.pm @@ -26,7 +26,7 @@ for the database. It can be used, for example, to automatically convert to and from L objects for your date and time fields. There's a -conveniece component to actually do that though, try +convenience component to actually do that though, try L. It will handle all types of references except scalar references. It @@ -114,7 +114,7 @@ sub _deflated_column { Fetch a column value in its inflated state. This is directly analogous to L in that it only fetches a -column already retreived from the database, and then inflates it. +column already retrieved from the database, and then inflates it. Throws an exception if the column requested is not an inflated column. =cut diff --git a/lib/DBIx/Class/InflateColumn/File.pm b/lib/DBIx/Class/InflateColumn/File.pm index 0fde5e8..3d67914 100644 --- a/lib/DBIx/Class/InflateColumn/File.pm +++ b/lib/DBIx/Class/InflateColumn/File.pm @@ -176,7 +176,7 @@ InflateColumn::File =head2 _file_column_callback ($file,$ret,$target) -method made to be overridden for callback purposes. +Method made to be overridden for callback purposes. =cut diff --git a/lib/DBIx/Class/Manual/Component.pod b/lib/DBIx/Class/Manual/Component.pod index 2a762f8..398ef2e 100644 --- a/lib/DBIx/Class/Manual/Component.pod +++ b/lib/DBIx/Class/Manual/Component.pod @@ -106,7 +106,7 @@ L - CRUD methods. =head2 Experimental -These components are under development, there interfaces may +These components are under development, their interfaces may change, they may not work, etc. So, use them if you want, but be warned. diff --git a/lib/DBIx/Class/Manual/Cookbook.pod b/lib/DBIx/Class/Manual/Cookbook.pod index 7fa60d8..c84df81 100644 --- a/lib/DBIx/Class/Manual/Cookbook.pod +++ b/lib/DBIx/Class/Manual/Cookbook.pod @@ -141,7 +141,7 @@ Next, you can execute your complex query using bind parameters like this: ); ... and you'll get back a perfect L (except, of course, -that you cannot modify the rows it contains, ie. cannot call L, +that you cannot modify the rows it contains, e.g. cannot call L, L, ... on it). Note that you cannot have bind parameters unless is_virtual is set to true. @@ -201,7 +201,7 @@ to access the returned value: # SELECT name name, LENGTH( name ) # FROM artist -Note that the C attribute B with the sql +Note that the C attribute B with the SQL syntax C< SELECT foo AS bar > (see the documentation in L). You can control the C part of the generated SQL via the C<-as> field attribute as follows: @@ -329,7 +329,7 @@ You can write subqueries relatively easily in DBIC. artist_id => { 'IN' => $inside_rs->get_column('id')->as_query }, }); -The usual operators ( =, !=, IN, NOT IN, etc) are supported. +The usual operators ( =, !=, IN, NOT IN, etc.) are supported. B: You have to explicitly use '=' when doing an equality comparison. The following will B work: @@ -411,7 +411,7 @@ Then call your new method in your code: Using SQL functions on the left hand side of a comparison is generally not a good idea since it requires a scan of the entire table. (Unless your RDBMS -supports indexes on expressions - including return values of functions -, and +supports indexes on expressions - including return values of functions - and you create an index on the return value of the function in question.) However, it can be accomplished with C when necessary. @@ -1621,10 +1621,10 @@ B Add the L schema component to your Schema class. This will add a new table to your database called C which will keep track of which version is installed -and warn if the user trys to run a newer schema version than the +and warn if the user tries to run a newer schema version than the database thinks it has. -Alternatively, you can send the conversion sql scripts to your +Alternatively, you can send the conversion SQL scripts to your customers as above. =head2 Setting quoting for the generated SQL @@ -1706,7 +1706,7 @@ methods: } ); -In conditions (eg. C<\%cond> in the L family of +In conditions (e.g. C<\%cond> in the L family of methods) you cannot directly use array references (since this is interpreted as a list of values to be Ced), but you can use the following syntax to force passing them as bind values: diff --git a/lib/DBIx/Class/Manual/Example.pod b/lib/DBIx/Class/Manual/Example.pod index 8371c7f..fe2cf9e 100644 --- a/lib/DBIx/Class/Manual/Example.pod +++ b/lib/DBIx/Class/Manual/Example.pod @@ -58,7 +58,7 @@ Save the following into a example.sql in the directory db title TEXT NOT NULL ); -and create the sqlite database file: +and create the SQLite database file: sqlite3 example.db < example.sql @@ -198,7 +198,7 @@ testdb.pl: use strict; my $schema = MyDatabase::Main->connect('dbi:SQLite:db/example.db'); - # for other DSNs, e.g. MySql, see the perldoc for the relevant dbd + # for other DSNs, e.g. MySQL, see the perldoc for the relevant dbd # driver, e.g perldoc L. get_tracks_by_cd('Bad'); @@ -345,7 +345,7 @@ It should output: =head1 Notes -A reference implentation of the database and scripts in this example +A reference implementation of the database and scripts in this example are available in the main distribution for DBIx::Class under the directory F. diff --git a/lib/DBIx/Class/Manual/Intro.pod b/lib/DBIx/Class/Manual/Intro.pod index 4625d06..5414e08 100644 --- a/lib/DBIx/Class/Manual/Intro.pod +++ b/lib/DBIx/Class/Manual/Intro.pod @@ -225,7 +225,7 @@ second database you want to access: Note that L does not cache connections for you. If you use multiple connections, you need to do this manually. -To execute some sql statements on every connect you can add them as an option in +To execute some SQL statements on every connect you can add them as an option in a special fifth argument to connect: my $another_schema = My::Schema->connect( diff --git a/lib/DBIx/Class/Manual/Joining.pod b/lib/DBIx/Class/Manual/Joining.pod index 0cf86bd..4bf3331 100644 --- a/lib/DBIx/Class/Manual/Joining.pod +++ b/lib/DBIx/Class/Manual/Joining.pod @@ -113,7 +113,7 @@ relationships. =head2 Whole related objects -To fetch entire related objects, eg CDs and all Track data, use the +To fetch entire related objects, e.g. CDs and all Track data, use the 'prefetch' attribute: $schema->resultset('CD')->search( @@ -129,7 +129,7 @@ This will produce SQL similar to the following: SELECT cd.ID, cd.Title, cd.Year, tracks.id, tracks.Name, tracks.Artist FROM CD JOIN Tracks ON CD.ID = tracks.CDID WHERE cd.Title = 'Funky CD' ORDER BY 'tracks.id'; The syntax of 'prefetch' is the same as 'join' and implies the -joining, so no need to use both together. +joining, so there is no need to use both together. =head2 Subset of related fields @@ -232,7 +232,7 @@ Which is: To perform joins using relations of the tables you are joining to, use a hashref to indicate the join depth. This can theoretically go as -deep as you like (warning, contrived examples!): +deep as you like (warning: contrived examples!): join => { room => { table => 'leg' } } diff --git a/lib/DBIx/Class/Manual/Reading.pod b/lib/DBIx/Class/Manual/Reading.pod index daf1a7c..bcd4610 100644 --- a/lib/DBIx/Class/Manual/Reading.pod +++ b/lib/DBIx/Class/Manual/Reading.pod @@ -17,14 +17,14 @@ additions are consistent with the rest of the documentation. Methods should be documented in the files which also contain the code for the method, or that file should be hidden from PAUSE completely, in which case the methods are documented in the file which loads -it. Methods may also be documented and refered to in files +it. Methods may also be documented and referred to in files representing the major objects or components on which they can be called. For example, L documents the methods actually coded in the helper relationship classes like DBIx::Class::Relationship::BelongsTo. The BelongsTo file itself is -hidden from pause as it has no documentation. The accessors created by +hidden from PAUSE as it has no documentation. The accessors created by relationships should be mentioned in L, the major object that they will be called on. @@ -145,10 +145,10 @@ self-explanatory enough to not require it. Use best judgement. =item * The argument list is followed by some examples of how to use the -method, using it's various types of arguments. +method, using its various types of arguments. The examples can also include ways to use the results if -applicable. For instance if the documentation is for a relationship +applicable. For instance, if the documentation is for a relationship type, the examples can include how to call the resulting relation accessor, how to use the relation name in a search and so on. diff --git a/lib/DBIx/Class/Manual/Troubleshooting.pod b/lib/DBIx/Class/Manual/Troubleshooting.pod index 5d46805..820359d 100644 --- a/lib/DBIx/Class/Manual/Troubleshooting.pod +++ b/lib/DBIx/Class/Manual/Troubleshooting.pod @@ -23,7 +23,7 @@ To send the output somewhere else set debugfh:- $schema->storage->debugfh(IO::File->new('/tmp/trace.out', 'w'); -Alternatively you can do this with the environment variable too:- +Alternatively you can do this with the environment variable, too:- export DBIC_TRACE="1=/tmp/trace.out" @@ -51,9 +51,8 @@ L version 1.50 and L 1.43 are known to work. There's likely a syntax error in the table class referred to elsewhere in this error message. In particular make sure that the package -declaration is correct, so for a schema C< MySchema > you need to -specify a fully qualified namespace: C< package MySchema::MyTable; > -for example. +declaration is correct. For example, for a schema C< MySchema > +you need to specify a fully qualified namespace: C< package MySchema::MyTable; >. =head2 syntax error at or near "" ... @@ -103,7 +102,7 @@ details. =head2 column "foo DESC" does not exist ... This can happen if you are still using the obsolete order hack, and also -happen to turn on sql-quoting. +happen to turn on SQL-quoting. $rs->search( {}, { order_by => [ 'name DESC' ] } ); @@ -133,15 +132,15 @@ with full current updates will not be subject to this problem):- Fedora 8 - perl-5.8.8-41.fc8 RHEL5 - perl-5.8.8-15.el5_2.1 -The issue is due to perl doing an exhaustive search of blessed objects +This issue is due to perl doing an exhaustive search of blessed objects under certain circumstances. The problem shows up as performance -degredation exponential to the number of L row objects in -memory, so can be unoticeable with certain data sets, but with huge +degradation exponential to the number of L row objects in +memory, so can be unnoticeable with certain data sets, but with huge performance impacts on other datasets. -A pair of tests for susceptability to the issue, and performance effects +A pair of tests for susceptibility to the issue and performance effects of the bless/overload problem can be found in the L test -suite in the file C +suite, in the C file. Further information on this issue can be found in L, @@ -150,7 +149,7 @@ L =head2 Excessive Memory Allocation with TEXT/BLOB/etc. Columns and Large LongReadLen -It has been observed, using L, that a creating a L +It has been observed, using L, that creating a L object which includes a column of data type TEXT/BLOB/etc. will allocate LongReadLen bytes. This allocation does not leak, but if LongReadLen is large in size, and many such row objects are created, e.g. as the diff --git a/lib/DBIx/Class/Ordered.pm b/lib/DBIx/Class/Ordered.pm index 5f17790..7842a40 100644 --- a/lib/DBIx/Class/Ordered.pm +++ b/lib/DBIx/Class/Ordered.pm @@ -127,7 +127,7 @@ __PACKAGE__->mk_classdata( 'grouping_column' ); This method specifies a value of L which B during normal operation. When a row is moved, its position is set to this value temporarily, so -that any unique constrainst can not be violated. This value defaults +that any unique constraints can not be violated. This value defaults to 0, which should work for all cases except when your positions do indeed start from 0. @@ -921,7 +921,7 @@ module to update positioning values in isolation (i.e. without triggering any of the positioning integrity code). Some day you might get confronted by datasets that have ambiguous -positioning data (i.e. duplicate position values within the same group, +positioning data (e.g. duplicate position values within the same group, in a table without unique constraints). When manually fixing such data keep in mind that you can not invoke L like you normally would, as it will get confused by the wrong data before @@ -956,14 +956,14 @@ will prevent such race conditions going undetected. =head2 Multiple Moves -Be careful when issueing move_* methods to multiple objects. If +Be careful when issuing move_* methods to multiple objects. If you've pre-loaded the objects then when you move one of the objects the position of the other object will not reflect their new value until you reload them from the database - see L. There are times when you will want to move objects as groups, such -as changeing the parent of several objects at once - this directly +as changing the parent of several objects at once - this directly conflicts with this problem. One solution is for us to write a ResultSet class that supports a parent() method, for example. Another solution is to somehow automagically modify the objects that exist diff --git a/lib/DBIx/Class/Relationship.pm b/lib/DBIx/Class/Relationship.pm index e1bed80..d4926d1 100644 --- a/lib/DBIx/Class/Relationship.pm +++ b/lib/DBIx/Class/Relationship.pm @@ -111,7 +111,7 @@ Both C<$cond> and C<$attrs> are optional. Pass C for C<$cond> if you want to use the default value for it, but still want to set C<\%attrs>. See L for documentation on the -attrubutes that are allowed in the C<\%attrs> argument. +attributes that are allowed in the C<\%attrs> argument. =head2 belongs_to @@ -234,7 +234,7 @@ which can be assigned to relationships as well. Creates a one-to-many relationship where the foreign class refers to this class's primary key. This relationship refers to zero or more -records in the foreign table (ie, a C). This relationship +records in the foreign table (e.g. a C). This relationship defaults to using the end of this classes namespace as the foreign key in C<$related_class> to resolve the join, unless C<$their_fk_column> specifies the foreign key column in C<$related_class> or C diff --git a/lib/DBIx/Class/Relationship/Base.pm b/lib/DBIx/Class/Relationship/Base.pm index daf853d..17de514 100644 --- a/lib/DBIx/Class/Relationship/Base.pm +++ b/lib/DBIx/Class/Relationship/Base.pm @@ -260,7 +260,7 @@ sub search_related { ( $objects_rs ) = $rs->search_related_rs('relname', $cond, $attrs); This method works exactly the same as search_related, except that -it guarantees a restultset, even in list context. +it guarantees a resultset, even in list context. =cut @@ -392,7 +392,7 @@ example, to set the correct author for a book, find the Author object, then call set_from_related on the book. This is called internally when you pass existing objects as values to -L, or pass an object to a belongs_to acessor. +L, or pass an object to a belongs_to accessor. The columns are only set in the local copy of the object, call L to set them in the storage. diff --git a/lib/DBIx/Class/ResultSet.pm b/lib/DBIx/Class/ResultSet.pm index a034cd9..1b12895 100644 --- a/lib/DBIx/Class/ResultSet.pm +++ b/lib/DBIx/Class/ResultSet.pm @@ -141,7 +141,7 @@ See: L, L, L, L, L. =head1 OVERLOADING If a resultset is used in a numeric context it returns the L. -However, if it is used in a booleand context it is always true. So if +However, if it is used in a boolean context it is always true. So if you want to check if a resultset has any results use C. C will always be true. @@ -524,7 +524,7 @@ sub find { # in ::Relationship::Base::search_related (the row method), and furthermore # the relationship is of the 'single' type. This means that the condition # provided by the relationship (already attached to $self) is sufficient, - # as there can be only one row in the databse that would satisfy the + # as there can be only one row in the database that would satisfy the # relationship } else { @@ -639,7 +639,7 @@ sub search_related { =head2 search_related_rs This method works exactly the same as search_related, except that -it guarantees a restultset, even in list context. +it guarantees a resultset, even in list context. =cut @@ -1597,7 +1597,7 @@ Example: Assuming an Artist Class that has many CDs Classes relating: ], }, { artistid => 5, name => 'Angsty-Whiny Girl', cds => [ - { title => 'My parents sold me to a record company' ,year => 2005 }, + { title => 'My parents sold me to a record company', year => 2005 }, { title => 'Why Am I So Ugly?', year => 2006 }, { title => 'I Got Surgery and am now Popular', year => 2007 } ], @@ -1625,7 +1625,7 @@ example: [qw/artistid name/], [100, 'A Formally Unknown Singer'], [101, 'A singer that jumped the shark two albums ago'], - [102, 'An actually cool singer.'], + [102, 'An actually cool singer'], ]); Please note an important effect on your data when choosing between void and @@ -2132,7 +2132,7 @@ To create related objects, pass a hashref of related-object column values B. If the relationship is of type C (L) - pass an arrayref of hashrefs. The process will correctly identify columns holding foreign keys, and will -transparrently populate them from the keys of the corresponding relation. +transparently populate them from the keys of the corresponding relation. This can be applied recursively, and will work correctly for a structure with an arbitrary depth and width, as long as the relationships actually exists and the correct column data has been supplied. @@ -3329,7 +3329,7 @@ attempting to use the accessor in an C clause or similar will fail miserably. To get around this limitation, you can supply literal SQL to your -C attribute that contains the C text, e.g. select => [\'myfield AS alias'] @@ -3440,7 +3440,7 @@ for a C attribute in the above search. C can be used with the following relationship types: C, C (or if you're using C, any relationship declared with an accessor type of 'single' or 'filter'). A more complex example that -prefetches an artists cds, the tracks on those cds, and the tags associted +prefetches an artists cds, the tracks on those cds, and the tags associated with that artist is given below (assuming many-to-many from artists to tags): my $rs = $schema->resultset('Artist')->search( @@ -3519,7 +3519,7 @@ C on it. =back -Specifes the maximum number of rows for direct retrieval or the number of +Specifies the maximum number of rows for direct retrieval or the number of rows per page if the page attribute or method is used. =head2 offset diff --git a/lib/DBIx/Class/ResultSource/Table.pm b/lib/DBIx/Class/ResultSource/Table.pm index cf263d1..9586d33 100644 --- a/lib/DBIx/Class/ResultSource/Table.pm +++ b/lib/DBIx/Class/ResultSource/Table.pm @@ -16,7 +16,7 @@ DBIx::Class::ResultSource::Table - Table object =head1 DESCRIPTION -Table object that inherits from L +Table object that inherits from L. =head1 METHODS diff --git a/lib/DBIx/Class/ResultSourceHandle.pm b/lib/DBIx/Class/ResultSourceHandle.pm index 33204df..cd5c45c 100644 --- a/lib/DBIx/Class/ResultSourceHandle.pm +++ b/lib/DBIx/Class/ResultSourceHandle.pm @@ -87,7 +87,7 @@ sub STORABLE_freeze { =head2 STORABLE_thaw Thaws frozen handle. Resets the internal schema reference to the package -variable C<$thaw_schema>. The recomened way of setting this is to use +variable C<$thaw_schema>. The recommended way of setting this is to use C<< $schema->thaw($ice) >> which handles this for you. =cut diff --git a/lib/DBIx/Class/Row.pm b/lib/DBIx/Class/Row.pm index f36eba0..a397ceb 100644 --- a/lib/DBIx/Class/Row.pm +++ b/lib/DBIx/Class/Row.pm @@ -450,7 +450,7 @@ need to preserve the hashref, it is sufficient to pass a shallow copy to C, e.g. ( { %{ $href } } ) If the values passed or any of the column values set on the object -contain scalar references, eg: +contain scalar references, e.g.: $row->last_modified(\'NOW()'); # OR @@ -952,7 +952,7 @@ so that the database can insert its own autoincremented values into the new object. Relationships will be followed by the copy procedure B if the -relationship specifes a true value for its +relationship specifies a true value for its L attribute. C is set by default on C relationships and unset on all others. @@ -975,7 +975,7 @@ sub copy { $new->insert; # Its possible we'll have 2 relations to the same Source. We need to make - # sure we don't try to insert the same row twice esle we'll violate unique + # sure we don't try to insert the same row twice else we'll violate unique # constraints my $rels_copied = {}; diff --git a/lib/DBIx/Class/SQLAHacks/OracleJoins.pm b/lib/DBIx/Class/SQLAHacks/OracleJoins.pm index 4b5efba..3a7e059 100644 --- a/lib/DBIx/Class/SQLAHacks/OracleJoins.pm +++ b/lib/DBIx/Class/SQLAHacks/OracleJoins.pm @@ -96,8 +96,7 @@ DBIx::Class::SQLAHacks::OracleJoins - Pre-ANSI Joins-via-Where-Clause Syntax This module was originally written to support Oracle < 9i where ANSI joins weren't supported at all, but became the module for Oracle >= 8 because -Oracle's optimising of ANSI joins is horrible. (See: -http://scsys.co.uk:8001/7495) +Oracle's optimising of ANSI joins is horrible. =head1 SYNOPSIS diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index 024e81d..c8be34e 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -82,7 +82,7 @@ particular which module inherits off which. With no arguments, this method uses L to load all your Result classes from a sub-namespace F under your Schema class' -namespace. Eg. With a Schema of I all files in +namespace, i.e. with a Schema of I all files in I are assumed to be Result classes. It also finds all ResultSet classes in the namespace F and @@ -748,7 +748,7 @@ Otherwise, each set of data is inserted into the database using L, and a arrayref of the resulting row objects is returned. -i.e., +e.g. $schema->populate('Artist', [ [ qw/artistid name/ ], @@ -851,7 +851,7 @@ attached to the current schema. It also attaches a corresponding L object to the new $schema object. If C<$additional_base_class> is given, the new composed -classes will inherit from first the corresponding classe from the current +classes will inherit from first the corresponding class from the current schema then the base class. For example, for a schema with My::Schema::CD and My::Schema::Artist classes, @@ -1155,7 +1155,7 @@ sub ddl_filename { Provided as the recommended way of thawing schema objects. You can call C directly if you wish, but the thawed objects will not have a -reference to any schema, so are rather useless +reference to any schema, so are rather useless. =cut @@ -1167,8 +1167,8 @@ sub thaw { =head2 freeze -This doesn't actualy do anything more than call L, it is just -provided here for symetry. +This doesn't actually do anything more than call L, it is just +provided here for symmetry. =cut diff --git a/lib/DBIx/Class/Schema/Versioned.pm b/lib/DBIx/Class/Schema/Versioned.pm index 26760b5..0e87d2c 100644 --- a/lib/DBIx/Class/Schema/Versioned.pm +++ b/lib/DBIx/Class/Schema/Versioned.pm @@ -303,7 +303,7 @@ list of schema versions (if ordered_schema_versions returns nothing then it is assumed you can do the upgrade as a single step). It then iterates through the list of versions between the current db version and the schema version applying one update at a time until -all relvant updates are applied. +all relevant updates are applied. The individual update steps are performed by using L, which will apply the update and also @@ -544,7 +544,7 @@ warns if they are not the same or if the DB is unversioned. It also provides compatibility between the old versions table (SchemaVersions) and the new one (dbix_class_schema_versions). -To avoid the checks on connect, set the env var DBIC_NO_VERSION_CHECK or alternatively you can set the ignore_version attr in the forth argument like so: +To avoid the checks on connect, set the environment var DBIC_NO_VERSION_CHECK or alternatively you can set the ignore_version attr in the forth argument like so: my $schema = MyApp::Schema->connect( $dsn, diff --git a/lib/DBIx/Class/StartupCheck.pm b/lib/DBIx/Class/StartupCheck.pm index 30bc51f..86230d6 100644 --- a/lib/DBIx/Class/StartupCheck.pm +++ b/lib/DBIx/Class/StartupCheck.pm @@ -17,7 +17,7 @@ all current Red Hat and Fedora distributions, but the old check still triggers, incorrectly flagging those versions of perl to be buggy. A more comprehensive check has been moved into the test suite in C and further information about the bug has been -put in L +put in L. Other checks may be added from time to time. diff --git a/lib/DBIx/Class/Storage.pm b/lib/DBIx/Class/Storage.pm index c9f4383..0def315 100644 --- a/lib/DBIx/Class/Storage.pm +++ b/lib/DBIx/Class/Storage.pm @@ -353,7 +353,7 @@ shell environment. =head2 debugfh Set or retrieve the filehandle used for trace/debug output. This should be -an IO::Handle compatible ojbect (only the C method is used. Initially +an IO::Handle compatible object (only the C method is used. Initially set to be STDERR - although see information on the L environment variable. diff --git a/lib/DBIx/Class/Storage/DBI.pm b/lib/DBIx/Class/Storage/DBI.pm index cc5aa4d..c1f852b 100644 --- a/lib/DBIx/Class/Storage/DBI.pm +++ b/lib/DBIx/Class/Storage/DBI.pm @@ -342,7 +342,7 @@ SQL Server you should use C<< quote_char => [qw/[ ]/] >>. =item name_sep This only needs to be used in conjunction with C, and is used to -specify the charecter that seperates elements (schemas, tables, columns) from +specify the character that separates elements (schemas, tables, columns) from each other. In most cases this is simply a C<.>. The consequences of not supplying this value is that L @@ -778,8 +778,8 @@ sub with_deferred_fk_checks { =back -Verifies that the the current database handle is active and ready to execute -an SQL statement (i.e. the connection did not get stale, server is still +Verifies that the current database handle is active and ready to execute +an SQL statement (e.g. the connection did not get stale, server is still answering, etc.) This method is used internally by L. =cut diff --git a/lib/DBIx/Class/Storage/DBI/AutoCast.pm b/lib/DBIx/Class/Storage/DBI/AutoCast.pm index c887a86..e5ac27a 100644 --- a/lib/DBIx/Class/Storage/DBI/AutoCast.pm +++ b/lib/DBIx/Class/Storage/DBI/AutoCast.pm @@ -23,7 +23,7 @@ statements with values bound to columns or conditions that are not strings will throw implicit type conversion errors. As long as a column L is -defined, and it resolves to a base RDBMS native type via L as +defined and resolves to a base RDBMS native type via L as defined in your Storage driver, the placeholder for this column will be converted to: diff --git a/lib/DBIx/Class/Storage/DBI/MSSQL.pm b/lib/DBIx/Class/Storage/DBI/MSSQL.pm index 8bd0d45..6bdb027 100644 --- a/lib/DBIx/Class/Storage/DBI/MSSQL.pm +++ b/lib/DBIx/Class/Storage/DBI/MSSQL.pm @@ -341,7 +341,7 @@ outright disabled for MSSQL. Thus compromise between usability and perfection is the MSSQL-specific L C. It is deliberately not possible to set this on the Storage level, as the user -should inspect (and preferrably regression-test) the return of every such +should inspect (and preferably regression-test) the return of every such ResultSet individually. The example above would work if written like: $rs->search ({}, { @@ -354,7 +354,7 @@ ResultSet individually. The example above would work if written like: If it is possible to rewrite the search() in a way that will avoid the need for this flag - you are urged to do so. If DBIC internals insist that an ordered subselect is necessary for an operation, and you believe there is a -differnt/better way to get the same result - please file a bugreport. +different/better way to get the same result - please file a bugreport. =head1 AUTHOR diff --git a/lib/DBIx/Class/Storage/DBI/ODBC/ACCESS.pm b/lib/DBIx/Class/Storage/DBI/ODBC/ACCESS.pm index 1b1909a..625498a 100644 --- a/lib/DBIx/Class/Storage/DBI/ODBC/ACCESS.pm +++ b/lib/DBIx/Class/Storage/DBI/ODBC/ACCESS.pm @@ -79,7 +79,7 @@ Information about support for different version of MS Access is welcome. =head1 IMPLEMENTATION NOTES -MS Access supports the @@IDENTITY function for retriving the id of the latest inserted row. +MS Access supports the @@IDENTITY function for retrieving the id of the latest inserted row. @@IDENTITY is global to the connection, so to support the possibility of getting the last inserted id for different tables, the insert() function stores the inserted id on a per table basis. last_insert_id() then just returns the stored value. diff --git a/lib/DBIx/Class/Storage/DBI/Oracle/WhereJoins.pm b/lib/DBIx/Class/Storage/DBI/Oracle/WhereJoins.pm index 6604847..945d546 100644 --- a/lib/DBIx/Class/Storage/DBI/Oracle/WhereJoins.pm +++ b/lib/DBIx/Class/Storage/DBI/Oracle/WhereJoins.pm @@ -23,8 +23,7 @@ support (instead of ANSI). This module was originally written to support Oracle < 9i where ANSI joins weren't supported at all, but became the module for Oracle >= 8 because -Oracle's optimising of ANSI joins is horrible. (See: -http://scsys.co.uk:8001/7495) +Oracle's optimising of ANSI joins is horrible. =head1 SYNOPSIS @@ -44,7 +43,7 @@ It will write: It should properly support left joins, and right joins. Full outer joins are not possible due to the fact that Oracle requires the entire query be written to union the results of a left and right join, and by the time this module is -called to create the where query and table definition part of the sql query, +called to create the where query and table definition part of the SQL query, it's already too late. =head1 METHODS diff --git a/lib/DBIx/Class/Storage/DBI/Replicated.pm b/lib/DBIx/Class/Storage/DBI/Replicated.pm index d64e9db..7e84f7c 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated.pm +++ b/lib/DBIx/Class/Storage/DBI/Replicated.pm @@ -26,7 +26,7 @@ DBIx::Class::Storage::DBI::Replicated - BETA Replicated database support =head1 SYNOPSIS The Following example shows how to change an existing $schema to a replicated -storage type, add some replicated (readonly) databases, and perform reporting +storage type, add some replicated (read-only) databases, and perform reporting tasks. You should set the 'storage_type attribute to a replicated type. You should @@ -75,7 +75,7 @@ walkthroughs. Warning: This class is marked BETA. This has been running a production website using MySQL native replication as its backend and we have some decent test coverage but the code hasn't yet been stressed by a variety of databases. -Individual DB's may have quirks we are not aware of. Please use this in first +Individual DBs may have quirks we are not aware of. Please use this in first development and pass along your experiences/bug fixes. This class implements replicated data store for DBI. Currently you can define @@ -89,12 +89,12 @@ L. Additionally, some methods need to be distributed to all existing storages. This way our storage class is a drop in replacement for L. -Read traffic is spread across the replicants (slaves) occuring to a user +Read traffic is spread across the replicants (slaves) occurring to a user selected algorithm. The default algorithm is random weighted. =head1 NOTES -The consistency betweeen master and replicants is database specific. The Pool +The consistency between master and replicants is database specific. The Pool gives you a method to validate its replicants, removing and replacing them when they fail/pass predefined criteria. Please make careful use of the ways to force a query to run against Master when needed. @@ -373,8 +373,8 @@ has _master_connect_info_opts => =head2 around: connect_info -Preserve master's C options (for merging with replicants.) -Also set any Replicated related options from connect_info, such as +Preserves master's C options (for merging with replicants.) +Also sets any Replicated-related options from connect_info, such as C, C, C and C. =cut @@ -594,7 +594,7 @@ sub all_storages { =head2 execute_reliably ($coderef, ?@args) Given a coderef, saves the current state of the L, forces it to -use reliable storage (ie sets it to the master), executes a coderef and then +use reliable storage (e.g. sets it to the master), executes a coderef and then restores the original state. Example: @@ -674,7 +674,7 @@ sub set_reliable_storage { =head2 set_balanced_storage Sets the current $schema to be use the for all reads, while all -writea are sent to the master only +writes are sent to the master only =cut diff --git a/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm b/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm index 5c32f56..025048b 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm +++ b/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm @@ -110,7 +110,7 @@ sub _build_current_replicant { This method should be defined in the class which consumes this role. Given a pool object, return the next replicant that will serve queries. The -default behavior is to grap the first replicant it finds but you can write +default behavior is to grab the first replicant it finds but you can write your own subclasses of L to support other balance systems. diff --git a/lib/DBIx/Class/Storage/DBI/Replicated/Balancer/First.pm b/lib/DBIx/Class/Storage/DBI/Replicated/Balancer/First.pm index d40fb63..806a05f 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated/Balancer/First.pm +++ b/lib/DBIx/Class/Storage/DBI/Replicated/Balancer/First.pm @@ -19,7 +19,7 @@ Given a pool (L) of replicated database's (L), defines a method by which query load can be spread out across each replicant in the pool. -This Balancer just get's whatever is the first replicant in the pool +This Balancer just gets whichever is the first replicant in the pool. =head1 ATTRIBUTES diff --git a/lib/DBIx/Class/Storage/DBI/Replicated/Introduction.pod b/lib/DBIx/Class/Storage/DBI/Replicated/Introduction.pod index 828793c..dcd7c30 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated/Introduction.pod +++ b/lib/DBIx/Class/Storage/DBI/Replicated/Introduction.pod @@ -9,8 +9,8 @@ DBIx::Class::Storage::DBI::Replicated::Introduction - Minimum Need to Know This is an introductory document for L. This document is not an overview of what replication is or why you should be -using it. It is not a document explaing how to setup MySQL native replication -either. Copious external resources are avialable for both. This document +using it. It is not a document explaining how to setup MySQL native replication +either. Copious external resources are available for both. This document presumes you have the basics down. =head1 DESCRIPTION @@ -33,7 +33,7 @@ patches and ideas to the #dbix-class IRC channel or the mailing list. For an easy way to start playing with MySQL native replication, see: L. -If you are using this with a L based appplication, you may also wish +If you are using this with a L based application, you may also want to see more recent updates to L, which has support for replication configuration options as well. @@ -48,8 +48,8 @@ database specific code to help smooth over the differences between databases and let L do its thing. If you want to use replication, you will override this setting so that the -replicated storage engine will 'wrap' your underlying storages and present to -the end programmer a unified interface. This wrapper storage class will +replicated storage engine will 'wrap' your underlying storages and present +a unified interface to the end programmer. This wrapper storage class will delegate method calls to either a master database or one or more replicated databases based on if they are read only (by default sent to the replicants) or write (reserved for the master). Additionally, the Replicated storage @@ -72,8 +72,8 @@ A replicated storage contains several parts. First, there is the replicated storage itself (L). A replicated storage takes a pool of replicants (L) and a software balancer (L). The -balancer does the job of splitting up all the read traffic amongst each -replicant in the Pool. Currently there are two types of balancers, a Random one +balancer does the job of splitting up all the read traffic amongst the +replicants in the Pool. Currently there are two types of balancers, a Random one which chooses a Replicant in the Pool using a naive randomizer algorithm, and a First replicant, which just uses the first one in the Pool (and obviously is only of value when you have a single replicant). @@ -145,14 +145,14 @@ The 'pool_args' are configuration options associated with the replicant pool. This object (L) manages all the declared replicants. 'maximum_lag' is the number of seconds a replicant is allowed to lag behind the master before being temporarily removed from the pool. -Keep in mind that the Balancer option 'auto_validate_every' determins how often +Keep in mind that the Balancer option 'auto_validate_every' determines how often a replicant is tested against this condition, so the true possible lag can be higher than the number you set. The default is zero. No matter how low you set the maximum_lag or the auto_validate_every settings, there is always the chance that your replicants will lag a bit behind the master for the supported replication system built into MySQL. You can ensure -reliabily reads by using a transaction, which will force both read and write +reliable reads by using a transaction, which will force both read and write activity to the master, however this will increase the load on your master database. diff --git a/lib/DBIx/Class/Storage/DBI/Replicated/Pool.pm b/lib/DBIx/Class/Storage/DBI/Replicated/Pool.pm index 500f739..db38c42 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated/Pool.pm +++ b/lib/DBIx/Class/Storage/DBI/Replicated/Pool.pm @@ -23,7 +23,7 @@ shouldn't need to create instances of this class. =head1 DESCRIPTION In a replicated storage type, there is at least one replicant to handle the -read only traffic. The Pool class manages this replicant, or list of +read-only traffic. The Pool class manages this replicant, or list of replicants, and gives some methods for querying information about their status. =head1 ATTRIBUTES @@ -53,7 +53,7 @@ has 'maximum_lag' => ( This is an integer representing a time since the last time the replicants were validated. It's nothing fancy, just an integer provided via the perl L -builtin. +built-in. =cut @@ -87,7 +87,7 @@ has 'replicant_type' => ( =head2 replicants A hashref of replicant, with the key being the dsn and the value returning the -actual replicant storage. For example if the $dsn element is something like: +actual replicant storage. For example, if the $dsn element is something like: "dbi:SQLite:dbname=dbfile" @@ -117,7 +117,7 @@ The number of replicants in the pool =item delete_replicant ($key) -removes the replicant under $key from the pool +Removes the replicant under $key from the pool =back @@ -268,7 +268,7 @@ The standard ensure_connected method with throw an exception should it fail to connect. For the master database this is desirable, but since replicants are allowed to fail, this behavior is not desirable. This method wraps the call to ensure_connected in an eval in order to catch any generated errors. That -way a slave can go completely offline (ie, the box itself can die) without +way a slave can go completely offline (e.g. the box itself can die) without bringing down your entire pool of databases. =cut @@ -365,7 +365,7 @@ defined by L. Replicants that fail any of these tests are set to inactive, and thus removed from the replication pool. This tests L, since a replicant that has been previous marked -as inactive can be reactived should it start to pass the validation tests again. +as inactive can be reactivated should it start to pass the validation tests again. See L for more about checking if a replicating connection is not following a master or is lagging. diff --git a/lib/DBIx/Class/Storage/DBI/Replicated/Replicant.pm b/lib/DBIx/Class/Storage/DBI/Replicated/Replicant.pm index f5b4f34..a541e7d 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated/Replicant.pm +++ b/lib/DBIx/Class/Storage/DBI/Replicated/Replicant.pm @@ -33,14 +33,14 @@ This class defines the following attributes. =head2 active This is a boolean which allows you to programmatically activate or deactivate a -replicant from the pool. This way to you do stuff like disallow a replicant -when it get's too far behind the master, if it stops replicating, etc. +replicant from the pool. This way you can do stuff like disallow a replicant +when it gets too far behind the master, if it stops replicating, etc. This attribute DOES NOT reflect a replicant's internal status, i.e. if it is properly replicating from a master and has not fallen too many seconds behind a reliability threshold. For that, use L and L. Since the implementation of those functions database specific (and not all DBIC -supported DB's support replication) you should refer your database specific +supported DBs support replication) you should refer your database-specific storage driver for more information. =cut diff --git a/lib/DBIx/Class/Storage/DBI/Role/QueryCounter.pm b/lib/DBIx/Class/Storage/DBI/Role/QueryCounter.pm index 3199e75..61d101d 100644 --- a/lib/DBIx/Class/Storage/DBI/Role/QueryCounter.pm +++ b/lib/DBIx/Class/Storage/DBI/Role/QueryCounter.pm @@ -19,7 +19,7 @@ Each time the schema does a query, increment the counter. This package defines the following attributes. -head2 _query_count +=head2 _query_count Is the attribute holding the current query count. It defines a public reader called 'query_count' which you can use to access the total number of queries @@ -42,7 +42,7 @@ This module defines the following methods. =head2 _query_start -override on the method so that we count the queries. +Override on the method so that we count the queries. =cut diff --git a/lib/DBIx/Class/Storage/DBI/Sybase/ASE.pm b/lib/DBIx/Class/Storage/DBI/Sybase/ASE.pm index 10cc9c8..604ddfa 100644 --- a/lib/DBIx/Class/Storage/DBI/Sybase/ASE.pm +++ b/lib/DBIx/Class/Storage/DBI/Sybase/ASE.pm @@ -977,7 +977,7 @@ for the Cs is taken from the L definitions in your Result classes, and are mapped to a Sybase type (if it isn't already) using a mapping based on L. -In other configurations, placeholers will work just as they do with the Sybase +In other configurations, placeholders will work just as they do with the Sybase Open Client libraries. Inserts or updates of TEXT/IMAGE columns will B work with FreeTDS. @@ -998,8 +998,8 @@ it's a session variable. =head1 TRANSACTIONS -Due to limitations of the TDS protocol, L, or both; you cannot -begin a transaction while there are active cursors; nor can you use multiple +Due to limitations of the TDS protocol, L, or both, you cannot +begin a transaction while there are active cursors, nor can you use multiple active cursors within a transaction. An active cursor is, for example, a L that has been executed using C or C but has not been exhausted or L. diff --git a/lib/DBIx/Class/Storage/DBI/Sybase/ASE/NoBindVars.pm b/lib/DBIx/Class/Storage/DBI/Sybase/ASE/NoBindVars.pm index dc8bf34..3dee4c3 100644 --- a/lib/DBIx/Class/Storage/DBI/Sybase/ASE/NoBindVars.pm +++ b/lib/DBIx/Class/Storage/DBI/Sybase/ASE/NoBindVars.pm @@ -68,8 +68,8 @@ Sybase ASE without placeholder support =head1 DESCRIPTION -If you're using this driver than your version of Sybase, or the libraries you -use to connect to it, do not support placeholders. +If you're using this driver then your version of Sybase or the libraries you +use to connect to it do not support placeholders. You can also enable this driver explicitly using: @@ -81,7 +81,7 @@ See the discussion in L<< DBD::Sybase/Using ? Placeholders & bind parameters to $sth->execute >> for details on the pros and cons of using placeholders. One advantage of not using placeholders is that C in a transaction as the base Sybase driver does. When using this driver, bind variables will be interpolated (properly quoted of diff --git a/lib/DBIx/Class/Storage/DBIHacks.pm b/lib/DBIx/Class/Storage/DBIHacks.pm index 44ad59b..4b66c4e 100644 --- a/lib/DBIx/Class/Storage/DBIHacks.pm +++ b/lib/DBIx/Class/Storage/DBIHacks.pm @@ -97,7 +97,7 @@ sub _adjust_select_args_for_complex_prefetch { } # construct the inner $from for the subquery - # we need to prune first, because this will determine if we need a group_bu below + # we need to prune first, because this will determine if we need a group_by below my $inner_from = $self->_prune_unused_joins ($from, $inner_select, $where, $inner_attrs); # if a multi-type join was needed in the subquery - add a group_by to simulate the diff --git a/lib/DBIx/Class/Storage/TxnScopeGuard.pm b/lib/DBIx/Class/Storage/TxnScopeGuard.pm index 122e016..459931c 100644 --- a/lib/DBIx/Class/Storage/TxnScopeGuard.pm +++ b/lib/DBIx/Class/Storage/TxnScopeGuard.pm @@ -89,7 +89,7 @@ L object as its only argument. =head2 commit Commit the transaction, and stop guarding the scope. If this method is not -called and this object goes out of scope (i.e. an exception is thrown) then +called and this object goes out of scope (e.g. an exception is thrown) then the transaction is rolled back, via L =cut @@ -102,7 +102,7 @@ L. Ash Berlin, 2008. -Insipred by L by chocolateboy. +Inspired by L by chocolateboy. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.