rroonga 3.0.0-x86-mingw32 → 3.0.1-x86-mingw32

data/vendor/local/share/man/man1/groonga.1

@@ -1,4 +1,4 @@
-.TH "GROONGA" "1" "March 28, 2013" "3.0.2" "groonga"
+.TH "GROONGA" "1" "April 26, 2013" "3.0.3" "groonga"
 .SH NAME
 groonga \- groonga documentation
 .
@@ -112,7 +112,7 @@ Start command prompt \fBcmd.exe\fP and download x86 executable binary by default
 .sp
 .nf
 .ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.2\-x86.exe
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.3\-x86.exe
 .ft P
 .fi
 .sp
@@ -124,7 +124,7 @@ Start command prompt \fBcmd.exe\fP and download x64 executable binary by default
 .sp
 .nf
 .ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.2\-x64.exe
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.3\-x64.exe
 .ft P
 .fi
 .sp
@@ -141,7 +141,7 @@ Start command prompt \fBcmd.exe\fP and download x86 zip archive by default brows
 .sp
 .nf
 .ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.2\-x86.zip
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.3\-x86.zip
 .ft P
 .fi
 .sp
@@ -153,7 +153,7 @@ Start command prompt \fBcmd.exe\fP and download x64 zip archive by default brows
 .sp
 .nf
 .ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.2\-x64.zip
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.3\-x64.zip
 .ft P
 .fi
 .sp
@@ -185,7 +185,7 @@ Visual Studio 2010 Express and download it by default browser:
 .nf
 .ft C
 > cd c:\eUsers\e%USERNAME%\eDownloads
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/source/groonga/groonga\-3.0.2.zip
+> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/source/groonga/groonga\-3.0.3.zip
 .ft P
 .fi
 .sp
