rroonga 0.9.5-x86-mingw32 → 1.0.1-x86-mingw32

data/vendor/local/share/groonga/doc/ja/source/conf.py

@@ -0,0 +1,265 @@
+# -*- coding: utf-8 -*-
+#
+# groonga documentation build configuration file, created by
+# sphinx-quickstart on Thu Oct 22 15:42:37 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+SPHINX_VERSION_REQUIRED = "1.0.1"
+RST2PDF_VERSION_REQUIRED = "0.14.2"
+
+import re
+import sphinx
+import sys, os
+from datetime import datetime
+from pkg_resources import parse_version
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+
+if parse_version(sphinx.__version__) < parse_version(SPHINX_VERSION_REQUIRED):
+  print 'sphinx version is old. %s is requred. exec "easy_install -U sphinx"' % SPHINX_VERSION_REQUIRED
+  sys.exit(1)
+
+#if sphinx.__version__ != SPHINX_VERSION_REQUIRED:
+#  print 'sphinx version is different. %s is requred. exec "easy_install -U sphinx"' % SPHINX_VERSION_REQUIRED
+#  sys.exit(1)
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+#extensions = ["source.rdoc"]
+extensions = []
+try:
+  import rst2pdf
+  if parse_version(rst2pdf.version) >= parse_version(RST2PDF_VERSION_REQUIRED):
+    extensions.append('sphinx.ext.autodoc')
+    extensions.append('rst2pdf.pdfbuilder')
+except:
+  pass
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'groonga'
+copyright = u'2009-' + unicode(datetime.today().year) + ', Brazil, Inc'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+
+# read version from env/file.
+if os.environ.has_key('GROONGA_VERSION'):
+  version_sh = 'GROONGA_VERSION=' + os.environ['GROONGA_VERSION']
+else:
+  os.system('../../../version-gen.sh')
+  version_sh = open(os.path.join(os.path.dirname(__file__), '../../../version.sh')).read()
+
+release_regex = re.compile(r'^GROONGA_VERSION=(?P<release>.*)$')
+# The full version, including alpha/beta/rc tags.
+release = release_regex.search(version_sh).group('release')
+
+version_regex = re.compile(r'^(?P<version>\d+(\.\d+)*)')
+# The short X.Y version.
+version = version_regex.search(release).group('version')
+
+# NOTE: release == version, because release includes git tag.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+  'rightsidebar': 'true',
+  'stickysidebar': 'true',
+#  'relbarbgcolor': '#ED4517',
+#  'relbartextcolor': 'white',
+#  'relbarlinkcolor': '#F8F0FF',
+#  'footerbgcolor': '#ED4517',
+#  'footertextcolor': 'white',
+#  'sidebarbgcolor': '#FFd587',
+#  'sidebartextcolor': '#ED4517',
+#  'sidebarlinkcolor': '#666666',
+  'bodyfont': '#666666',
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'groongadoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'groonga.tex', u'groonga Documentation',
+   u'Brazil, Inc', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+# -- Options for rst2pdf output --------------------------------------------------
+pdf_documents = [
+  ('index',
+   u'groonga-%s' % (release,),
+   u'groonga %s document' % (release,),
+   u'groonga project')
+]
+pdf_stylesheets = ['sphinx', 'kerning', 'a4', 'ja']
+pdf_font_path = ['/usr/share/fonts']
+pdf_language = 'ja'
+pdf_fit_mode = "shrink"
+pdf_inline_footnotes = True
+pdf_break_level = 2
+
+# -- Options for manual page output --------------------------------------------
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'groonga', u'groonga documentation',
+     [u'groonga project'], 1)
+]

data/vendor/local/share/groonga/doc/ja/source/developer.txt

