Kouhei Sutou
null+****@clear*****
Wed Aug 19 23:27:50 JST 2015
Kouhei Sutou 2015-08-19 23:27:50 +0900 (Wed, 19 Aug 2015) New Revision: 135866f9996e86356bf0f99e529fbb702aec7917 https://github.com/groonga/groonga/commit/135866f9996e86356bf0f99e529fbb702aec7917 Message: doc: fix syntax Modified files: doc/source/tutorial/introduction.rst Modified: doc/source/tutorial/introduction.rst (+17 -17) =================================================================== --- doc/source/tutorial/introduction.rst 2015-08-19 23:22:54 +0900 (8ee2cc6) +++ doc/source/tutorial/introduction.rst 2015-08-19 23:27:50 +0900 (bd54735) @@ -19,7 +19,7 @@ Form:: groonga -n DB_PATH -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 (For example, ``db open failed (DB_PATH): syscall error 'DB_PATH' (File exists)``. You can operate an existing database in a way that is in the next chapter). +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 (For example, ``db open failed (DB_PATH): syscall error 'DB_PATH' (File exists)``. You can operate an existing database in a way that is in the next chapter). 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. @@ -99,7 +99,7 @@ In most cases, a table has a primary key which must be specified with its data t There are various data types such as integers, strings, etc. See also :doc:`/reference/types` 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 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. +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-3.log @@ -116,7 +116,7 @@ A :doc:`/reference/commands/select` command can enumerate records in a table. .. include:: ../example/tutorial/introduction-4.log .. select --table Site -When only a table name is specified with a `table` parameter, a :doc:`/reference/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. +When only a table name is specified with a ``table`` parameter, a :doc:`/reference/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. @@ -125,7 +125,7 @@ Create a column A :doc:`/reference/commands/column_create` command creates a new column. -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. +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 @@ -167,15 +167,15 @@ Get a record A :doc:`/reference/commands/select` command can search records in a table. -If a search condition is specified with a `query` parameter, a :doc:`/reference/commands/select` command searches records matching the search condition and returns the matched records. +If a search condition is specified with a ``query`` parameter, a :doc:`/reference/commands/select` command searches records matching the search condition and returns the matched records. -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. +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-8.log .. select --table Site --query _id: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 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/". .. groonga-command .. include:: ../example/tutorial/introduction-9.log @@ -196,9 +196,9 @@ The following shows a command which creates a lexicon table named Terms. The dat The :doc:`/reference/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 `default_tokenizer` parameter specifies the method for tokenizing text. This example uses TokenBigram that is generally called N-gram. +The TABLE_PAT_KEY flag specifies to store index terms in a patricia trie. The ``default_tokenizer`` parameter specifies the method for tokenizing text. This example uses TokenBigram that is generally called N-gram. -The `normalizer` parameter specifies to normalize index terms. +The ``normalizer`` parameter specifies to normalize index terms. Create an index column for full text search ------------------------------------------- @@ -211,7 +211,7 @@ Let's create an index column. The following example creates an index column for .. 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. +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:: @@ -222,7 +222,7 @@ Full text search It's time. You can make full text search with a :doc:`/reference/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 NormalizerAuto was specified when creating a lexcon table. +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 NormalizerAuto was specified when creating a lexcon table. .. groonga-command .. include:: ../example/tutorial/introduction-12.log @@ -241,7 +241,7 @@ The combination of "`--match_columns` title" and "`--query` this" brings you the Specify output columns ---------------------- -An `output_columns` parameter of a :doc:`/reference/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 (','). +An ``output_columns`` parameter of a :doc:`/reference/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-14.log @@ -252,9 +252,9 @@ This example specifies three output columns including the _score column, which s Specify output ranges --------------------- -A :doc:`/reference/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. +A :doc:`/reference/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-15.log @@ -265,9 +265,9 @@ An `offset` parameter specifies the starting point and a `limit` parameter speci Sort a search result -------------------- -A :doc:`/reference/commands/select` command sorts its result when used with a `sortby` parameter. +A :doc:`/reference/commands/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 in a parameter. The following example shows records in the Site table in reverse order. @@ -289,4 +289,4 @@ If you want to specify more than one columns, please separate column names by co .. rubric:: footnote -.. [#] 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. -------------- next part -------------- HTML����������������������������...Download