This is an automated email from the ASF dual-hosted git repository.
etudenhoefner pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git
The following commit(s) were added to refs/heads/main by this push:
new af9522ac7e Docs: Document reading in Spark using branch and tag
identifiers (#9238)
af9522ac7e is described below
commit af9522ac7e8e25dc044622c566b66301b6df9581
Author: Wing Yew Poon <[email protected]>
AuthorDate: Thu Dec 7 03:11:30 2023 -0800
Docs: Document reading in Spark using branch and tag identifiers (#9238)
---
docs/spark-queries.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/docs/spark-queries.md b/docs/spark-queries.md
index 54b1ee6bd1..38d989f003 100644
--- a/docs/spark-queries.md
+++ b/docs/spark-queries.md
@@ -120,6 +120,17 @@ SELECT * FROM prod.db.table TIMESTAMP AS OF 499162860;
SELECT * FROM prod.db.table FOR SYSTEM_TIME AS OF 499162860;
```
+The branch or tag may also be specified using a similar syntax to metadata
tables, with `branch_<branchname>` or `tag_<tagname>`:
+
+```sql
+SELECT * FROM prod.db.table.`branch_audit-branch`;
+SELECT * FROM prod.db.table.`tag_historical-snapshot`;
+```
+
+(Identifiers with "-" are not valid, and so must be escaped using back quotes.)
+
+Note that the identifier with branch or tag may not be used in combination
with `VERSION AS OF`.
+
#### DataFrame
To select a specific table snapshot or the snapshot at some time in the
DataFrame API, Iceberg supports four Spark read options:
