This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 368ef64166a [doc](lance) add doc about lance_index_entries TVF (#4311)
368ef64166a is described below
commit 368ef64166a6100e723c258c2ad1328e659a496a
Author: kid <[email protected]>
AuthorDate: Sat Oct 17 05:38:36 2026 +0800
[doc](lance) add doc about lance_index_entries TVF (#4311)
Document the physical `lance_index_entries` table-valued function for
Lance Filesystem Catalog tables added in apache/doris#66671. This closes
the documentation item deferred in that PR and tracked in
apache/doris#66497 ("Show index names, UUIDs, columns, types, and
dataset versions ... user documentation for the physical
`lance_index_entries` TVF remains outstanding"). It also resolves the
forward reference to `lance_index_entries()` already present in the
Lance time-travel limitations (#4172).
## What Changed
- `lakehouse/catalogs/lance-catalog.mdx` (EN + zh-CN)
- Feature Overview: metadata access now lists the `lance_index_entries`
TVF alongside `SHOW INDEX` (both Filesystem Catalogs only); the
system-tables row points users to both surfaces for index metadata.
- New "List Physical Index Entries with lance_index_entries" subsection
under "Inspect Lance Indexes": why the physical view exists (UUID and
dataset version do not fit the fixed MySQL-style 13-column `SHOW INDEX`
schema), the six fixed columns, the dataset-version semantics recorded
on each entry, read/validation semantics (all-or-error, 16,384 raw-entry
cap, reserved system indexes validated but not displayed, ordered by
`(IndexName, IndexUuid)`), ordinary-predicate filtering, the `SHOW`
privilege requirement, and the fixed `lance_index_entries is not
supported for Lance REST catalogs` error.
-
`sql-manual/sql-functions/table-valued-functions/lance-index-entries.md`
(EN + zh-CN, new)
- Standalone TVF reference: description, syntax, required `table`
parameter (fully qualified three-part name, backtick quoting), the fixed
return columns, and examples including a predicate filter. Linked back
to the Lance Catalog page.
- `versioned_sidebars/version-4.x-sidebars.json`
- Registered the new page in the table-valued-functions list
(alphabetical, between `jobs` and `local`).
`docs/` (dev) is intentionally untouched: the Lance catalog
documentation is not present in dev because apache/doris master has no
Lance code (the feature lives on branch-4.1), matching #4090.
## Verified versions and validation
Lance Catalog is available from 4.1.4; `lance_index_entries` is
available from 4.1.5. Verified against `branch-4.1`, the 4.1.4 and
4.1.5-release source tags, the TVF argument/authorization
implementation, physical-entry validation and the existing Lance
regression suite. Master has no Lance catalog implementation, so current
docs are intentionally not added.
Rebased onto current website master. Both languages include version
markers, prerequisites, parameter/empty-result behavior and expected
example results. `git diff --check` and sidebar JSON validation pass. No
source build or live cluster execution was performed in this audit.
## Versions
- [ ] dev
- [x] 4.x
## Languages
- [x] Chinese
- [x] English
---------
Co-authored-by: u70b3 <[email protected]>
Co-authored-by: morningman <[email protected]>
---
.../lakehouse/catalogs/lance-catalog.mdx | 43 +++++++++-
.../table-valued-functions/lance-index-entries.md | 97 ++++++++++++++++++++++
.../lakehouse/catalogs/lance-catalog.mdx | 43 +++++++++-
.../table-valued-functions/lance-index-entries.md | 97 ++++++++++++++++++++++
versioned_sidebars/version-4.x-sidebars.json | 1 +
5 files changed, 275 insertions(+), 6 deletions(-)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
index 199da0e385b..0ecad36aa7d 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
@@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem';
:::note
这是一个实验性功能。
-Lance Catalog 自 Apache Doris 4.2 版本开始支持。
+Lance Catalog 自 Apache Doris 4.1.4 版本开始支持。
:::
Lance 是面向分析和 AI 场景的列式数据格式。Doris 可以通过 Lance Catalog 发现 Lance Namespace
中的数据库和表，并直接查询存储在本地文件系统、S3 兼容对象存储或阿里云 OSS 中的 Lance 数据集。
@@ -35,8 +35,8 @@ Lance 是面向分析和 AI 场景的列式数据格式。Doris 可以通过 Lan
|---|---|
| Filesystem Catalog | 支持本地文件系统、`file://`、`s3://` 和 `oss://` Warehouse |
| REST Catalog | 支持 Lance REST Namespace，以及无认证、Bearer Token、API Key 和自定义 HTTP
Header |
-| 元数据访问 | 支持 `SHOW DATABASES`、`SHOW TABLES`、`DESC` 和 `SHOW INDEX`（仅 Filesystem
Catalog） |
-| 系统表（`table$...`） | 暂不支持；索引元数据请使用 `SHOW INDEX` |
+| 元数据访问 | 支持 `SHOW DATABASES`、`SHOW TABLES`、`DESC`、`SHOW INDEX` 和
`lance_index_entries` TVF（后两者仅 Filesystem Catalog） |
+| 系统表（`table$...`） | 暂不支持；索引元数据请使用 `SHOW INDEX` 和 `lance_index_entries` TVF |
| 数据查询 | 支持列裁剪、并行扫描 Lance Fragment 和当前版本的快照一致性读取 |
| 谓词下推 | 支持将部分静态标量谓词和 Join Runtime Filter 下推到 Lance 执行 |
| 文件 TVF | 支持通过 `s3()` 和 `local()` 直接查询 Lance 数据集 |
@@ -469,6 +469,43 @@ nested_index nested_label_btree 1
attributes.`child.with.dot`
`SHOW INDEX` 需要用户拥有该表的 `SHOW` 权限。对于 REST Catalog，该语句会被拒绝并返回错误 `SHOW INDEX is
not supported for Lance REST catalogs`。
+### 使用 lance_index_entries 查看物理索引条目
+
+:::note
+`lance_index_entries` 自 Apache Doris 4.1.5 起支持。
+:::
+
+`SHOW INDEX` 提供 Lance 表索引的逻辑视图：索引名、被索引列、索引类型和属性，使用固定的 MySQL 风格 13
列结果集。索引条目的物理身份（UUID 和数据集版本）无法放入该固定 Schema，因此由只读表函数 `lance_index_entries`
提供物理视图。它为最新数据集快照中记录的每个物理索引条目返回一行：
+
+```sql
+SELECT *
+FROM lance_index_entries("table" = "lance_catalog.default.vs_ivf_pq_f32");
+```
+
+`table` 必须是完整的三部分 `catalog.database.table` 名称。标识符支持反引号引用，多级 Namespace 映射为包含
`.` 的数据库名时，需要使用反引号引用数据库部分。
+
+该 TVF 返回以下固定列：
+
+| 列 | 类型 | 说明 |
+|---|---|---|
+| `CatalogName` | STRING | Catalog 名。 |
+| `DatabaseName` | STRING | 数据库名。 |
+| `TableName` | STRING | 表名。 |
+| `IndexName` | STRING | Lance 逻辑索引名。一个逻辑索引存在多个不同 UUID 的物理条目时会输出多行。 |
+| `IndexUuid` | STRING | 该物理索引条目的 UUID。 |
+| `DatasetVersion` | BIGINT |
物理索引条目上记录的数据集版本，即该条目写入时的数据集版本。同一逻辑索引的不同物理条目可能对应不同的数据集版本。恒大于等于 `1`。 |
+
+下面的示例展示了上文中 `IVF_PQ` 索引对应的一行结果，其中 `IndexUuid` 和 `DatasetVersion` 为示意值：
+
+```text
+CatalogName DatabaseName TableName IndexName IndexUuid
DatasetVersion
+lance_catalog default vs_ivf_pq_f32 embedding_ivf_pq_f32
3f9c2a1e-7b4d-4e6f-9a1c-2d5e8f0b3a47 12
+```
+
+`lance_index_entries` 只通过 `Dataset.getIndexes()`
读取索引元数据，不读取行数或统计信息，也不会修改数据集。结果可以使用普通谓词过滤，例如 `WHERE IndexName = ...`。结果按
`(IndexName, IndexUuid)` 排序。读取经过完整校验且为 all-or-error：空白或超长名称、缺失 UUID、非正
`DatasetVersion`、重复 UUID，或原始条目数超过 16,384，都会使整个查询失败，而不是返回截断后的部分结果。Lance
内部维护的保留系统索引（`__lance_frag_reuse` 和 `__lance_mem_wal`）会被校验但不会展示。
+
+`lance_index_entries` 需要用户拥有该表的 `SHOW` 权限。对于 REST Catalog，该 TVF 会被拒绝并返回错误
`lance_index_entries is not supported for Lance REST catalogs`。
+
## 类型映射
| Lance / Arrow 类型 | Doris 类型 | 说明 |
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-functions/table-valued-functions/lance-index-entries.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-functions/table-valued-functions/lance-index-entries.md
new file mode 100644
index 00000000000..c15b28f5f4b
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-functions/table-valued-functions/lance-index-entries.md
@@ -0,0 +1,97 @@
+---
+{
+ "title": "LANCE_INDEX_ENTRIES",
+ "language": "zh-CN",
+ "description": "lance_index_entries 表函数（table-valued function, TVF），用于列出
Filesystem Catalog 中 Lance 表最新快照记录的物理索引条目。"
+}
+---
+
+## 描述
+
+:::note
+`lance_index_entries` 自 Apache Doris 4.1.5 起支持。
+:::
+
+`lance_index_entries` 表函数（TVF）列出 Lance 表最新快照中记录的物理索引条目，每个物理索引条目返回一行。它是对 `SHOW
INDEX` 的补充：`SHOW INDEX` 以固定的 MySQL 风格结果集展示逻辑索引视图（索引名、被索引列、索引类型和属性），而物理索引条目的
UUID 和数据集版本无法放入该固定 Schema，只能通过本 TVF 获取。一个逻辑索引存在多个不同 UUID 的物理条目时，同一索引名会出现在多行中。
+
+该 TVF 为只读，仅通过 `Dataset.getIndexes()` 读取索引元数据，不读取行数或统计信息。结果可以使用普通谓词过滤。结果按
`(IndexName, IndexUuid)` 排序。读取经过完整校验且为 all-or-error：空白或超长名称、缺失 UUID、非正
`DatasetVersion`、重复 UUID，或原始条目数超过 16,384，都会使整个查询失败，而不是返回截断后的部分结果。Lance
内部维护的保留系统索引（`__lance_frag_reuse` 和 `__lance_mem_wal`）会被校验但不会展示。
+
+该 TVF 需要用户拥有该表的 `SHOW` 权限，且仅支持 Lance Filesystem Catalog。对于 REST Catalog，该 TVF
会被拒绝并返回错误 `lance_index_entries is not supported for Lance REST catalogs`。
+
+## 语法
+
+```sql
+LANCE_INDEX_ENTRIES(
+ "table" = "<table>"
+ );
+```
+
+## 参数
+
+`lance_index_entries` 表函数（TVF）接受一个 `"key"="value"` 参数对。
+
+| 参数 | 描述 |
+|---|---|
+| `<table>` | 要查看的 Lance 表的完整三部分 `catalog.database.table` 名称。标识符支持反引号引用；多级
Lance Namespace 映射为包含 `.` 的数据库名时，需要使用反引号引用数据库部分，例如 ``
lance_catalog.`doris.analytics`.items ``。 |
+
+## 返回值
+
+该 TVF 返回一个结果集，不返回标量 NULL。表中没有用户索引时返回零行；缺失或无效的 `table` 参数会报错。`table`
必须为非空字符串，不接受 SQL NULL。
+
+该 TVF 返回以下固定列：
+
+| 列 | 类型 | 说明 |
+|---|---|---|
+| `CatalogName` | STRING | Catalog 名。 |
+| `DatabaseName` | STRING | 数据库名。 |
+| `TableName` | STRING | 表名。 |
+| `IndexName` | STRING | Lance 逻辑索引名。 |
+| `IndexUuid` | STRING | 物理索引条目的 UUID。 |
+| `DatasetVersion` | BIGINT |
物理索引条目上记录的数据集版本，即该条目写入时的数据集版本。同一逻辑索引的不同物理条目可能对应不同的数据集版本。恒大于等于 `1`。 |
+
+## 示例
+
+先按 [Lance Catalog](../../../lakehouse/catalogs/lance-catalog.mdx) 配置
Filesystem Catalog，并在外部 Lance 工具中创建数据集及索引。将示例名称替换为可访问的表；需要该表的 `SHOW` 权限。
+
+- 查看 `lance_catalog` 中表 `vs_ivf_pq_f32` 的物理索引条目：
+
+ ```sql
+ select * from lance_index_entries("table" =
"lance_catalog.default.vs_ivf_pq_f32");
+ ```
+ ```text
+
+---------------+--------------+---------------+----------------------+--------------------------------------+----------------+
+ | CatalogName | DatabaseName | TableName | IndexName |
IndexUuid | DatasetVersion |
+
+---------------+--------------+---------------+----------------------+--------------------------------------+----------------+
+ | lance_catalog | default | vs_ivf_pq_f32 | embedding_ivf_pq_f32 |
3f9c2a1e-7b4d-4e6f-9a1c-2d5e8f0b3a47 | 12 |
+
+---------------+--------------+---------------+----------------------+--------------------------------------+----------------+
+ ```
+
+ 以上输出中的 `IndexUuid` 和 `DatasetVersion` 为示意值。
+
+- 使用普通谓词过滤结果：
+
+ ```sql
+ select IndexName, IndexUuid
+ from lance_index_entries("table" = "lance_catalog.default.vs_ivf_pq_f32")
+ where DatasetVersion >= 12
+ order by IndexName, IndexUuid;
+ ```
+
+ ```text
+ IndexName IndexUuid
+ embedding_ivf_pq_f32 3f9c2a1e-7b4d-4e6f-9a1c-2d5e8f0b3a47
+ ```
+
+空的 `table` 参数会报错，错误信息包含：
+
+```sql
+SELECT * FROM lance_index_entries("table" = "");
+```
+
+```text
+Missing required lance_index_entries property 'table'
+```
+
+## 相关说明
+
+更多关于 Lance 索引查看的信息，包括 `SHOW INDEX` 提供的逻辑视图，请参阅 [Lance
Catalog](../../../lakehouse/catalogs/lance-catalog.mdx)。
diff --git a/versioned_docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
b/versioned_docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
index 2303fd5996e..a335affdc17 100644
--- a/versioned_docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
+++ b/versioned_docs/version-4.x/lakehouse/catalogs/lance-catalog.mdx
@@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem';
:::note
This is an experimental feature.
-Lance Catalog is supported starting from Apache Doris 4.2.
+Lance Catalog is supported starting from Apache Doris 4.1.4.
:::
Lance is a columnar data format designed for analytics and AI workloads. Doris
can use a Lance Catalog to discover databases and tables in a Lance Namespace
and directly query Lance datasets stored on a local file system, S3-compatible
object storage, or Alibaba Cloud OSS.
@@ -35,8 +35,8 @@ Doris currently provides read-only access to Lance. Creating,
writing, updating,
|---|---|
| Filesystem Catalog | Supports warehouses on a local file system, `file://`,
`s3://`, or `oss://` |
| REST Catalog | Supports Lance REST Namespace with no authentication, Bearer
Token, API Key, or custom HTTP headers |
-| Metadata access | Supports `SHOW DATABASES`, `SHOW TABLES`, `DESC`, and
`SHOW INDEX` (Filesystem Catalogs only) |
-| System tables (`table$...`) | Not supported; use `SHOW INDEX` for index
metadata |
+| Metadata access | Supports `SHOW DATABASES`, `SHOW TABLES`, `DESC`, `SHOW
INDEX`, and the `lance_index_entries` TVF (the last two only for Filesystem
Catalogs) |
+| System tables (`table$...`) | Not supported; use `SHOW INDEX` and the
`lance_index_entries` TVF for index metadata |
| Data queries | Supports column pruning, parallel Lance Fragment scans, and
snapshot-consistent reads of the current version |
| Predicate pushdown | Supports pushing compatible static scalar predicates
and join Runtime Filters down to Lance |
| File TVFs | Supports querying Lance datasets directly through `s3()` and
`local()` |
@@ -469,6 +469,43 @@ nested_index nested_label_btree 1
attributes.`child.with.dot`
`SHOW INDEX` requires the `SHOW` privilege on the table. For a REST Catalog,
the statement is rejected with the error `SHOW INDEX is not supported for Lance
REST catalogs`.
+### List Physical Index Entries with lance_index_entries
+
+:::note
+`lance_index_entries` is supported starting from Apache Doris 4.1.5.
+:::
+
+`SHOW INDEX` provides the logical view of the indexes of a Lance table: index
name, indexed columns, index type, and properties, in the fixed MySQL-style
13-column result set. The physical identity of an index entry, its UUID and
dataset version, does not fit into that fixed schema. The read-only
table-valued function `lance_index_entries` provides this physical view. It
returns one row for each physical index entry recorded in the latest dataset
snapshot:
+
+```sql
+SELECT *
+FROM lance_index_entries("table" = "lance_catalog.default.vs_ivf_pq_f32");
+```
+
+`table` must be a fully qualified, three-part `catalog.database.table` name.
Identifiers support backtick quoting, so if a multilevel Namespace maps to a
database name containing `.`, quote the database part with backticks.
+
+The TVF returns the following fixed columns:
+
+| Column | Type | Description |
+|---|---|---|
+| `CatalogName` | STRING | Catalog name. |
+| `DatabaseName` | STRING | Database name. |
+| `TableName` | STRING | Table name. |
+| `IndexName` | STRING | Name of the Lance logical index. One logical index
produces multiple rows when it has several physical entries with different
UUIDs. |
+| `IndexUuid` | STRING | UUID of this physical index entry. |
+| `DatasetVersion` | BIGINT | Dataset version recorded on this physical index
entry, that is, the dataset version at which the entry was written. Physical
entries of the same logical index can carry different dataset versions. It is
always `1` or greater. |
+
+The following row illustrates the result for the `IVF_PQ` index shown above.
`IndexUuid` and `DatasetVersion` are illustrative values:
+
+```text
+CatalogName DatabaseName TableName IndexName IndexUuid
DatasetVersion
+lance_catalog default vs_ivf_pq_f32 embedding_ivf_pq_f32
3f9c2a1e-7b4d-4e6f-9a1c-2d5e8f0b3a47 12
+```
+
+`lance_index_entries` only reads index metadata through
`Dataset.getIndexes()`. It does not read row counts or statistics, and it does
not modify the dataset. The result can be filtered with ordinary predicates,
for example `WHERE IndexName = ...`. Rows are sorted by `(IndexName,
IndexUuid)`. The read is fully validated and all-or-error: a blank or overlong
name, a missing UUID, a non-positive `DatasetVersion`, a duplicate UUID, or a
raw entry count above 16,384 fails the entire query in [...]
+
+`lance_index_entries` requires the `SHOW` privilege on the table. For a REST
Catalog, the TVF is rejected with the error `lance_index_entries is not
supported for Lance REST catalogs`.
+
## Type Mapping
| Lance / Arrow Type | Doris Type | Description |
diff --git
a/versioned_docs/version-4.x/sql-manual/sql-functions/table-valued-functions/lance-index-entries.md
b/versioned_docs/version-4.x/sql-manual/sql-functions/table-valued-functions/lance-index-entries.md
new file mode 100644
index 00000000000..cff1db5a957
--- /dev/null
+++
b/versioned_docs/version-4.x/sql-manual/sql-functions/table-valued-functions/lance-index-entries.md
@@ -0,0 +1,97 @@
+---
+{
+ "title": "LANCE_INDEX_ENTRIES",
+ "language": "en",
+ "description": "lance_index_entries table-valued function (TVF). Lists the
physical index entries recorded in the latest snapshot of a Lance table in a
Filesystem Catalog."
+}
+---
+
+## Description
+
+:::note
+`lance_index_entries` is supported starting from Apache Doris 4.1.5.
+:::
+
+The `lance_index_entries` table-valued function (TVF) lists the physical index
entries recorded in the latest snapshot of a Lance table. It returns one row
per physical index entry and complements `SHOW INDEX`, which displays the
logical index view (index name, indexed columns, index type, and properties) in
the fixed MySQL-style result set. The UUID and dataset version of a physical
index entry do not fit into that fixed schema and are exposed only through this
TVF. One logical index na [...]
+
+The TVF is read-only. It reads index metadata only through
`Dataset.getIndexes()` and does not read row counts or statistics. The result
can be filtered with ordinary predicates. Rows are sorted by `(IndexName,
IndexUuid)`. The read is fully validated and all-or-error: a blank or overlong
name, a missing UUID, a non-positive `DatasetVersion`, a duplicate UUID, or a
raw entry count above 16,384 fails the entire query instead of returning a
truncated result. The reserved system indexes tha [...]
+
+The TVF requires the `SHOW` privilege on the table and is only supported for
Lance Filesystem Catalogs. For a REST Catalog, it is rejected with the error
`lance_index_entries is not supported for Lance REST catalogs`.
+
+## Syntax
+
+```sql
+LANCE_INDEX_ENTRIES(
+ "table" = "<table>"
+ );
+```
+
+## Parameters
+
+`lance_index_entries` accepts exactly one `"key"="value"` pair.
+
+| Parameter | Description |
+|---|---|
+| `<table>` | The fully qualified, three-part `catalog.database.table` name of
the Lance table to inspect. Identifiers support backtick quoting. If a
multilevel Lance Namespace maps to a database name containing `.`, quote the
database part with backticks, for example ``
lance_catalog.`doris.analytics`.items ``. |
+
+## Return Value
+
+The TVF returns a result set rather than a scalar NULL. A table without user
indexes produces zero rows. A missing or invalid `table` argument raises an
error. The `table` argument must be a nonempty string and does not accept SQL
NULL.
+
+The TVF returns the following fixed columns:
+
+| Column | Type | Description |
+|---|---|---|
+| `CatalogName` | STRING | Catalog name. |
+| `DatabaseName` | STRING | Database name. |
+| `TableName` | STRING | Table name. |
+| `IndexName` | STRING | Name of the Lance logical index. |
+| `IndexUuid` | STRING | UUID of the physical index entry. |
+| `DatasetVersion` | BIGINT | Dataset version recorded on the physical index
entry, that is, the dataset version at which the entry was written. Physical
entries of the same logical index can carry different dataset versions. It is
always `1` or greater. |
+
+## Example
+
+First configure a Filesystem Catalog as described in [Lance
Catalog](../../../lakehouse/catalogs/lance-catalog.mdx), and create a dataset
and index using external Lance tooling. Replace the example names with a table
you can access. The `SHOW` privilege on that table is required.
+
+- List the physical index entries of table `vs_ivf_pq_f32` in catalog
`lance_catalog`:
+
+ ```sql
+ select * from lance_index_entries("table" =
"lance_catalog.default.vs_ivf_pq_f32");
+ ```
+ ```text
+
+---------------+--------------+---------------+----------------------+--------------------------------------+----------------+
+ | CatalogName | DatabaseName | TableName | IndexName |
IndexUuid | DatasetVersion |
+
+---------------+--------------+---------------+----------------------+--------------------------------------+----------------+
+ | lance_catalog | default | vs_ivf_pq_f32 | embedding_ivf_pq_f32 |
3f9c2a1e-7b4d-4e6f-9a1c-2d5e8f0b3a47 | 12 |
+
+---------------+--------------+---------------+----------------------+--------------------------------------+----------------+
+ ```
+
+ `IndexUuid` and `DatasetVersion` in this output are illustrative values.
+
+- Filter the result with an ordinary predicate:
+
+ ```sql
+ select IndexName, IndexUuid
+ from lance_index_entries("table" = "lance_catalog.default.vs_ivf_pq_f32")
+ where DatasetVersion >= 12
+ order by IndexName, IndexUuid;
+ ```
+
+ ```text
+ IndexName IndexUuid
+ embedding_ivf_pq_f32 3f9c2a1e-7b4d-4e6f-9a1c-2d5e8f0b3a47
+ ```
+
+An empty `table` argument raises an error containing the following message:
+
+```sql
+SELECT * FROM lance_index_entries("table" = "");
+```
+
+```text
+Missing required lance_index_entries property 'table'
+```
+
+## Related
+
+For more information about Lance index inspection, including the logical view
provided by `SHOW INDEX`, refer to [Lance
Catalog](../../../lakehouse/catalogs/lance-catalog.mdx#inspect-lance-indexes).
diff --git a/versioned_sidebars/version-4.x-sidebars.json
b/versioned_sidebars/version-4.x-sidebars.json
index ecd12601907..0a4f3107288 100644
--- a/versioned_sidebars/version-4.x-sidebars.json
+++ b/versioned_sidebars/version-4.x-sidebars.json
@@ -2451,6 +2451,7 @@
"sql-manual/sql-functions/table-valued-functions/hudi-meta",
"sql-manual/sql-functions/table-valued-functions/iceberg-meta",
"sql-manual/sql-functions/table-valued-functions/jobs",
+
"sql-manual/sql-functions/table-valued-functions/lance-index-entries",
"sql-manual/sql-functions/table-valued-functions/local",
"sql-manual/sql-functions/table-valued-functions/mv_infos",
"sql-manual/sql-functions/table-valued-functions/numbers",
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
