これはPGroonga 2.X and 3.X用のドキュメントです。古いPGroongaを使っているならPGroonga 1.xのドキュメントを見てください。

チュートリアル

このドキュメントはPGroongaの使い方を段階を追って説明します。まだPGroongaをインストールしていない場合は、このドキュメントを読む前にPGroongaをインストールしてください。

PGroongaは高速な全文検索インデックスを提供します。さらに、等価条件（=）・比較条件（<や>=など）用の一般的なインデックスも提供します。

PostgreSQLは組み込みのインデックスとしてGiSTとGINを提供しています。PGroongaはGiST・GINの代わりに使うことができます。PGroongaとGiST・GINの違いはPGroonga対GiST・GINを参照してください。

このドキュメントは次のことを説明します。

PGroongaを全文検索用インデックスとして使う方法
PGroongaを正規表現用インデックスとして使う方法
PGroongaを類似文書用インデックスとして使う方法
PGroongaを等価条件・比較条件用インデックスとして使う方法
PGroongaを配列用インデックスとして使う方法
PGroongaをJSON用インデックスとして使う方法
PGroongaをオートコンプリート用インデックスとして使う方法
PGroonga経由でGroongaを使う方法（高度な話題）

全文検索

このセクションでは次のことを説明します。

PGroongaベースの全文検索システムの準備方法
全文検索用の演算子
スコアー

PGroongaベースの全文検索システムの準備方法

このセクションはPGroongaベースの全文検索システムの準備方法を説明します。

全文検索をしたいカラムをtext型のカラムとして作ります。

CREATE TABLE memos (
  id integer,
  content text
);

memos.contentカラムが全文検索対象のカラムです。

このカラムに対してpgroongaインデックスを作ります。

CREATE EXTENSION IF NOT EXISTS pgroonga;
CREATE INDEX pgroonga_content_index ON memos USING pgroonga (content);

詳細はCREATE INDEX USING pgroongaを参照してください。

テストデータを挿入します。

INSERT INTO memos VALUES (1, 'PostgreSQLはリレーショナル・データベース管理システムです。');
INSERT INTO memos VALUES (2, 'Groongaは日本語対応の高速な全文検索エンジンです。');
INSERT INTO memos VALUES (3, 'PGroongaはインデックスとしてGroongaを使うためのPostgreSQLの拡張機能です。');
INSERT INTO memos VALUES (4, 'groongaコマンドがあります。');

確実にpgroongaインデックスを使うためにシーケンシャルスキャンを無効にします。

SET enable_seqscan = off;

注意：本番環境ではシーケンシャルスキャンを無効にするべきではありません。これはテスト用の設定です。

全文検索用演算子

全文検索をする場合は次の演算子を使います。

&@
&@~
LIKE
ILIKE

`&@`演算子

1つのキーワードで全文検索をする場合は&@演算子を使います。

SELECT * FROM memos WHERE content &@ '全文検索';
--  id |                      content                      
-- ----+---------------------------------------------------
--   2 | Groongaは日本語対応の高速な全文検索エンジンです。
-- (1 row)

詳細は&@演算子を参照してください。

`&@~`演算子

キーワード1 OR キーワード2というようなクエリー構文を使って全文検索をする場合は&@~演算子を使えます。

SELECT * FROM memos WHERE content &@~ 'PGroonga OR PostgreSQL';
--  id |                                  content
-- ----+---------------------------------------------------------------------------
--   3 | PGroongaはインデックスとしてGroongaを使うためのPostgreSQLの拡張機能です。
--   1 | PostgreSQLはリレーショナル・データベース管理システムです。
-- (2 rows)

クエリーの構文はWeb検索エンジンで使われている構文と似ています。( keyword1 OR keyword2はOR検索で、keyword1 keyword2はAND 検索です) たとえば、ORを使うと複数のキーワードでの全文検索結果をマージできます。上の例ではマージされた結果が返ってきています。PGroongaまたはPostgreSQLを含むレコードがマージされた結果になります。

クエリー構文の詳細はGroongaのドキュメントを参照してください。

詳細は&@~演算子を参照してください。

