File: tokenizer_list.rst

package info (click to toggle)
groonga 15.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 163,080 kB
  • sloc: ansic: 770,564; cpp: 48,925; ruby: 40,447; javascript: 10,250; yacc: 7,045; sh: 5,602; python: 2,821; makefile: 1,672
file content (61 lines) | stat: -rw-r--r-- 1,063 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.. -*- rst -*-

.. groonga-command
.. database: commands_tokenizer_list

``tokenizer_list``
==================

Summary
-------

``tokenizer_list`` command lists tokenizers in a database.

Syntax
------

This command takes no parameters::

  tokenizer_list

Usage
-----

Here is a simple example.

.. groonga-command
.. include:: ../../example/reference/commands/tokenizer_list/simple_example.log
.. tokenizer_list

It returns tokenizers in a database.

Return value
------------

``tokenizer_list`` command returns tokenizers. Each tokenizers has an attribute
that contains the name. The attribute will be increased in the feature::

  [HEADER, tokenizers]

``HEADER``

  See :doc:`/reference/command/output_format` about ``HEADER``.

``tokenizers``

  ``tokenizers`` is an array of tokenizer. Tokenizer is an object that has the following
  attributes.

  .. list-table::
     :header-rows: 1

     * - Name
       - Description
     * - ``name``
       - Tokenizer name.

See also
--------

* :doc:`/reference/tokenizers`
* :doc:`/reference/commands/tokenize`