Navigation Menu

Skip to content

Commit

Permalink
doc: add vector_size document
Browse files Browse the repository at this point in the history
  • Loading branch information
kenhys committed Apr 28, 2015
1 parent cf2840d commit f66d284
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions doc/source/reference/functions/vector_size.rst
@@ -0,0 +1,71 @@
.. -*- rst -*-
.. highlightlang:: none

.. groonga-command
.. database: vector_size
vector_size
===========

Summary
-------

.. versionadded:: 5.0.3

``vector_size`` returns the value of vector column size.

Use ``--command_version 2`` to enable this feature.

Syntax
------

``vector_size`` requires one argument - ``target``.

::

vector_size(target)

Usage
-----

Here is a schema definition and sample data.

Sample schema:

.. groonga-command
.. include:: ../../example/reference/functions/vector_size/usage_setup_schema.log
.. table_create Memos TABLE_HASH_KEY ShortText
.. column_create Memos tags COLUMN_VECTOR ShortText
Sample data:

.. groonga-command
.. include:: ../../example/reference/functions/vector_size/usage_setup_data.log
.. load --table Memos
.. [
.. {"_key": "Groonga", "tags": ["Groonga"]},
.. {"_key": "Rroonga", "tags": ["Groonga", "Ruby"]},
.. {"_key": "Nothing"}
.. ]
Here is the simple usage of ``vector_size`` function which returns tags and size - the value of ``tags`` column and size of it.

.. groonga-command
.. include:: ../../example/reference/functions/vector_size/usage_only.log
.. select Memos --output_columns 'tags, vector_size(tags)' --command-version 2
Parameters
----------

There are one required parameter, ``target``.

``target``
^^^^^^^^^^^^^^^^

Specifies a vector column of table that is specified by ``table`` parameter in ``select``.

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

``vector_size`` returns the value of target vector column size.

0 comments on commit f66d284

Please sign in to comment.