`LIKE`演算子

PGroongaはLIKE演算子をサポートしています。既存のSQLを変更しなくてもPGroongaを使った高速な全文検索を実現できます。

column LIKE '%キーワード%'はcolumn &@ 'キーワード'とほぼ同じです。

SELECT * FROM memos WHERE content LIKE '%全文検索%';
--  id |                      content
-- ----+---------------------------------------------------
--   2 | Groongaは日本語対応の高速な全文検索エンジンです。
-- (1 row)

LIKE演算子のサポートは既存のアプリケーションを変更せずに性能を改善できるので便利です。しかし、LIKE演算子は&@よりも遅いです。なぜなら、LIKE演算子はインデックスを使った検索のあとにシーケンシャルサーチする必要があるからです。この処理は「recheck」と呼ばれています。より性能を出すためにアプリケーション中のLIKEを&@または&@~に変更することをオススメします。

詳細はLIKE演算子を参照してください。

LIKE演算子のようにILIKE演算子を使うこともできます。

スコアー

pgroonga_score関数を使うとマッチした度合いを数値で取得することができます。検索したクエリーに対してよりマッチしているレコードほど高い数値になります。

以下はインデックス対象のカラムにプライマリーキーが入っているスキーマの例です。

CREATE TABLE score_memos (
  id integer PRIMARY KEY,
  content text
);

CREATE INDEX pgroonga_score_memos_content_index
          ON score_memos
       USING pgroonga (content);

テストデータを挿入します。

INSERT INTO score_memos VALUES (1, 'PostgreSQLはリレーショナル・データベース管理システムです。');
INSERT INTO score_memos VALUES (2, 'Groongaは日本語対応の高速な全文検索エンジンです。');
INSERT INTO score_memos VALUES (3, 'PGroongaはインデックスとしてGroongaを使うためのPostgreSQLの拡張機能です。');
INSERT INTO score_memos VALUES (4, 'groongaコマンドがあります。');

確実にpgroongaインデックスを使うためにシーケンシャルスキャンを無効にします。

SET enable_seqscan = off;

全文検索を実行してスコアーを取得します。

SELECT *, pgroonga_score(tableoid, ctid) AS score
  FROM score_memos
 WHERE content &@ 'PGroonga' OR content &@ 'PostgreSQL';
--  id |                                  content                                  | score 
-- ----+---------------------------------------------------------------------------+-------
--   1 | PostgreSQLはリレーショナル・データベース管理システムです。                |     1
--   3 | PGroongaはインデックスとしてGroongaを使うためのPostgreSQLの拡張機能です。 |     2
-- (2 rows)

ORDER BY節でpgroonga_score関数を使うことでスコアー順にマッチしたレコードをソートできます。

SELECT *, pgroonga_score(tableoid, ctid) AS score
  FROM score_memos
 WHERE content &@ 'PGroonga' OR content &@ 'PostgreSQL'
 ORDER BY pgroonga_score(tableoid, ctid) DESC;
--  id |                                  content                                  | score 
-- ----+---------------------------------------------------------------------------+-------
--   3 | PGroongaはインデックスとしてGroongaを使うためのPostgreSQLの拡張機能です。 |     2
--   1 | PostgreSQLはリレーショナル・データベース管理システムです。                |     1
-- (2 rows)

マッチした度合いの計算方法など詳細はpgroonga_score関数を参照してください。

ハイライト

pgroonga_highlight_html 関数を使うことで検索結果の中身を手軽に検索キーワードでハイライトすることができます。

サンプルスキーマは以下の通りです:

-- PGroonga Extensionが既にあるかをチェックし、無ければ追加
CREATE EXTENSION IF NOT EXISTS pgroonga;

-- サンプルテーブル作成
CREATE TABLE sample_texts (
  id integer PRIMARY KEY,
  content text
);

CREATE INDEX pgroonga_sample_content_index
          ON sample_texts
       USING pgroonga (content);

サンプルデータを挿入します。

