From 198c004913047760b30f63d1498e931b4b36feee Mon Sep 17 00:00:00 2001
From: Masahiko Sawada <sawada.mshk@gmail.com>
Date: Mon, 9 Mar 2015 19:56:18 +0900
Subject: [PATCH] Add the limitations section into document of pg_bigm 1.1.

Also add the news into top page.

Backpatch to 1.1.

Beena Emerson
---
 html/index.html          |  1 +
 html/index_en.html       |  1 +
 html/pg_bigm-1-1.html    | 18 ++++++++++++++++++
 html/pg_bigm_en-1-1.html | 18 ++++++++++++++++++
 4 files changed, 38 insertions(+)

diff --git a/html/index.html b/html/index.html
index ebfed9d..1faa281 100644
--- a/html/index.html
+++ b/html/index.html
@@ -23,6 +23,7 @@
 
 <h2 id="news">ニュース</h2>
 <ul>
+<li>2015-03-09: pg_bigm 1.1のドキュメントに<a href="pg_bigm-1-1.html#limitations">制約</a>を追加しました。</li>
 <li>2015-02-05: PostgreSQL9.4用のpg_bigm 1.1のRPMファイルをリリースしました。RPMファイルは<a href="http://sourceforge.jp/projects/pgbigm/releases/?package_id=13634">こちら</a>からダウンロードできます。</li>
 <li>2014-12-19: pg_bigmバージョン1.1が<a href="http://www.postgresql.org/about/press/presskit94/jp/">PostgreSQL9.4</a>に対応していることを確認しました。</li>
 <li>2013-12-20: PostgreSQL9.1～9.3用のpg_bigm 1.1のRPMファイルをリリースしました。RPMファイルは<a href="http://sourceforge.jp/projects/pgbigm/releases/?package_id=13634">こちら</a>からダウンロードできます。</li>
diff --git a/html/index_en.html b/html/index_en.html
index d30780d..a0c31ac 100644
--- a/html/index_en.html
+++ b/html/index_en.html
@@ -23,6 +23,7 @@
 
 <h2 id="news">News</h2>
 <ul>
+<li>2015-03-09: <a href="pg_bigm_en-1-1.html#limitations"> Limitations</a> section was added into document of pg_bigm 1.1.</li>
 <li>2015-02-05: The RPM file of pg_bigm 1.1 for PostgreSQL 9.4 was released. It can be downloaded from <a href="http://en.sourceforge.jp/projects/pgbigm/releases/?package_id=13634">here</a>.</li>
 <li>2014-12-19: pg_bigm 1.1 was confirmed to work with <a href="http://www.postgresql.org/about/press/presskit94/">PostgreSQL9.4</a>.</li>
 <li>2013-12-20: The RPM files of pg_bigm 1.1 for PostgreSQL 9.1, 9.2, 9.3 were released. They can be downloaded from <a href="http://en.sourceforge.jp/projects/pgbigm/releases/?package_id=13634">here</a>.</li>
diff --git a/html/pg_bigm-1-1.html b/html/pg_bigm-1-1.html
index aa4b66a..7384a4f 100644
--- a/html/pg_bigm-1-1.html
+++ b/html/pg_bigm-1-1.html
@@ -30,6 +30,7 @@
 <li><a href="#fulltext_search">全文検索機能</a></li>
 <li><a href="#functions">提供関数</a></li>
 <li><a href="#parametares">パラメータ</a></li>
+<li><a href="#limitations">制約</a></li>
 <li><a href="#release_notes">リリースノート</a></li>
 </ol>
 </div>
@@ -82,6 +83,9 @@
 <tr><td>類似文字列の検索</td>
   <td nowrap>対応済</td>
   <td>対応済(バージョン1.1以降)</td></tr>
+<tr><td>インデックス作成が可能な列の最大サイズ</td>
+  <td nowrap>238,609,291Byte (約228MB)</td>
+  <td nowrap>44,739,241Byte (約43MB)</td></tr>
 </tbody>
 </table>
 
