From: Peter Rabbitson Date: Sun, 21 Sep 2014 18:00:27 +0000 (+0200) Subject: A massive amount of link fixes (just links, almost no rewording) X-Git-Tag: v0.082800~27 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=5529838f7afff91467ef2664087999ab222da48d;p=dbsrgits%2FDBIx-Class.git A massive amount of link fixes (just links, almost no rewording) kryde++ for the insanely useful tool App::PodLinkCheck. It is a bit heavy and way too noisy for automated use, but with some handholding it is scarily effective (as can be seen by the sheer size of this commit) --- diff --git a/lib/DBIx/Class/Exception.pm b/lib/DBIx/Class/Exception.pm index 07f587d..b3e5cbe 100644 --- a/lib/DBIx/Class/Exception.pm +++ b/lib/DBIx/Class/Exception.pm @@ -40,8 +40,8 @@ overload fallback to give natural boolean/numeric values. This is meant for internal use by L's C code, and shouldn't be used directly elsewhere. -Expects a scalar exception message. The optional argument -C<$stacktrace> tells it to output a full trace similar to L. +Expects a scalar exception message. The optional boolean C<$stacktrace> +causes it to output a full trace similar to L. DBIx::Class::Exception->throw('Foo'); try { ... } catch { DBIx::Class::Exception->throw(shift) } diff --git a/lib/DBIx/Class/InflateColumn/DateTime.pm b/lib/DBIx/Class/InflateColumn/DateTime.pm index 3162223..eeed3f3 100644 --- a/lib/DBIx/Class/InflateColumn/DateTime.pm +++ b/lib/DBIx/Class/InflateColumn/DateTime.pm @@ -78,8 +78,8 @@ deflation/inflation as defined in the storage class. For instance, for a C field the methods C and C would be called on deflation/inflation. If the storage class does not provide a specialized inflator/deflator, C<[parse|format]_datetime> will -be used as a fallback. See L for more information on -date formatting. +be used as a fallback. See L +for more information on date formatting. For more help with using components, see L. diff --git a/lib/DBIx/Class/Manual/Cookbook.pod b/lib/DBIx/Class/Manual/Cookbook.pod index 0cb560b..c18ab66 100644 --- a/lib/DBIx/Class/Manual/Cookbook.pod +++ b/lib/DBIx/Class/Manual/Cookbook.pod @@ -146,8 +146,9 @@ 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, e.g. cannot call L, -L, ... on it). +that you cannot modify the rows it contains, e.g. cannot call +L or +L on it). Note that you cannot have bind parameters unless is_virtual is set to true. @@ -448,8 +449,8 @@ See also L is either too slow or does -not work at all, you can try the +and L is either +too slow or does not work at all, you can try the L L attribute, which skips over records to simulate limits in the Perl layer. @@ -1065,7 +1066,7 @@ See L for more documentation. Sometimes you have a (set of) result objects that you want to put into a resultset without the need to hit the DB again. You can do that by using the -L method: +L method: my @uploadable_groups; while (my $group = $groups->next) { @@ -1380,9 +1381,11 @@ row. } In this example it might be hard to see where the rollbacks, releases and -commits are happening, but it works just the same as for plain L<>: If -the C-block around C fails, a rollback is issued. If the C -succeeds, the transaction is committed (or the savepoint released). +commits are happening, but it works just the same as for plain +L: If the L-block +around L fails, a rollback is issued. +If the L succeeds, the transaction is committed +(or the savepoint released). While you can get more fine-grained control using C, C and C, it is strongly recommended to use C with coderefs. @@ -1840,7 +1843,7 @@ See L for further details. =head3 Oracle Information about Oracle support for unicode can be found in -L. +L. =head3 PostgreSQL @@ -2202,10 +2205,9 @@ classes dynamically based on the database schema then there will be a significant startup delay. For production use a statically defined schema (which can be generated -using L to dump -the database schema once - see +using L to dump the database schema once - see L and -L for more +L for more details on creating static schemas from a database). =head2 Move Common Startup into a Base Class @@ -2251,10 +2253,11 @@ avoiding L. =head2 Cached statements -L normally caches all statements with L<< prepare_cached()|DBI/prepare_cached >>. -This is normally a good idea, but if too many statements are cached, the database may use too much -memory and may eventually run out and fail entirely. If you suspect this may be the case, you may want -to examine DBI's L<< CachedKids|DBI/CachedKidsCachedKids_(hash_ref) >> hash: +L normally caches all statements with +L. This is normally a good idea, but if +too many statements are cached, the database may use too much memory and may +eventually run out and fail entirely. If you suspect this may be the case, +you may want to examine DBI's L hash: # print all currently cached prepared statements print for keys %{$schema->storage->dbh->{CachedKids}}; diff --git a/lib/DBIx/Class/Manual/FAQ.pod b/lib/DBIx/Class/Manual/FAQ.pod index bef779e..48b3d56 100644 --- a/lib/DBIx/Class/Manual/FAQ.pod +++ b/lib/DBIx/Class/Manual/FAQ.pod @@ -78,7 +78,7 @@ lot later. If your database server allows you to run queries across multiple databases at once, then so can DBIx::Class. All you need to do is make sure you write the database name as part of the -L call. Eg: +L call. Eg: __PACKAGE__->table('mydb.mytablename'); @@ -87,10 +87,10 @@ L call. =item .. use DBIx::Class across PostgreSQL/DB2/Oracle schemas? -Add the name of the schema to the L -as part of the name, and make sure you give the one user you are going -to connect with has permissions to read/write all the schemas/tables as -necessary. +Add the name of the schema to the table name, when invoking +L, and make sure the user +you are about to connect as has permissions to read/write all the +schemas/tables as necessary. =back @@ -154,7 +154,7 @@ See L. =item .. use a relationship? Use its name. An accessor is created using the name. See examples in -L. +L. =back diff --git a/lib/DBIx/Class/Manual/Features.pod b/lib/DBIx/Class/Manual/Features.pod index a28bb35..523e927 100644 --- a/lib/DBIx/Class/Manual/Features.pod +++ b/lib/DBIx/Class/Manual/Features.pod @@ -479,7 +479,9 @@ on our system (Microsoft SQL) is: ) rpt_score WHERE rno__row__index BETWEEN 1 AND 1 -See: L, L, and L. +See: L, +L, and +L. =head2 bonus rel methods @@ -661,5 +663,5 @@ Better: price => \['price + ?', [inc => $inc]], }); -See L +See L diff --git a/lib/DBIx/Class/Manual/Glossary.pod b/lib/DBIx/Class/Manual/Glossary.pod index 136355d..334637d 100644 --- a/lib/DBIx/Class/Manual/Glossary.pod +++ b/lib/DBIx/Class/Manual/Glossary.pod @@ -66,11 +66,11 @@ relationships must be used. A Schema object represents your entire table collection, plus the connection to the database. You can create one or more schema objects, connected to various databases, with various users, using the same set -of table L definitions. +of table L definitions. At least one L class is needed per database. -=head2 Result class +=head2 Result Class A Result class defines both a source of data (usually one per table), and the methods that will be available in the L objects @@ -87,7 +87,7 @@ ResultSource objects represent the source of your data, these are sometimes (incorrectly) called table objects. ResultSources do not need to be directly created, a ResultSource -instance is created for each L in your L, by +instance is created for each L in your L, by the proxied methods C and C. See also: L @@ -148,7 +148,7 @@ to issue multiple SQL queries. A normalised database is a sane database. Each table contains only data belonging to one concept, related tables refer to the key field or fields of each other. Some links to webpages about normalisation -can be found in L. +can be found in L. =head2 Related data diff --git a/lib/DBIx/Class/Optional/Dependencies.pm b/lib/DBIx/Class/Optional/Dependencies.pm index 76229c2..468237f 100644 --- a/lib/DBIx/Class/Optional/Dependencies.pm +++ b/lib/DBIx/Class/Optional/Dependencies.pm @@ -154,7 +154,7 @@ my $reqs = { }, pod => { title => 'Storage::DBI::deploy()', - desc => 'Modules required for L and L', + desc => 'Modules required for L and L', }, }, diff --git a/lib/DBIx/Class/Ordered.pm b/lib/DBIx/Class/Ordered.pm index 539abd8..e227d23 100644 --- a/lib/DBIx/Class/Ordered.pm +++ b/lib/DBIx/Class/Ordered.pm @@ -147,7 +147,7 @@ Returns an B resultset of all other objects in the same group excluding the one you called it on. The ordering is a backwards-compatibility artifact - if you need -a resultset with no ordering applied use L +a resultset with no ordering applied use C<_siblings> =cut sub siblings { diff --git a/lib/DBIx/Class/Relationship/Base.pm b/lib/DBIx/Class/Relationship/Base.pm index 56adec8..39d74a8 100644 --- a/lib/DBIx/Class/Relationship/Base.pm +++ b/lib/DBIx/Class/Relationship/Base.pm @@ -814,8 +814,8 @@ 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 accessor. -The columns are only set in the local copy of the object, call L to -set them in the storage. +The columns are only set in the local copy of the object, call +L to update them in the storage. =cut diff --git a/lib/DBIx/Class/ResultSet.pm b/lib/DBIx/Class/ResultSet.pm index a699745..08bbb43 100644 --- a/lib/DBIx/Class/ResultSet.pm +++ b/lib/DBIx/Class/ResultSet.pm @@ -58,7 +58,7 @@ just stores all the conditions needed to create the query. A basic ResultSet representing the data of an entire table is returned by calling C on a L and passing in a -L name. +L name. my $users_rs = $schema->resultset('User'); @@ -1147,7 +1147,7 @@ You most likely want to use L with specific operators. For more information, see L. -This method is deprecated and will be removed in 0.09. Use L +This method is deprecated and will be removed in 0.09. Use L instead. An example conversion is: ->search_like({ foo => 'bar' }); @@ -1542,8 +1542,8 @@ L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class. Note that changing the result_class will also remove any components that were originally loaded in the source class via -L. Any overloaded methods -in the original source class will not run. +L. +Any overloaded methods in the original source class will not run. =cut diff --git a/lib/DBIx/Class/ResultSource.pm b/lib/DBIx/Class/ResultSource.pm index de51b5e..237227a 100644 --- a/lib/DBIx/Class/ResultSource.pm +++ b/lib/DBIx/Class/ResultSource.pm @@ -77,7 +77,7 @@ More specifically, the L base class pulls in the L component, which defines the L method. When called, C
creates and stores an instance of -L. Luckily, to use tables as result +L. Luckily, to use tables as result sources, you don't need to remember any of this. Result sources representing select queries, or views, can also be @@ -86,7 +86,8 @@ created, see L for full details. =head2 Finding result source objects As mentioned above, a result source instance is created and stored for -you when you define a L. +you when you define a +L. You can retrieve the result source at runtime in the following ways: @@ -582,7 +583,7 @@ sub remove_column { shift->remove_columns(@_); } # DO NOT CHANGE THIS TO GLOB Defines one or more columns as primary key for this source. Must be called after L. -Additionally, defines a L +Additionally, defines a L named C. Note: you normally do want to define a primary key on your sources diff --git a/lib/DBIx/Class/Row.pm b/lib/DBIx/Class/Row.pm index 630d2bc..861a54b 100644 --- a/lib/DBIx/Class/Row.pm +++ b/lib/DBIx/Class/Row.pm @@ -52,7 +52,7 @@ All "Row objects" derived from a Schema-attached L object (such as a typical C<< L-> L >> call) are actually Result instances, based on your application's -L. +L. L implements most of the row-based communication with the underlying storage, but a Result class B. @@ -480,8 +480,8 @@ sub insert { Indicates whether the object exists as a row in the database or not. This is set to true when L, -L or L -are used. +L or L +are invoked. Creating a result object using L, or calling L on one, sets it to false. @@ -1325,7 +1325,7 @@ sub inflate_result { =back -Ls the object if it's already in the database, according to +Ls the object if it's already in the database, according to L, else Ls it. =head2 insert_or_update diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index c83dc87..dca80c8 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -108,11 +108,12 @@ are no matching Result classes like this: load_namespaces found ResultSet class $classname with no corresponding Result class -If a Result class is found to already have a ResultSet class set using -L to some other class, you will be warned like this: +If a ResultSource instance is found to already have a ResultSet class set +using L to some +other class, you will be warned like this: - We found ResultSet class '$rs_class' for '$result', but it seems - that you had already set '$result' to use '$rs_set' instead + We found ResultSet class '$rs_class' for '$result_class', but it seems + that you had already set '$result_class' to use '$rs_set' instead =head3 Examples @@ -1117,8 +1118,8 @@ sub deploy { A convenient shortcut to C<< $self->storage->deployment_statements($self, @args) >>. -Returns the SQL statements used by L and -L. +Returns the statements used by L and +L. =cut @@ -1218,8 +1219,8 @@ sub thaw { =head2 freeze -This doesn't actually do anything more than call L, it is just -provided here for symmetry. +This doesn't actually do anything beyond calling 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 e92f356..74fbd8d 100644 --- a/lib/DBIx/Class/Schema/Versioned.pm +++ b/lib/DBIx/Class/Schema/Versioned.pm @@ -239,7 +239,7 @@ Call this to initialise a previously unversioned database. The table 'dbix_class Takes one argument which should be the version that the database is currently at. Defaults to the return value of L. -See L for more details. +See L for more details. =cut diff --git a/lib/DBIx/Class/Storage/DBI.pm b/lib/DBIx/Class/Storage/DBI.pm index 9a456d4..473e503 100644 --- a/lib/DBIx/Class/Storage/DBI.pm +++ b/lib/DBIx/Class/Storage/DBI.pm @@ -1402,7 +1402,19 @@ sub disconnect_call_do_sql { $self->_do_query(@_); } -# override in db-specific backend when necessary +=head2 connect_call_datetime_setup + +A no-op stub method, provided so that one can always safely supply the +L + + on_connect_call => 'datetime_setup' + +This way one does not need to know in advance whether the underlying +storage requires any sort of hand-holding when dealing with calendar +data. + +=cut + sub connect_call_datetime_setup { 1 } sub _do_query { @@ -2982,7 +2994,8 @@ sub create_ddl_dir { =back -Returns the statements used by L and L. +Returns the statements used by L +and L. The L (not L) database driver name can be explicitly provided in C<$type>, otherwise the result of L is used as default. diff --git a/lib/DBIx/Class/Storage/DBI/ADO/Microsoft_SQL_Server.pm b/lib/DBIx/Class/Storage/DBI/ADO/Microsoft_SQL_Server.pm index 9bb93f9..7a1b039 100644 --- a/lib/DBIx/Class/Storage/DBI/ADO/Microsoft_SQL_Server.pm +++ b/lib/DBIx/Class/Storage/DBI/ADO/Microsoft_SQL_Server.pm @@ -60,7 +60,7 @@ size of the bind sizes in the first prepare call: L -The C workaround is used (see L) with the +The C workaround is used (see L) with the approximate maximum size of the data_type of the bound column, or 8000 (maximum VARCHAR size) if the data_type is not available. diff --git a/lib/DBIx/Class/Storage/DBI/AutoCast.pm b/lib/DBIx/Class/Storage/DBI/AutoCast.pm index db9fb8b..aa08f50 100644 --- a/lib/DBIx/Class/Storage/DBI/AutoCast.pm +++ b/lib/DBIx/Class/Storage/DBI/AutoCast.pm @@ -23,7 +23,8 @@ 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 resolves to a base RDBMS native type via L as +defined and resolves to a base RDBMS native type via +L<_native_data_type|DBIx::Class::Storage::DBI/_native_data_type> as defined in your Storage driver, the placeholder for this column will be converted to: diff --git a/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm b/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm index 84799f1..92cb34f 100644 --- a/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm +++ b/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm @@ -635,7 +635,7 @@ Unfortunately, Oracle doesn't support identifiers over 30 chars in length, so the L name is shortened and appended with half of an MD5 hash. -See L. +See L. =cut diff --git a/lib/DBIx/Class/Storage/DBI/Replicated.pm b/lib/DBIx/Class/Storage/DBI/Replicated.pm index 0a73c4b..b3247ab 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated.pm +++ b/lib/DBIx/Class/Storage/DBI/Replicated.pm @@ -405,7 +405,7 @@ for my $method (@{$method_dispatch->{unimplemented}}) { =head2 read_handler -Defines an object that implements the read side of L. +Defines an object that implements the read side of L. =cut @@ -418,7 +418,7 @@ has 'read_handler' => ( =head2 write_handler -Defines an object that implements the write side of L, +Defines an object that implements the write side of L, as well as methods that don't write or read that can be called on only one storage, methods that return a C<$dbh>, and any methods that don't make sense to run on a replicant. @@ -590,7 +590,8 @@ sub _build_read_handler { =head2 around: connect_replicants All calls to connect_replicants needs to have an existing $schema tacked onto -top of the args, since L needs it, and any C +top of the args, since L needs it, and any +L options merged with the master, with replicant opts having higher priority. =cut diff --git a/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm b/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm index de9c2e9..f07a958 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm +++ b/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm @@ -97,7 +97,7 @@ This class defines the following methods. =head2 _build_current_replicant -Lazy builder for the L attribute. +Lazy builder for the L attribute. =cut diff --git a/lib/DBIx/Class/Storage/DBI/Replicated/Introduction.pod b/lib/DBIx/Class/Storage/DBI/Replicated/Introduction.pod index 0b49b98..77f2d08 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated/Introduction.pod +++ b/lib/DBIx/Class/Storage/DBI/Replicated/Introduction.pod @@ -6,19 +6,19 @@ DBIx::Class::Storage::DBI::Replicated::Introduction - Minimum Need to Know =head1 SYNOPSIS -This is an introductory document for L. +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 explaining how to setup MySQL native replication -either. Copious external resources are available 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 -L supports a framework for using database replication. This system +L supports a framework for using database replication. This system is integrated completely, which means once it's setup you should be able to automatically just start using a replication cluster without additional work or -changes to your code. Some caveats apply, primarily related to the proper use +changes to your code. Some caveats apply, primarily related to the proper use of transactions (you are wrapping all your database modifying statements inside a transaction, right ;) ) however in our experience properly written DBIC will work transparently with Replicated storage. @@ -137,7 +137,7 @@ will result in increased database loads, so choose a number with care. Our experience is that setting the number around 5 seconds results in a good performance / integrity balance. -'master_read_weight' is an option associated with the ::Random balancer. It +'master_read_weight' is an option associated with the ::Random balancer. It allows you to let the master be read from. I usually leave this off (default is off). diff --git a/lib/DBIx/Class/Storage/DBI/Replicated/Replicant.pm b/lib/DBIx/Class/Storage/DBI/Replicated/Replicant.pm index a541e7d..344e1a6 100644 --- a/lib/DBIx/Class/Storage/DBI/Replicated/Replicant.pm +++ b/lib/DBIx/Class/Storage/DBI/Replicated/Replicant.pm @@ -38,7 +38,9 @@ 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. +reliability threshold. For that, use +L and +L. Since the implementation of those functions database specific (and not all DBIC supported DBs support replication) you should refer your database-specific storage driver for more information. diff --git a/lib/DBIx/Class/Storage/DBI/Sybase/ASE.pm b/lib/DBIx/Class/Storage/DBI/Sybase/ASE.pm index 252a50c..eceef20 100644 --- a/lib/DBIx/Class/Storage/DBI/Sybase/ASE.pm +++ b/lib/DBIx/Class/Storage/DBI/Sybase/ASE.pm @@ -233,7 +233,7 @@ Also sets the C value for blob write operations. The default is C<1>, but C<0> is better if your database is configured for it. See -L. +L. =cut @@ -1082,15 +1082,15 @@ for L. =head1 LIMITED QUERIES -Because ASE does not have a good way to limit results in SQL that works for all -types of queries, the limit dialect is set to -L. +Because ASE does not have a good way to limit results in SQL that works for +all types of queries, the limit dialect is set to +L. Fortunately, ASE and L support cursors properly, so when -L is too slow you can use -the L -L attribute to simulate limited queries by skipping over -records. +L is too slow +you can use the L +L attribute to simulate limited queries by skipping +over records. =head1 TEXT/IMAGE COLUMNS diff --git a/lib/DBIx/Class/Storage/DBI/Sybase/ASE/NoBindVars.pm b/lib/DBIx/Class/Storage/DBI/Sybase/ASE/NoBindVars.pm index b5ade31..107a0e0 100644 --- a/lib/DBIx/Class/Storage/DBI/Sybase/ASE/NoBindVars.pm +++ b/lib/DBIx/Class/Storage/DBI/Sybase/ASE/NoBindVars.pm @@ -81,8 +81,10 @@ You can also enable this driver explicitly using: $schema->storage_type('::DBI::Sybase::ASE::NoBindVars'); $schema->connect($dsn, $user, $pass, \%opts); -See the discussion in L<< DBD::Sybase/Using ? Placeholders & bind parameters to -$sth->execute >> for details on the pros and cons of using placeholders. +See the discussion in +L<< DBD::Sybase/Using ? Placeholders & bind parameters to $sth->execute >> +for details on the pros and cons of using placeholders with this particular +driver. One advantage of not using placeholders is that C