INSERT INTO sample_texts VALUES (1, 'PostgreSQL is a relational database management system.');
INSERT INTO sample_texts VALUES (2, 'Groonga is a fast full text search engine that supports all languages.');
INSERT INTO sample_texts VALUES (3, 'PGroonga is a PostgreSQL extension that uses Groonga as index.');
INSERT INTO sample_texts VALUES (4, 'There is groonga command.');

全文検索を実施し、検索キーワード（この例では’PostgreSQL’と’database’ですね）をハイライト表示させます。

SELECT
	pgroonga_highlight_html (content,
		pgroonga_query_extract_keywords ('PostgreSQL database')) AS highlighted_content
FROM
	sample_texts
WHERE
	CONTENT &@~ 'PostgreSQL database';
 
--                                                highlighted_content                                                
-- ------------------------------------------------------------------------------------------------------------------
--  <span class="keyword">PostgreSQL</span> is a relational <span class="keyword">database</span> management system.
-- (1 row)

詳細は pgroonga_highlight_html 関数と pgroonga_query_extract_keywords 関数を参照してください。

スニペット（KWIC、keyword in context）

pgroonga_snippet_html関数を使うと検索対象のテキストからキーワード周辺のテキストを抽出できます。この処理をKWIC（keyword in context）とも言います。Webの検索エンジンの検索結果でみたことがある人も多いでしょう。

説明用のサンプルテキストは次の通りです。なお、これはGroongaの説明文です。

Groonga is a fast and accurate full text search engine based on inverted index. One of the characteristics of Groonga is that a newly registered document instantly appears in search results. Also, Groonga allows updates without read locks. These characteristics result in superior performance on real-time applications.

この中にはfastというキーワードがいくつか出現しています。pgroonga_snippet_htmlはfast周辺のテキストを抽出します。抽出されたテキスト内のキーワードは<span class="keyword">と</span>で囲まれています。

pgroonga_snippet_htmlという関数名の中のhtmlは、この関数はHTML出力用の結果を返す、という意味です。

上述のテキストに対してpgroonga_snippet_htmlを実行した結果は次の通りです。

Groonga is a fast and accurate full text search engine based on inverted index. One of the characteristics of Groonga is that a newly registered document instantly appears in search results. Also, Gro

この関数はすべてのテキストに対して使うことができます。PGroongaでの検索結果以外にも使えるということです。

この挙動を説明するサンプルSQLは次の通りです。FROMがない次のSELECTでもこの関数を使えます。unnestは配列を列に変換するPostgreSQLの関数であることに注意してください。

SELECT unnest(pgroonga_snippet_html(
  'Groonga is a fast and accurate full text search engine based on ' ||
  'inverted index. One of the characteristics of Groonga is that a ' ||
  'newly registered document instantly appears in search results. ' ||
  'Also, Groonga allows updates without read locks. These characteristics ' ||
  'result in superior performance on real-time applications.' ||
  '\n' ||
  '\n' ||
  'Groonga is also a column-oriented database management system (DBMS). ' ||
  'Compared with well-known row-oriented systems, such as MySQL and ' ||
  'PostgreSQL, column-oriented systems are more suited for aggregate ' ||
  'queries. Due to this advantage, Groonga can cover weakness of ' ||
  'row-oriented systems.',
  ARRAY['fast', 'PostgreSQL']));
                                                                                 --                                unnest                                                                                                                 
-- ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--  Groonga is a <span class="keyword">fast</span> and accurate full text search engine based on inverted index. One of the characteristics of Groonga is that a newly registered document instantly appears in search results. Also, Gro
--  ase management system (DBMS). Compared with well-known row-oriented systems, such as MySQL and <span class="keyword">PostgreSQL</span>, column-oriented systems are more suited for aggregate queries. Due to this advantage, Groonga
-- (2 rows)

詳細はpgroonga_snippet_html関数を参照してください。

同義語

詳細は同義語展開の使い方を参照してください。

正規表現

TODO

詳細は&~演算子を参照してください。

類似文書検索

TODO

詳細は&@*演算子を参照してください。

等価条件と比較条件

等価条件と比較条件にもPGroongaを使うことができます。この使い方をする場合、文字列型と他の型でインデックスの作り方が異なります。条件の書き方は文字列型でも他の型でも違いはありません。

