argra****@users*****
argra****@users*****
2012年 9月 30日 (日) 05:01:59 JST
Index: docs/modules/Class-DBI-Sweet-0.05/Sweet.pod
diff -u docs/modules/Class-DBI-Sweet-0.05/Sweet.pod:1.2 docs/modules/Class-DBI-Sweet-0.05/Sweet.pod:1.3
--- docs/modules/Class-DBI-Sweet-0.05/Sweet.pod:1.2 Thu Jan 27 22:14:47 2011
+++ docs/modules/Class-DBI-Sweet-0.05/Sweet.pod Sun Sep 30 05:01:58 2012
@@ -3,8 +3,14 @@
=head1 NAME
+=begin original
+
Class::DBI::Sweet - Making sweet things sweeter
+=end original
+
+ Class::DBI::Sweet - 素敵なものをより素敵にする
+
=head1 SYNOPSIS
package MyApp::DBI;
@@ -107,27 +113,39 @@
=head1 DESCRIPTION
+=begin original
+
Class::DBI::Sweet provides convenient count, search, page, and
cache functions in a sweet package. It integrates these functions with
C<Class::DBI> in a convenient and efficient way.
+=end original
+
Class::DBI::Sweetは便利なcount、search、page、cache機能をsweetなパッケージに提供します。
Class::DBI::Sweetはこれらの機能を便利で効率的な方法によりC<Class::DBI>に統合します。
=head1 RETRIEVING OBJECTS
+=begin original
+
All retrieving methods can take the same criteria and attributes. Criteria is
the only required parameter.
+=end original
+
全ての検索メソッドが同じ評価基準と属性を取得することができます。
評価基準が唯一必要なパラメータです。
=head2 criteria
+=begin original
+
Can be a hash, hashref, or an arrayref. Takes the same options as the
L<SQL::Abstract> C<where> method. If values contain any objects, they
will be deflated before querying the database.
+=end original
+
criteriaはhashまたはhashrefまたはarrayrefのどれかであることができます。
L<SQL::Abstract>のC<where>メソッドと同じオプションを設定します。
もし値に何かオブジェクトを含んでいるのであれば、データベースにクエリーを投げる前に
@@ -139,9 +157,13 @@
=item case, cmp, convert, and logic
+=begin original
+
These attributes are passed to L<SQL::Abstact>'s constuctor and alter the
behavior of the criteria.
+=end original
+
これらの属性はL<SQL::Abstact>のconstuctorに渡され、評価基準の振る舞いを変えます。
{ cmp => 'like' }
@@ -156,10 +178,14 @@
=item rows
+=begin original
+
Specifies the maximum number of rows to return. Currently supported RDBMs are
Interbase, MaxDB, MySQL, PostgreSQL and SQLite. For other RDBMs, it will be
emulated.
+=end original
+
検索結果のROWの最大数を指定します。
現在、サポートされているRDBMsはInterbase、MaxDB、MySQL、PostgreSQLそしてSQLiteです。
他のRDBMsについてはエミュレートされるでしょう。
@@ -168,8 +194,12 @@
=item offset
+=begin original
+
Specifies the offset of the first row to return. Defaults to 0 if unspecified.
+=end original
+
検索結果の最初のROWのオフセットを指定します。
もし、不特定ならば0をデフォルトとします。
@@ -177,8 +207,12 @@
=item page
+=begin original
+
Specifies the current page in C<page>. Defaults to 1 if unspecified.
+=end original
+
C<page>メソッドで現在のページを指定します。
もし、不特定ならば1をデフォルトとします。
@@ -186,12 +220,16 @@
=item prefetch
+=begin original
+
Specifies a listref of relationships to prefetch. These must be has_a or
might_haves or Sweet will throw an error. This will cause Sweet to do
a join across to the related tables in order to return the related object
without a second trip to the database. All 'Essential' columns of the
foreign table are retrieved.
+=end original
+
prefetchメソッドとのリレーションをlistrefで指定します。
これらによりhas_aまたはmight_havesまたはSweetがエラーを投げなければなりません。
関連するオブジェクトを返す為に、特別にデータベースを始動させること無しに関連するテーブルとを
@@ -200,6 +238,8 @@
{ prefetch => [ qw/some_rel some_other_rel/ ] }
+=begin original
+
Sweet constructs the joined SQL statement by aliasing the columns in
each table and prefixing the column name with 'sweet__N_' where N is a
counter starting at 1. Note that if your database has a column length limit
@@ -207,6 +247,8 @@
your application, Sweet's addition of at least 9 extra characters to your
column name may cause database errors.
+=end original
+
Sweetの構造は内部ではそれぞれのカラム名の前に、
Nは1で始まるカウンタでという前提で'sweet__N_'を置き、
カラムをエイリアスによって結合します。
@@ -218,19 +260,27 @@
=item use_resultset_cache
+=begin original
+
Enables the resultset cache. This is a little experimental and massive gotchas
may rear their ugly head at some stage, but it does seem to work pretty well.
+=end original
+
検索結果のキャッシュを可能にします。
これは少し実験的です、そして大規模なgotchasは何らかの段階で危険な危機を起こすかもしれません。
しかし、それはかなり良く動作するように思えます。
+=begin original
+
For best results, the resultset cache should only be used selectively on
queries where you experience performance problems. Enabling it for every
single query in your application will most likely cause a drop in performance
as the cache overhead is greater than simply fetching the data from the
database.
+=end original
+
最良な結果の為に、あなたがパフォーマンスの問題を体験するところで
resultsetは選択的に使用されるべきでしょう。
あなたのアプリケーションにおけるあらゆるクエリーにおいてそれを可能にすると、
@@ -239,10 +289,14 @@
=item profile_cache
+=begin original
+
Records cache hits/misses and what keys they were for in ->profiling_data.
Note that this is class metadata so if you don't want it to be global for
Sweet you need to do
+=end original
+
どのようなキーに関してキャッシュヒット/キャッシュミスがあったかを
->profiling_dataによって記録します。
もしあなたがSweetにそれがグローバルであって欲しくないのであれば、
@@ -250,17 +304,25 @@
__PACKAGE__->profiling_data({ });
+=begin original
+
in either your base class or your table classes to taste.
+=end original
+
どちらかは、あなたのBaseクラスかあなたのテーブルクラスのお好みによります。
=item disable_sql_paging
+=begin original
+
Disables the use of paging in SQL statements if set, forcing Sweet to emulate
paging by slicing the iterator at the end of ->search (which it normally only
uses as a fallback mechanism). Useful for testing or for causing the entire
query to be retrieved initially when the resultset cache is used.
+=end original
+
もし、設定されるならばページングでSQLステートメントを使用することはできません
->searchメソッドの終わりにslicingイテレータによりSweetにページングを見習わせます
（通常、後退的なメカニズムとしてそれが使用されるだけです）
@@ -271,9 +333,13 @@
=head2 count
+=begin original
+
Returns a count of the number of rows matching the criteria. C<count> will
discard C<offset>, C<order_by>, and C<rows>.
+=end original
+
評価基準に一致したRowの数の個数を返却します。
C<count>メソッドはC<offset>、C<order_by>、and C<rows>を捨てます。
@@ -281,9 +347,13 @@
=head2 search
+=begin original
+
Returns an iterator in scalar context, or an array of objects in list
context.
+=end original
+
スカラーコンテキストのイテレータまたはリストコンテキストのオブジェクトの配列を返却します。
@objects = MyApp::Article->search(%criteria);
@@ -292,15 +362,23 @@
=head2 search_like
+=begin original
+
As search but adds the attribute { cmp => 'like' }.
+=end original
+
{ cmp => 'like' }属性を追加して検索します。
=head2 page
+=begin original
+
Retuns a page object and an iterator. The page object is an instance of
L<Data::Page>.
+=end original
+
ページオブジェクトかイテレータを返却します。
ページオブジェクトはL<Data::Page>のインスタンスオブジェクトです。
@@ -312,15 +390,23 @@
=head2 pager
+=begin original
+
An alias to page.
+=end original
+
pageメソッドのエイリアスです。
=head2 retrieve_all
+=begin original
+
Same as C<Class::DBI> with addition that it takes C<attributes> as arguments,
C<attributes> can be a hash or a hashref.
+=end original
+
C<Class::DBI>がとるC<attributes>の引数と同じで、C<attributes>はハッシュもしくは
ハッシュリファレンスであることができます。
@@ -328,33 +414,49 @@
=head2 retrieve_next
+=begin original
+
Returns the next record after the current one according to the order_by
attribute (or primary key if no order_by specified) matching the criteria.
Must be called as an object method.
+=end original
+
order_by属性（またはもしorder_byを指定しないのであればプライマリキー）で評価基準を合わせながら
現在のレコードを記録して次のレコードを返却します
これはオブジェクトメソッドとして呼び出さなければなりません。
=head2 retrieve_previous
+=begin original
+
As retrieve_next but retrieves the previous record.
+=end original
+
retrieve_nextメソッドと同じようなものですが、retrieve_previousメソッドは前のレコードを検索します
=head1 CACHING OBJECTS
+=begin original
+
Objects will be stored deflated in cache. Only C<Primary> and C<Essential>
columns will be cached.
+=end original
+
オブジェクトはキャッシュでdeflateした状態で保存されるでしょう。
C<Primary>とC<Essential>カラムだけがキャッシュされます。
=head2 cache
+=begin original
+
Class method: if this is set caching is enabled. Any cache object that has a
C<get>, C<set>, and C<remove> method is supported.
+=end original
+
クラスメソッドです：これが設定されるのであればキャッシュが可能となります。
どのキャッシュオブジェクトでもC<get>、C<set>、C<remove>メソッドがサポートされます。
@@ -367,8 +469,12 @@
=head2 cache_key
+=begin original
+
Returns a cache key for an object consisting of class and primary keys.
+=end original
+
クラスとプライマリキーから構成されるオブジェクトにキャッシュキーを返却します。
=head2 Overloaded methods
@@ -377,47 +483,71 @@
=item _init
+=begin original
+
Overrides C<Class::DBI>'s internal cache. On a cache hit, it will return
a cached object; on a cache miss it will create an new object and store
it in the cache.
+=end original
+
C<Class::DBI>の内部キャッシュをオーバーライドしています。
キャッシュヒットした場合、キャッシュオブジェクトが返却されます。
キャッシュミスした場合、新しいオブジェクトが作成され、キャッシュに保存されます。
=item create
+=begin original
+
All caches for this table are marked stale and will be re-cached on next
retrieval.
+=end original
+
このテーブルの為の全てのキャッシュが古いと判断される場合、次の検索の時点で際キャッシュされます。
=item retrieve
+=begin original
+
On a cache hit the object will be inflated by the C<select> trigger and
then served.
+=end original
+
キャッシュヒットによりオブジェクトはC<select>トリガーによりinflateされ次に役立てられるでしょう。
=item update
+=begin original
+
Object is removed from the cache and will be cached on next retrieval.
+=end original
+
オブジェクトはキャッシュから削除され、次の検索時に再度キャッシュされます。
=item delete
+=begin original
+
Object is removed from the cache.
+=end original
+
オブジェクトはキャッシュから削除されます。
=back
=head1 UNIVERSALLY UNIQUE IDENTIFIERS
+=begin original
+
If enabled a UUID string will be generated for primary column. A CHAR(36)
column is suitable for storage.
+=end original
+
もしUUID文字列がプライマリのカラムに作成することを可能にするとCHAR(36)カラムが
格納に妥当です。