@@ -489,6 +493,20 @@ GINインデックスの待機リストとFASTUPDATEオプションの詳細は
 <h3 id="similarity_limit">pg_bigm.similarity_limit</h3>
 <p>pg_bigm.similarity_limitは、類似度検索の閾値を指定するパラメータです。類似度検索では、検索条件の文字列との類似度がこの閾値以上の行が検索結果となります。設定値は0以上1以下の小数点数で、デフォルト値は0.3です。このパラメータは、postgresql.confとSET文(スーパーユーザに限らずどのユーザからでも)で設定値を変更できます。</p>
 
+<h2 id="limitations">制約</h2>
+<h3 id="indexed_column_size">インデックス作成が可能な列の最大サイズ</h3>
+
+<p>pg_bigmでは、列サイズが44,739,241Byte (約43MB)を越える列へインデックスを作成できません。制限を越える大きさのデータを挿入するとエラーを起こします。</p>
+
+<pre>
+=# CREATE TABLE t1 (description text);
+=# CREATE INDEX t1_idx ON t1 USING gin (description gin_bigm_ops);
+=# INSERT INTO t1 SELECT repeat('A', 44739242);
+ERROR:  invalid memory alloc request size 1073741860
+</pre>
+
+この制約はpg_trgmにも存在しますが、pg_trgmでは最大238,609,291Byte (約228MB)までインデックスの作成が可能です。
+
 <h2 id="release_notes">リリースノート</h2>
 <ul>
 <li><a href="release-1-1-20131122.html">バージョン1.1 (2013-11-22 リリース)</a></li>
diff --git a/html/pg_bigm_en-1-1.html b/html/pg_bigm_en-1-1.html
index d3888d7..93221dc 100644
--- a/html/pg_bigm_en-1-1.html
+++ b/html/pg_bigm_en-1-1.html
@@ -30,6 +30,7 @@
 <li><a href="#fulltext_search">Full text search</a></li>
 <li><a href="#functions">Functions</a></li>
 <li><a href="#parametares">Parameters</a></li>
+<li><a href="#limitations">Limitations</a></li>
 <li><a href="#release_notes">Release Notes</a></li>
 </ol>
 </div>
@@ -82,6 +83,9 @@ For example, x.y is 1.1 and YYYYMMDD is 20131122 if the file of the version 1.1
 <tr><td>Similarity search</td>
   <td nowrap>Supported</td>
   <td>Supported (version 1.1 or later)</td></tr>
+<tr><td>Maximum indexed column size</td>
+  <td nowrap>238,609,291 Bytes (~228MB)</td>
+  <td nowrap>44,739,241 Bytes (~43MB)</td></tr>
 </tbody>
 </table>
 
@@ -488,6 +492,20 @@ Please see <a href="http://www.postgresql.org/docs/current/static/gin-implementa
 <h3 id="similarity_limit">pg_bigm.similarity_limit</h3>
 <p>pg_bigm.similarity_limit is a parameter that specifies the threshold used by the similarity search. The similarity search returns all the rows whose similarity with the search keyword is higher than or equal to this threshold. Value must be between 0 and 1 (default is 0.3). Not only superuser but also any user can change this parameter value in postgresql.conf or by using SET command.</p>
 
+<h2 id="limitations">Limitations</h2>
+<h3 id="indexed_column_size">Indexed Column Size</h3>
+
+<p>The size of the column indexed by bigm GIN index cannot exceed 44,739,241 Bytes (~43MB). Any attempt to enter larger values will result in an error. </p>
+
+<pre>
+=# CREATE TABLE t1 (description text);
+=# CREATE INDEX t1_idx ON t1 USING gin (description gin_bigm_ops);
+=# INSERT INTO t1 SELECT repeat('A', 44739242);
+ERROR:  invalid memory alloc request size 1073741860
+</pre>
+
+<p>pg_trgm also has this limitation. However, the maximum size in the case of trgm indexed column is 238,609,291 Bytes (~228MB).</p>
+
 <h2 id="release_notes">Release Notes</h2>
 <ul>
 <li><a href="release-1-1-20131122_en.html">Version 1.1, released on 2013-11-22</a></li>
-- 
2.11.0