Kouhei Sutou
null+****@clear*****
Tue Sep 15 13:39:25 JST 2015
Kouhei Sutou 2015-09-15 13:39:25 +0900 (Tue, 15 Sep 2015) New Revision: 20205c76eb7dc3045e72554cf17ac6ccfdb44ea0 https://github.com/groonga/groonga/commit/20205c76eb7dc3045e72554cf17ac6ccfdb44ea0 Message: doc: add anchors to the build-in types Modified files: doc/source/reference/types.rst Modified: doc/source/reference/types.rst (+71 -30) =================================================================== --- doc/source/reference/types.rst 2015-09-15 13:53:18 +0900 (bbfe990) +++ doc/source/reference/types.rst 2015-09-15 13:39:25 +0900 (d9fb3a1) @@ -28,86 +28,131 @@ Builtin types The following types are defined as builtin types. -``Object`` - - All records that belong to any table. [#]_ +.. _bultin-type-bool: ``Bool`` +^^^^^^^^ + +Boolean type. The possible values are true and false. (default: false) - Boolean type. The possible values are true and false. (default: false) +To store a value by :doc:`/reference/commands/load` command, becomes false if you specify false, 0 or empty string, becomes true if you specify others. - To store a value by :doc:`/reference/commands/load` command, becomes false if you specify false, 0 or empty string, becomes true if you specify others. +.. _bultin-type-int8: ``Int8`` +^^^^^^^^ + +Signed 8bit integer. It's -128 or more and 127 or less. (default: 0) - Signed 8bit integer. It's -128 or more and 127 or less. (default: 0) +.. _bultin-type-uint8: ``UInt8`` +^^^^^^^^^ - Unsigned 8bit integer. Is't 0 or more and 255 or less. (default: 0) +Unsigned 8bit integer. Is't 0 or more and 255 or less. (default: 0) + +.. _bultin-type-int16: ``Int16`` +^^^^^^^^^ + +Signed 16bit integer. It's -32,768 or more and 32,767 or less. (default: 0) - Signed 16bit integer. It's -32,768 or more and 32,767 or less. (default: 0) +.. _bultin-type-uint16: ``UInt16`` +^^^^^^^^^^ - Unsigned 16bit integer. It's 0 or more and 65,535 or less. (default: 0) +Unsigned 16bit integer. It's 0 or more and 65,535 or less. (default: 0) + +.. _bultin-type-int32: ``Int32`` +^^^^^^^^^ + +Signed 32bit integer. It's -2,147,483,648 or more and 2,147,483,647 or less. (default: 0) - Signed 32bit integer. It's -2,147,483,648 or more and 2,147,483,647 or less. (default: 0) +.. _bultin-type-uint32: ``UInt32`` +^^^^^^^^^^ + +Unsigned 32bit integer. It's 0 or more and 4,294,967,295 or less. (default: 0) - Unsigned 32bit integer. It's 0 or more and 4,294,967,295 or less. (default: 0) +.. _bultin-type-int64: ``Int64`` +^^^^^^^^^ - Signed 64bit integer. It's -9,223,372,036,854,775,808 or more and 9,223,372,036,854,775,807 or less. (default: 0) +Signed 64bit integer. It's -9,223,372,036,854,775,808 or more and 9,223,372,036,854,775,807 or less. (default: 0) + +.. _bultin-type-uint64: ``UInt64`` +^^^^^^^^^^ + +Unsigned 64bit integer. It's 0 or more and 18,446,744,073,709,551,615 or less. (default: 0) - Unsigned 64bit integer. It's 0 or more and 18,446,744,073,709,551,615 or less. (default: 0) +.. _bultin-type-float: ``Float`` +^^^^^^^^^ - Double-precision floating-point number of IEEE 754 as a real number. (default: 0.0) +Double-precision floating-point number of IEEE 754 as a real number. (default: 0.0) - See `IEEE floating point - Wikipedia, the free encyclopedia <http://en.wikipedia.org/wiki/IEEE_floating_point>`_ or `IEEE 754: Standard for Binary Floating-Point <http://grouper.ieee.org/groups/754/>`_ for details of IEEE 754 format. +See `IEEE floating point - Wikipedia, the free encyclopedia <http://en.wikipedia.org/wiki/IEEE_floating_point>`_ or `IEEE 754: Standard for Binary Floating-Point <http://grouper.ieee.org/groups/754/>`_ for details of IEEE 754 format. + +.. _bultin-type-time: ``Time`` +^^^^^^^^ + +Date and Time, the number of seconds that have elapsed since 1970-01-01 00:00:00 by 64 bit signed integer. (default: 0) - Date and Time, the number of seconds that have elapsed since 1970-01-01 00:00:00 by 64 bit signed integer. (default: 0) +To store a value by :doc:`/reference/commands/load` command, specifies the number of elapsed seconds since 1970-01-01 00:00:00. To specify the detailed date and time than seconds, use the decimal. - To store a value by :doc:`/reference/commands/load` command, specifies the number of elapsed seconds since 1970-01-01 00:00:00. To specify the detailed date and time than seconds, use the decimal. +.. _bultin-type-short-text: ``ShortText`` +^^^^^^^^^^^^^ + +String of 4,095 or less bytes. (default: "") - String of 4,095 or less bytes. (default: "") +.. _bultin-type:-ext ``Text`` +^^^^^^^^ - String of 65,535 or less bytes. (default: "") +String of 65,535 or less bytes. (default: "") + +.. _bultin-type-long-text: ``LongText`` +^^^^^^^^^^^^ + +String of 2,147,483,647 or less bytes. (default: "") - String of 2,147,483,647 or less bytes. (default: "") +.. _bultin-type-tokyo-geo-point: ``TokyoGeoPoint`` +^^^^^^^^^^^^^^^^^ - 旧日本測地系による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0） +旧日本測地系による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0） - 度分秒形式でx度y分z秒となる経度・緯度は、(((x * 60) + y) * 60 + z) * 1000という計算式でミリ秒単位へと変換されます。 - :doc:`/reference/commands/load` コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。 +度分秒形式でx度y分z秒となる経度・緯度は、(((x * 60) + y) * 60 + z) * 1000という計算式でミリ秒単位へと変換されます。 - 測地系の詳細については、 `測地系 - Wikipedia <http://ja.wikipedia.org/wiki/%E6%B8%AC%E5%9C%B0%E7%B3%BB>`_ を参照してください。 +:doc:`/reference/commands/load` コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。 + +測地系の詳細については、 `測地系 - Wikipedia <http://ja.wikipedia.org/wiki/%E6%B8%AC%E5%9C%B0%E7%B3%BB>`_ を参照してください。 + +.. _bultin-type-wgs84-geo-pointer: ``WGS84GeoPoint`` +^^^^^^^^^^^^^^^^^ - 世界測地系（World Geodetic System, WGS 84）による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0） +世界測地系（World Geodetic System, WGS 84）による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。（デフォルト値: 0x0） - 度分秒形式からミリ秒形式への変換方法や :doc:`/reference/commands/load` コマンドにおける指定方法はTokyoGeoPointと同じです。 +度分秒形式からミリ秒形式への変換方法や :doc:`/reference/commands/load` コマンドにおける指定方法はTokyoGeoPointと同じです。 Limitations about types ----------------------- @@ -123,7 +168,3 @@ Types that can't be specified in primary key of table Groongaのカラムは、ある型のベクターを保存することができます。しかし、ShortText, Text, LongTextの３つの型についてはベクターとして保存したり出力したりすることはできますが、検索条件やドリルダウン条件に指定することができません。 テーブル型は、ベクターとして格納することができます。よって、ShortTextのベクターを検索条件やドリルダウン条件に使用したい場合には、主キーがShortText型のテーブルを別途作成し、そのテーブルを型として利用します。 - -.. rubric:: 脚注 - -.. [#] Object型はv1.2でサポートされます。 -------------- next part -------------- HTML����������������������������...Download