@@ -0,0 +1,10 @@
+.. highlightlang:: none
+
+groonga開発者向け情報
+=====================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   developer/*

data/vendor/local/share/groonga/doc/ja/source/developer/com.txt

@@ -0,0 +1,18 @@
+groonga 通信アーキテクチャ
+==========================
+
+gqtpでのアーキテクチャ
+----------------------
+
+- comが外部からの接続を受け付ける。
+- comは1スレッド。
+- comがedgeを作る。
+- edgeは接続と１対１対応。
+- edgeはctxを含む。
+- workerはthreadと１対１対応。
+- workerは上限が個定数。
+- workerは、１つのedgeと結びつくことができる。
+
+- edgeごとにqueueを持つ。
+- msgはcomによって、edgeのqueueにenqueueされる。
+  edgeがworkerに結びついていないときは、同時に、ctx_newというqueueに、msgをenqueueした対象のedgeをenqueueする。

data/vendor/local/share/groonga/doc/ja/source/developer/document.txt

@@ -0,0 +1,38 @@
+.. highlightlang:: none
+
+ドキュメント作成
+================
+
+Sphinxのインストール
+--------------------------
+
+groongaのドキュメントは、Sphinxというツールを用いて作成されています。Sphinxは以下のように導入します。::
+
+ # aptitude install python-setuptools
+ # easy_install -U sphinx
+
+htmlの作成
+----------------
+
+以下のコマンドでhtmlが作成されます。::
+
+ % make html
+
+pdfの作成
+---------------
+
+groongaのドキュメントは、pdf出力することもできます。rst2pdfと、IPAフォント(IPA Gothic/IPAexGothic)が必要となります。
+
+rst2pdfのインストール
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+以下のようにしてインストールできます。::
+
+ # eazy_install rst2pdf
+
+pdfの作成
+^^^^^^^^^^^^^^^
+
+以下のコマンドでpdfが作成されます。::
+
+ % make pdf

data/vendor/local/share/groonga/doc/ja/source/developer/query.txt

@@ -0,0 +1,212 @@
+.. highlightlang:: none
+
+クエリの実現
+============
+
+groongaのデータベースには大量のデータを格納し、その中から必要な部分を高速に取り出すことができます。必要な部分をgroongaのデータベースに問い合わせるためのクエリの表現と実行に関して、groongaは複数の手段を用意しています。
+
+クエリ実行のためのインタフェース
+--------------------------------
+
+groongaは低機能で単純なライブラリインタフェースから、高機能で複雑なコマンドインタフェースまでいくつかの階層的なインタフェースをユーザプログラムに提供しています。
+
+クエリ実行のためのインタフェースも階層的なインタフェースのそれぞれに対応する形で用意されています。以下に低レイヤなインタフェースから順に説明します。
+
+DB_API
+^^^^^^
+
+DB_APIは、groongaデータベースを操作するための一群のC言語向けAPI関数を提供します。DB_APIはデータベースを構成する個々の部分に対する単純な操作関数を提供します。DB_APIの機能を組み合わせることによって複雑なクエリを実行することができます。後述のすべてのクエリインタフェースはDB_APIの機能を組み合わせることによって実現されています。
+
+grn_expr
+^^^^^^^^
+
+grn_exprは、groongaデータベースに対する検索処理や更新処理のための条件を表現するためのデータ構造で、複数の条件を再帰的に組み合わせてより複雑な条件を表現することができます。grn_exprによって表現されたクエリを実行するためには、grn_table_select()関数を使用します。
+
+groonga実行ファイル
+^^^^^^^^^^^^^^^^^^^
+
+groongaデータベースを操作するためのコマンドインタープリタです。渡されたコマンドを解釈し、実行結果を返します。コマンドの実処理はC言語で記述されます。ユーザがC言語で定義した関数を新たなコマンドとしてgroonga実行ファイルに組み込むことができます。各コマンドはいくつかの文字列引数を受け取り、これをクエリとして解釈して実行します。引数をgrn_exprとして解釈するか、別の形式として解釈してDB_APIを使ってデータベースを操作するかはコマンド毎に自由に決めることができます。
+
+grn_exprで表現できるクエリ
+--------------------------
+
+grn_exprは代入や関数呼び出しのような様々な操作を表現できますが、この中で検索クエリを表現するgrn_exprのことを特に条件式とよびます。条件式を構成する個々の要素を関係式と呼びます。条件式は一個以上の関係式か、あるいは条件式を論理演算子で結合したものです。
+
+論理演算子は、以下の3種類があります。
+::
+
+ && (論理積)
+ || (論理和)
+ !  (否定)
+
+関係式は、下記の11種類が用意されています。また、ユーザが定義した関数を新たな関係式として使うこともできます。
+::
+
+ equal(==)
+ not_equal(!=)
+ less(<)
+ greater(>)
+ less_equal(<=)
+ greater_equal(>=)
+ contain()
+ near()
+ similar()
+ prefix()
+ suffix()
+
+grn_table_select()
+------------------
+
+grn_table_select()関数は、grn_exprで表現された検索クエリを実行するときに使います。引数として、検索対象となるテーブル、クエリを表すgrn_expr、検索結果を格納するテーブル、それに検索にマッチしたレコードを検索結果にどのように反映するかを指定する演算子を渡します。演算子と指定できるのは下記の4種類です。
+::
+
+ GRN_OP_OR
+ GRN_OP_AND
+ GRN_OP_BUT
+ GRN_OP_ADJUST
+
+GRN_OP_ORは、検索対象テーブルの中からクエリにマッチするレコードを検索結果テーブルに加えます。GRN_OP_OR以外の演算子は、検索結果テーブルが空でない場合にだけ意味を持ちます。GRN_OP_ANDは、検索結果テーブルの中からクエリにマッチしないレコードを取り除きます。GRN_OP_BUTは、検索結果テーブルの中からクエリにマッチするレコードを取り除きます。GRN_OP_ADJUSTは、検索結果テーブルの中でクエリにマッチするレコードに対してスコア値の更新のみを行います。
+
+grn_table_select()は、データベース上に定義されたテーブルや索引などを組み合わせて可能な限り高速に指定されたクエリを実行しようとします。
+
+関係式
+------
+
+関係式は、検索しようとしているデータが満たすべき条件を、指定した値の間の関係として表現します。いずれの関係式も、その関係が成り立ったときに評価されるcallback、コールバック関数に渡されるargとを引数として指定することができます。callbackが与えられず、argのみが数値で与えられた場合はスコア値の係数とみなされます。主な関係式について説明します。
+
+equal(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値とv2の値が等しいことを表します。
+
+not_equal(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値とv2の値が等しくないことを表します。
+
+less(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値がv2の値よりも小さいことを表します。
+
+greater(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値がv2の値よりも大きいことを表します。
+
+less_equal(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値がv2の値と等しいか小さいことを表します。
+
+greater_equal(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値がv2の値と等しいか大きいことを表します。
+
+contain(v1, v2, mode, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値がv2の値を含んでいることを表します。また、v1の値が要素に分解されるとき、それぞれの要素に対して二つ目の要素が一致するためのmodeとして下記のいずれかを指定することができます。
+
+::
+
+ EXACT: v2の値もv1の値と同様に要素に分解したとき、それぞれの要素が完全に一致する(デフォルト)
+ UNSPLIT: v2の値は要素に分解しない
+ PREFIX: v1の値の要素がv2の値に前方一致する
+ SUFFIX: v1の値の要素がv2の値に後方一致する
+ PARTIAL: v1の値の要素がv2の値に中間一致する
+
+near(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値の中に、v2の値の要素が接近して含まれていることを表します。(v2には値の配列を渡します)
+
+similar(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値とv2の値が類似していることを表します。
+
+prefix(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値がv2の値に対して前方一致することを表します。
+
+suffix(v1, v2, arg, callback)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+v1の値がv2の値に対して後方一致することを表します。
+
+クエリの実例
+============
+
+grn_exprを使って様々な検索クエリを表現することができます。
+
+検索例1
+-------
+::
+
+ GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
+ grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
+ grn_expr_append_obj(ctx, query, column, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
+ grn_expr_append_op(ctx, query, GRN_OP_CALL, 3);
+ result = grn_table_select(ctx, table, query, NULL, GRN_OP_OR);
+
+tableのcolumnの値がstringを含むレコードをresultに返します。columnの値が'needle in haystack'であるレコードr1と、columnの値が'haystack'であるレコードr2がtableに登録されていたとき、stringに'needle'を指定したなら、レコードr1のみがヒットします。
+
+
+検索例2
+-------
+::
+
+ GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
+ grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
+ grn_expr_append_obj(ctx, query, column1, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, exact, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, score1, GRN_OP_PUSH, 1);
+ grn_expr_append_op(ctx, query, GRN_OP_CALL, 5);
+ result = grn_table_select(ctx, table, query, NULL, GRN_OP_OR);
+ grn_obj_close(ctx, query);
+ GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
+ grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
+ grn_expr_append_obj(ctx, query, column2, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, exact, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, score2, GRN_OP_PUSH, 1);
+ grn_expr_append_op(ctx, query, GRN_OP_CALL, 5);
+ grn_table_select(ctx, table, query, result, GRN_OP_ADJUST);
+ grn_obj_close(ctx, query);
+
+tableのcolumn1の値がstringにexactモードでヒットするレコードについて得られるスコア値にscore1を積算してresultにセットします。次に、resultにセットされたレコードのうち、column2の値がstringにexactモードでヒットするレコードについては、得られたスコア値にscore2を積算したものを、元のスコア値に加えます。
+
+検索例3
+-------
+::
+
+ GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
+ grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
+ grn_expr_append_obj(ctx, query, column1, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, exact, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, score1, GRN_OP_PUSH, 1);
+ grn_expr_append_op(ctx, query, GRN_OP_CALL, 5);
+ result = grn_table_select(ctx, table, query, NULL, GRN_OP_OR);
+ grn_obj_close(ctx, query);
+ if (grn_table_size(ctx, result) < t1) {
+   GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
+   grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
+   grn_expr_append_obj(ctx, query, column1, GRN_OP_PUSH, 1);
+   grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
+   grn_expr_append_const(ctx, query, partial, GRN_OP_PUSH, 1);
+   grn_expr_append_const(ctx, query, score2, GRN_OP_PUSH, 1);
+   grn_expr_append_op(ctx, query, GRN_OP_CALL, 3);
+   grn_table_select(ctx, table, query, result, GRN_OP_OR);
+   grn_obj_close(ctx, query);
+ }
+
+tableのcolumn1の値がstringにexactモードでヒットするレコードについて得られるスコア値にscore1を積算してresultにセットします。得られた検索結果数がt1よりも小さい場合は、partialモードで再度検索し、ヒットしたレコードについて得られるスコア値にscore2を積算してresultに追加します。
+
+検索例4
+-------
+::
+
+ GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var);
+ grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1);
+ grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1);
+ grn_expr_append_obj(ctx, query, column, GRN_OP_PUSH, 1);
+ grn_expr_append_op(ctx, query, GRN_OP_CALL, 3);
+ result = grn_table_select(ctx, table, query, NULL, GRN_OP_OR);
+
+tableのcolumnの値がstringに含まれるレコードをresultに返します。
+columnの値が'needle'であるレコードr1と、columnの値が'haystack'であるレコードr2がtableに登録されていたとき、stringに'hay in haystack'を指定したなら、レコードr2のみがヒットします。