Translate query-builder/index.rst

Author: nakamura-to

docs/query-builder/index.rst

@@ -1,38 +1,17 @@
-============
-クエリビルダ
-============
+==============
+Query builders
+==============
 
-.. contents:: 目次
+.. contents::
    :depth: 3
 
-``org.seasar.doma.jdbc.builder`` パッケージでは、
-プログラムでSQLを組み立てるためのクエリビルダを提供しています。
+The package ``org.seasar.doma.jdbc.builder`` provides SQL builders.
 
-何らかの理由により :doc:`../query/index` の利用が難しい場合にのみ、
-クエリビルダを利用することを推奨します。
-また、クエリビルダは :ref:`dao-default-method` の中で使用することを推奨します。
+When it is difficult to build a SQL statement with :doc:`../query/index`,
+consider to use the SQL builders in :ref:`dao-default-method`.
 
-どのクエリビルダも、インスタンスは ``Config`` 型の引数をとる
-``static`` な ``newInstance`` メソッドで生成できます。
-インスタンスには、 ``sql`` メソッドでSQL文字列の断片を、
-``param`` メソッドと ``literal`` メソッドでパラメータの型とパラメータを渡せます。
-
-``param`` メソッドで渡されたパラメータは ``PreparedStatement`` のバインド変数として扱われます。
-
-``literal`` メソッドで渡されたパラメータはSQLにリテラルとして埋め込まれます。
-このメソッドでパラメータが渡された場合、SQLインジェクション対策としてのエスケープ処理は実施されません。
-しかし、SQLインジェクションを防ぐためにパラメータの値にシングルクォテーションを含めることは禁止しています。
-
-検索においてパラメータのリストを渡す場合は ``params`` メソッドと ``literals`` メソッドを利用できます。
-パラメータはカンマで連結されたSQLに変換されます。
-これらは、IN句と一緒に利用されることを想定されたメソッドです。
-
-検索
-====
-
-検索には、 ``SelectBuilder`` クラスを使用します。
-
-利用例は次のとおりです。
+Search
+======
 
 .. code-block:: java
 
@@ -50,10 +29,10 @@
   builder.sql("age in (").params(Integer.class, Arrays.asList(20, 30, 40)).sql(")");
   List<Emp> employees = builder.getEntityResultList(Emp.class);
 
-組み立てたSQLのいくつかの方法で取得できます。
+You can get result of the SQL execution in various ways.
 
-1件取得
--------
+Single record search
+--------------------
 
 * getScalarSingleResult
 * getOptionalScalarSingleResult
@@ -62,36 +41,24 @@
 * getMapSingleResult
 * getOptionalMapSingleResult
 
-複数件取得
-----------
+Multiple records search
+-----------------------
 
 * getScalarResultList
 * getOptionalScalarResultList
 * getEntityResultList
 * getMapResultList
 
-イテレート検索
---------------
-
-* iterateAsScalar
-* iterateAsOptionalScalar
-* iterateAsEntity
-* iterateAsMap
-
-ストリーム検索
---------------
+Stream search
+-------------
 
 * streamAsScalar
 * streamAsOptionalScalar
 * streamAsEntity
 * streamAsMap
 
-挿入
-====
-
-挿入には、 ``InsertBuilder`` クラスを使用します。
-
-利用例は次のとおりです。
+Insert
+======
 
 .. code-block:: java
 
@@ -103,14 +70,8 @@
   builder.param(BigDecimal.class, new BigDecimal(1000)).sql(")");
   builder.execute();
 
-組み立てたSQLは ``execute`` メソッドで実行できます。
-
-更新
-====
-
-更新には、 ``UpdateBuilder`` クラスを使用します。
-
-利用例は次のとおりです。
+Update
+======
 
 .. code-block:: java
 
@@ -123,14 +84,8 @@
   builder.sql("id = ").param(int.class, 10);
   builder.execute();
 
-組み立てたSQLは ``execute`` メソッドで実行できます。
-
-削除
-====
-
-削除には、 ``DeleteBuilder`` クラスを使用します。
-
-利用例は次のとおりです。
+Delete
+======
 
 .. code-block:: java
 
@@ -142,5 +97,3 @@
   builder.sql("salary = ").param(BigDecimal.class, new BigDecimal(1000));
   builder.execute();
 
-組み立てたSQLは ``execute`` メソッドで実行できます。
-