rroonga 2.0.0-x86-mingw32 → 2.0.1-x86-mingw32

data/vendor/local/share/doc/groonga/source/tutorial/data.txt

@@ -7,70 +7,149 @@
 .. groonga-command
 .. database: tutorial
 
-さまざまな種類をもったデータの保存
-==================================
+Various data types
+==================
 
-groongaでは、さまざまなデータを格納させることが出来ます。
+Groonga is a full text search engine but also serves as a column-oriented data store. Groonga supports various data types, such as numeric types, string types, date and time type, longitude and latitude types, etc. This tutorial shows a list of data types and explains how to use them.
 
-データ型
+Overview
 --------
 
-groongaでは、数値（整数・小数）や文字列や時刻や経緯度などの情報を格納することができます。
+The basic data types of groonga are roughly divided into 5 groups --- boolean type, numeric types, string types, date/time type and longitude/latitude types. The numeric types are further divided according to whether integer or floating point number, signed or unsigned and the number of bits allocated to each integer. The string types are further divided according to the maximum length. The longitude/latitude types are further divided according to the geographic coordinate system. For more details, see :doc:`/type`.
 
-ここでは、Int32型のカラムに整数を格納、Float型のカラムに浮動小数点の小数を、ShortText型のカラムに文字列を、Time型のカラムに時間を格納する例を示します。経緯度の格納については、のちのチュートリアルで触れます。
+In addition, groonga supports reference types and vector types. Reference types are designed for accessing other tables. Vector types are designed for storing a variable number of values in one element.
 
-その他のデータ型の一覧は、 :doc:`/type` を参照してください。
+First, let's create a table for this tutorial.
 
 .. groonga-command
 .. include:: ../example/tutorial/data-1.log
-.. table_create --name Type --flags TABLE_HASH_KEY --key_type ShortText
-.. column_create --table Type --name number --type Int32
-.. column_create --table Type --name float --type Float
-.. column_create --table Type --name string --type ShortText
-.. column_create --table Type --name time --type Time
-.. load --table Type
-.. [{"_key":"sample","number":12345,"float":42.195,"string":"GROONGA","time":1234567890.12}]
-.. select --table Type
+.. table_create --name ToyBox --flags TABLE_HASH_KEY --key_type ShortText
 
+Boolean type
+------------
 
-テーブル型
-----------
+The boolean type is used to store true or false. To create a boolean type column, specify Bool to the `type` parameter of :doc:`/commands/column_create` command. The default value of the boolean type is false.
 
-table_createで作成したテーブルを、カラムの型として使うことが出来ます。
+The following example creates a boolean type column and adds three records. Note that the third record has the default value because no value is specified.
 
-また、output_columnsにおいて「.」を区切りとして、参照先のテーブルに存在するカラムを指定すると、指定したカラムの値を表示することができます。
+.. groonga-command
+.. include:: ../example/tutorial/data-2.log
+.. column_create --table ToyBox --name is_animal --type Bool
+.. load --table ToyBox
+.. [
+.. {"_key":"Monkey","is_animal":true}
+.. {"_key":"Flower","is_animal":false}
+.. {"_key":"Block"}
+.. ]
+.. select --table ToyBox --output_columns _key,is_animal
 
-ここでは、先のチュートリアルで作成したSiteテーブルに手を加え、どのサイトをリンクしているのかを保存してみましょう。
+Numeric types
+-------------
 
-他のテーブルを参照するカラムにデータを入力する場合には、参照先のテーブルの_keyカラムの値を代入する必要があります。
+The numeric types are divided into integer types and a floating point number type. The integer types are further divided into the signed integer types and unsigned integer types. In addition, you can choose the number of bits allocated to each integer. For more details, see :doc:`/type`. The default value of the numeric types is 0.
+
+The following example creates an Int8 column and a Float column, and then updates existing records. The :doc:`/commands/load` command updates the weight column as expected. On the other hand, the price column values are different from the specified values because 15.9 is not an integer and 200 is too large. 15.9 is converted to 15 by removing the fractional part. 200 causes an overflow and the result becomes -56. Note that the result of an overflow/underflow is undefined.
 
 .. groonga-command