このセクションでは次のことを説明します。

文字列型以外の型に対してPGroongaを使う方法
文字列型に対してPGroongaを使う方法

文字列型以外の型に対してPGroongaを使う方法

数値型のように文字列型以外の型にPGroongaを使うことができます。対象の型に対して等価条件と比較条件を使うことができます。

USING pgroonga付きでインデックスを作成します。

CREATE TABLE ids (
  id integer
);

CREATE INDEX pgroonga_id_index ON ids USING pgroonga (id);

PGroongaを使うために必要になる特別なSQLの書き方はCREATE INDEXの書き方だけです。PGroongaを使うときはBツリーのインデックスを使うときのSQLと同じSQLを使えます。

テストデータを挿入します。

INSERT INTO ids VALUES (1);
INSERT INTO ids VALUES (2);
INSERT INTO ids VALUES (3);

シーケンシャルスキャンを無効にします。

SET enable_seqscan = off;

検索します。

SELECT * FROM ids WHERE id <= 2;
--  id
-- ----
--   1
--   2
-- (2 rows)

文字列型に対してPGroongaを使う方法

文字列に対する等価条件・比較条件用のインデックスとしてPGroongaを使うためにはvarchar型を使う必要があります。

varchar型の最大文字数は最大バイト数が4096バイト以下になるように指定する必要があります。たとえば、UTF-8エンコーディングを使う場合は最大文字数は1023文字以下にする必要があります。なぜなら、UTF-8エンコーディングのvarcharは1文字あたり4バイト確保し、PostgreSQLはメタデータ用に4バイトを確保するからです。

USING pgroonga付きでインデックスを作成します。

CREATE TABLE tags (
  id integer,
  tag varchar(1023)
);

CREATE INDEX pgroonga_tag_index ON tags USING pgroonga (tag);

テストデータを挿入します。

INSERT INTO tags VALUES (1, 'PostgreSQL');
INSERT INTO tags VALUES (2, 'Groonga');
INSERT INTO tags VALUES (3, 'Groonga');

シーケンシャルスキャンを無効にします。

SET enable_seqscan = off;

検索します。

SELECT * FROM tags WHERE tag = 'Groonga';
--  id |   tag
-- ----+---------
--   2 | Groonga
--   3 | Groonga
-- (2 rows)
--

配列に対してPGroongaを使う方法

text型の配列またはvarchar型の配列のインデックスとしてPGroongaを使うことができます。

text型の配列に対して全文検索することができます。配列の中の1つ以上の要素がマッチしたらそのレコードはマッチしたことになります。

varchar型の配列に対して等価条件で検索することができます。配列の中の1つ以上の要素がマッチしたらそのレコードはマッチしたことになります。これはタグ検索で有用です。

text型の配列に対してPGroongaを使う方法
varchar型の配列に対してPGroongaを使う方法

`text`型の配列に対してPGroongaを使う方法

USING pgroonga付きでインデックスを作成します。

CREATE TABLE docs (
  id integer,
  sections text[]
);

CREATE INDEX pgroonga_sections_index ON docs USING pgroonga (sections);

テストデータを挿入します。

INSERT INTO docs
     VALUES (1,
             ARRAY['PostgreSQLはリレーショナル・データベース管理システムです。',
                   'PostgreSQLは部分的に全文検索をサポートしています。']);
INSERT INTO docs
     VALUES (2,
             ARRAY['Groongaは日本語対応の高速な全文検索エンジンです。',
                   'Groongaは他のシステムに組み込むことができます。']);
INSERT INTO docs
     VALUES (3,
             ARRAY['PGroongaはインデックスとしてGroongaを使うためのPostgreSQLの拡張機能です。',
                   'PostgreSQLに高機能な全文検索機能を追加します。']);

全文検索には&@演算子または&@~演算子を使います。全文検索では何番目の要素かは考慮しません。

