Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
71 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |