Kouhei Sutou
null+****@clear*****
Mon Apr 10 14:51:17 JST 2017
Kouhei Sutou 2017-04-10 14:51:17 +0900 (Mon, 10 Apr 2017) New Revision: 7abd4f7f438142b67a0f2fcbcf7482ddd5610bb3 https://github.com/groonga/groonga/commit/7abd4f7f438142b67a0f2fcbcf7482ddd5610bb3 Message: doc object_inspect: update Modified files: doc/locale/ja/LC_MESSAGES/reference.po doc/source/reference/commands/object_inspect.rst Modified: doc/locale/ja/LC_MESSAGES/reference.po (+525 -10) =================================================================== --- doc/locale/ja/LC_MESSAGES/reference.po 2017-04-10 12:11:26 +0900 (c593b09) +++ doc/locale/ja/LC_MESSAGES/reference.po 2017-04-10 14:51:17 +0900 (8185658) @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: 1.2.1\n" "Report-Msgid-Bugs-To: \n" -"PO-Revision-Date: 2017-04-05 15:16+0900\n" +"PO-Revision-Date: 2017-04-10 14:49+0900\n" "Last-Translator: Masafumi Yokoyama <yokoyama �� clear-code.com>\n" "Language-Team: Japanese\n" "Language: ja\n" @@ -9180,6 +9180,12 @@ msgstr "" ":ref:`table-dat-key` は値の情報を返しません。なぜなら値を持っていないからで" "す。" +msgid "``TABLE_ID``" +msgstr "" + +msgid "The ID of the inspected table." +msgstr "調査対象のテーブルのID。" + msgid "``TABLE_NAME``" msgstr "" @@ -9284,6 +9290,524 @@ msgstr "調査対象のテーブルのレコード数。" msgid "It's a 64bit unsigned integer value." msgstr "64bitの正の整数です。" +msgid "" +"Data column (scalar column and vector column) returns the following " +"information::" +msgstr "" +"データカラム（スカラーカラムとベクターカラム）を調査すると次の情報を返しま" +"す。::" + +msgid "Index column is similar to data column but there are some differences." +msgstr "インデックスカラムはデータカラムと似ていますがいくつか違いがあります。" + +msgid "Index column doesn't have ``value.compress`` key." +msgstr "インデックスカラムの情報にはキー ``value.compress`` がありません。" + +msgid "Index column has ``value.section`` key." +msgstr "インデックスカラムの情報にはキー ``value.section`` があります。" + +msgid "Index column has ``value.weight`` key." +msgstr "インデックスカラムの情報にはキー ``value.weight`` があります。" + +msgid "Index column has ``value.position`` key." +msgstr "インデックスカラムの情報にはキー ``value.position`` があります。" + +msgid "Index column has ``value.size`` key." +msgstr "インデックスカラムの情報にはキー ``value.size`` があります。" + +msgid "Index column has ``value.statistics`` key." +msgstr "インデックスカラムの情報にはキー ``value.statistics`` があります。" + +msgid "Index column has ``sources`` key." +msgstr "インデックスカラムの情報にはキー ``sources`` があります。" + +msgid "Index column returns the following information::" +msgstr "インデックスカラムを調査すると次の情報を返します。" + +msgid "``COLUMN_ID``" +msgstr "" + +msgid "The ID of the inspected column." +msgstr "調査対象のカラムのID。" + +msgid "``COLUMN_NAME``" +msgstr "" + +msgid "The name of the inspected column." +msgstr "調査対象のカラムの名前。" + +msgid "It doesn't include table name. It's just only column name." +msgstr "テーブル名は含みません。カラム名のみを含みます。" + +msgid "" +"If you want full column name (``TABLE_NAME.COLUMN_NAME`` style), use :ref:" +"`object-inspect-return-value-column-full-name` instead." +msgstr "" +"``TABLE_NAME.COLUMN_NAME`` スタイルの完全なカラム名を欲しい場合は代わりに :" +"ref:`object-inspect-return-value-column-full-name` を使ってください。" + +msgid "``COLUMN_TABLE``" +msgstr "" + +msgid "The table of the inspected column." +msgstr "調査対象のカラムのテーブル。" + +msgid "``COLUMN_FULL_NAME``" +msgstr "" + +msgid "The full name of the inspected column." +msgstr "調査対象のカラムの完全な名前。" + +msgid "" +"It includes both table name and column name as ``TABLE_NAME.COLUMN_NAME`` " +"format." +msgstr "" +"``テーブル名.カラム名`` という書式でテーブル名とカラム名を両方含みます。" + +msgid "" +"If you just want only column name, use :ref:`object-inspect-return-value-" +"column-name` instead." +msgstr "" +"カラム名だけが欲しい場合は代わりに :ref:`object-inspect-return-value-column-" +"name` を使ってください。" + +msgid "``COLUMN_TYPE_NAME``" +msgstr "" + +msgid "The type name of the inspected column." +msgstr "調査対象のカラムの種類の名前。" + +msgid "Column type" +msgstr "カラムの種類" + +msgid ":doc:`/reference/columns/scalar`" +msgstr "" + +msgid "``\"scalar\"``" +msgstr "" + +msgid ":doc:`/reference/columns/vector`" +msgstr "" + +msgid "``\"vector\"``" +msgstr "" + +msgid ":doc:`/reference/columns/index`" +msgstr "" + +msgid "``\"index\"``" +msgstr "" + +msgid "``COLUMN_TYPE_RAW_ID``" +msgstr "" + +msgid "The raw type ID of the inspected column." +msgstr "調査対象のカラムの未加工の種類のID" + +msgid "Here is a list of raw type IDs:" +msgstr "以下は未加工の種類のIDのリストです。" + +msgid "Raw column type" +msgstr "カラムの未加工の種類" + +msgid "Fix size column" +msgstr "固定長サイズカラム" + +msgid "``64``" +msgstr "" + +msgid "Variable size column" +msgstr "可変長サイズカラム" + +msgid "``65``" +msgstr "" + +msgid "``72``" +msgstr "" + +msgid "``COLUMN_TYPE_RAW_NAME``" +msgstr "" + +msgid "The raw type name of the inspected column." +msgstr "調査対象のカラムの未加工の種類の名前。" + +msgid "Here is a list of raw type names:" +msgstr "以下は未加工の種類の名前のリストです。" + +msgid "``\"column:fix_size\"``" +msgstr "" + +msgid "``\"column:var_size\"``" +msgstr "" + +msgid "``\"column:index\"``" +msgstr "" + +msgid "``COLUMN_VALUE_TYPE``" +msgstr "" + +msgid "The type of value of the inspected column." +msgstr "調査対象のカラムの値の型。" + +msgid "``DATA_COLUMN_VALUE_COMPRESS_METHOD``" +msgstr "" + +msgid "The compress method of value of the inspected data column." +msgstr "調査対象のデータカラムの値の圧縮方法です。" + +msgid "Here is a list of compress methods:" +msgstr "以下は圧縮方法のリストです。" + +msgid "Compress method" +msgstr "圧縮方法" + +msgid "zlib" +msgstr "" + +msgid "``\"zlib\"``" +msgstr "" + +msgid "LZ4" +msgstr "" + +msgid "``\"lz4\"``" +msgstr "" + +msgid "Zstandard" +msgstr "" + +msgid "``\"zstd\"``" +msgstr "" + +msgid "None" +msgstr "なし" + +msgid "``null``" +msgstr "" + +msgid "``INDEX_COLUMN_VALUE_SECTION``" +msgstr "" + +msgid "" +"Whether the inspected column is created with ``WITH_SECTION`` flag or not. " +"The value is ``true`` if ``WITH_SECTION`` was specified, ``false`` otherwise." +msgstr "" +"調査対象のカラムが ``WITH_SECTION`` フラグ付きで作ったカラムかどうかを返しま" +"す。 ``WITH_SECTION`` フラグ付きでカラムを作ったときは ``true`` 、そうでない" +"ときは ``false`` になります。" + +msgid ":ref:`column-create-flags`" +msgstr "" + +msgid "``INDEX_COLUMN_VALUE_WEIGHT``" +msgstr "" + +msgid "" +"Whether the inspected column is created with ``WITH_WEIGHT`` flag or not. " +"The value is ``true`` if ``WITH_WEIGHT`` was specified, ``false`` otherwise." +msgstr "" +"調査対象のカラムが ``WITH_WEIGHT`` フラグ付きで作ったカラムかどうかを返しま" +"す。 ``WITH_WEIGHT`` フラグ付きでカラムを作ったときは ``true`` 、そうでないと" +"きは ``false`` になります。" + +msgid "``INDEX_COLUMN_VALUE_POSITION``" +msgstr "" + +msgid "" +"Whether the inspected column is created with ``WITH_POSITION`` flag or not. " +"The value is ``true`` if ``WITH_POSITION`` was specified, ``false`` " +"otherwise." +msgstr "" +"調査対象のカラムが ``WITH_POSITION`` フラグ付きで作ったカラムかどうかを返しま" +"す。 ``WITH_POSITION`` フラグ付きでカラムを作ったときは ``true`` 、そうでない" +"ときは ``false`` になります。" + +msgid "``INDEX_COLUMN_VALUE_SIZE``" +msgstr "" + +msgid "" +"The size of the inspected index column. Index size can be specified by :ref:" +"`column-create-flags`." +msgstr "" +"調査対象のインデックスカラムのサイズ。インデックスのサイズは :ref:`column-" +"create-flags` で指定できます。" + +msgid "Here is a list of index column sizes:" +msgstr "以下がインデックスカラムのサイズのリストです。" + +msgid "Index column size" +msgstr "インデックスカラムのサイズ" + +msgid "``\"small\"``" +msgstr "" + +msgid "``\"medium\"``" +msgstr "" + +msgid "Default" +msgstr "デフォルト" + +msgid "``\"normal\"``" +msgstr "" + +msgid "``INDEX_COLUMN_VALUE_STATISTICS_MAX_SECTION_ID``" +msgstr "" + +msgid "The max section ID in the inspected index column." +msgstr "調査対象のインデックスカラム最大セクションID。" + +msgid "" +"It's always ``0`` for index column that is created without ``WITH_SECTION`` " +"flag." +msgstr "" +"``WITH_SECTION`` フラグなしで作ったインデックスの場合は常に ``0`` になりま" +"す。" + +msgid "" +"It's ``0`` or larger for index column that is created with ``WITH_SECTION`` " +"flag. It's ``0`` for empty ``WITH_SECTION`` index column. It's ``1`` or " +"larger for non-empty ``WITH_SECTION`` index column." +msgstr "" +"``WITH_SECTION`` フラグ付きで作ったインデックスカラムの場合は ``0`` 以上にな" +"ります。空の ``WITH_SECTION`` 指定のインデックスカラムは ``0`` になります。空" +"でない ``WITH_SECTION`` 指定のインデックスカラムは ``1`` 以上になります。" + +msgid "" +"The max value for ``WITH_SECTION`` index column is the number of source " +"columns." +msgstr "" +"``WITH_SECTION`` 指定のインデックスカラムの最大値はソースカラム数です。" + +msgid "``INDEX_COLUMN_VALUE_STATISTICS_N_GARBAGE_SEGMENTS``" +msgstr "" + +msgid "The number of garbage segments in the inspected index column." +msgstr "調査対象のインデックスカラム内のゴミセグメントの数。" + +msgid "" +"Index column reuses segment (internal allocated space) that is no longer " +"used. It's called \"garbage segment\"." +msgstr "" +"インデックスカラムは使われなくなったセグメント（内部で確保している領域）を再" +"利用します。このセグメントのことを「ゴミセグメント」と呼びます。" + +msgid "The max value is the max number of segments. It depends on index size:" +msgstr "" +"最大値は最大セグメント数です。最大セグメント数はインデックスサイズに依りま" +"す。" + +msgid "The max number of segments" +msgstr "最大セグメント数" + +msgid "``2**9`` (512)" +msgstr "" + +msgid "``2**16`` (65536)" +msgstr "" + +msgid "``2**17`` (131072)" +msgstr "" + +msgid "``INDEX_COLUMN_VALUE_STATISTICS_MAX_ARRAY_SEGMENT_ID``" +msgstr "" + +msgid "The max ID of segment used for \"array\" in the inspected index column." +msgstr "" +"調査対象のインデックスカラム内の「array」に使用しているセグメントのうち一番大" +"きいIDの値。" + +msgid "\"array\" is used for managing \"buffer\"." +msgstr "「array」は「buffer」を管理するために使っています。" + +msgid "" +"The max value is the max number of segments. See :ref:`object-inspect-return-" +"value-index-column-value-statistics-n-garbage-segments` for the max number " +"of segments." +msgstr "" +"この値の最大値は最大セグメント数です。最大セグメント数は :ref:`object-" +"inspect-return-value-index-column-value-statistics-n-garbage-segments` を見て" +"ください。" + +msgid "" +"The number of segments used for \"array\" in the inspected index column." +msgstr "調査対象のインデックスカラム内の「array」に使っているセグメント数。" + +msgid "" +"The max value is ``the max number of segments - the number of segments used " +"for \"buffer\"``. See :ref:`object-inspect-return-value-index-column-value-" +"statistics-n-garbage-segments` for the max number of segments." +msgstr "" +"最大値は ``最大セグメント数 - 「buffer」に使っているセグメント数`` です。最大" +"セグメント数は :ref:`object-inspect-return-value-index-column-value-" +"statistics-n-garbage-segments` を見てください。" + +msgid "``INDEX_COLUMN_VALUE_STATISTICS_MAX_BUFFER_SEGMENT_ID``" +msgstr "" + +msgid "" +"The max ID of segment used for \"buffer\" in the inspected index column." +msgstr "" +"調査対象のインデックスカラム内の「buffer」に使っている最大セグメントID。" + +msgid "\"buffer\" is used for storing posting lists." +msgstr "「buffer」はポスティングリストを保存する場所です。" + +msgid "" +"The number of segments used for \"buffer\" in the inspected index column." +msgstr "" +"調査対象のインデックスカラム内の「buffer」に使っている最大セグメント数。" + +msgid "" +"The max value is ``the max number of segments - the number of segments used " +"for \"array\"``. See :ref:`object-inspect-return-value-index-column-value-" +"statistics-n-garbage-segments` for the max number of segments." +msgstr "" +"最大値は ``最大セグメント数 - 「array」に使っているセグメント数`` です。最大" +"セグメント数は :ref:`object-inspect-return-value-index-column-value-" +"statistics-n-garbage-segments` を見てください。" + +msgid "``INDEX_COLUMN_VALUE_STATISTICS_MAX_IN_USE_PHYSICAL_SEGMENT_ID``" +msgstr "" + +msgid "" +"The max segment ID in use as \"garbage\", \"array\" or \"buffer\" in the " +"inspected index column." +msgstr "" +"調査対象のインデックスカラム内の「ゴミセグメント」、「arrayセグメント」" +"「bufferセグメント」全体で使っているセグメントの最大ID。" + +msgid "``INDEX_COLUMN_VALUE_STATISTICS_N_UNMANAGED_SEGMENTS``" +msgstr "" + +msgid "The number of unmanaged segments in the inspected index column." +msgstr "調査対象のインデックスカラム内の未管理のセグメント数。" + +msgid "It must be ``0``." +msgstr "``0`` であるべきです。" + +msgid "``INDEX_COLUMN_VALUE_STATISTICS_TOTAL_CHUNK_SIZE``" +msgstr "" + +msgid "The total \"chunk\" size in the inspected index column." +msgstr "調査対象のインデックスカラム内の総「チャンク」サイズ。" + +msgid "" +"\"chunk\" is used for storing posting lists. \"buffer\" is mutable but " +"\"chunk\" is immutable. \"chunk\" is more space effective than \"buffer\". " +"\"buffer\" is more update effective than \"chunk\"." +msgstr "" +"「chunk」はポスティングリストを保存する場所です。「buffer」は変更可能ですが、" +"「chunk」は変更不可です。「chunk」は「buffer」よりも空間効率がよいです。" +"「buffer」は「chunk」よりも更新効率がよいです。" + +msgid "" +"Small posting lists are stored into \"buffer\". Posting lists in \"buffer\" " +"are moved to \"chunk\" when these posting lists are grew." +msgstr "" +"小さなポスティングリストは「buffer」に保存します。「buffer」内のポスティング" +"リストが大きくなると「chunk」に移動します。" + +msgid "" +"The max value is ``the max size of a chunk * the max number of chunks``. But " +"you will not be able to use all spaces because there are overheads." +msgstr "" +"最大値は ``1チャンクあたりの最大サイズ * 最大チャンク数`` 数です。ただし、" +"オーバーヘッドがあるためすべての領域を使い切ることはできないでしょう。" + +msgid "" +"The max size of a chunk is ``2 ** 22`` bytes (4MiB). The max number of " +"chunks depend on index size:" +msgstr "" +"1チャンクあたりの最大サイズは ``2 ** 22`` バイト（4MiB）です。最大チャンク数" +"はインデックスサイズに依存します。" + +msgid "The max number of chunks" +msgstr "最大チャンク数" + +msgid "``2**10`` (1024)" +msgstr "" + +msgid "``2**14`` (16384)" +msgstr "" + +msgid "``2**18`` (262144)" +msgstr "" + +msgid "``INDEX_COLUMN_VALUE_STATISTICS_MAX_IN_USE_CHUNK_ID``" +msgstr "" + +msgid "The max \"chunk\" ID in use in the inspected index column." +msgstr "調査対象のインデックスカラム内で使っている最大「chunk」ID。" + +msgid "" +"The max value is the max number of chunks. See :ref:`object-inspect-return-" +"value-index-column-value-statistics-total-chunk-size` for the max number of " +"chunks." +msgstr "" +"最大値は最大チャンク数です。最大チャンク数は :ref:`object-inspect-return-" +"value-index-column-value-statistics-total-chunk-size` を見てください。" + +msgid "``INDEX_COLUMN_VALUE_STATISTICS_N_GARBAGE_CHUNKS``" +msgstr "" + +msgid "" +"The array of the number of garbage \"chunks\" in the inspected index column." +msgstr "調査対象のインデックスカラム内のゴミ「chunk」の配列です。" + +msgid "" +"Garbage \"chunks\" are managed by separated 14 spaces. It shows all the " +"number of garbage \"chunks\" as an array like the following::" +msgstr "" +"ゴミ「chunk」は14個の領域で管理されています。次のように配列ですべての領域のゴ" +"ミ「chunk」の数を示します。::" + +msgid "" +"The max value of each space is the max number of chunks. See :ref:`object-" +"inspect-return-value-index-column-value-statistics-total-chunk-size` for the " +"max number of chunks." +msgstr "" +"各領域の最大値は最大チャンク数です。最大チャンク数は :ref:`object-inspect-" +"return-value-index-column-value-statistics-total-chunk-size` を見てください。" + +msgid "``INDEX_COLUMN_SOURCE_ID``" +msgstr "" + +msgid "The ID of a source column of the inspected index column." +msgstr "調査対象のインデックスカラム内のソースカラムのID。" + +msgid "``INDEX_COLUMN_SOURCE_NAME``" +msgstr "" + +msgid "The name of a source column of the inspected index column." +msgstr "調査対象のインデックスカラムのソースカラムの名前。" + +msgid "" +"If you want full column name (``TABLE_NAME.COLUMN_NAME`` style), use :ref:" +"`object-inspect-return-value-index-column-source-full-name` instead." +msgstr "" +"``TABLE_NAME.COLUMN_NAME`` スタイルの完全なカラム名を欲しい場合は代わりに :" +"ref:`object-inspect-return-value-index-column-source-full-name` を使ってくだ" +"さい。" + +msgid "``INDEX_COLUMN_SOURCE_TABLE``" +msgstr "" + +msgid "The table of a source column of the inspected index column." +msgstr "調査対象のインデックスカラム内のソースカラムのテーブル。" + +msgid "``INDEX_COLUMN_SOURCE_FULL_NAME``" +msgstr "" + +msgid "The full name of a source column of the inspected index column." +msgstr "調査対象のインデックスカラム内のソースカラムの完全な名前。" + +msgid "" +"If you just want only column name, use :ref:`object-inspect-return-value-" +"index-column-source-name` instead." +msgstr "" +"カラム名だけが必要な場合は代わりに :ref:`object-inspect-return-value-index-" +"column-source-name` を使ってください。" + msgid "Type" msgstr "型" @@ -12167,9 +12691,6 @@ msgstr "デフォルト値" msgid "Required or optional" msgstr "必須か省略可能か" -msgid "``null``" -msgstr "" - msgid "Required" msgstr "必須" @@ -16280,9 +16801,6 @@ msgstr "" msgid "Synopsis::" msgstr "書式::" -msgid "Default" -msgstr "" - msgid "``groonga off;``" msgstr "" @@ -17657,9 +18175,6 @@ msgstr "ログレベル" msgid "Integer value" msgstr "整数値" -msgid "None" -msgstr "なし" - msgid "``none``" msgstr "" Modified: doc/source/reference/commands/object_inspect.rst (+514 -0) =================================================================== --- doc/source/reference/commands/object_inspect.rst 2017-04-10 12:11:26 +0900 (d174714) +++ doc/source/reference/commands/object_inspect.rst 2017-04-10 14:51:17 +0900 (d464fa2) @@ -154,6 +154,7 @@ Table Table inspection returns the following information:: { + "id": TABLE_ID, "name": TABLE_NAME, "type": { "id": TABLE_TYPE_ID, @@ -178,6 +179,13 @@ There are some exceptions: * :ref:`table-dat-key` doesn't return value information because it doesn't have value. +.. _object-inspect-return-value-table-id: + +``TABLE_ID`` +"""""""""""" + +The ID of the inspected table. + .. _object-inspect-return-value-table-name: ``TABLE_NAME`` @@ -272,6 +280,512 @@ The number of records of the inspected table. It's a 64bit unsigned integer value. +.. _object-inspect-return-value-column: + +Column +^^^^^^ + +.. versionadded:: 7.0.2 + +Data column (scalar column and vector column) returns the following +information:: + + { + "id": COLUMN_ID, + "name": COLUMN_NAME + "table": COLUMN_TABLE, + "full_name": COLUMN_FULL_NAME, + "type": { + "name": COLUMN_TYPE_NAME, + "raw": { + "id": COLUMN_TYPE_RAW_ID, + "name": COLUMN_TYPE_RAW_NAME + } + }, + "value": { + "type": COLUMN_VALUE_TYPE, + "compress": DATA_COLUMN_VALUE_COMPRESS_METHOD, + } + } + +Index column is similar to data column but there are some differences. + + * Index column doesn't have ``value.compress`` key. + + * Index column has ``value.section`` key. + + * Index column has ``value.weight`` key. + + * Index column has ``value.position`` key. + + * Index column has ``value.size`` key. + + * Index column has ``value.statistics`` key. + + * Index column has ``sources`` key. + +Index column returns the following information:: + + { + "id": COLUMN_ID, + "name": COLUMN_NAME + "table": COLUMN_TABLE, + "full_name": COLUMN_FULL_NAME, + "type": { + "name": COLUMN_TYPE_NAME, + "raw": { + "id": COLUMN_TYPE_RAW_ID, + "name": COLUMN_TYPE_RAW_NAME + } + }, + "value": { + "type": COLUMN_VALUE_TYPE, + "section": INDEX_COLUMN_VALUE_SECTION, + "weight": INDEX_COLUMN_VALUE_WEIGHT, + "position": INDEX_COLUMN_VALUE_POSITION, + "size": INDEX_COLUMN_VALUE_SIZE, + "statistics": { + "max_section_id": INDEX_COLUMN_VALUE_STATISTICS_MAX_SECTION_ID, + "n_garbage_segments": INDEX_COLUMN_VALUE_STATISTICS_N_GARBAGE_SEGMENTS, + "max_array_segment_id": INDEX_COLUMN_VALUE_STATISTICS_MAX_ARRAY_SEGMENT_ID, + "n_array_segments": INDEX_COLUMN_VALUE_STATISTICS_N_ARRAY_SEGMENTS, + "max_buffer_segment_id": INDEX_COLUMN_VALUE_STATISTICS_MAX_BUFFER_SEGMENT_ID, + "n_buffer_segments": INDEX_COLUMN_VALUE_STATISTICS_N_BUFFER_SEGMENTS, + "max_in_use_physical_segment_id": INDEX_COLUMN_VALUE_STATISTICS_MAX_IN_USE_PHYSICAL_SEGMENT_ID, + "n_unmanaged_segments": INDEX_COLUMN_VALUE_STATISTICS_N_UNMANAGED_SEGMENTS, + "total_chunk_size": INDEX_COLUMN_VALUE_STATISTICS_TOTAL_CHUNK_SIZE, + "max_in_use_chunk_id": INDEX_COLUMN_VALUE_STATISTICS_MAX_IN_USE_CHUNK_ID, + "n_garbage_chunks": INDEX_COLUMN_VALUE_STATISTICS_N_GARBAGE_CHUNKS + } + }, + "sources": [ + { + "id": INDEX_COLUMN_SOURCE_ID, + "name": INDEX_COLUMN_SOURCE_NAME, + "table": INDEX_COLUMN_SOURCE_TABLE, + "full_name": INDEX_COLUMN_SOURCE_FULL_NAME + }, + ... + ] + } + +.. _object-inspect-return-value-column-id: + +``COLUMN_ID`` +""""""""""""" + +The ID of the inspected column. + +.. _object-inspect-return-value-column-name: + +``COLUMN_NAME`` +""""""""""""""" + +The name of the inspected column. + +It doesn't include table name. It's just only column name. + +If you want full column name (``TABLE_NAME.COLUMN_NAME`` style), use +:ref:`object-inspect-return-value-column-full-name` instead. + +.. _object-inspect-return-value-column-table: + +``COLUMN_TABLE`` +"""""""""""""""" + +The table of the inspected column. + +See :ref:`object-inspect-return-value-table` for format details. + +.. _object-inspect-return-value-column-full-name: + +``COLUMN_FULL_NAME`` +"""""""""""""""""""" + +The full name of the inspected column. + +It includes both table name and column name as +``TABLE_NAME.COLUMN_NAME`` format. + +If you just want only column name, use +:ref:`object-inspect-return-value-column-name` instead. + +.. _object-inspect-return-value-column-type-name: + +``COLUMN_TYPE_NAME`` +"""""""""""""""""""" + +The type name of the inspected column. + +Here is a list of type names: + +.. list-table:: + :header-rows: 1 + + * - Column type + - Name + * - :doc:`/reference/columns/scalar` + - ``"scalar"`` + * - :doc:`/reference/columns/vector` + - ``"vector"`` + * - :doc:`/reference/columns/index` + - ``"index"`` + +.. _object-inspect-return-value-column-type-raw-id: + +``COLUMN_TYPE_RAW_ID`` +"""""""""""""""""""""" + +The raw type ID of the inspected column. + +Here is a list of raw type IDs: + +.. list-table:: + :header-rows: 1 + + * - Raw column type + - ID + * - Fix size column + - ``64`` + * - Variable size column + - ``65`` + * - Index column + - ``72`` + +.. _object-inspect-return-value-column-type-raw-name: + +``COLUMN_TYPE_RAW_NAME`` +"""""""""""""""""""""""" + +The raw type name of the inspected column. + +Here is a list of raw type names: + +.. list-table:: + :header-rows: 1 + + * - Raw column type + - Name + * - Fix size column + - ``"column:fix_size"`` + * - Variable size column + - ``"column:var_size"`` + * - Index column + - ``"column:index"`` + +.. _object-inspect-return-value-column-value-type: + +``COLUMN_VALUE_TYPE`` +""""""""""""""""""""" + +The type of value of the inspected column. + +See :ref:`object-inspect-return-value-type` for format details. + +.. _object-inspect-return-value-data-column-value-compress-method: + +``DATA_COLUMN_VALUE_COMPRESS_METHOD`` +""""""""""""""""""""""""""""""""""""" + +The compress method of value of the inspected data column. + +Here is a list of compress methods: + +.. list-table:: + :header-rows: 1 + + * - Compress method + - Value + * - zlib + - ``"zlib"`` + * - LZ4 + - ``"lz4"`` + * - Zstandard + - ``"zstd"`` + * - None + - ``null`` + +.. _object-inspect-return-value-index-column-value-section: + +``INDEX_COLUMN_VALUE_SECTION`` +"""""""""""""""""""""""""""""" + +Whether the inspected column is created with ``WITH_SECTION`` flag or +not. The value is ``true`` if ``WITH_SECTION`` was specified, +``false`` otherwise. + +.. seealso:: :ref:`column-create-flags` + +.. _object-inspect-return-value-index-column-value-weight: + +``INDEX_COLUMN_VALUE_WEIGHT`` +""""""""""""""""""""""""""""" + +Whether the inspected column is created with ``WITH_WEIGHT`` flag or +not. The value is ``true`` if ``WITH_WEIGHT`` was specified, +``false`` otherwise. + +.. seealso:: :ref:`column-create-flags` + + .. _object-inspect-return-value-index-column-value-position: + +``INDEX_COLUMN_VALUE_POSITION`` +""""""""""""""""""""""""""""""" + +Whether the inspected column is created with ``WITH_POSITION`` flag or +not. The value is ``true`` if ``WITH_POSITION`` was specified, +``false`` otherwise. + +.. seealso:: :ref:`column-create-flags` + +.. _object-inspect-return-value-index-column-value-size: + +``INDEX_COLUMN_VALUE_SIZE`` +""""""""""""""""""""""""""" + +The size of the inspected index column. Index size can be specified by +:ref:`column-create-flags`. + +Here is a list of index column sizes: + +.. list-table:: + :header-rows: 1 + + * - Index column size + - Value + * - ``INDEX_SMALL`` + - ``"small"`` + * - ``INDEX_MEDIUM`` + - ``"medium"`` + * - Default + - ``"normal"`` + +.. _object-inspect-return-value-index-column-value-statistics-max-section-id: + +``INDEX_COLUMN_VALUE_STATISTICS_MAX_SECTION_ID`` +"""""""""""""""""""""""""""""""""""""""""""""""" + +The max section ID in the inspected index column. + +It's always ``0`` for index column that is created without +``WITH_SECTION`` flag. + +It's ``0`` or larger for index column that is created with +``WITH_SECTION`` flag. It's ``0`` for empty ``WITH_SECTION`` index +column. It's ``1`` or larger for non-empty ``WITH_SECTION`` index +column. + +The max value for ``WITH_SECTION`` index column is the number of +source columns. + +.. _object-inspect-return-value-index-column-value-statistics-n-garbage-segments: + +``INDEX_COLUMN_VALUE_STATISTICS_N_GARBAGE_SEGMENTS`` +"""""""""""""""""""""""""""""""""""""""""""""""""""" + +The number of garbage segments in the inspected index column. + +Index column reuses segment (internal allocated space) that is no +longer used. It's called "garbage segment". + +The max value is the max number of segments. It depends on index size: + +.. list-table:: + :header-rows: 1 + + * - Index column size + - The max number of segments + * - ``INDEX_SMALL`` + - ``2**9`` (512) + * - ``INDEX_MEDIUM`` + - ``2**16`` (65536) + * - Default + - ``2**17`` (131072) + +.. _object-inspect-return-value-index-column-value-statistics-max-array-segment-id: + +``INDEX_COLUMN_VALUE_STATISTICS_MAX_ARRAY_SEGMENT_ID`` +"""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The max ID of segment used for "array" in the inspected index column. + +"array" is used for managing "buffer". + +The max value is the max number of segments. See +:ref:`object-inspect-return-value-index-column-value-statistics-n-garbage-segments` +for the max number of segments. + +.. _object-inspect-return-value-index-column-value-statistics-n-array-segments: + +``INDEX_COLUMN_VALUE_STATISTICS_MAX_ARRAY_SEGMENT_ID`` +"""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The number of segments used for "array" in the inspected index column. + +"array" is used for managing "buffer". + +The max value is ``the max number of segments - the number of segments +used for "buffer"``. See +:ref:`object-inspect-return-value-index-column-value-statistics-n-garbage-segments` +for the max number of segments. + +.. _object-inspect-return-value-index-column-value-statistics-max-buffer-segment-id: + +``INDEX_COLUMN_VALUE_STATISTICS_MAX_BUFFER_SEGMENT_ID`` +""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The max ID of segment used for "buffer" in the inspected index column. + +"buffer" is used for storing posting lists. + +The max value is the max number of segments. See +:ref:`object-inspect-return-value-index-column-value-statistics-n-garbage-segments` +for the max number of segments. + +.. _object-inspect-return-value-index-column-value-statistics-n-buffer-segments: + +``INDEX_COLUMN_VALUE_STATISTICS_MAX_BUFFER_SEGMENT_ID`` +""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The number of segments used for "buffer" in the inspected index column. + +"buffer" is used for storing posting lists. + +The max value is ``the max number of segments - the number of segments +used for "array"``. See +:ref:`object-inspect-return-value-index-column-value-statistics-n-garbage-segments` +for the max number of segments. + +.. _object-inspect-return-value-index-column-value-statistics-max-in-use-physical-segment-id: + +``INDEX_COLUMN_VALUE_STATISTICS_MAX_IN_USE_PHYSICAL_SEGMENT_ID`` +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The max segment ID in use as "garbage", "array" or "buffer" in the +inspected index column. + +The max value is the max number of segments. See +:ref:`object-inspect-return-value-index-column-value-statistics-n-garbage-segments` +for the max number of segments. + +.. _object-inspect-return-value-index-column-value-statistics-n-unmanaged-segments: + +``INDEX_COLUMN_VALUE_STATISTICS_N_UNMANAGED_SEGMENTS`` +"""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The number of unmanaged segments in the inspected index column. + +It must be ``0``. + +.. _object-inspect-return-value-index-column-value-statistics-total-chunk-size: + +``INDEX_COLUMN_VALUE_STATISTICS_TOTAL_CHUNK_SIZE`` +"""""""""""""""""""""""""""""""""""""""""""""""""" + +The total "chunk" size in the inspected index column. + +"chunk" is used for storing posting lists. "buffer" is mutable but +"chunk" is immutable. "chunk" is more space effective than +"buffer". "buffer" is more update effective than "chunk". + +Small posting lists are stored into "buffer". Posting lists in +"buffer" are moved to "chunk" when these posting lists are grew. + +The max value is ``the max size of a chunk * the max number of +chunks``. But you will not be able to use all spaces because there are +overheads. + +The max size of a chunk is ``2 ** 22`` bytes (4MiB). The max +number of chunks depend on index size: + +.. list-table:: + :header-rows: 1 + + * - Index column size + - The max number of chunks + * - ``INDEX_SMALL`` + - ``2**10`` (1024) + * - ``INDEX_MEDIUM`` + - ``2**14`` (16384) + * - Default + - ``2**18`` (262144) + +.. _object-inspect-return-value-index-column-value-statistics-max-in-use-chunk-id: + +``INDEX_COLUMN_VALUE_STATISTICS_MAX_IN_USE_CHUNK_ID`` +""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The max "chunk" ID in use in the inspected index column. + +The max value is the max number of chunks. See +:ref:`object-inspect-return-value-index-column-value-statistics-total-chunk-size` +for the max number of chunks. + +.. _object-inspect-return-value-index-column-value-statistics-n-garbage-chunks: + +``INDEX_COLUMN_VALUE_STATISTICS_N_GARBAGE_CHUNKS`` +"""""""""""""""""""""""""""""""""""""""""""""""""" + +The array of the number of garbage "chunks" in the inspected index +column. + +Garbage "chunks" are managed by separated 14 spaces. It shows all the +number of garbage "chunks" as an array like the following:: + + [ + N_GARBAGE_CHUNKS_IN_SPACE0, + N_GARBAGE_CHUNKS_IN_SPACE1, + ... + N_GARBAGE_CHUNKS_IN_SPACE13 + ] + +The max value of each space is the max number of chunks. See +:ref:`object-inspect-return-value-index-column-value-statistics-total-chunk-size` +for the max number of chunks. + +.. _object-inspect-return-value-index-column-source-id: + +``INDEX_COLUMN_SOURCE_ID`` +"""""""""""""""""""""""""" + +The ID of a source column of the inspected index column. + +.. _object-inspect-return-value-index-column-source-name: + +``INDEX_COLUMN_SOURCE_NAME`` +"""""""""""""""""""""""""""" + +The name of a source column of the inspected index column. + +It doesn't include table name. It's just only column name. + +If you want full column name (``TABLE_NAME.COLUMN_NAME`` style), use +:ref:`object-inspect-return-value-index-column-source-full-name` +instead. + +.. _object-inspect-return-value-index-column-source-table: + +``INDEX_COLUMN_SOURCE_TABLE`` +""""""""""""""""""""""""""""" + +The table of a source column of the inspected index column. + +See :ref:`object-inspect-return-value-table` for format details. + +.. _object-inspect-return-value-index-column-source-full-name: + +``INDEX_COLUMN_SOURCE_FULL_NAME`` +""""""""""""""""""""""""""""""""" + +The full name of a source column of the inspected index column. + +It includes both table name and column name as +``TABLE_NAME.COLUMN_NAME`` format. + +If you just want only column name, use +:ref:`object-inspect-return-value-index-column-source-name` instead. + + .. _object-inspect-return-value-type: Type -------------- next part -------------- HTML����������������������������...Download