> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Representa o conteúdo dos arquivos de índice e de marcas das tabelas MergeTree. Pode ser usada para introspecção.

# mergeTreeIndex

Representa o conteúdo dos arquivos de índice e de marcas das tabelas MergeTree. Pode ser usada para introspecção.

<div id="syntax">
  ## Sintaxe
</div>

```sql theme={null}
mergeTreeIndex(database, table [, with_marks = true] [, with_minmax = true])
```

<div id="arguments">
  ## Argumentos
</div>

| Argumento     | Descrição                                                  |
| ------------- | ---------------------------------------------------------- |
| `database`    | O nome do banco de dados de onde ler o índice e as marcas. |
| `table`       | O nome da tabela de onde ler o índice e as marcas.         |
| `with_marks`  | Se deve incluir colunas com marcas no resultado.           |
| `with_minmax` | Se deve incluir o índice min-max no resultado.             |

<div id="returned_value">
  ## Valor retornado
</div>

Um objeto do tipo tabela com colunas contendo valores do índice primário e do índice min-max (se estiver habilitado) da tabela de origem, colunas com os valores das marcas (se estiverem habilitadas) para todos os arquivos possíveis nas partes de dados da tabela de origem e colunas virtuais:

* `part_name` - O nome da parte de dados.
* `mark_number` - O número da marca atual na parte de dados.
* `rows_in_granule` - O número de linhas no grânulo atual.

A coluna de marcas pode conter o valor `(NULL, NULL)` caso a coluna esteja ausente na parte de dados ou as marcas de um de seus substreams não tenham sido gravadas (por exemplo, em partes compactas).

<div id="usage-example">
  ## Exemplo de uso
</div>

```sql theme={null}
CREATE TABLE test_table
(
    `id` UInt64,
    `n` UInt64,
    `arr` Array(UInt64)
)
ENGINE = MergeTree
ORDER BY id
SETTINGS index_granularity = 3, min_bytes_for_wide_part = 0, min_rows_for_wide_part = 8;

INSERT INTO test_table SELECT number, number, range(number % 5) FROM numbers(5);

INSERT INTO test_table SELECT number, number, range(number % 5) FROM numbers(10, 10);
```

```sql theme={null}
SELECT * FROM mergeTreeIndex(currentDatabase(), test_table, with_marks = true);
```

```text theme={null}
┌─part_name─┬─mark_number─┬─rows_in_granule─┬─id─┬─id.mark─┬─n.mark──┬─arr.size0.mark─┬─arr.mark─┐
│ all_1_1_0 │           0 │               3 │  0 │ (0,0)   │ (42,0)  │ (NULL,NULL)    │ (84,0)   │
│ all_1_1_0 │           1 │               2 │  3 │ (133,0) │ (172,0) │ (NULL,NULL)    │ (211,0)  │
│ all_1_1_0 │           2 │               0 │  4 │ (271,0) │ (271,0) │ (NULL,NULL)    │ (271,0)  │
└───────────┴─────────────┴─────────────────┴────┴─────────┴─────────┴────────────────┴──────────┘
┌─part_name─┬─mark_number─┬─rows_in_granule─┬─id─┬─id.mark─┬─n.mark─┬─arr.size0.mark─┬─arr.mark─┐
│ all_2_2_0 │           0 │               3 │ 10 │ (0,0)   │ (0,0)  │ (0,0)          │ (0,0)    │
│ all_2_2_0 │           1 │               3 │ 13 │ (0,24)  │ (0,24) │ (0,24)         │ (0,24)   │
│ all_2_2_0 │           2 │               3 │ 16 │ (0,48)  │ (0,48) │ (0,48)         │ (0,80)   │
│ all_2_2_0 │           3 │               1 │ 19 │ (0,72)  │ (0,72) │ (0,72)         │ (0,128)  │
│ all_2_2_0 │           4 │               0 │ 19 │ (0,80)  │ (0,80) │ (0,80)         │ (0,160)  │
└───────────┴─────────────┴─────────────────┴────┴─────────┴────────┴────────────────┴──────────┘
```

```sql theme={null}
DESCRIBE mergeTreeIndex(currentDatabase(), test_table, with_marks = true) SETTINGS describe_compact_output = 1;
```

```text theme={null}
┌─name────────────┬─type─────────────────────────────────────────────────────────────────────────────────────────────┐
│ part_name       │ String                                                                                           │
│ mark_number     │ UInt64                                                                                           │
│ rows_in_granule │ UInt64                                                                                           │
│ id              │ UInt64                                                                                           │
│ id.mark         │ Tuple(offset_in_compressed_file Nullable(UInt64), offset_in_decompressed_block Nullable(UInt64)) │
│ n.mark          │ Tuple(offset_in_compressed_file Nullable(UInt64), offset_in_decompressed_block Nullable(UInt64)) │
│ arr.size0.mark  │ Tuple(offset_in_compressed_file Nullable(UInt64), offset_in_decompressed_block Nullable(UInt64)) │
│ arr.mark        │ Tuple(offset_in_compressed_file Nullable(UInt64), offset_in_decompressed_block Nullable(UInt64)) │
└─────────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────┘
```