Kouhei Sutou
null+****@clear*****
Wed Aug 16 22:39:00 JST 2017
Kouhei Sutou 2017-08-16 22:39:00 +0900 (Wed, 16 Aug 2017) New Revision: d863f9537eb5d7a97cfea93f8f0d46e4a917711f https://github.com/pgroonga/pgroonga.github.io/commit/d863f9537eb5d7a97cfea93f8f0d46e4a917711f Message: Update for 2.0.0 Modified files: _po/ja/reference/functions/pgroonga-escape.po ja/reference/functions/pgroonga-escape.md reference/functions/pgroonga-escape.md Modified: _po/ja/reference/functions/pgroonga-escape.po (+36 -38) =================================================================== --- _po/ja/reference/functions/pgroonga-escape.po 2017-08-16 22:36:45 +0900 (a9f6d40) +++ _po/ja/reference/functions/pgroonga-escape.po 2017-08-16 22:39:00 +0900 (80c5188) @@ -1,7 +1,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" -"PO-Revision-Date: 2016-12-05 15:46+0900\n" +"PO-Revision-Date: 2017-08-16 22:38+0900\n" "Language: ja\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -10,17 +10,17 @@ msgstr "" msgid "" "---\n" -"title: pgroonga.escape function\n" +"title: pgroonga_escape function\n" "upper_level: ../\n" "---" msgstr "" "---\n" -"title: pgroonga.escape関数\n" +"title: pgroonga_escape関数\n" "upper_level: ../\n" "---" -msgid "# `pgroonga.escape` function" -msgstr "# `pgroonga.escape`関数" +msgid "# `pgroonga_escape` function" +msgstr "# `pgroonga_escape`関数" msgid "Since 1.1.9." msgstr "1.1.9で追加。" @@ -29,25 +29,25 @@ msgid "## Summary" msgstr "## 概要" msgid "" -"`pgroonga.escape` function converts the given value to a literal for [script s" +"`pgroonga_escape` function converts the given value to a literal for [script s" "yntax](http://groonga.org/docs/reference/grn_expr/script_syntax.html). The lit" "eral is safely used in script syntax. Script syntax is used by [jsonb `@@` ope" "rator](../operators/jsonb-query.html) and so on." msgstr "" -"`pgroonga.escape`関数は渡された値を[スクリプト構文](http://groonga.org/ja/docs/reference/grn_e" +"`pgroonga_escape`関数は渡された値を[スクリプト構文](http://groonga.org/ja/docs/reference/grn_e" "xpr/script_syntax.html)のリテラルに変換します。このリテラルはスクリプト構文内で安全に使えます。スクリプト構文は[JSONBの`@@`" "演算子](../operators/jsonb-query.html)などで使っています。" msgid "" -"`pgroonga.escape` function is useful to prevent Groonga command injection via " -"[`pgroonga.command` function](pgroonga-command.html). See also [`pgroonga.comm" +"`pgroonga_escape` function is useful to prevent Groonga command injection via " +"[`pgroonga_command` function](pgroonga-command.html). See also [`pgroonga_comm" "and_escape_value` function](pgroonga-command-escape-value.html) and [`pgroonga" -".query_escape` function](pgroonga-query-escape.html) for preventing Groonga co" +"_query_escape` function](pgroonga-query-escape.html) for preventing Groonga co" "mmand injection." msgstr "" -"`pgroonga.escape`関数は[`pgroonga.command`関数](pgroonga-command.html)経由でのGroongaコマ" -"ンドインジェクションが発生することを防ぐために使えます。Groongaコマンドインジェクションを防ぐことについては[`pgroonga.command_es" -"cape_value`関数](pgroonga-command-escape-value.html)と[`pgroonga.query_escape`関数]" +"`pgroonga_escape`関数は[`pgroonga_command`関数](pgroonga-command.html)経由でのGroongaコマ" +"ンドインジェクションが発生することを防ぐために使えます。Groongaコマンドインジェクションを防ぐことについては[`pgroonga_command_es" +"cape_value`関数](pgroonga-command-escape-value.html)と[`pgroonga_query_escape`関数]" "(pgroonga-query-escape.html)も見てください。" msgid "## Syntax" @@ -58,7 +58,7 @@ msgstr "この関数の構文は次の通りです。" msgid "" "```text\n" -"text pgroonga.escape(value)\n" +"text pgroonga_escape(value)\n" "```" msgstr "" @@ -100,9 +100,9 @@ msgstr "" "html)で使うリテラルです。" msgid "" -"`pgroonga.query_escape` returns a `text` type value. The value can be used as " +"`pgroonga_query_escape` returns a `text` type value. The value can be used as " "a literal in script syntax safely." -msgstr "`pgroonga.query_escape`は`text`型の値を返します。この値はスクリプト構文中でリテラルとして安全に使えます。" +msgstr "`pgroonga_query_escape`は`text`型の値を返します。この値はスクリプト構文中でリテラルとして安全に使えます。" msgid "" "If `value` is a `text` type value, you can specify characters to be escaped li" @@ -111,7 +111,7 @@ msgstr "もし`value`が`text`型の値の場合は、次のようにエスケ msgid "" "```text\n" -"text pgroonga.escape(value, special_characters)\n" +"text pgroonga_escape(value, special_characters)\n" "```" msgstr "" @@ -162,13 +162,13 @@ msgid "" "```" msgstr "" -msgid "You can use `pgroonga.escape` function for it:" -msgstr "この用途に`pgroonga.escape`関数を使えます。" +msgid "You can use `pgroonga_escape` function for it:" +msgstr "この用途に`pgroonga_escape`関数を使えます。" msgid "" "```sql\n" "SELECT * FROM logs\n" -" WHERE message @@ ('string @ ' || pgroonga.escape('\"index.html\" not found'));\n" +" WHERE message @@ ('string @ ' || pgroonga_escape('\"index.html\" not found'));\n" "-- message \n" "-- --------------------------------------\n" "-- {\"body\": \"\\\"index.html\\\" not found\"}\n" @@ -177,20 +177,20 @@ msgid "" msgstr "" msgid "" -"`pgroonga.escape` function is also useful with [`pgroonga.command` function](p" +"`pgroonga_escape` function is also useful with [`pgroonga_command` function](p" "groonga-command.html):" msgstr "" -"`pgroonga.escape`関数は[`pgroonga.command`関数](pgroonga-command.html)と組み合わせたときも便利で" +"`pgroonga_escape`関数は[`pgroonga_command`関数](pgroonga-command.html)と組み合わせたときも便利で" "す。" msgid "" "```sql\n" "SELECT jsonb_pretty(\n" -" pgroonga.command('select',\n" +" pgroonga_command('select',\n" " ARRAY[\n" -" 'table', pgroonga.table_name('pgroonga_logs_index'),\n" +" 'table', pgroonga_table_name('pgroonga_logs_index'),\n" " 'output_columns', 'message.string',\n" -" 'filter', 'message.string @ ' || pgroonga.escape('\"index." +" 'filter', 'message.string @ ' || pgroonga_escape('\"index." "html\" not found')\n" " ])::jsonb\n" ");\n" @@ -227,18 +227,18 @@ msgid "" msgstr "" msgid "" -"You can use `pgroonga.escape` function for non `text` type value such as integ" +"You can use `pgroonga_escape` function for non `text` type value such as integ" "er:" -msgstr "数値のように`text`型以外の値にも`pgroonga.escape`関数を使えます。" +msgstr "数値のように`text`型以外の値にも`pgroonga_escape`関数を使えます。" msgid "" "```sql\n" "SELECT jsonb_pretty(\n" -" pgroonga.command('select',\n" +" pgroonga_command('select',\n" " ARRAY[\n" -" 'table', pgroonga.table_name('pgroonga_logs_index'),\n" +" 'table', pgroonga_table_name('pgroonga_logs_index'),\n" " 'output_columns', '_id',\n" -" 'filter', '_id == ' || pgroonga.escape(1)\n" +" 'filter', '_id == ' || pgroonga_escape(1)\n" " ])::jsonb\n" ");\n" "-- jsonb_pretty \n" @@ -273,13 +273,11 @@ msgstr "" msgid "## See also" msgstr "## 参考" -msgid " * [`pgroonga.command` function](pgroonga-command.html)" -msgstr " * [`pgroonga.command`関数](pgroonga-command.html)" +msgid " * [`pgroonga_command` function][command]" +msgstr " * [`pgroonga_command`関数][command]" -msgid "" -" * [`pgroonga.command_escape_value` function](pgroonga-command-escape-value.h" -"tml)" -msgstr " * [`pgroonga.command_escape_value`関数](pgroonga-command-escape-value.html)" +msgid " * [`pgroonga_command_escape_value` function][command-escape-value]" +msgstr " * [`pgroonga_command_escape_value`関数][command-escape-value]" -msgid " * [`pgroonga.query_escape` function](pgroonga-query-escape.html)" -msgstr " * [`pgroonga.query_escape`関数](pgroonga-query-escape.html)" +msgid " * [`pgroonga_query_escape` function][query-escape]" +msgstr " * [`pgroonga_query_escape`関数][query-escape]" Modified: ja/reference/functions/pgroonga-escape.md (+20 -20) =================================================================== --- ja/reference/functions/pgroonga-escape.md 2017-08-16 22:36:45 +0900 (b04ce39) +++ ja/reference/functions/pgroonga-escape.md 2017-08-16 22:39:00 +0900 (d8d5ec3) @@ -1,24 +1,24 @@ --- -title: pgroonga.escape関数 +title: pgroonga_escape関数 upper_level: ../ --- -# `pgroonga.escape`関数 +# `pgroonga_escape`関数 1.1.9で追加。 ## 概要 -`pgroonga.escape`関数は渡された値を[スクリプト構文](http://groonga.org/ja/docs/reference/grn_expr/script_syntax.html)のリテラルに変換します。このリテラルはスクリプト構文内で安全に使えます。スクリプト構文は[JSONBの`@@`演算子](../operators/jsonb-query.html)などで使っています。 +`pgroonga_escape`関数は渡された値を[スクリプト構文](http://groonga.org/ja/docs/reference/grn_expr/script_syntax.html)のリテラルに変換します。このリテラルはスクリプト構文内で安全に使えます。スクリプト構文は[JSONBの`@@`演算子](../operators/jsonb-query.html)などで使っています。 -`pgroonga.escape`関数は[`pgroonga.command`関数](pgroonga-command.html)経由でのGroongaコマンドインジェクションが発生することを防ぐために使えます。Groongaコマンドインジェクションを防ぐことについては[`pgroonga.command_escape_value`関数](pgroonga-command-escape-value.html)と[`pgroonga.query_escape`関数](pgroonga-query-escape.html)も見てください。 +`pgroonga_escape`関数は[`pgroonga_command`関数](pgroonga-command.html)経由でのGroongaコマンドインジェクションが発生することを防ぐために使えます。Groongaコマンドインジェクションを防ぐことについては[`pgroonga_command_escape_value`関数](pgroonga-command-escape-value.html)と[`pgroonga_query_escape`関数](pgroonga-query-escape.html)も見てください。 ## 構文 この関数の構文は次の通りです。 ```text -text pgroonga.escape(value) +text pgroonga_escape(value) ``` `value`の型は次のどれかです。 @@ -43,12 +43,12 @@ text pgroonga.escape(value) `value`は[スクリプト構文](http://groonga.org/ja/docs/reference/grn_expr/script_syntax.html)で使うリテラルです。 -`pgroonga.query_escape`は`text`型の値を返します。この値はスクリプト構文中でリテラルとして安全に使えます。 +`pgroonga_query_escape`は`text`型の値を返します。この値はスクリプト構文中でリテラルとして安全に使えます。 もし`value`が`text`型の値の場合は、次のようにエスケープ対象の文字を0個以上指定できます。 ```text -text pgroonga.escape(value, special_characters) +text pgroonga_escape(value, special_characters) ``` `special_characters`は`text`型の値です。この値にエスケープ対象の文字をすべて含めます。「(」と「)」をエスケープしたい場合は`'()'`と指定します。 @@ -80,26 +80,26 @@ SELECT * FROM logs -- (1 row) ``` -この用途に`pgroonga.escape`関数を使えます。 +この用途に`pgroonga_escape`関数を使えます。 ```sql SELECT * FROM logs - WHERE message @@ ('string @ ' || pgroonga.escape('"index.html" not found')); + WHERE message @@ ('string @ ' || pgroonga_escape('"index.html" not found')); -- message -- -------------------------------------- -- {"body": "\"index.html\" not found"} -- (1 row) ``` -`pgroonga.escape`関数は[`pgroonga.command`関数](pgroonga-command.html)と組み合わせたときも便利です。 +`pgroonga_escape`関数は[`pgroonga_command`関数](pgroonga-command.html)と組み合わせたときも便利です。 ```sql SELECT jsonb_pretty( - pgroonga.command('select', + pgroonga_command('select', ARRAY[ - 'table', pgroonga.table_name('pgroonga_logs_index'), + 'table', pgroonga_table_name('pgroonga_logs_index'), 'output_columns', 'message.string', - 'filter', 'message.string @ ' || pgroonga.escape('"index.html" not found') + 'filter', 'message.string @ ' || pgroonga_escape('"index.html" not found') ])::jsonb ); -- jsonb_pretty @@ -133,15 +133,15 @@ SELECT jsonb_pretty( -- (1 row) ``` -数値のように`text`型以外の値にも`pgroonga.escape`関数を使えます。 +数値のように`text`型以外の値にも`pgroonga_escape`関数を使えます。 ```sql SELECT jsonb_pretty( - pgroonga.command('select', + pgroonga_command('select', ARRAY[ - 'table', pgroonga.table_name('pgroonga_logs_index'), + 'table', pgroonga_table_name('pgroonga_logs_index'), 'output_columns', '_id', - 'filter', '_id == ' || pgroonga.escape(1) + 'filter', '_id == ' || pgroonga_escape(1) ])::jsonb ); -- jsonb_pretty @@ -174,8 +174,8 @@ SELECT jsonb_pretty( ## 参考 - * [`pgroonga.command`関数](pgroonga-command.html) + * [`pgroonga_command`関数][command] - * [`pgroonga.command_escape_value`関数](pgroonga-command-escape-value.html) + * [`pgroonga_command_escape_value`関数][command-escape-value] - * [`pgroonga.query_escape`関数](pgroonga-query-escape.html) + * [`pgroonga_query_escape`関数][query-escape] Modified: reference/functions/pgroonga-escape.md (+20 -20) =================================================================== --- reference/functions/pgroonga-escape.md 2017-08-16 22:36:45 +0900 (63c7f91) +++ reference/functions/pgroonga-escape.md 2017-08-16 22:39:00 +0900 (e14976f) @@ -1,24 +1,24 @@ --- -title: pgroonga.escape function +title: pgroonga_escape function upper_level: ../ --- -# `pgroonga.escape` function +# `pgroonga_escape` function Since 1.1.9. ## Summary -`pgroonga.escape` function converts the given value to a literal for [script syntax](http://groonga.org/docs/reference/grn_expr/script_syntax.html). The literal is safely used in script syntax. Script syntax is used by [jsonb `@@` operator](../operators/jsonb-query.html) and so on. +`pgroonga_escape` function converts the given value to a literal for [script syntax](http://groonga.org/docs/reference/grn_expr/script_syntax.html). The literal is safely used in script syntax. Script syntax is used by [jsonb `@@` operator](../operators/jsonb-query.html) and so on. -`pgroonga.escape` function is useful to prevent Groonga command injection via [`pgroonga.command` function](pgroonga-command.html). See also [`pgroonga.command_escape_value` function](pgroonga-command-escape-value.html) and [`pgroonga.query_escape` function](pgroonga-query-escape.html) for preventing Groonga command injection. +`pgroonga_escape` function is useful to prevent Groonga command injection via [`pgroonga_command` function](pgroonga-command.html). See also [`pgroonga_command_escape_value` function](pgroonga-command-escape-value.html) and [`pgroonga_query_escape` function](pgroonga-query-escape.html) for preventing Groonga command injection. ## Syntax Here is the syntax of this function: ```text -text pgroonga.escape(value) +text pgroonga_escape(value) ``` `value` type is one of the following types: @@ -43,12 +43,12 @@ text pgroonga.escape(value) `value` is a literal to be used in [script syntax](http://groonga.org/docs/reference/grn_expr/script_syntax.html). -`pgroonga.query_escape` returns a `text` type value. The value can be used as a literal in script syntax safely. +`pgroonga_query_escape` returns a `text` type value. The value can be used as a literal in script syntax safely. If `value` is a `text` type value, you can specify characters to be escaped like the following: ```text -text pgroonga.escape(value, special_characters) +text pgroonga_escape(value, special_characters) ``` `special_characters` is a `text` type value. It contains all characters to be escaped. If you want to escape "(" and ")", you should specify `'()'`. @@ -80,26 +80,26 @@ SELECT * FROM logs -- (1 row) ``` -You can use `pgroonga.escape` function for it: +You can use `pgroonga_escape` function for it: ```sql SELECT * FROM logs - WHERE message @@ ('string @ ' || pgroonga.escape('"index.html" not found')); + WHERE message @@ ('string @ ' || pgroonga_escape('"index.html" not found')); -- message -- -------------------------------------- -- {"body": "\"index.html\" not found"} -- (1 row) ``` -`pgroonga.escape` function is also useful with [`pgroonga.command` function](pgroonga-command.html): +`pgroonga_escape` function is also useful with [`pgroonga_command` function](pgroonga-command.html): ```sql SELECT jsonb_pretty( - pgroonga.command('select', + pgroonga_command('select', ARRAY[ - 'table', pgroonga.table_name('pgroonga_logs_index'), + 'table', pgroonga_table_name('pgroonga_logs_index'), 'output_columns', 'message.string', - 'filter', 'message.string @ ' || pgroonga.escape('"index.html" not found') + 'filter', 'message.string @ ' || pgroonga_escape('"index.html" not found') ])::jsonb ); -- jsonb_pretty @@ -133,15 +133,15 @@ SELECT jsonb_pretty( -- (1 row) ``` -You can use `pgroonga.escape` function for non `text` type value such as integer: +You can use `pgroonga_escape` function for non `text` type value such as integer: ```sql SELECT jsonb_pretty( - pgroonga.command('select', + pgroonga_command('select', ARRAY[ - 'table', pgroonga.table_name('pgroonga_logs_index'), + 'table', pgroonga_table_name('pgroonga_logs_index'), 'output_columns', '_id', - 'filter', '_id == ' || pgroonga.escape(1) + 'filter', '_id == ' || pgroonga_escape(1) ])::jsonb ); -- jsonb_pretty @@ -174,8 +174,8 @@ SELECT jsonb_pretty( ## See also - * [`pgroonga.command` function](pgroonga-command.html) + * [`pgroonga_command` function][command] - * [`pgroonga.command_escape_value` function](pgroonga-command-escape-value.html) + * [`pgroonga_command_escape_value` function][command-escape-value] - * [`pgroonga.query_escape` function](pgroonga-query-escape.html) + * [`pgroonga_query_escape` function][query-escape] -------------- next part -------------- HTML����������������������������...ダウンロード