SELECT * FROM docs WHERE sections &@ '全文検索';
--  id |                                                          sections                                                          
-- ----+----------------------------------------------------------------------------------------------------------------------------
--   1 | {PostgreSQLはリレーショナル・データベース管理システムです。,PostgreSQLは部分的に全文検索をサポートしています。}
--   2 | {Groongaは日本語対応の高速な全文検索エンジンです。,Groongaは他のシステムに組み込むことができます。}
--   3 | {PGroongaはインデックスとしてGroongaを使うためのPostgreSQLの拡張機能です。,PostgreSQLに高機能な全文検索機能を追加します。}
-- (3 rows)

`varchar`型の配列に対してPGroongaを使う方法

USING pgroonga付きでインデックスを作成します。

CREATE TABLE products (
  id integer,
  name text,
  tags varchar(1023)[]
);

CREATE INDEX pgroonga_tags_index ON products USING pgroonga (tags);

テストデータを挿入します。

INSERT INTO products
     VALUES (1,
             'PostgreSQL',
             ARRAY['PostgreSQL', 'RDBMS']);
INSERT INTO products
     VALUES (2,
             'Groonga',
             ARRAY['Groonga', 'full-text search']);
INSERT INTO products
     VALUES (3,
             'PGroonga',
             ARRAY['PostgreSQL', 'Groonga', 'full-text search']);

指定した要素を含むレコードを検索するには&@演算子を使います。要素の値が指定した値と同じなら、その要素はマッチしたことになります。

SELECT * FROM products WHERE tags &@ 'PostgreSQL';
--  id |    name    |                  tags                   
-- ----+------------+-----------------------------------------
--   1 | PostgreSQL | {PostgreSQL,RDBMS}
--   3 | PGroonga   | {PostgreSQL,Groonga,"full-text search"}
-- (2 rows)

JSONに対してPGroongaを使う方法

PGroongaはjsonb型にも対応しています。PGroongaを使うとJSON中のキー・値に対して検索することができます。

JSON中のすべてのテキスト値に対して全文検索することもできます。これはPGroonga独自の機能です。PostgreSQL 9の組み込みの機能でもJsQueryでもこの機能はサポートしていません。PostgreSQL 10では組み込みの機能でサポートしています。

次のJSONを考えてください。

{
  "message": "Server is started.",
  "host": "www.example.com",
  "tags": [
    "web",
  ]
}

server、example、webのどれで全文検索してもこのJSONを見つけることができます。なぜなら、すべてのテキスト値が全文検索対象だからです。

PGroongaはjsonbに対して検索するために次の2つの演算子を提供しています。

@>演算子
&@演算子
&@~演算子
&`演算子

@>演算子はPostgreSQL組み込みの演算子です。@>は右辺のjsonbが左辺のjsonbのサブセットなら真を返します。

PGroongaを使うことで高速に@>を実行出来ます。

&@演算子はPGroonga独自の演算子です。JSON中のすべてのテキストを対象に指定した1つのキーワードを全文検索できます。

&@~演算子はPGroonga独自の演算子です。JSON中のすべてのテキストを対象にクエリー構文を使って全文検索できます。

&`演算子はPGroonga独自の演算子です。@>演算子では記述できない範囲検索のような複雑な条件も書けます。

サンプルスキーマとデータ

例に使うサンプルスキーマとデータは次の通りです。

CREATE TABLE logs (
  record jsonb
);

CREATE INDEX pgroonga_logs_index ON logs USING pgroonga (record);

INSERT INTO logs
     VALUES ('{
                "message": "Server is started.",
                "host":    "www.example.com",
                "tags": [
                  "web",
                  "example.com"
                ]
              }');
INSERT INTO logs
     VALUES ('{
                "message": "GET /",
                "host":    "www.example.com",
                "code":    200,
                "tags": [
                  "web",
                  "example.com"
                ]
              }');
INSERT INTO logs
     VALUES ('{
                "message": "Send to <info@example.com>.",
                "host":    "mail.example.net",
                "tags": [
                  "mail",
                  "example.net"
                ]
              }');

シーケンシャルスキャンを無効にします。

SET enable_seqscan = off;

`@>`演算子

