Kouhei Sutou
null+****@clear*****
Wed Aug 16 22:33:35 JST 2017
Kouhei Sutou 2017-08-16 22:33:35 +0900 (Wed, 16 Aug 2017) New Revision: 94d5613692a76d8766690e1edff439a198c5b88f https://github.com/pgroonga/pgroonga.github.io/commit/94d5613692a76d8766690e1edff439a198c5b88f Message: Update for 2.0.0 Modified files: _po/ja/reference/functions/pgroonga-command-escape-value.po _po/ja/reference/index.po ja/reference/functions/pgroonga-command-escape-value.md ja/reference/index.md reference/functions/pgroonga-command-escape-value.md reference/index.md Modified: _po/ja/reference/functions/pgroonga-command-escape-value.po (+42 -36) =================================================================== --- _po/ja/reference/functions/pgroonga-command-escape-value.po 2017-08-16 22:20:32 +0900 (29625fd) +++ _po/ja/reference/functions/pgroonga-command-escape-value.po 2017-08-16 22:33:35 +0900 (9fdacc0) @@ -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:32+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.command_escape_value function\n" +"title: pgroonga_command_escape_value function\n" "upper_level: ../\n" "---" msgstr "" "---\n" -"title: pgroonga.command_escape_value関数\n" +"title: pgroonga_command_escape_value関数\n" "upper_level: ../\n" "---" -msgid "# `pgroonga.command_escape_value` function" -msgstr "# `pgroonga.command_escape_value`関数" +msgid "# `pgroonga_command_escape_value` function" +msgstr "# `pgroonga_command_escape_value`関数" msgid "Since 1.1.9." msgstr "1.1.9で追加。" @@ -29,9 +29,9 @@ msgid "## Summary" msgstr "## 概要" msgid "" -"`pgroonga.command_escape_value` function escapes special characters in \"value\"" +"`pgroonga_command_escape_value` function escapes special characters in \"value\"" " part of Groonga command format." -msgstr "`pgroonga.command_escape_value`関数はGroongaコマンドのフォーマットのうち「値」部分の特別な文字をエスケープします。" +msgstr "`pgroonga_command_escape_value`関数はGroongaコマンドのフォーマットのうち「値」部分の特別な文字をエスケープします。" msgid "Here is an example Groonga command format:" msgstr "以下はGroongaコマンドのフォーマット例です。" @@ -51,23 +51,23 @@ msgstr "" "ogs`では`table`が引数名で`Logs`が引数値です。" msgid "" -"`pgroonga.command_escape_value` function is useful to prevent Groonga command " -"injection via [`pgroonga.command` function](pgroonga-command.html). See also [" -"`pgroonga.query_escape` function](pgroonga-query-escape.html) and [`pgroonga.e" +"`pgroonga_command_escape_value` function is useful to prevent Groonga command " +"injection via [`pgroonga_command` function](pgroonga-command.html). See also [" +"`pgroonga_query_escape` function](pgroonga-query-escape.html) and [`pgroonga_e" "scape` function](pgroonga-escape.html) for preventing Groonga command injectio" "n." msgstr "" -"`pgroonga.command_escape_value`関数は[`pgroonga.command`関数](pgroonga-command.html" -")経由でのGroongaコマンドインジェクションを防ぐために使えます。Groongaコマンドインジェクションを防ぐことについては[`pgroonga.que" -"ry_escape`関数](pgroonga-query-escape.html)と[`pgroonga.escape`関数](pgroonga-escap" +"`pgroonga_command_escape_value`関数は[`pgroonga_command`関数](pgroonga-command.html" +")経由でのGroongaコマンドインジェクションを防ぐために使えます。Groongaコマンドインジェクションを防ぐことについては[`pgroonga_que" +"ry_escape`関数](pgroonga-query-escape.html)と[`pgroonga_escape`関数](pgroonga-escap" "e.html)も見てください。" msgid "" -"If you use `pgroonga.command(command, ARRAY[arguments...])` style, you don't n" +"If you use `pgroonga_command(command, ARRAY[arguments...])` style, you don't n" "eed to use this function. Because the style do the same thing of this function" " internally." msgstr "" -"`pgroonga.command(command, ARRAY[arguments...])`スタイルを使っている場合はこの関数を使う必要はありません。な" +"`pgroonga_command(command, ARRAY[arguments...])`スタイルを使っている場合はこの関数を使う必要はありません。な" "ぜなら、このスタイルではこの関数がやることと同じことを内部でやってくれるからです。" msgid "## Syntax" @@ -78,7 +78,7 @@ msgstr "この関数の構文は次の通りです。" msgid "" "```text\n" -"text pgroonga.command_escape_value(value)\n" +"text pgroonga_command_escape_value(value)\n" "```" msgstr "" @@ -86,9 +86,9 @@ msgid "`value` is a `text` type value. It's a \"value\" part of Groonga command msgstr "`value`は`text`型の値です。Groongaコマンドのフォーマットの「値」部分を指定します。" msgid "" -"`pgroonga.command_escape_value` returns a `text` type value. All special chara" +"`pgroonga_command_escape_value` returns a `text` type value. All special chara" "cters in the text are escaped." -msgstr "`pgroonga.command_escape_value`は`text`型の値を返します。この値中の特別な意味を持つ文字はすべてエスケープされています。" +msgstr "`pgroonga_command_escape_value`は`text`型の値を返します。この値中の特別な意味を持つ文字はすべてエスケープされています。" msgid "## Usage" msgstr "## 使い方" @@ -122,8 +122,8 @@ msgstr "クエリーが「(PostgreSQL」の場合はエラーが発生します msgid "" "```sql\n" "SELECT jsonb_pretty(\n" -" pgroonga.command('select ' ||\n" -" '--table ' || pgroonga.table_name('pgroonga_memos_index') |" +" pgroonga_command('select ' ||\n" +" '--table ' || pgroonga_table_name('pgroonga_memos_index') |" "| ' ' ||\n" " '--match_columns content ' ||\n" " '--query (PostgreSQL')::jsonb\n" @@ -150,20 +150,20 @@ msgid "" msgstr "" msgid "" -"`pgroonga.command_escape_value` function with [`pgroonga.query_escape` functio" +"`pgroonga_command_escape_value` function with [`pgroonga_query_escape` functio" "n](pgroonga-qurey-escape.html) can prevent the case:" msgstr "" -"`pgroonga.command_escape_value`関数を[`pgroonga.query_escape`関数](pgroonga-qurey-e" +"`pgroonga_command_escape_value`関数を[`pgroonga_query_escape`関数](pgroonga-qurey-e" "scape.html)と一緒に使うとこのケースを防げます。" msgid "" "```sql\n" "SELECT jsonb_pretty(\n" -" pgroonga.command('select ' ||\n" -" '--table ' || pgroonga.table_name('pgroonga_memos_index') |" +" pgroonga_command('select ' ||\n" +" '--table ' || pgroonga_table_name('pgroonga_memos_index') |" "| ' ' ||\n" " '--match_columns content ' ||\n" -" '--query ' || pgroonga.command_escape_value(pgroonga.query_" +" '--query ' || pgroonga_command_escape_value(pgroonga_query_" "escape('(PostgreSQL')))::jsonb\n" ");\n" "-- jsonb_pretty \n" @@ -206,20 +206,20 @@ msgid "" msgstr "" msgid "" -"You can also use arguments array style [`pgroonga.command` function](pgroonga-" +"You can also use arguments array style [`pgroonga_command` function](pgroonga-" "command.html):" msgstr "" -"コマンドの引数を配列で指定するスタイルで[`pgroonga.command`関数](pgroonga-command.html)使ってもこのケースを防ぐこ" +"コマンドの引数を配列で指定するスタイルで[`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_memos_index'),\n" +" 'table', pgroonga_table_name('pgroonga_memos_index'),\n" " 'match_columns', 'content',\n" -" 'query', pgroonga.query_escape('(PostgreSQL')\n" +" 'query', pgroonga_query_escape('(PostgreSQL')\n" " ])::jsonb\n" ");\n" "-- jsonb_pretty \n" @@ -264,11 +264,17 @@ 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.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]" -msgid " * [`pgroonga.escape` function](pgroonga-escape.html)" -msgstr " * [`pgroonga.escape`関数](pgroonga-escape.html)" +msgid " * [`pgroonga_escape` function][escape]" +msgstr " * [`pgroonga_escape`関数][escape]" + +msgid "" +"[command]:pgroonga-command.html\n" +"[query-escape]:pgroonga-query-escape.html\n" +"[escape]:pgroonga-escape.html" +msgstr "" Modified: _po/ja/reference/index.po (+39 -44) =================================================================== --- _po/ja/reference/index.po 2017-08-16 22:20:32 +0900 (5ff0d77) +++ _po/ja/reference/index.po 2017-08-16 22:33:35 +0900 (2a132d2) @@ -1,7 +1,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" -"PO-Revision-Date: 2017-08-16 22:15+0900\n" +"PO-Revision-Date: 2017-08-16 22:33+0900\n" "Language: ja\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -467,59 +467,41 @@ msgstr " * 1.2.1から非推奨です。代わりに[`` &` ``演算子][scrip msgid "## Functions" msgstr "## 関数" -msgid " * [`pgroonga_command` function](functions/pgroonga-command.html)" -msgstr " * [`pgroonga_command`関数](functions/pgroonga-command.html)" +msgid " * [`pgroonga_command` function][command]" +msgstr " * [`pgroonga_command`関数][command]" -msgid "" -" * [`pgroonga_command_escape_value` function](functions/pgroonga-command-esca" -"pe-value.html)" -msgstr "" -" * [`pgroonga_command_escape_value`関数](functions/pgroonga-command-escape-valu" -"e.html)" +msgid " * [`pgroonga_command_escape_value` function][command-escape-value]" +msgstr " * [`pgroonga_command_escape_value`関数][command-escape-value]" -msgid " * [`pgroonga_escape` function](functions/pgroonga-escape.html)" -msgstr " * [`pgroonga_escape`関数](functions/pgroonga-escape.html)" +msgid " * [`pgroonga_escape` function][escape]" +msgstr " * [`pgroonga_escape`関数][escape]" -msgid " * [`pgroonga_flush` function](functions/pgroonga-flush.html)" -msgstr " * [`pgroonga_flush`関数](functions/pgroonga-flush.html)" +msgid " * [`pgroonga_flush` function][flush]" +msgstr " * [`pgroonga_flush`関数][flush]" -msgid "" -" * [`pgroonga_highlight_html` function](functions/pgroonga-highlight-html.htm" -"l)" -msgstr " * [`pgroonga_highlight_html`関数](functions/pgroonga-highlight-html.html)" +msgid " * [`pgroonga_highlight_html` function][highlight-html]" +msgstr " * [`pgroonga_highlight_html`関数][highlight-html]" -msgid "" -" * [`pgroonga_match_positions_byte` function](functions/pgroonga-match-positi" -"ons-byte.html)" -msgstr "" -" * [`pgroonga_match_positions_byte`関数](functions/pgroonga-match-positions-byt" -"e.html)" +msgid " * [`pgroonga_match_positions_byte` function][match-positions-byte]" +msgstr " * [`pgroonga_match_positions_byte`関数][match-positions-byte]" -msgid "" -" * [`pgroonga_match_positions_character` function](functions/pgroonga-match-p" -"ositions-character.html)" -msgstr "" -" * [`pgroonga_match_positions_character`関数](functions/pgroonga-match-position" -"s-character.html)" +msgid " * [`pgroonga_match_positions_character` function][match-positions-character]" +msgstr " * [`pgroonga_match_positions_character`関数][match-positions-character]" -msgid " * [`pgroonga_query_escape` function](functions/pgroonga-query-escape.html)" -msgstr " * [`pgroonga_query_escape`関数](functions/pgroonga-query-escape.html)" +msgid " * [`pgroonga_query_escape` function][query-escape]" +msgstr " * [`pgroonga_query_escape`関数][query-escape]" -msgid "" -" * [`pgroonga_query_extract_keywords` function](functions/pgroonga-query-extr" -"act-keywords.html)" -msgstr "" -" * [`pgroonga_query_extract_keywords`関数](functions/pgroonga-query-extract-key" -"words.html)" +msgid " * [`pgroonga_query_extract_keywords` function][query-extract-keywords]" +msgstr " * [`pgroonga_query_extract_keywords`関数][query-extract-keywords]" -msgid " * [`pgroonga_score` function](functions/pgroonga-score.html)" -msgstr " * [`pgroonga_score`関数](functions/pgroonga-score.html)" +msgid " * [`pgroonga_score` function][score]" +msgstr " * [`pgroonga_score`関数][score]" -msgid " * [`pgroonga_snippet_html` function](functions/pgroonga-snippet-html.html)" -msgstr " * [`pgroonga_snippet_html`関数](functions/pgroonga-snippet-html.html)" +msgid " * [`pgroonga_snippet_html` function][snippet-html]" +msgstr " * [`pgroonga_snippet_html`関数][snippet-html]" -msgid " * [`pgroonga_table_name` function](functions/pgroonga-table-name.html)" -msgstr " * [`pgroonga_table_name`関数](functions/pgroonga-table-name.html)" +msgid " * [`pgroonga_table_name` function][table-name]" +msgstr " * [`pgroonga_table_name`関数][table-name]" msgid " * [`pgroonga_query_expand` function][query-expand]" msgstr " * [`pgroonga_query_expand`関数][query-expand]" @@ -633,5 +615,18 @@ msgstr "" msgid "[upgrade-incompatible]:../upgrade/#incompatible-case" msgstr "" -msgid "[query-expand]:functions/pgroonga-query-expand.html" +msgid "" +"[command]:functions/pgroonga-command.html\n" +"[command-escape-value]:functions/pgroonga-command-escape-value.html)\n" +"[escape]:functions/pgroonga-escape.html\n" +"[flush]:functions/pgroonga-flush.html\n" +"[highlight-html]:functions/pgroonga-highlight-html.html\n" +"[match-positions-byte]:functions/pgroonga-match-positions-byte.html\n" +"[match-positions-character]:functions/pgroonga-match-positions-character.html\n" +"[query-escape]:functions/pgroonga-query-escape.html\n" +"[query-extract-keywords]:functions/pgroonga-query-extract-keywords.html\n" +"[score]:functions/pgroonga-score.html\n" +"[snippet-html]:functions/pgroonga-snippet-html.html\n" +"[table-name]:functions/pgroonga-table-name.html\n" +"[query-expand]:functions/pgroonga-query-expand.html" msgstr "" Modified: ja/reference/functions/pgroonga-command-escape-value.md (+24 -20) =================================================================== --- ja/reference/functions/pgroonga-command-escape-value.md 2017-08-16 22:20:32 +0900 (f8dce4b) +++ ja/reference/functions/pgroonga-command-escape-value.md 2017-08-16 22:33:35 +0900 (d08e0b3) @@ -1,15 +1,15 @@ --- -title: pgroonga.command_escape_value関数 +title: pgroonga_command_escape_value関数 upper_level: ../ --- -# `pgroonga.command_escape_value`関数 +# `pgroonga_command_escape_value`関数 1.1.9で追加。 ## 概要 -`pgroonga.command_escape_value`関数はGroongaコマンドのフォーマットのうち「値」部分の特別な文字をエスケープします。 +`pgroonga_command_escape_value`関数はGroongaコマンドのフォーマットのうち「値」部分の特別な文字をエスケープします。 以下はGroongaコマンドのフォーマット例です。 @@ -19,21 +19,21 @@ select --table Logs --match_columns message --query Error `select`はコマンド名です。`--XXX YYY`は引数の名前と値です。`XXX`は引数名です。`YYY`は引数値です。たとえば、`--table Logs`では`table`が引数名で`Logs`が引数値です。 -`pgroonga.command_escape_value`関数は[`pgroonga.command`関数](pgroonga-command.html)経由でのGroongaコマンドインジェクションを防ぐために使えます。Groongaコマンドインジェクションを防ぐことについては[`pgroonga.query_escape`関数](pgroonga-query-escape.html)と[`pgroonga.escape`関数](pgroonga-escape.html)も見てください。 +`pgroonga_command_escape_value`関数は[`pgroonga_command`関数](pgroonga-command.html)経由でのGroongaコマンドインジェクションを防ぐために使えます。Groongaコマンドインジェクションを防ぐことについては[`pgroonga_query_escape`関数](pgroonga-query-escape.html)と[`pgroonga_escape`関数](pgroonga-escape.html)も見てください。 -`pgroonga.command(command, ARRAY[arguments...])`スタイルを使っている場合はこの関数を使う必要はありません。なぜなら、このスタイルではこの関数がやることと同じことを内部でやってくれるからです。 +`pgroonga_command(command, ARRAY[arguments...])`スタイルを使っている場合はこの関数を使う必要はありません。なぜなら、このスタイルではこの関数がやることと同じことを内部でやってくれるからです。 ## 構文 この関数の構文は次の通りです。 ```text -text pgroonga.command_escape_value(value) +text pgroonga_command_escape_value(value) ``` `value`は`text`型の値です。Groongaコマンドのフォーマットの「値」部分を指定します。 -`pgroonga.command_escape_value`は`text`型の値を返します。この値中の特別な意味を持つ文字はすべてエスケープされています。 +`pgroonga_command_escape_value`は`text`型の値を返します。この値中の特別な意味を持つ文字はすべてエスケープされています。 ## 使い方 @@ -55,8 +55,8 @@ INSERT INTO memos VALUES ('PGroonga (PostgreSQL+Groonga) is great!'); ```sql SELECT jsonb_pretty( - pgroonga.command('select ' || - '--table ' || pgroonga.table_name('pgroonga_memos_index') || ' ' || + pgroonga_command('select ' || + '--table ' || pgroonga_table_name('pgroonga_memos_index') || ' ' || '--match_columns content ' || '--query (PostgreSQL')::jsonb ); @@ -80,14 +80,14 @@ SELECT jsonb_pretty( -- (1 row) ``` -`pgroonga.command_escape_value`関数を[`pgroonga.query_escape`関数](pgroonga-qurey-escape.html)と一緒に使うとこのケースを防げます。 +`pgroonga_command_escape_value`関数を[`pgroonga_query_escape`関数](pgroonga-qurey-escape.html)と一緒に使うとこのケースを防げます。 ```sql SELECT jsonb_pretty( - pgroonga.command('select ' || - '--table ' || pgroonga.table_name('pgroonga_memos_index') || ' ' || + pgroonga_command('select ' || + '--table ' || pgroonga_table_name('pgroonga_memos_index') || ' ' || '--match_columns content ' || - '--query ' || pgroonga.command_escape_value(pgroonga.query_escape('(PostgreSQL')))::jsonb + '--query ' || pgroonga_command_escape_value(pgroonga_query_escape('(PostgreSQL')))::jsonb ); -- jsonb_pretty -- ------------------------------------------------------------ @@ -127,15 +127,15 @@ SELECT jsonb_pretty( -- (1 row) ``` -コマンドの引数を配列で指定するスタイルで[`pgroonga.command`関数](pgroonga-command.html)使ってもこのケースを防ぐことができます。 +コマンドの引数を配列で指定するスタイルで[`pgroonga_command`関数](pgroonga-command.html)使ってもこのケースを防ぐことができます。 ```sql SELECT jsonb_pretty( - pgroonga.command('select', + pgroonga_command('select', ARRAY[ - 'table', pgroonga.table_name('pgroonga_memos_index'), + 'table', pgroonga_table_name('pgroonga_memos_index'), 'match_columns', 'content', - 'query', pgroonga.query_escape('(PostgreSQL') + 'query', pgroonga_query_escape('(PostgreSQL') ])::jsonb ); -- jsonb_pretty @@ -178,8 +178,12 @@ SELECT jsonb_pretty( ## 参考 - * [`pgroonga.command`関数](pgroonga-command.html) + * [`pgroonga_command`関数][command] - * [`pgroonga.query_escape`関数](pgroonga-query-escape.html) + * [`pgroonga_query_escape`関数][query-escape] - * [`pgroonga.escape`関数](pgroonga-escape.html) + * [`pgroonga_escape`関数][escape] + +[command]:pgroonga-command.html +[query-escape]:pgroonga-query-escape.html +[escape]:pgroonga-escape.html Modified: ja/reference/index.md (+24 -12) =================================================================== --- ja/reference/index.md 2017-08-16 22:20:32 +0900 (c3175f8) +++ ja/reference/index.md 2017-08-16 22:33:35 +0900 (06212a6) @@ -468,29 +468,29 @@ PGroongaは`pgroonga`スキーマに関数・演算子・演算子クラスな ## 関数 - * [`pgroonga_command`関数](functions/pgroonga-command.html) + * [`pgroonga_command`関数][command] - * [`pgroonga_command_escape_value`関数](functions/pgroonga-command-escape-value.html) + * [`pgroonga_command_escape_value`関数][command-escape-value] - * [`pgroonga_escape`関数](functions/pgroonga-escape.html) + * [`pgroonga_escape`関数][escape] - * [`pgroonga_flush`関数](functions/pgroonga-flush.html) + * [`pgroonga_flush`関数][flush] - * [`pgroonga_highlight_html`関数](functions/pgroonga-highlight-html.html) + * [`pgroonga_highlight_html`関数][highlight-html] - * [`pgroonga_match_positions_byte`関数](functions/pgroonga-match-positions-byte.html) + * [`pgroonga_match_positions_byte`関数][match-positions-byte] - * [`pgroonga_match_positions_character`関数](functions/pgroonga-match-positions-character.html) + * [`pgroonga_match_positions_character`関数][match-positions-character] - * [`pgroonga_query_escape`関数](functions/pgroonga-query-escape.html) + * [`pgroonga_query_escape`関数][query-escape] - * [`pgroonga_query_extract_keywords`関数](functions/pgroonga-query-extract-keywords.html) + * [`pgroonga_query_extract_keywords`関数][query-extract-keywords] - * [`pgroonga_score`関数](functions/pgroonga-score.html) + * [`pgroonga_score`関数][score] - * [`pgroonga_snippet_html`関数](functions/pgroonga-snippet-html.html) + * [`pgroonga_snippet_html`関数][snippet-html] - * [`pgroonga_table_name`関数](functions/pgroonga-table-name.html) + * [`pgroonga_table_name`関数][table-name] * [`pgroonga_query_expand`関数][query-expand] @@ -558,4 +558,16 @@ PGroongaは`pgroonga`スキーマに関数・演算子・演算子クラスな [upgrade-incompatible]:../upgrade/#incompatible-case +[command]:functions/pgroonga-command.html +[command-escape-value]:functions/pgroonga-command-escape-value.html) +[escape]:functions/pgroonga-escape.html +[flush]:functions/pgroonga-flush.html +[highlight-html]:functions/pgroonga-highlight-html.html +[match-positions-byte]:functions/pgroonga-match-positions-byte.html +[match-positions-character]:functions/pgroonga-match-positions-character.html +[query-escape]:functions/pgroonga-query-escape.html +[query-extract-keywords]:functions/pgroonga-query-extract-keywords.html +[score]:functions/pgroonga-score.html +[snippet-html]:functions/pgroonga-snippet-html.html +[table-name]:functions/pgroonga-table-name.html [query-expand]:functions/pgroonga-query-expand.html Modified: reference/functions/pgroonga-command-escape-value.md (+24 -20) =================================================================== --- reference/functions/pgroonga-command-escape-value.md 2017-08-16 22:20:32 +0900 (d72f26f) +++ reference/functions/pgroonga-command-escape-value.md 2017-08-16 22:33:35 +0900 (149e51f) @@ -1,15 +1,15 @@ --- -title: pgroonga.command_escape_value function +title: pgroonga_command_escape_value function upper_level: ../ --- -# `pgroonga.command_escape_value` function +# `pgroonga_command_escape_value` function Since 1.1.9. ## Summary -`pgroonga.command_escape_value` function escapes special characters in "value" part of Groonga command format. +`pgroonga_command_escape_value` function escapes special characters in "value" part of Groonga command format. Here is an example Groonga command format: @@ -19,21 +19,21 @@ select --table Logs --match_columns message --query Error `select` is the command name. `--XXX YYY` is argument name and value. `XXX` is argument name. `YYY` is argument value. For example `table` is argument name and `Logs` is argument value in `--table Logs`. -`pgroonga.command_escape_value` function is useful to prevent Groonga command injection via [`pgroonga.command` function](pgroonga-command.html). See also [`pgroonga.query_escape` function](pgroonga-query-escape.html) and [`pgroonga.escape` function](pgroonga-escape.html) for preventing Groonga command injection. +`pgroonga_command_escape_value` function is useful to prevent Groonga command injection via [`pgroonga_command` function](pgroonga-command.html). See also [`pgroonga_query_escape` function](pgroonga-query-escape.html) and [`pgroonga_escape` function](pgroonga-escape.html) for preventing Groonga command injection. -If you use `pgroonga.command(command, ARRAY[arguments...])` style, you don't need to use this function. Because the style do the same thing of this function internally. +If you use `pgroonga_command(command, ARRAY[arguments...])` style, you don't need to use this function. Because the style do the same thing of this function internally. ## Syntax Here is the syntax of this function: ```text -text pgroonga.command_escape_value(value) +text pgroonga_command_escape_value(value) ``` `value` is a `text` type value. It's a "value" part of Groonga command format. -`pgroonga.command_escape_value` returns a `text` type value. All special characters in the text are escaped. +`pgroonga_command_escape_value` returns a `text` type value. All special characters in the text are escaped. ## Usage @@ -55,8 +55,8 @@ You get an error with the query "(PostgreSQL" because "(" is a special character ```sql SELECT jsonb_pretty( - pgroonga.command('select ' || - '--table ' || pgroonga.table_name('pgroonga_memos_index') || ' ' || + pgroonga_command('select ' || + '--table ' || pgroonga_table_name('pgroonga_memos_index') || ' ' || '--match_columns content ' || '--query (PostgreSQL')::jsonb ); @@ -80,14 +80,14 @@ SELECT jsonb_pretty( -- (1 row) ``` -`pgroonga.command_escape_value` function with [`pgroonga.query_escape` function](pgroonga-qurey-escape.html) can prevent the case: +`pgroonga_command_escape_value` function with [`pgroonga_query_escape` function](pgroonga-qurey-escape.html) can prevent the case: ```sql SELECT jsonb_pretty( - pgroonga.command('select ' || - '--table ' || pgroonga.table_name('pgroonga_memos_index') || ' ' || + pgroonga_command('select ' || + '--table ' || pgroonga_table_name('pgroonga_memos_index') || ' ' || '--match_columns content ' || - '--query ' || pgroonga.command_escape_value(pgroonga.query_escape('(PostgreSQL')))::jsonb + '--query ' || pgroonga_command_escape_value(pgroonga_query_escape('(PostgreSQL')))::jsonb ); -- jsonb_pretty -- ------------------------------------------------------------ @@ -127,15 +127,15 @@ SELECT jsonb_pretty( -- (1 row) ``` -You can also use arguments array style [`pgroonga.command` function](pgroonga-command.html): +You can also use arguments array style [`pgroonga_command` function](pgroonga-command.html): ```sql SELECT jsonb_pretty( - pgroonga.command('select', + pgroonga_command('select', ARRAY[ - 'table', pgroonga.table_name('pgroonga_memos_index'), + 'table', pgroonga_table_name('pgroonga_memos_index'), 'match_columns', 'content', - 'query', pgroonga.query_escape('(PostgreSQL') + 'query', pgroonga_query_escape('(PostgreSQL') ])::jsonb ); -- jsonb_pretty @@ -178,8 +178,12 @@ SELECT jsonb_pretty( ## See also - * [`pgroonga.command` function](pgroonga-command.html) + * [`pgroonga_command` function][command] - * [`pgroonga.query_escape` function](pgroonga-query-escape.html) + * [`pgroonga_query_escape` function][query-escape] - * [`pgroonga.escape` function](pgroonga-escape.html) + * [`pgroonga_escape` function][escape] + +[command]:pgroonga-command.html +[query-escape]:pgroonga-query-escape.html +[escape]:pgroonga-escape.html Modified: reference/index.md (+24 -12) =================================================================== --- reference/index.md 2017-08-16 22:20:32 +0900 (35bada5) +++ reference/index.md 2017-08-16 22:33:35 +0900 (4886e05) @@ -468,29 +468,29 @@ Use [`pgroonga_jsonb_ops_v2` operator class](#text-jsonb-ops-v2) instead. ## Functions - * [`pgroonga_command` function](functions/pgroonga-command.html) + * [`pgroonga_command` function][command] - * [`pgroonga_command_escape_value` function](functions/pgroonga-command-escape-value.html) + * [`pgroonga_command_escape_value` function][command-escape-value] - * [`pgroonga_escape` function](functions/pgroonga-escape.html) + * [`pgroonga_escape` function][escape] - * [`pgroonga_flush` function](functions/pgroonga-flush.html) + * [`pgroonga_flush` function][flush] - * [`pgroonga_highlight_html` function](functions/pgroonga-highlight-html.html) + * [`pgroonga_highlight_html` function][highlight-html] - * [`pgroonga_match_positions_byte` function](functions/pgroonga-match-positions-byte.html) + * [`pgroonga_match_positions_byte` function][match-positions-byte] - * [`pgroonga_match_positions_character` function](functions/pgroonga-match-positions-character.html) + * [`pgroonga_match_positions_character` function][match-positions-character] - * [`pgroonga_query_escape` function](functions/pgroonga-query-escape.html) + * [`pgroonga_query_escape` function][query-escape] - * [`pgroonga_query_extract_keywords` function](functions/pgroonga-query-extract-keywords.html) + * [`pgroonga_query_extract_keywords` function][query-extract-keywords] - * [`pgroonga_score` function](functions/pgroonga-score.html) + * [`pgroonga_score` function][score] - * [`pgroonga_snippet_html` function](functions/pgroonga-snippet-html.html) + * [`pgroonga_snippet_html` function][snippet-html] - * [`pgroonga_table_name` function](functions/pgroonga-table-name.html) + * [`pgroonga_table_name` function][table-name] * [`pgroonga_query_expand` function][query-expand] @@ -557,4 +557,16 @@ But you need to tune PGroonga in some cases such as a case that you need to hand [upgrade-incompatible]:../upgrade/#incompatible-case +[command]:functions/pgroonga-command.html +[command-escape-value]:functions/pgroonga-command-escape-value.html) +[escape]:functions/pgroonga-escape.html +[flush]:functions/pgroonga-flush.html +[highlight-html]:functions/pgroonga-highlight-html.html +[match-positions-byte]:functions/pgroonga-match-positions-byte.html +[match-positions-character]:functions/pgroonga-match-positions-character.html +[query-escape]:functions/pgroonga-query-escape.html +[query-extract-keywords]:functions/pgroonga-query-extract-keywords.html +[score]:functions/pgroonga-score.html +[snippet-html]:functions/pgroonga-snippet-html.html +[table-name]:functions/pgroonga-table-name.html [query-expand]:functions/pgroonga-query-expand.html -------------- next part -------------- HTML����������������������������...Download