@@ -195,7 +195,7 @@ Move to the groonga\(aqs source folder:
 .sp
 .nf
 .ft C
-> cd c:\eUsers\e%USERNAME%\eDownloads\egroonga\-3.0.2
+> cd c:\eUsers\e%USERNAME%\eDownloads\egroonga\-3.0.3
 .ft P
 .fi
 .sp
@@ -205,7 +205,7 @@ parameter instead:
 .sp
 .nf
 .ft C
-groonga\-3.0.2> cmake . \-G "Visual Studio 10 Win64" \-DCMAKE_INSTALL_PREFIX=C:\egroonga
+groonga\-3.0.3> cmake . \-G "Visual Studio 10 Win64" \-DCMAKE_INSTALL_PREFIX=C:\egroonga
 .ft P
 .fi
 .sp
@@ -213,7 +213,7 @@ Build by Visual C++ 2010 Express:
 .sp
 .nf
 .ft C
-groonga\-3.0.2> msbuild groonga.sln /p:Configuration=Release
+groonga\-3.0.3> msbuild groonga.sln /p:Configuration=Release
 .ft P
 .fi
 .sp
@@ -221,7 +221,7 @@ Install by Visual C++ 2010 Express:
 .sp
 .nf
 .ft C
-groonga\-3.0.2> msbuild groonga.sln /p:Configuration=Release /t:Install
+groonga\-3.0.3> msbuild groonga.sln /p:Configuration=Release /t:Install
 .ft P
 .fi
 .sp
@@ -231,7 +231,7 @@ Build by Visual Studio 2010:
 .sp
 .nf
 .ft C
-groonga\-3.0.2> devenv groonga.sln /Build Release
+groonga\-3.0.3> devenv groonga.sln /Build Release
 .ft P
 .fi
 .sp
@@ -239,7 +239,7 @@ Install by Visual Studio 2010:
 .sp
 .nf
 .ft C
-groonga\-3.0.2> devenv groonga.sln /Build Release /Project Install
+groonga\-3.0.3> devenv groonga.sln /Build Release /Project Install
 .ft P
 .fi
 .sp
@@ -281,9 +281,9 @@ Download source:
 .sp
 .nf
 .ft C
-% curl \-O http://packages.groonga.org/source/groonga/groonga\-3.0.2.tar.gz
-% tar xvzf groonga\-3.0.2.tar.gz
-% cd groonga\-3.0.2
+% curl \-O http://packages.groonga.org/source/groonga/groonga\-3.0.3.tar.gz
+% tar xvzf groonga\-3.0.3.tar.gz
+% cd groonga\-3.0.3
 .ft P
 .fi
 .sp
@@ -522,9 +522,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.2.tar.gz
-% tar xvzf groonga\-3.0.2.tar.gz
-% cd groonga\-3.0.2
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.3.tar.gz
+% tar xvzf groonga\-3.0.3.tar.gz
+% cd groonga\-3.0.3
 .ft P
 .fi
 .sp
@@ -846,6 +846,73 @@ Install groonga\-normalizer\-mysql package:
 % sudo apt\-get \-y install groonga\-normalizer\-mysql
 .ft P
 .fi
+.SS 13.04 Raring Ringtail
+.IP Note
+Enable the universe repository to install groonga:
+.sp
+.nf
+.ft C
+% sudo cp /etc/apt/sources.list /etc/apt/sources.list.d/universe.list
+% sudo sed \-i\(aq\(aq \-e \(aqs/main/universe/\(aq /etc/apt/sources.list.d/universe.list
+.ft P
+.fi
+.RE
+.sp
+Add the groonga apt repository.
+.sp
+/etc/apt/sources.list.d/groonga.list:
+.sp
+.nf
+.ft C
+deb http://packages.groonga.org/ubuntu/ raring universe
+deb\-src http://packages.groonga.org/ubuntu/ raring universe
+.ft P
+.fi
+.sp
+Install:
+.sp
+.nf
+.ft C
+% sudo apt\-get update
+% sudo apt\-get \-y \-\-allow\-unauthenticated install groonga\-keyring
+% sudo apt\-get update
+% sudo apt\-get \-y install groonga
+.ft P
+.fi
+.sp
+If you want to use \fI\%MeCab\fP as a
+tokenizer, install groonga\-tokenizer\-mecab package.
+.sp
+Install groonga\-tokenizer\-mecab package:
+.sp
+.nf
+.ft C
+% sudo apt\-get \-y install groonga\-tokenizer\-mecab
+.ft P
+.fi
+.sp
+There is a package that provides \fI\%Munin\fP plugins. If you want to monitor
+groonga status by Munin, install groonga\-munin\-plugins package.
+.sp
+Install groonga\-munin\-plugins package:
+.sp
+.nf
+.ft C
+% sudo apt\-get \-y install groonga\-munin\-plugins
+.ft P
+.fi
+.sp
+There is a package that provides MySQL compatible normalizer as
+groonga plugins.
+If you want to use that one, install groonga\-normalizer\-mysql package.
+.sp
+Install groonga\-normalizer\-mysql package:
+.sp
+.nf
+.ft C
+% sudo apt\-get \-y install groonga\-normalizer\-mysql
+.ft P
+.fi
 .SS Build from source
 .sp
 Install required packages to build groonga:
@@ -860,9 +927,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.2.tar.gz
-% tar xvzf groonga\-3.0.2.tar.gz
-% cd groonga\-3.0.2
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.3.tar.gz
+% tar xvzf groonga\-3.0.3.tar.gz
+% cd groonga\-3.0.3
 .ft P
 .fi
 .sp
@@ -1104,9 +1171,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.2.tar.gz
-% tar xvzf groonga\-3.0.2.tar.gz
-% cd groonga\-3.0.2
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.3.tar.gz
+% tar xvzf groonga\-3.0.3.tar.gz
+% cd groonga\-3.0.3
 .ft P
 .fi
 .sp
@@ -1137,14 +1204,15 @@ Install:
 .sp
 This section describes how to install groonga related RPM packages on
 Fedora. You can install them by \fByum\fP.
-.sp
-Groonga related RPM pakcages are also in the official Fedora yum
-repository. So you can use them instead of the groonga yum
-repository. The different between the groonga yum repository and the
-official Fedora yum repository is that the groonga yum repository
-provides the latest version at the release day but the official Fedora
-yum repository provides the latest version a few days later. That is,
-the different is very small. :\-)
+.IP Note
+Since groonga 3.0.2 release, Groonga related RPM pakcages are in the official
+Fedora yum repository (Fedora 18). So you can use them instead of the groonga yum
+repository now. There is some exceptions to use the groonga yum
+repository because \fBgroonga\-normalizer\-mysql\fP and mecab dictionaries
+(mecab\-ipadic or mecab\-jumandic) are provided by
+the groonga yum repository. But we will also plan to release
+\fBgroonga\-normalizer\-mysql\fP in the official Fedora yum repository in the future.
+.RE
 .sp
 We distribute both 32\-bit and 64\-bit packages but we strongly
 recommend a 64\-bit package for server. You should use a 32\-bit package
@@ -1174,9 +1242,18 @@ Install:
 .sp
 .nf
 .ft C
+% sudo yum install \-y groonga
+.ft P
+.fi
+.sp
+Note that additional packages such as \fBgroonga\-normalizer\-mysql\fP,
+\fBmecab\-dic\fP and \fBmecab\-jumandic\fP packages require to install
+\fBgroonga\-release\fP package which provides the groonga yum repository beforehand:
+.sp
+.nf
+.ft C
 % sudo rpm \-ivh http://packages.groonga.org/fedora/groonga\-release\-1.1.0\-1.noarch.rpm
 % sudo yum update
-% sudo yum install \-y groonga
 .ft P
 .fi
 .sp
@@ -1245,9 +1322,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.2.tar.gz
-% tar xvzf groonga\-3.0.2.tar.gz
-% cd groonga\-3.0.2
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.3.tar.gz
+% tar xvzf groonga\-3.0.3.tar.gz
+% cd groonga\-3.0.3
 .ft P
 .fi
 .sp
@@ -1292,9 +1369,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.2.tar.gz
-% gtar xvzf groonga\-3.0.2.tar.gz
-% cd groonga\-3.0.2
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.3.tar.gz
+% gtar xvzf groonga\-3.0.3.tar.gz
+% cd groonga\-3.0.3
 .ft P
 .fi
 .sp
@@ -1418,9 +1495,9 @@ steps:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.2.tar.gz
-% tar xvzf groonga\-3.0.2.tar.gz
-% cd groonga\-3.0.2
+% wget http://packages.groonga.org/source/groonga/groonga\-3.0.3.tar.gz
+% tar xvzf groonga\-3.0.3.tar.gz
+% cd groonga\-3.0.3
 % ./configure
 % make
 % sudo make install
@@ -2787,10 +2864,10 @@ status
 #     "max_command_version": 2,
 #     "n_queries": 0,
 #     "cache_hit_rate": 0.0,
-#     "version": "2.0.5",
-#     "alloc_count": 121,
+#     "version": "3.0.2",
+#     "alloc_count": 129,
 #     "command_version": 1,
-#     "starttime": 1343713541,
+#     "starttime": 1364461102,
 #     "default_command_version": 1
 #   }
 # ]
@@ -2875,10 +2952,10 @@ status
 #     "max_command_version": 2,
 #     "n_queries": 0,
 #     "cache_hit_rate": 0.0,
-#     "version": "2.0.5",
-#     "alloc_count": 122,
+#     "version": "3.0.2",
+#     "alloc_count": 130,
 #     "command_version": 1,
-#     "starttime": 1343713541,
+#     "starttime": 1364461102,
 #     "default_command_version": 1
 #   }
 # ]
@@ -9286,14 +9363,14 @@ Execution example:
     0.000355720520019531
   ],
   {
-    "uptime": 0,
+    "uptime": 1,
     "max_command_version": 2,
     "n_queries": 0,
     "cache_hit_rate": 0.0,
-    "version": "2.1.0",
-    "alloc_count": 152,
+    "version": "3.0.2",
+    "alloc_count": 150,
     "command_version": 1,
-    "starttime": 1356678595,
+    "starttime": 1364461070,
     "default_command_version": 1
   }
 ]
@@ -14419,14 +14496,14 @@ status
 #     0.000355720520019531
 #   ],
 #   {
-#     "uptime": 6,
+#     "uptime": 5,
 #     "max_command_version": 2,
 #     "n_queries": 30,
 #     "cache_hit_rate": 0.0,
-#     "version": "2.1.0",
-#     "alloc_count": 280,
+#     "version": "3.0.2",
+#     "alloc_count": 278,
 #     "command_version": 1,
-#     "starttime": 1356678580,
+#     "starttime": 1364461054,
 #     "default_command_version": 1
 #   }
 # ]
@@ -16232,6 +16309,10 @@ Here is a list of additional normalizers provided by \fBgroonga\-normalizer\-mys
 .INDENT 0.0
 .IP \(bu 2
 \fBNormalizerMySQLGeneralCI\fP
+.IP \(bu 2
+\fBNormalizerMySQLUnicodeCI\fP
+.IP \(bu 2
+\fBNormalizerMySQLGeneralCIExceptKanaCIKanaWithVoicedSoundMark\fP
 .UNINDENT
 .UNINDENT
 .UNINDENT
@@ -19458,30 +19539,17 @@ TODO: ...
 .sp
 TODO: ...
 .SS Assignment operators
+.SS Addition assignment operator
 .sp
-TODO: ...
-.SS Original operators
-.sp
-Script syntax adds the original binary opearators to ECMAScript
-syntax. They operate search specific operations. They are starts with
-\fB@\fP or \fB*\fP.
-.SS Match operator
-.sp
-Its syntax is \fBcolumn @ value\fP.
-.sp
-The operator searches \fBvalue\fP by inverted index of \fBcolumn\fP.
-Normally, full text search is operated but tag search can be operated.
-Because tag search is also implemented by inverted index.
-.sp
-\fBquery_syntax\fP uses this operator by default.
+Its syntax is \fBcolumn1 += column2\fP.
 .sp
-Here is a simple exmaple.
+The operator performs addition assginment operation on column1 by column2.
 .sp
 Execution example:
 .sp
 .nf
 .ft C
-select Entries \-\-filter \(aqcontent @ "fast"\(aq \-\-output_columns content
+select Entries \-\-output_columns _key,n_likes,_score \-\-filter true \-\-scorer \(aq_score += n_likes\(aq
 # [
 #   [
 #     0,
@@ -19491,19 +19559,46 @@ select Entries \-\-filter \(aqcontent @ "fast"\(aq \-\-output_columns content
 #   [
 #     [
 #       [
-#         2
+#         5
 #       ],
 #       [
 #         [
-#           "content",
-#           "Text"
+#           "_key",
+#           "ShortText"
+#         ],
+#         [
+#           "n_likes",
+#           "UInt32"
+#         ],
+#         [
+#           "_score",
+#           "Int32"
 #         ]
 #       ],
 #       [
-#         "I started to use groonga. It\(aqs very fast!"
+#         "Good\-bye Senna",
+#         3,
+#         4
 #       ],
 #       [
-#         "I also started to use mroonga. It\(aqs also very fast! Really fast!"
+#         "Good\-bye Tritonn",
+#         3,
+#         4
+#       ],
+#       [
+#         "Groonga",
+#         10,
+#         11
+#       ],
+#       [
+#         "Mroonga",
+#         15,
+#         16
+#       ],
+#       [
+#         "The first post!",
+#         5,
+#         6
 #       ]
 #     ]
 #   ]
@@ -19511,33 +19606,24 @@ select Entries \-\-filter \(aqcontent @ "fast"\(aq \-\-output_columns content
 .ft P
 .fi
 .sp
-The expression matches records that contain a word \fBfast\fP in
-\fBcontent\fP column value.
-.SS Prefix search operator
-.sp
-Its syntax is \fBcolumn @^ value\fP.
+The value of \fB_score\fP by \fB\-\-filter\fP is always 1 in this case,
+then performs addition assignment operation such as \(aq_score = _score + n_likes\(aq for each records.
 .sp
-The operator does prefix search with \fBvalue\fP. Prefix search searches
-records that contain a word that starts with \fBvalue\fP.
+For example, the value of \fB_score\fP about the record which stores "Good\-bye Senna" as the \fB_key\fP
+is 3.
 .sp
-You can use fast prefix search against a column. The column must be
-indexed and index table must be patricia trie table
-(\fBTABLE_PAT_KEY\fP) or double array trie table
-(\fBTABLE_DAT_KEY\fP). You can also use fast prefix search against
-\fB_key\fP pseudo column of patricia trie table or double array trie
-table. You don\(aqt need to index \fB_key\fP.
+So the expression \fB1 + 3\fP is evaluated and stored to \fB_score\fP column as the execution result.
+.SS Subtraction assignment operator
 .sp
-Prefix search can be used with other table types but it causes all
-records scan. It\(aqs not problem for small records but it spends more
-time for large records.
+Its syntax is \fBcolumn1 \-= column2\fP.
 .sp
-Here is a simple exmaple.
+The operator performs subtraction assginment operation on column1 by column2.
 .sp
 Execution example:
 .sp
 .nf
 .ft C
-select Entries \-\-filter \(aq_key @^ "Goo"\(aq \-\-output_columns _key
+select Entries \-\-output_columns _key,n_likes,_score \-\-filter true \-\-scorer \(aq_score \-= n_likes\(aq
 # [
 #   [
 #     0,
@@ -19547,19 +19633,46 @@ select Entries \-\-filter \(aq_key @^ "Goo"\(aq \-\-output_columns _key
 #   [
 #     [
 #       [
-#         2
+#         5
 #       ],
 #       [
 #         [
 #           "_key",
 #           "ShortText"
+#         ],
+#         [
+#           "n_likes",
+#           "UInt32"
+#         ],
+#         [
+#           "_score",
+#           "Int32"
 #         ]
 #       ],
 #       [
-#         "Good\-bye Tritonn"
+#         "Good\-bye Senna",
+#         3,
+#         \-2
 #       ],
 #       [
-#         "Good\-bye Senna"
+#         "Good\-bye Tritonn",
+#         3,
+#         \-2
+#       ],
+#       [
+#         "Groonga",
+#         10,
+#         \-9
+#       ],
+#       [
+#         "Mroonga",
+#         15,
+#         \-14
+#       ],
+#       [
+#         "The first post!",
+#         5,
+#         \-4
 #       ]
 #     ]
 #   ]
@@ -19567,61 +19680,24 @@ select Entries \-\-filter \(aq_key @^ "Goo"\(aq \-\-output_columns _key
 .ft P
 .fi
 .sp
-The expression matches records that contain a word that starts with
-\fBGoo\fP in \fB_key\fP pseudo column value. \fBGood\-bye Senna\fP and
-\fBGood\-bye Tritonn\fP are matched with the expression.
-.SS Suffix search operator
-.sp
-Its syntax is \fBcolumn @$ value\fP.
+The value of \fB_score\fP by \fB\-\-filter\fP is always 1 in this case,
+then performs subtraction assignment operation such as \(aq_score = _score \- n_likes\(aq for each records.
 .sp
-This operator does suffix search with \fBvalue\fP. Suffix search
-searches records that contain a word that ends with \fBvalue\fP.
+For example, the value of \fB_score\fP about the record which stores "Good\-bye Senna" as the \fB_key\fP
+is 3.
 .sp
-You can use fast suffix search against a column. The column must be
-indexed and index table must be patricia trie table
-(\fBTABLE_PAT_KEY\fP) with \fBKEY_WITH_SIS\fP flag. You can also use fast
-suffix search against \fB_key\fP pseudo column of patricia trie table
-(\fBTABLE_PAT_KEY\fP) with \fBKEY_WITH_SIS\fP flag. You don\(aqt need to
-index \fB_key\fP. We recommended that you use index column based fast
-suffix search instead of \fB_key\fP based fast suffix search. \fB_key\fP
-based fast suffix search returns automatically registered
-substrings. (TODO: write document about suffix search and link to it
-from here.)
-.IP Note
-Fast suffix search can be used only for non\-ASCII characters such
-as hiragana in Japanese. You cannot use fast suffix search for
-ASCII character.
-.RE
+So the expression \fB1 \- 3\fP is evaluated and stored to \fB_score\fP column as the execution result.
+.SS Multiplication assignment operator
 .sp
-Suffix search can be used with other table types or patricia trie
-table without \fBKEY_WITH_SIS\fP flag but it causes all records
-scan. It\(aqs not problem for small records but it spends more time for
-large records.
+Its syntax is \fBcolumn1 *= column2\fP.
 .sp
-Here is a simple exmaple. It uses fast suffix search for hiragana in
-Japanese that is one of non\-ASCII characters.
+The operator performs multiplication assginment operation on column1 by column2.
 .sp
 Execution example:
 .sp
 .nf
 .ft C
-table_create Titles TABLE_NO_KEY
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-column_create Titles content COLUMN_SCALAR ShortText
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-table_create SuffixSearchTerms TABLE_PAT_KEY|KEY_WITH_SIS ShortText
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-column_create SuffixSearchTerms index COLUMN_INDEX Titles content
-# [[0, 1337566253.89858, 0.000355720520019531], true]
-load \-\-table Titles
-[
-{"content": "ぐるんが"},
-{"content": "むるんが"},
-{"content": "せな"},
-{"content": "とりとん"}
-]
-# [[0, 1337566253.89858, 0.000355720520019531], 4]
-select Titles \-\-query \(aqcontent:$んが\(aq
+select Entries \-\-output_columns _key,n_likes,_score \-\-filter true \-\-scorer \(aq_score *= n_likes\(aq
 # [
 #   [
 #     0,
@@ -19631,41 +19707,720 @@ select Titles \-\-query \(aqcontent:$んが\(aq
 #   [
 #     [
 #       [
-#         2
+#         5
 #       ],
 #       [
 #         [
-#           "_id",
+#           "_key",
+#           "ShortText"
+#         ],
+#         [
+#           "n_likes",
 #           "UInt32"
 #         ],
 #         [
-#           "content",
-#           "ShortText"
+#           "_score",
+#           "Int32"
 #         ]
 #       ],
 #       [
-#         2,
-#         "むるんが"
+#         "Good\-bye Senna",
+#         3,
+#         3
 #       ],
 #       [
-#         1,
-#         "ぐるんが"
-#       ]
-#     ]
-#   ]
-# ]
-.ft P
-.fi
-.sp
-The expression matches records that have value that ends with \fBんが\fP
-in \fBcontent\fP column value. \fBぐるんが\fP and \fBむるんが\fP are matched
-with the expression.
-.SS Near search operator
-.sp
-Its syntax is \fBcolumn *N "word1 word2 ..."\fP.
-.sp
-The operator does near search with words \fBword1 word2 ...\fP. Near
-search searches records that contain the words and the words are
+#         "Good\-bye Tritonn",
+#         3,
+#         3
+#       ],
+#       [
+#         "Groonga",
+#         10,
+#         10
+#       ],
+#       [
+#         "Mroonga",
+#         15,
+#         15
+#       ],
+#       [
+#         "The first post!",
+#         5,
+#         5
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The value of \fB_score\fP by \fB\-\-filter\fP is always 1 in this case,
+then performs subtraction assignment operation such as \(aq_score = _score * n_likes\(aq for each records.
+.sp
+For example, the value of \fB_score\fP about the record which stores "Good\-bye Senna" as the \fB_key\fP
+is 3.
+.sp
+So the expression \fB1 * 3\fP is evaluated and stored to \fB_score\fP column as the execution result.
+.SS Division assignment operator
+.sp
+Its syntax is \fBcolumn1 /= column2\fP.
+.sp
+The operator performs division assginment operation on column1 by column2.
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+select Entries \-\-output_columns _key,n_likes,_score \-\-filter true \-\-scorer \(aq_score /= n_likes\(aq
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         5
+#       ],
+#       [
+#         [
+#           "_key",
+#           "ShortText"
+#         ],
+#         [
+#           "n_likes",
+#           "UInt32"
+#         ],
+#         [
+#           "_score",
+#           "Int32"
+#         ]
+#       ],
+#       [
+#         "Good\-bye Senna",
+#         3,
+#         0
+#       ],
+#       [
+#         "Good\-bye Tritonn",
+#         3,
+#         0
+#       ],
+#       [
+#         "Groonga",
+#         10,
+#         0
+#       ],
+#       [
+#         "Mroonga",
+#         15,
+#         0
+#       ],
+#       [
+#         "The first post!",
+#         5,
+#         0
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The value of \fB_score\fP by \fB\-\-filter\fP is always 1 in this case,
+then performs subtraction assignment operation such as \(aq_score = _score / n_likes\(aq for each records.
+.sp
+For example, the value of \fB_score\fP about the record which stores "Good\-bye Senna" as the \fB_key\fP
+is 3.
+.sp
+So the expression \fB1 / 3\fP is evaluated and stored to \fB_score\fP column as the execution result.
+.SS Modulo assignment operator
+.sp
+Its syntax is \fBcolumn1 %= column2\fP.
+.sp
+The operator performs modulo assginment operation on column1 by column2.
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+select Entries \-\-output_columns _key,n_likes,_score \-\-filter true \-\-scorer \(aq_score %= n_likes\(aq
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         5
+#       ],
+#       [
+#         [
+#           "_key",
+#           "ShortText"
+#         ],
+#         [
+#           "n_likes",
+#           "UInt32"
+#         ],
+#         [
+#           "_score",
+#           "Int32"
+#         ]
+#       ],
+#       [
+#         "Good\-bye Senna",
+#         3,
+#         1
+#       ],
+#       [
+#         "Good\-bye Tritonn",
+#         3,
+#         1
+#       ],
+#       [
+#         "Groonga",
+#         10,
+#         1
+#       ],
+#       [
+#         "Mroonga",
+#         15,
+#         1
+#       ],
+#       [
+#         "The first post!",
+#         5,
+#         1
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The value of \fB_score\fP by \fB\-\-filter\fP is always 1 in this case,
+then performs subtraction assignment operation such as \(aq_score = _score % n_likes\(aq for each records.
+.sp
+For example, the value of \fB_score\fP about the record which stores "Good\-bye Senna" as the \fB_key\fP
+is 3.
+.sp
+So the expression \fB1 % 3\fP is evaluated and stored to \fB_score\fP column as the execution result.
+.SS Bitwise left shift assignment operator
+.sp
+Its syntax is \fBcolumn1 <<= column2\fP.
+.sp
+The operator performs left shift assginment operation on column1 by column2.
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+select Entries \-\-output_columns _key,n_likes,_score \-\-filter true \-\-scorer \(aq_score <<= n_likes\(aq
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         5
+#       ],
+#       [
+#         [
+#           "_key",
+#           "ShortText"
+#         ],
+#         [
+#           "n_likes",
+#           "UInt32"
+#         ],
+#         [
+#           "_score",
+#           "Int32"
+#         ]
+#       ],
+#       [
+#         "Good\-bye Senna",
+#         3,
+#         8
+#       ],
+#       [
+#         "Good\-bye Tritonn",
+#         3,
+#         8
+#       ],
+#       [
+#         "Groonga",
+#         10,
+#         1024
+#       ],
+#       [
+#         "Mroonga",
+#         15,
+#         32768
+#       ],
+#       [
+#         "The first post!",
+#         5,
+#         32
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The value of \fB_score\fP by \fB\-\-filter\fP is always 1 in this case,
+then performs subtraction assignment operation such as \(aq_score = _score << n_likes\(aq for each records.
+.sp
+For example, the value of \fB_score\fP about the record which stores "Good\-bye Senna" as the \fB_key\fP
+is 3.
+.sp
+So the expression \fB1 << 3\fP is evaluated and stored to \fB_score\fP column as the execution result.
+.SS Bitwise signed right shift assignment operator
+.sp
+Its syntax is \fBcolumn2 >>= column2\fP.
+.sp
+The operator performs signed right shift assginment operation on column1 by column2.
+.SS Bitwise unsigned right shift assignment operator
+.sp
+Its syntax is \fBcolumn1 >>>= column2\fP.
+.sp
+The operator performs unsigned right shift assginment operation on column1 by column2.
+.SS Bitwise AND assignment operator
+.sp
+Its syntax is \fBcolumn1 &= column2\fP.
+.sp
+The operator performs bitwise AND assignment operation on column1 by column2.
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+select Entries \-\-output_columns _key,n_likes,_score \-\-filter true \-\-scorer \(aq_score &= n_likes\(aq
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         5
+#       ],
+#       [
+#         [
+#           "_key",
+#           "ShortText"
+#         ],
+#         [
+#           "n_likes",
+#           "UInt32"
+#         ],
+#         [
+#           "_score",
+#           "Int32"
+#         ]
+#       ],
+#       [
+#         "Good\-bye Senna",
+#         3,
+#         1
+#       ],
+#       [
+#         "Good\-bye Tritonn",
+#         3,
+#         1
+#       ],
+#       [
+#         "Groonga",
+#         10,
+#         0
+#       ],
+#       [
+#         "Mroonga",
+#         15,
+#         1
+#       ],
+#       [
+#         "The first post!",
+#         5,
+#         1
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The value of \fB_score\fP by \fB\-\-filter\fP is always 1 in this case,
+then performs subtraction assignment operation such as \(aq_score = _score & n_likes\(aq for each records.
+.sp
+For example, the value of \fB_score\fP about the record which stores "Groonga" as the \fB_key\fP
+is 10.
+.sp
+So the expression \fB1 & 10\fP is evaluated and stored to \fB_score\fP column as the execution result.
+.SS Bitwise OR assignment operator
+.sp
+Its syntax is \fBcolumn1 |= column2\fP.
+.sp
+The operator performs bitwise OR assignment operation on column1 by column2.
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+select Entries \-\-output_columns _key,n_likes,_score \-\-filter true \-\-scorer \(aq_score |= n_likes\(aq
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         5
+#       ],
+#       [
+#         [
+#           "_key",
+#           "ShortText"
+#         ],
+#         [
+#           "n_likes",
+#           "UInt32"
+#         ],
+#         [
+#           "_score",
+#           "Int32"
+#         ]
+#       ],
+#       [
+#         "Good\-bye Senna",
+#         3,
+#         3
+#       ],
+#       [
+#         "Good\-bye Tritonn",
+#         3,
+#         3
+#       ],
+#       [
+#         "Groonga",
+#         10,
+#         11
+#       ],
+#       [
+#         "Mroonga",
+#         15,
+#         15
+#       ],
+#       [
+#         "The first post!",
+#         5,
+#         5
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The value of \fB_score\fP by \fB\-\-filter\fP is always 1 in this case,
+then performs subtraction assignment operation such as \(aq_score = _score | n_likes\(aq for each records.
+.sp
+For example, the value of \fB_score\fP about the record which stores "Groonga" as the \fB_key\fP
+is 10.
+.sp
+So the expression \fB1 | 10\fP is evaluated and stored to \fB_score\fP column as the execution result.
+.SS Bitwise XOR assignment operator
+.sp
+Its syntax is \fBcolumn1 ^= column2\fP.
+.sp
+The operator performs bitwise XOR assginment operation on column1 by column2.
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+select Entries \-\-output_columns _key,n_likes,_score \-\-filter true \-\-scorer \(aq_score ^= n_likes\(aq
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         5
+#       ],
+#       [
+#         [
+#           "_key",
+#           "ShortText"
+#         ],
+#         [
+#           "n_likes",
+#           "UInt32"
+#         ],
+#         [
+#           "_score",
+#           "Int32"
+#         ]
+#       ],
+#       [
+#         "Good\-bye Senna",
+#         3,
+#         2
+#       ],
+#       [
+#         "Good\-bye Tritonn",
+#         3,
+#         2
+#       ],
+#       [
+#         "Groonga",
+#         10,
+#         11
+#       ],
+#       [
+#         "Mroonga",
+#         15,
+#         14
+#       ],
+#       [
+#         "The first post!",
+#         5,
+#         4
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The value of \fB_score\fP by \fB\-\-filter\fP is always 1 in this case,
+then performs subtraction assignment operation such as \(aq_score = _score ^ n_likes\(aq for each records.
+.sp
+For example, the value of \fB_score\fP about the record which stores "Good\-bye Senna" as the \fB_key\fP
+is 3.
+.sp
+So the expression \fB1 ^ 3\fP is evaluated and stored to \fB_score\fP column as the execution result.
+.SS Original operators
+.sp
+Script syntax adds the original binary opearators to ECMAScript
+syntax. They operate search specific operations. They are starts with
+\fB@\fP or \fB*\fP.
+.SS Match operator
+.sp
+Its syntax is \fBcolumn @ value\fP.
+.sp
+The operator searches \fBvalue\fP by inverted index of \fBcolumn\fP.
+Normally, full text search is operated but tag search can be operated.
+Because tag search is also implemented by inverted index.
+.sp
+\fBquery_syntax\fP uses this operator by default.
+.sp
+Here is a simple exmaple.
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+select Entries \-\-filter \(aqcontent @ "fast"\(aq \-\-output_columns content
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           "content",
+#           "Text"
+#         ]
+#       ],
+#       [
+#         "I started to use groonga. It\(aqs very fast!"
+#       ],
+#       [
+#         "I also started to use mroonga. It\(aqs also very fast! Really fast!"
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The expression matches records that contain a word \fBfast\fP in
+\fBcontent\fP column value.
+.SS Prefix search operator
+.sp
+Its syntax is \fBcolumn @^ value\fP.
+.sp
+The operator does prefix search with \fBvalue\fP. Prefix search searches
+records that contain a word that starts with \fBvalue\fP.
+.sp
+You can use fast prefix search against a column. The column must be
+indexed and index table must be patricia trie table
+(\fBTABLE_PAT_KEY\fP) or double array trie table
+(\fBTABLE_DAT_KEY\fP). You can also use fast prefix search against
+\fB_key\fP pseudo column of patricia trie table or double array trie
+table. You don\(aqt need to index \fB_key\fP.
+.sp
+Prefix search can be used with other table types but it causes all
+records scan. It\(aqs not problem for small records but it spends more
+time for large records.
+.sp
+Here is a simple exmaple.
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+select Entries \-\-filter \(aq_key @^ "Goo"\(aq \-\-output_columns _key
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           "_key",
+#           "ShortText"
+#         ]
+#       ],
+#       [
+#         "Good\-bye Tritonn"
+#       ],
+#       [
+#         "Good\-bye Senna"
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The expression matches records that contain a word that starts with
+\fBGoo\fP in \fB_key\fP pseudo column value. \fBGood\-bye Senna\fP and
+\fBGood\-bye Tritonn\fP are matched with the expression.
+.SS Suffix search operator
+.sp
+Its syntax is \fBcolumn @$ value\fP.
+.sp
+This operator does suffix search with \fBvalue\fP. Suffix search
+searches records that contain a word that ends with \fBvalue\fP.
+.sp
+You can use fast suffix search against a column. The column must be
+indexed and index table must be patricia trie table
+(\fBTABLE_PAT_KEY\fP) with \fBKEY_WITH_SIS\fP flag. You can also use fast
+suffix search against \fB_key\fP pseudo column of patricia trie table
+(\fBTABLE_PAT_KEY\fP) with \fBKEY_WITH_SIS\fP flag. You don\(aqt need to
+index \fB_key\fP. We recommended that you use index column based fast
+suffix search instead of \fB_key\fP based fast suffix search. \fB_key\fP
+based fast suffix search returns automatically registered
+substrings. (TODO: write document about suffix search and link to it
+from here.)
+.IP Note
+Fast suffix search can be used only for non\-ASCII characters such
+as hiragana in Japanese. You cannot use fast suffix search for
+ASCII character.
+.RE
+.sp
+Suffix search can be used with other table types or patricia trie
+table without \fBKEY_WITH_SIS\fP flag but it causes all records
+scan. It\(aqs not problem for small records but it spends more time for
+large records.
+.sp
+Here is a simple exmaple. It uses fast suffix search for hiragana in
+Japanese that is one of non\-ASCII characters.
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+table_create Titles TABLE_NO_KEY
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Titles content COLUMN_SCALAR ShortText
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+table_create SuffixSearchTerms TABLE_PAT_KEY|KEY_WITH_SIS ShortText
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create SuffixSearchTerms index COLUMN_INDEX Titles content
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+load \-\-table Titles
+[
+{"content": "ぐるんが"},
+{"content": "むるんが"},
+{"content": "せな"},
+{"content": "とりとん"}
+]
+# [[0, 1337566253.89858, 0.000355720520019531], 4]
+select Titles \-\-query \(aqcontent:$んが\(aq
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           "_id",
+#           "UInt32"
+#         ],
+#         [
+#           "content",
+#           "ShortText"
+#         ]
+#       ],
+#       [
+#         2,
+#         "むるんが"
+#       ],
+#       [
+#         1,
+#         "ぐるんが"
+#       ]
+#     ]
+#   ]
+# ]
+.ft P
+.fi
+.sp
+The expression matches records that have value that ends with \fBんが\fP
+in \fBcontent\fP column value. \fBぐるんが\fP and \fBむるんが\fP are matched
+with the expression.
+.SS Near search operator
+.sp
+Its syntax is \fBcolumn *N "word1 word2 ..."\fP.
+.sp
+The operator does near search with words \fBword1 word2 ...\fP. Near
+search searches records that contain the words and the words are
 appeared in the near distance. Near distance is always \fB10\fP for
 now. The unit of near distance is the number of characters in N\-gram
 family tokenizers and the number of words in morphological analysis
@@ -20646,9 +21401,13 @@ by combination of multiple \fBquery\fP function.
 .sp
 \fBquery\fP requires two arguments \- \fBmatch_column\fP and \fBquery_string\fP.
 .sp
+The parameter \fBquery_expander\fP or \fBsubstitution_table\fP is optional.
+.sp
 .nf
 .ft C
 query(match_column, query_string)
+query(match_column, query_string, query_expander)
+query(match_column, query_string, substitution_table)
 .ft P
 .fi
 .SS Usage
@@ -20881,6 +21640,7 @@ On the other hand, by specifying multiple \fBquery\fP, the keywords
 As a result, you can control full text search result by giving different weight to the
 keywords on your purpose.
 .SS Parameters
+.SS Required parameter
 .sp
 There are two required parameter, \fBmatch_column\fP and \fBquery_string\fP.
 .SS \fBmatch_column\fP
@@ -20899,14 +21659,28 @@ It specifies \fBquery\fP equivalent parameter.
 .UNINDENT
 .sp
 See \fIselect\-query\fP about query string.
+.SS Optional parameter
+.sp
+There is a optional parameter, \fBapproximate_type\fP.
+.SS \fBquery_expander\fP
+.sp
+It specifies the plugin name for query expansion.
+.sp
+There is one plugin bundled in official release \- \fB/reference/query_expanders/tsv\fP.
+.sp
+See \fB/reference/query_expanders/tsv\fP about details.
+.SS \fBsubstitution_table\fP
+.sp
+It specifies the substitution table and substitution column name
+by following format such as \fB${TABLE}.${COLUMN}\fP for query expansion.
+.sp
+See \fIquery\-expander\fP about details.
 .SS Return value
 .sp
 \fBquery\fP returns a value of boolean (true or false).
 .SS TODO
 .INDENT 0.0
 .IP \(bu 2
-Support query_expansion
-.IP \(bu 2
 Support query_flags
 .UNINDENT
 .SS See also
@@ -21218,8 +21992,33 @@ Execution example:
 .sp
 .nf
 .ft C
-select Blog \-\-output_columns _key \e
-  \-\-filter "comments.name @ \e"A\e" && comments.content @ \e"groonga\e""
+select Blog \-\-output_columns _key \-\-filter "comments.name @ \e"A\e" && comments.content @ \e"groonga\e""
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           "_key",
+#           "ShortText"
+#         ]
+#       ],
+#       [
+#         "groonga\(aqs blog"
+#       ],
+#       [
+#         "mroonga\(aqs blog"
+#       ]
+#     ]
+#   ]
+# ]
 .ft P
 .fi
 .sp
@@ -21238,7 +22037,7 @@ Execution example:
 .sp
 .nf
 .ft C
-select Blog \-\-output_columns _key \e
+select Blog \-\-output_columns _key \-\-filter \(aqsub_filter(comments, "name @ \e\e"A\e\e" && content @ \e\e"groonga\e\e"")\(aq
 # [
 #   [
 #     0,
@@ -21248,7 +22047,7 @@ select Blog \-\-output_columns _key \e
 #   [
 #     [
 #       [
-#         2
+#         1
 #       ],
 #       [
 #         [
@@ -21258,14 +22057,10 @@ select Blog \-\-output_columns _key \e
 #       ],
 #       [
 #         "groonga\(aqs blog"
-#       ],
-#       [
-#         "mroonga\(aqs blog"
 #       ]
 #     ]
 #   ]
 # ]
-  \-\-filter \(aqsub_filter(comments, "name @ \e\e"A\e\e" && content @ \e\e"groonga\e\e"")\(aq
 .ft P
 .fi
 .sp