Merge pull request #277 from domaframework/translate

Translate documents from Japanese into English

Author: nakamura-to

docs/basic.rst

@@ -1,19 +1,21 @@
-==================
-基本型
-==================
+=============
+Basic classes
+=============
 
-.. contents:: 目次
+.. contents::
    :depth: 3
 
-Domaでは、データベースのカラムにマッピング可能なJavaの型を基本型と呼びます。
+Overview
+========
 
-種類
-==================
+The Java types can be mapped to database column types are called "Basic classes" in Doma.
 
-基本型には以下の種類があります。
+List of basic classes
+=====================
 
-* プリミティブ型とそのラッパー型（ただし ``char`` と ``java.lang.Character`` は除く）
-* 列挙型
+* primitive types except ``char``
+* wrapper class for above primitive types
+* enum types
 * byte[]
 * java.lang.String
 * java.lang.Object
@@ -31,37 +33,35 @@ Domaでは、データベースのカラムにマッピング可能なJavaの型
 * java.sql.SQLXML
 * java.util.Date
 
-日付/時刻型
-------------------
+Differences between temporal classes
+------------------------------------
 
-日付と時刻の型の違いについて説明します。
+:java.time.LocalDate:
+  represents SQL DATE
 
-java.time.LocalDate
-  SQL標準のDATE型 (日付のみ)を表します。
+:java.time.LocalTime:
+  represents SQL TIME
 
-java.time.LocalTime
-  SQL標準のTIME型 (時刻のみ)を表します。
+:java.time.LocalDateTime:
+  represents SQL TIMESTAMP and may hold nanoseconds if RDBMS supports it
 
-java.time.LocalDateTime
-  SQL標準のTIMESTAMP型 (日付と時刻)を表します。RDBMSがサポートしている場合ナノ秒を保持します。
+:java.sql.Date:
+  represents SQL DATE
 
-java.sql.Date
-  SQL標準のDATE型 (日付のみ)を表します。
+:java.sql.Time:
+  represents SQL TIME
 
-java.sql.Time
-  SQL標準のTIME型 (時刻のみ)を表します。
+:java.sql.Timestamp:
+  represents SQL TIMESTAMP and may hold nanoseconds if RDBMS supports it
 
-java.sql.Timestamp
-  SQL標準のTIMESTAMP型 (日付と時刻)を表します。RDBMSがサポートしている場合ナノ秒を保持します。
+:java.util.Date:
+  represents SQL TIMESTAMP and doesn't hold nanoseconds
 
-java.util.Date
-  SQL標準のTIMESTAMP型 (日付と時刻)を表します。ナノ秒を保持しません。
+Examples
+========
 
-利用例
-==================
-
-エンティティクラス
-------------------
+Using in entity class
+---------------------
 
 .. code-block:: java
 
@@ -80,8 +80,8 @@ java.util.Date
   }
 
 
-ドメインクラス
-------------------
+Using in domain class
+---------------------
 
 .. code-block:: java
 
@@ -99,8 +99,8 @@ java.util.Date
       }
   }
 
-Daoクラス
-------------------
+Using in DAO interface
+----------------------
 
 .. code-block:: java
 

docs/index.rst

@@ -13,12 +13,12 @@ Welcome to Doma 2
 =====================
 
 Doma 2 is a database access framework for Java 8+.
-Doma has some strong points:
+Doma has various strengths:
 
-* Verifies and generates source code at compile-time using annotation processing.
-* Maps a database column to a user-defined Java object.
-* Uses SQL-templates that is called two-way-SQL.
-* Supports classes introduced in Java8, such as ``java.time.LocalDate``,  ``java.util.Optional`` and ``java.util.stream.Stream``.
+* Verifies and generates source code at compile time using annotation processing.
+* Maps database columns to user-defined Java objects.
+* Uses SQL templates, called "two-way SQL".
+* Supports classes introduced in Java 8, such as ``java.time.LocalDate``, ``java.util.Optional``, and ``java.util.stream.Stream``.
 * Has no dependence on other libraries.
 
 This document consists of following sections:

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`` メソッドで実行できます。
-