@>演算子はjsonbの値で検索条件を指定します。もし、条件に指定したjsonbの値が検索対象のjsonbの値のサブセットなら@>演算子はtrueを返します。

例です。

SELECT jsonb_pretty(record) FROM logs WHERE record @> '{"host": "www.example.com"}'::jsonb;
--             jsonb_pretty             
-- -------------------------------------
--  {                                  +
--      "host": "www.example.com",     +
--      "tags": [                      +
--          "web",                     +
--          "example.com"              +
--      ],                             +
--      "message": "Server is started."+
--  }
--  {                                  +
--      "code": 200,                   +
--      "host": "www.example.com",     +
--      "tags": [                      +
--          "web",                     +
--          "example.com"              +
--      ],                             +
--      "message": "GET /"             +
--  }
-- (2 rows)

詳細は@>演算子を参照してください。

`&@`演算子

&@演算子はPGroonga独自の演算子です。JSON中のすべてのテキストを対象に指定した1つのキーワードを全文検索できます。

以下はJSON中の「server」を検索する例です。

SELECT jsonb_pretty(record) FROM logs WHERE record &@ 'server';
--             jsonb_pretty             
-- -------------------------------------
--  {                                  +
--      "host": "www.example.com",     +
--      "tags": [                      +
--          "web",                     +
--          "example.com"              +
--      ],                             +
--      "message": "Server is started."+
--  }
-- (1 row)

詳細はjsonb用の&@演算子を参照してください。

`&@~`演算子

&@~演算子はPGroonga独自の演算子です。JSON中のすべてのテキストを対象にクエリー構文を使って全文検索できます。

以下はJSON中の「server」または「send」を検索する例です。

SELECT jsonb_pretty(record) FROM logs WHERE record &@~ 'server OR send';
--                  jsonb_pretty                 
-- ----------------------------------------------
--  {                                           +
--      "host": "www.example.com",              +
--      "tags": [                               +
--          "web",                              +
--          "example.com"                       +
--      ],                                      +
--      "message": "Server is started."         +
--  }
--  {                                           +
--      "host": "mail.example.net",             +
--      "tags": [                               +
--          "mail",                             +
--          "example.net"                       +
--      ],                                      +
--      "message": "Send to <info@example.com>."+
--  }
-- (2 rows)

詳細はjsonb用の&@~演算子を参照してください。

&`演算子

&`演算子はPGroonga独自の演算子です。@>演算子では記述できない範囲検索のような複雑な条件も書けます。

範囲検索をする例です。このSELECTは次の条件にマッチするレコードを返します。

トップレベルのオブジェクトにcodeというキーが存在する
そのcodeの値が200以上300未満である

SELECT jsonb_pretty(record) FROM logs WHERE record &` 'paths @ ".code" && number >= 200 && number < 300';
--           jsonb_pretty          
-- --------------------------------
--  {                             +
--      "code": 200,              +
--      "host": "www.example.com",+
--      "tags": [                 +
--          "web",                +
--          "example.com"         +
--      ],                        +
--      "message": "GET /"        +
--  }
-- (1 row)

詳細はjsonb用の&`演算子を参照してください。

オートコンプリート

TODO

詳細はオートコンプリート機能の実装方法を参照してください。

PGroonga経由でGroongaを使う方法

これは上級者向けの内容です。

多くの場合、GroongaはPostgreSQLより高速です。

たとえば、Groongaのドリルダウン機能はPostgreSQLでSELECT1回と複数のGROUP BY（または1回のGROUP BY GROUPING SET）を実行するよりも速いです。なぜならGroongaでは1回のクエリーで必要な結果をすべて返すからです。

別の例も紹介します。レコード中の一部のカラムしか使わないクエリーの実行はPostgreSQLよりGroongaの方が速いです。なぜなら、Groongaはカラム指向（列指向）のデータストアを実装しているからです。カラム指向のデータストア（Groonga）は行指向のデータストア（PostgreSQL）よりも一部のカラムにアクセスするのが速いのです。行指向のデータストアは一部のカラムにアクセスするだけでよい場合でもすべてのカラムを読み込む必要があります。一方、カラム指向のデータストアは必要なカラムだけを読み込むことができます。

