[Groonga-commit] groonga/groonga at 12b152b [master] doc: document summary of grn_expr

Back to archive index

Kouhei Sutou null+****@clear*****
Fri Aug 9 16:26:25 JST 2013


Kouhei Sutou	2013-08-09 16:26:25 +0900 (Fri, 09 Aug 2013)

  New Revision: 12b152bf25854af8bdbc13537999bbe285c2e750
  https://github.com/groonga/groonga/commit/12b152bf25854af8bdbc13537999bbe285c2e750

  Message:
    doc: document summary of grn_expr

  Modified files:
    doc/source/reference/api/grn_expr.txt

  Modified: doc/source/reference/api/grn_expr.txt (+20 -0)
===================================================================
--- doc/source/reference/api/grn_expr.txt    2013-08-08 13:34:50 +0900 (b860ffc)
+++ doc/source/reference/api/grn_expr.txt    2013-08-09 16:26:25 +0900 (9473ed2)
@@ -5,4 +5,24 @@
 grn_expr
 ========
 
+`grn_expr` is an :c:type:`grn_obj` that represents an expression. Here
+is a list of what expression can do:
+
+  * Expression can apply some operations to a record by
+    :c:function:`grn_expr_exec`.
+  * Expression can represents search condition. :c:function:`grn_table_select`
+    can select records that match against the search condition represented
+    by expression.
+
+There are two string representations of expression:
+
+  * :doc:`/reference/grn_expr/query_syntax`
+  * :doc:`/reference/grn_expr/script_syntax`
+
+:c:function:`grn_expr_parse` parses string represented expression and
+appends the parsed expression to another expression.
+
+Example
+-------
+
 TODO...
-------------- next part --------------
HTML����������������������������...
다운로드 



More information about the Groonga-commit mailing list
Back to archive index