HAYASHI Kentaro
null+****@clear*****
Fri Mar 22 18:25:19 JST 2013
HAYASHI Kentaro 2013-03-22 18:25:19 +0900 (Fri, 22 Mar 2013) New Revision: 0b54ced3cbfbdcd3db605b37d93ed2af1fdc65d4 https://github.com/groonga/groonga/commit/0b54ced3cbfbdcd3db605b37d93ed2af1fdc65d4 Message: doc en: add initial template file for sub_filter function Added files: doc/source/reference/functions/sub_filter.txt Added: doc/source/reference/functions/sub_filter.txt (+68 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/functions/sub_filter.txt 2013-03-22 18:25:19 +0900 (65695fa) @@ -0,0 +1,68 @@ +.. -*- rst -*- + +.. highlightlang:: none + +.. groonga-command +.. database: functions_sub_filter + +sub_filter +========== + +Summary +------- + +TODO + +``sub_filter`` can be used in only ``--filter`` in :doc:`/reference/commands/select`. + +Syntax +------ + +``sub_filter`` requires two arguments - ``match_column`` and ``query_string``. + +:: + + sub_filter(match_column, query_string) + + +Usage +----- + +Here are a schema definition and sample data to show usage. + +Sample schema: + +TODO: + +Sample data: + +TODO: + +Parameters +---------- + +There are two required parameter, ``match_column`` and ``query_string``. + +``match_column`` +^^^^^^^^^^^^^^^^ + + It specifies ``match_column`` equivalent parameter. + +See :ref:`select-match-columns` about match_column. + +``query_string`` +^^^^^^^^^^^^^^^^ + + It specifies ``query`` equivalent parameter. + +See :ref:`select-query` about query string. + +Return value +------------ + +``sub_filter`` returns a value of boolean (true or false). + +See also +-------- + +* :doc:`/reference/commands/select` -------------- next part -------------- HTML����������������������������...下載
