File: scalar.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 (85 lines) | stat: -rw-r--r-- 1,501 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
.. -*- rst -*-

.. groonga-command
.. database: columns_scalar

Scalar column
=============

Summary
-------

Scalar column is a data store object.

It can store one scalar value per record. Scalar value is one of the
following type values:

* ``Bool``
* ``Int8``
* ``Int16``
* ``Int32``
* ``Int64``
* ``UInt8``
* ``UInt16``
* ``UInt32``
* ``UInt64``
* ``BFloat16``
* ``Float32``
* ``Float``
* ``Time``
* ``ShortText``
* ``Text``
* ``LongText``
* ``TokyoGeoPoint``
* ``WGS84GeoPoint``

If you want to store zero or more values per record, you can use
multiple scalar columns or one :doc:`vector`. If these values are
related and use the same types such as tags (zero or more strings),
:doc:`vector` is suitable. If these values aren't related such as
title and location, multiple scalar columns are suitable.

Usage
-----

See :doc:`../commands/column_create` how to create a column.

There are three scalar column types:

* Normal scalar column
* Reference scalar column
* Generated scalar column

This section describes how to use these types.

.. _normal-scalar-column:

Normal scalar column
^^^^^^^^^^^^^^^^^^^^

TODO

.. _reference-scalar-column:

Reference scalar column
^^^^^^^^^^^^^^^^^^^^^^^

TODO

.. _generated-scalar-column:

Generated scalar column
^^^^^^^^^^^^^^^^^^^^^^^

You can use a scalar column as a :ref:`generated-column`.

How to create
"""""""""""""

See :ref:`column-create-generated-column` for details.

See also
--------

* :doc:`vector`
* :doc:`../commands/column_create`