GroongaそのものはSQLのインターフェイスを提供していません。これはPostgreSQLユーザーには使いづらいです。しかし、PGroongaはSQL経由でGroongaを使う機能を提供しています。

`pgroonga_command`関数

pgroonga_command関数を使うとGroongaのコマンドを実行し、その結果を文字列で取得できます。

以下はstatusコマンドを実行する例です。

SELECT pgroonga_command('status') AS command;
--                                   command                                                                                                                  
-- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--  [[0,1423911561.69344,6.15119934082031e-05],{"alloc_count":164,"starttime":1423911561,"uptime":0,"version":"5.0.0-6-g17847c9","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}]
-- (1 row)

Groongaから返ってくる結果はJSONです。Groongaから返ってくる結果にアクセスするためにPostgreSQLが提供するJSON関連の関数を使うことができます。

以下はstatusコマンドの結果のキーと値のペアそれぞれを列に変換する例です。

SELECT * FROM json_each(pgroonga_command('status')::json->1);
--            key           |       value        
-- -------------------------+--------------------
--  alloc_count             | 168
--  starttime               | 1423911561
--  uptime                  | 221
--  version                 | "5.0.0-6-g17847c9"
--  n_queries               | 0
--  cache_hit_rate          | 0.0
--  command_version         | 1
--  default_command_version | 1
--  max_command_version     | 2
-- (9 rows)

詳細はpgroonga_command関数を参照してください。

`pgroonga_table_name`関数

PGroongaはインデックス対象のカラムの値を保存しています。これらの値をGroongaのselectコマンドで検索・出力するために使うことができます。

Groongaのselectコマンドを使うにはテーブル名が必要です。pgroonga_table_name関数を使うとPostgreSQLでのインデックス名をGroongaでのテーブル名に変換できます。

以下はpgroonga_table_name関数を使ってselectコマンドを実行する例です。

SELECT *
  FROM json_array_elements(pgroonga_command('select ' || pgroonga_table_name('pgroonga_content_index'))::json->1->0);
--                                        value                                       
-- -----------------------------------------------------------------------------------
--  [4]
--  [["_id","UInt32"],["_key","UInt64"],["content","LongText"]]
--  [1,1,"PostgreSQLはリレーショナル・データベース管理システムです。"]
--  [2,2,"Groongaは日本語対応の高速な全文検索エンジンです。"]
--  [3,3,"PGroongaはインデックスとしてGroongaを使うためのPostgreSQLの拡張機能です。"]
--  [4,4,"groongaコマンドがあります。"]
-- (6 rows)

詳細はpgroonga_table_name関数を参照してください。

次のステップ

これでPGroongaのすべての機能を知ったことになります！各機能を理解したい場合は各機能のリファレンスマニュアルを参照しくてください。

ハウツーは特定用途向けのPGroongaの使い方を紹介しています。

なにか問題にぶつかった、有用な情報を持っている、そんな方はPGroongaのコミュニティーに参加してください。

チュートリアル

全文検索

PGroongaベースの全文検索システムの準備方法

全文検索用演算子

&@演算子

&@~演算子

LIKE演算子

スコアー

ハイライト

スニペット（KWIC、keyword in context）

同義語

正規表現

類似文書検索

等価条件と比較条件

文字列型以外の型に対してPGroongaを使う方法

文字列型に対してPGroongaを使う方法

配列に対してPGroongaを使う方法

text型の配列に対してPGroongaを使う方法

varchar型の配列に対してPGroongaを使う方法

JSONに対してPGroongaを使う方法

サンプルスキーマとデータ

@>演算子

&@演算子

&@~演算子

&`演算子

オートコンプリート

PGroonga経由でGroongaを使う方法

pgroonga_command関数

pgroonga_table_name関数

次のステップ

`&@`演算子

`&@~`演算子

`LIKE`演算子

`text`型の配列に対してPGroongaを使う方法

`varchar`型の配列に対してPGroongaを使う方法

`@>`演算子

`&@`演算子

`&@~`演算子

`pgroonga_command`関数

`pgroonga_table_name`関数