-.. include:: ../example/tutorial/data-2.log
+.. include:: ../example/tutorial/data-3.log
+.. column_create --table ToyBox --name price --type Int8
+.. column_create --table ToyBox --name weight --type Float
+.. load --table ToyBox
+.. [
+.. {"_key":"Monkey","price":15.9}
+.. {"_key":"Flower","price":200,"weight":0.13}
+.. {"_key":"Block","weight":25.7}
+.. ]
+.. select --table ToyBox --output_columns _key,price,weight
+
+String types
+------------
+
+The string types are divided according to the maximum length. For more details, see :doc:`/type`. The default value is the zero-length string.
+
+The following example creates a ShortText column and updates existing records. The third record has the default value because not updated.
+
+.. groonga-command
+.. include:: ../example/tutorial/data-4.log
+.. column_create --table ToyBox --name name --type ShortText
+.. load --table ToyBox
+.. [
+.. {"_key":"Monkey","name":"Grease"}
+.. {"_key":"Flower","name":"Rose"}
+.. ]
+.. select --table ToyBox --output_columns _key,name
+
+Date and time type
+------------------
+
+The date and time type of groonga is Time. Actually, a Time column stores a date and time as the number of microseconds since the Epoch, 1970-01-01 00:00:00. A Time value can represent a date and time before the Epoch because the actual data type is a signed integer. Note that :doc:`/commands/load` and :doc:`/commands/select commands use a decimal number to represent a data and time in seconds. The default value is 0.0, which means the Epoch.
+
+The following example creates a Time column and updates existing records. The first record has the default value because not updated.
+
+.. groonga-command
+.. include:: ../example/tutorial/data-5.log
+.. column_create --table ToyBox --name time --type Time
+.. load --table ToyBox
+.. [
+.. {"_key":"Flower","time":1234567890.1234569999}
+.. {"_key":"Block","time":-1234567890}
+.. ]
+.. select --table ToyBox --output_columns _key,time
+
+Longitude and latitude types
+----------------------------
+
+The longitude and latitude types are divided according to the geographic coordinate system. For more details, see :doc:`/type`. To represent a longitude and latitude, groonga uses a string formatted as follows:
+
+* "longitude x latitude" in milliseconds (e.g.: "128452975x503157902")
+* "longitude x latitude" in degrees (e.g.: "35.6813819x139.7660839")
+
+A number with/without a decimal point represents a longitude or latitude in milliseconds/degrees respectively. Note that a combination of a number with a decimal point and a number without a decimal point (e.g. 35.1x139) must not be used. A comma (',') is also available as a delimiter. The default value is "0x0".
+
+The following example creates a WGS84GeoPoint column and updates existing records. The second record has the default value because not updated.
+
+.. groonga-command
+.. include:: ../example/tutorial/data-6.log
+.. column_create --table ToyBox --name location --type WGS84GeoPoint
+.. load --table ToyBox
+.. [
+.. {"_key":"Monkey","location":"128452975x503157902"}
+.. {"_key":"Block","location":"35.6813819x139.7660839"}
+.. ]
+.. select --table ToyBox --output_columns _key,location
+
+Reference types
+---------------
+
+Groonga supports a reference column, which stores references to records in its associated table. In practice, a reference column stores the IDs of the referred records in the associated table and enables access to those records.
+
+You can specify a column in the associated table to the `output_columns` parameter of a :doc:`/commands/select` command. The format is "Src.Dest" where Src is the name of the reference column and Dest is the name of the target column. If only the reference column is specified, it is handled as "Src._key". Note that if a reference does not point to a valid record, a :doc:`/commands/select` command outputs the default value of the target column.
+
+The following example adds a reference column to the Site table that was created in the previous tutorial. The new column, named link, is designed for storing links among records in the Site table.
+
+.. groonga-command
+.. include:: ../example/tutorial/data-7.log
 .. column_create --table Site --name link --type Site
 .. load --table Site
 .. [{"_key":"http://example.org/","link":"http://example.net/"}]
 .. select --table Site --output_columns _key,title,link._key,link.title --query title:@this
 
-このように、linkカラムに他のサイトへの参照を保存することができました。また、参照先の_keyとtitleカラムの内容を表示することができました。
+The `type` parameter of the :doc:`/commands/column_create` command specifies the table to be associated with the reference column. In this example, the reference column is associated with the own table. Then, the :doc:`/commands/load` command registers a link from "http://example.org" to "http://example.net". Note that a reference column requires the primary key, not the ID, of the record to be referred to. After that, the link is confirmed by the :doc:`/commands/select` command. In this case, the primary key and the title of the referred record are output because link._key and link.title are specified to the `output_columns` parameter.
 
-ベクターカラム
---------------
+Vector types
+------------
 
-column_createコマンドでカラムを作成するとき、--flagsオプションでCOLUMN_VECTORフラグを指定すると、複数の値を配列で格納できるカラムが作成されます。
+Groonga supports a vector column, in which each element can store a variable number of values. To create a vector column, specify the COLUMN_VECTOR flag to the `flags` parameter of a :doc:`/commands/column_create` command. A vector column is useful to represent a many-to-many relationship.
 
-テーブル型で配列を格納するカラムは、1対多の参照関係を表すのに有効です。
-
-テーブル型のチュートリアルでは、Siteテーブルに手を加え、どのサイトをリンクしているのかを保存しました。しかし、通常は1つのサイトから多くのサイトにリンクが張られています。複数のリンク情報を格納するために、複数の参照関係を保存するカラムを作成してみましょう。
-
-他のテーブルを参照するベクターカラムにデータを入力する場合には、参照先のテーブルの_keyカラムの値の「配列」を代入する必要があります。
+The previous example used a regular column, so each record could have at most one link. Obviously, the specification is insufficient because a site usually has more than one links. To solve this problem, the following example uses a vector column.
 
 .. FIXME: _idの配列ではダメなのかどうか。検証する。
 
 .. groonga-command
-.. include:: ../example/tutorial/data-3.log
+.. include:: ../example/tutorial/data-8.log
 .. column_create --table Site --name links --flags COLUMN_VECTOR --type Site
 .. load --table Site
 .. [{"_key":"http://example.org/","links":["http://example.net/","http://example.org/","http://example.com/"]}]
 .. select --table Site --output_columns _key,title,links._key,links.title --query title:@this
 
-このように、複数の参照関係が保存できました。また、output_columnsによって、複数の参照先のカラム値も表示させることができました。
+The only difference at the first step is the `flags` parameter that specifies to create a vector column. The `type` parameter of the :doc:`/commands/column_create` command is the same as in the previous example. Then, the :doc:`/commands/load` command registers three links from "http://example.org/" to "http://example.net/", "http://example.org/" and "http://example.com/". After that, the links are confirmed by the :doc:`/commands/select` command. In this case, the primary keys and the titles are output as arrays because links._key and links.title are specified to the `output_columns` parameter.

data/vendor/local/share/doc/groonga/source/tutorial/introduction.txt

@@ -8,46 +8,48 @@
 Basic operations
 ================
 
-The groonga package provides a C library (libgroonga) and a command line tool (groonga). This tutorial explains how to use the groonga command, with which you can create/operate databases, start a server, establish a connection with a server, etc.
+A groonga package provides a C library (libgroonga) and a command line tool (groonga). This tutorial explains how to use the command line tool, with which you can create/operate databases, start a server, establish a connection with a server, etc.
 
 Create a database
 -----------------
 
-You can create a new database with the following command.
+The first step to using groonga is to create a new database. The following shows how to do it.
 
 Form::
 
-  groonga -n DB_PATH_NAME
+  groonga -n DB_PATH
 
-The '-n' option specifies to create a new database. DB_PATH_NAME specifies the path of the new database. Note that this command fails if the specified path already exists.
+The `-n` option specifies to create a new database and DB_PATH specifies the path of the new database. Actually, a database consists of a series of files and DB_PATH specifies the file which will be the entrance to the new database. DB_PATH also specifies the path prefix for other files. Note that database creation fails if DB_PATH points to an existing file.
 
-This command creates a database and then enters into interactive mode in which groonga prompts you to enter commands for operating that database. You can terminate this mode with Ctrl-d.
+This command creates a new database and then enters into interactive mode in which groonga prompts you to enter commands for operating that database. You can terminate this mode with Ctrl-d.
 
-Execution example::
+.. groonga-command
+.. include:: ../example/tutorial/introduction-1.log
+.. .. % groonga -n /tmp/groonga-databases/introduction.db
 
-  % groonga -n /tmp/tutorial.db
-  > Ctrl-d
-  %
+After this database creation, you can find a series of files in /tmp/groonga-databases.
 
 Operate a database
 ------------------
 
+The following shows how to operate an existing database.
+
 Form::
 
-  groonga DB_PATH_NAME [COMMAND]
+  groonga DB_PATH [COMMAND]
 
-DB_PATH_NAME specifies the path of a target database.
+DB_PATH specifies the path of a target database. This command fails if the specified database does not exist.
 
-If COMMAND is specified, groonga executes COMMAND and returns the result. Otherwise, groonga starts in interactive mode that reads commands from the standard input and execute them one by one. This tutorial focuses on the interactive mode.
+If COMMAND is specified, groonga executes COMMAND and returns the result. Otherwise, groonga starts in interactive mode that reads commands from the standard input and executes them one by one. This tutorial focuses on the interactive mode.
 
-Let's try to see the status of a groonga process by using a :doc:`/commands/status` command.
+Let's see the status of a groonga process by using a :doc:`/commands/status` command.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-1.log
-.. .. % groonga -n /tmp/groonga-databases/introduction.db
+.. include:: ../example/tutorial/introduction-2.log
+.. .. % groonga /tmp/groonga-databases/introduction.db
 .. status
 
-As shown in the above example, a command basically returns a JSON array. The first element contains an error code, execution time, etc. The second element is the result of an operation.
+As shown in the above example, a command returns a JSON array. The first element contains an error code, execution time, etc. The second element is the result of an operation.
 
 Command format
 --------------
@@ -87,84 +89,54 @@ Basic commands
 Create a table
 --------------
 
-A :doc:`/commands/table_create` command creates a table.
+A :doc:`/commands/table_create` command creates a new table.
 
-In most cases, a table of groonga has a primary key which must be specified with its data type and index type. 
+In most cases, a table has a primary key which must be specified with its data type and index type. 
 
-There are various data types such as integers, floating-point numbers, etc. The index type determines the search performance and the availability of prefix searches. We will explain the details later.
+There are various data types such as integers, strings, etc. See also :doc:`/type` for more details. The index type determines the search performance and the availability of prefix searches. The details will be described later.
 
-Let's create a 'Site' table which has a primary key of ShortText. In this example, the index type is HASH.
+Let's create a table. The following example creates a table with a primary key. The `name` parameter specifies the name of the table. The `flags` parameter specifies the index type for the primary key. The `key_type` parameter specifies the data type of the primary key.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-2.log
+.. include:: ../example/tutorial/introduction-3.log
 .. table_create --name Site --flags TABLE_HASH_KEY --key_type ShortText
 
+The second element of the result indicates that the operation succeeded.
+
 View a table
 ------------
 
-A :doc:`/commands/select` command shows contents of table.
+A :doc:`/commands/select` command can enumerate records in a table.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-3.log
+.. include:: ../example/tutorial/introduction-4.log
 .. select --table Site
 
-When only a table is specified, the 'select' command returns the first (at most) 10 records of that table. "[0]" in the result shows the number of records in the 'Site' table. The next array is a list of columns. ["_id","Uint32"] is a column of UInt32, named "_id". ["_key","ShortText"] is a column of ShortText, named "_key".
+When only a table name is specified with a `table` parameter, a :doc:`/commands/select` command returns the first (at most) 10 records in the table. [0] in the result shows the number of records in the table. The next array is a list of columns. ["_id","Uint32"] is a column of UInt32, named _id. ["_key","ShortText"] is a column of ShortText, named _key.
 
-The above two columns, '_id' and '_key', are the necessary columns. The '_id' column stores IDs those are automatically allocated by groonga. The '_key' column is associated with the primary key. You are not allowed to rename these columns.
+The above two columns, _id and _key, are the necessary columns. The _id column stores IDs those are automatically allocated by groonga. The _key column is associated with the primary key. You are not allowed to rename these columns.
 
 Create a column
 ---------------
 
-A :doc:`/commands/column_create` command adds a column to a table.
-
-Let's add a column of ShortText to store titles. You may give a descriptive name 'title' to the column.
-
-.. groonga-command
-.. include:: ../example/tutorial/introduction-4.log
-.. column_create --table Site --name title --flags COLUMN_SCALAR --type ShortText
-.. select --table Site
-
-The COLUMN_SCALAR flag specifies to add a regular column.
-
-Create a lexicon table for full text searches
----------------------------------------------
-
-Let's go on to how to make a full text search.
-
-Groonga uses an inverted index to provide fast full text search. So, the first step is to create a lexicon table which stores an inverted index, also known as postings lists. The primary key of this table is associated with a vocabulary made up of index terms and each record stores postings lists for one index term.
+A :doc:`/commands/column_create` command creates a new column.
 
-The following shows a command which creates a lexicon table named 'Terms'. The data type of its primary key is ShortText.
+Let's add a column. The following example adds a column to the Site table. The `table` parameter specifies the target table. The `name` parameter specifies the name of the column. The `type` parameter specifies the data type of the column.
 
 .. groonga-command
 .. include:: ../example/tutorial/introduction-5.log
-.. table_create --name Terms --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
-
-The table_create command takes many parameters but you don't need to understand all of them. Please skip the next paragraph if you are not interested in how it works.
-
-The 'TABLE_PAT_KEY' flag specifies to store index terms in a patricia trie. The 'KEY_NORMALIZE' flag specifies to normalize index terms. In this example, both flags are validated by using a '|'. The 'default_tokenizer' parameter specifies a method for tokenizing text. This example specifies 'TokenBigram' that is generally called 'N-gram'.
-
-Create an index column for full text search
--------------------------------------------
-
-The second step is to create an index column, which allows you to search records from its associated column. That is to say this step specifies which column needs an index.
-
-Let's create an index column for the 'title' column in the 'Site' table.
-
-.. groonga-command
-.. include:: ../example/tutorial/introduction-6.log
-.. column_create --table Terms --name blog_title --flags COLUMN_INDEX|WITH_POSITION --type Site --source title
-
-This command creates an index column 'blog_title' in the 'Terms' table. The '--type' option specifies a target table and the '--source' option specifies a target column. Then, the 'COLUMN_INDEX' flag specifies to create an index column and the 'WITH_POSITION' flag specifies to create a full inverted index, which contains the positions of each index term. This combination 'COLUMN_INDEX|WITH_POSITION' is recommended for the general purpose.
+.. column_create --table Site --name title --type ShortText
+.. select --table Site
 
-Load data
----------
+Load records
+------------
 
 A :doc:`/commands/load` command loads JSON-formatted records into a table.
 
-The following adds nine records to the 'Site' table.
+The following example loads nine records into the Site table.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-7.log
+.. include:: ../example/tutorial/introduction-6.log
 .. load --table Site
 .. [
 .. {"_key":"http://example.org/","title":"This is test record 1!"},
@@ -178,99 +150,137 @@ The following adds nine records to the 'Site' table.
 .. {"_key":"http://example.com/vdw","title":"test test record nine."},
 .. ]
 
+The second element of the result indicates how many records were successfully loaded. In this case, all the records are successfully loaded.
+
 Let's make sure that these records are correctly stored.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-8.log
+.. include:: ../example/tutorial/introduction-7.log
 .. select --table Site
 
-Search data
------------
+Get a record
+------------
+
+A :doc:`/commands/select` command can search records in a table.
 
-Before a full text search, let's try to search data by '_id' and '_key'. These columns work as unique keys.
+If a search condition is specified with a `query` parameter, a :doc:`/commands/select` command searches records matching the search condition and returns the matched records.
 
-You can search records by using a 'select' command with a 'query' parameter.
+Let's get a record having a specified record ID. The following example gets the first record in the Site table. More precisely, the `query` parameter specifies a record whose _id column stores 1.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-9.log
+.. include:: ../example/tutorial/introduction-8.log
 .. select --table Site --query _id:1
 
-'_id:1' specifies to search a record whose ID is 1.
+Next, let's get a record having a specified key. The following example gets the record whose primary key is "http://example.org/". More precisely, the `query` parameter specifies a record whose _key column stores "http://example.org/".
 
-Next, let's search a record by a primary key.
+.. groonga-command
+.. include:: ../example/tutorial/introduction-9.log
+.. select --table Site --query '_key:"http://example.org/"'
+
+Create a lexicon table for full text search
+-------------------------------------------
+
+Let's go on to how to make full text search.
+
+Groonga uses an inverted index to provide fast full text search. So, the first step is to create a lexicon table which stores an inverted index, also known as postings lists. The primary key of this table is associated with a vocabulary made up of index terms and each record stores postings lists for one index term.
+
+The following shows a command which creates a lexicon table named Terms. The data type of its primary key is ShortText.
 
 .. groonga-command
 .. include:: ../example/tutorial/introduction-10.log
-.. select --table Site --query "_key:\"http://example.org/\""
+.. table_create --name Terms --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
+
+The :doc:`/commands/table_create` command takes many parameters but you don't need to understand all of them. Please skip the next paragraph if you are not interested in how it works.
+
+The TABLE_PAT_KEY flag specifies to store index terms in a patricia trie. The KEY_NORMALIZE flag specifies to normalize index terms. In this example, both flags are validated by using a '|'. The `default_tokenizer` parameter specifies the method for tokenizing text. This example uses TokenBigram that is generally called N-gram.
+
+Create an index column for full text search
+-------------------------------------------
+
+The second step is to create an index column, which allows you to search records from its associated column. That is to say this step specifies which column needs an index.
+
+Let's create an index column. The following example creates an index column for a column in the Site table.
 
-'_key:\"http://example.org/\"' specifies to search a record whose primary key is "http://example.org/".
+.. groonga-command
+.. include:: ../example/tutorial/introduction-11.log
+.. column_create --table Terms --name blog_title --flags COLUMN_INDEX|WITH_POSITION --type Site --source title
+
+The `table` parameter specifies the index table and the `name` parameter specifies the index column. The `type` parameter specifies the target table and the `source` parameter specifies the target column. The COLUMN_INDEX flag specifies to create an index column and the WITH_POSITION flag specifies to create a full inverted index, which contains the positions of each index term. This combination, COLUMN_INDEX|WITH_POSITION, is recommended for the general purpose.
+
+.. note::
+
+   You can create a lexicon table and index columns before/during/after loading records. If a target column already has records, groonga creates an inverted index in a static manner. In contrast, if you load records into an already indexed column, groonga updates the inverted index in a dynamic manner.
 
 Full text search
 ----------------
 
-It's time to make a full text search. You can make a full text search query with the same 'query' parameter.
+It's time. You can make full text search with a :doc:`/commands/select` command.
+
+A query for full text search is specified with a `query` parameter. The following example searches records whose "title" column contains "this". The '@' specifies to make full text search. Note that a lower case query matches upper case and capitalized terms in a record if KEY_NORMALIZE was specified when creating a lexcon table.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-11.log
+.. include:: ../example/tutorial/introduction-12.log
 .. select --table Site --query title:@this
 
-This command searches records whose 'title' column contains a string 'this'. In this case, only one record matches this query. Note that the lower case query 'this' matches a capitalized 'This' in the 1st record because 'KEY_NORMALIZE' was specified in lexicon column creation.
+In this example, the first record matches the query because its title contains "This", that is the capitalized form of the query.
 
-The 'select' command has an optional parameter 'match_columns'. This parameter specifies default target columns and it is used when target columns are not specified in a query.[1]_
+A :doc:`/commands/select` command accepts an optional parameter, named `match_columns`, that specifies the default target columns. This parameter is used if target columns are not specified in a query. [#]_
 
-A combination of '--match_columns title' and '--query this' brings you the same result that '--query title:@this' does.
+The combination of "`--match_columns` title" and "`--query` this" brings you the same result that "`--query` title:@this" does.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-12.log
+.. include:: ../example/tutorial/introduction-13.log
 .. select --table Site --match_columns title --query this
 
 Specify output columns
 ----------------------
 
-An 'output_columns' parameter in a 'select' command specifies columns to be shown in the search result. If you want to specify more than one columns, please separate column names by commas (,).
+An `output_columns` parameter of a :doc:`/commands/select` command specifies columns to appear in the search result. If you want to specify more than one columns, please separate column names by commas (',').
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-13.log
+.. include:: ../example/tutorial/introduction-14.log
 .. select --table Site --output_columns _key,title,_score --query title:@test
 
-This command specifies three output columns including the '_score' column, which stores the relevance score of each record.
+This example specifies three output columns including the _score column, which stores the relevance score of each record.
 
 Specify output ranges
 ---------------------
 
-A 'select' command returns a part of its search result if 'offset' and/or 'limit' parameters are specified. These parameters are useful to paginate a search result, a widely-used interface which shows a search result on a page by page basis.
+A :doc:`/commands/select` command returns a part of its search result if `offset` and/or `limit` parameters are specified. These parameters are useful to paginate a search result, a widely-used interface which shows a search result on a page by page basis.
 
-An 'offset' parameter specifies the starting point and a 'limit' parameter specifies the maximum number of records to be returned. If you need the first record in a search result, the offset parameter must be 0 or omitted.
+An `offset` parameter specifies the starting point and a `limit` parameter specifies the maximum number of records to be returned. If you need the first record in a search result, the offset parameter must be 0 or omitted.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-14.log
+.. include:: ../example/tutorial/introduction-15.log
 .. select --table Site --offset 0 --limit 3
 .. select --table Site --offset 3 --limit 3
 .. select --table Site --offset 7 --limit 3
 
-Sort
-----
+Sort a search result
+--------------------
+
+A :doc:`/commands/select` command sorts its result when used with a `sortby` parameter.
 
-A 'select' command sorts its result when used with a 'sortby' parameter.
+A `sortby` parameter specifies a column as a sorting creteria. A search result is arranged in ascending order of the column values. If you want to sort a search result in reverse order, please add a leading hyphen ('-') to the column name in a parameter.
 
-A 'sortby' parameter specifies a column as a sorting creteria. A search result is arranged in ascending order of the column values. If you want to sort a search result in reverse order, please add a leading hyphen (-) to the column name of a parameter.
+The following example shows records in the Site table in reverse order.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-15.log
+.. include:: ../example/tutorial/introduction-16.log
 .. select --table Site --sortby -_id
 
-You can use the '_score' column as a sorting criteria for ranking a search result.
+The next example uses the _score column as the sorting criteria for ranking the search result. The result is sorted in relevance order.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-16.log
-.. select --table Site --query title:@test --output_columns _id,_score,title --sortby _score
+.. include:: ../example/tutorial/introduction-17.log
+.. select --table Site --query title:@test --output_columns _id,_score,title --sortby -_score
 
-If you want to specify more than one columns, please separate column names by commas. In such a case, a search result is sorted in order of the column values in the first column, and then records having the same values in the first column are sorted in order of the second column values.
+If you want to specify more than one columns, please separate column names by commas (','). In such a case, a search result is sorted in order of the values in the first column, and then records having the same values in the first column are sorted in order of the second column values.
 
 .. groonga-command
-.. include:: ../example/tutorial/introduction-17.log
-.. select --table Site --query title:@test --output_columns _id,_score,title --sortby _score,_id
+.. include:: ../example/tutorial/introduction-18.log
+.. select --table Site --query title:@test --output_columns _id,_score,title --sortby -_score,_id
 
 .. rubric:: footnote
 
-.. [1] Currently, a 'match_columns' parameter is available iff there exists an inverted index for full text search. A 'match_columns' parameter for a regular column is not supported.
+.. [#] Currently, a `match_columns` parameter is available iff there exists an inverted index for full text search. A `match_columns` parameter for a regular column is not supported.