This is an automated email from the ASF dual-hosted git repository.
roryqi pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new ab28a7f2ad [#9973] fix(docs): Add the documents about Flink catalog
name limitation (#10145)
ab28a7f2ad is described below
commit ab28a7f2ad6a358fc47c01961a2eb69a67e05490
Author: roryqi <[email protected]>
AuthorDate: Tue Mar 3 19:22:29 2026 +0800
[#9973] fix(docs): Add the documents about Flink catalog name limitation
(#10145)
### What changes were proposed in this pull request?
Add the documents about Flink catalog name limitation
### Why are the changes needed?
Fix: #9973
### Does this PR introduce _any_ user-facing change?
Just documents.
### How was this patch tested?
No.
---
docs/flink-connector/flink-connector.md | 10 ++++++++++
docs/manage-relational-metadata-using-gravitino.md | 5 +++++
2 files changed, 15 insertions(+)
diff --git a/docs/flink-connector/flink-connector.md
b/docs/flink-connector/flink-connector.md
index 5725f9a9b5..1d0c31664e 100644
--- a/docs/flink-connector/flink-connector.md
+++ b/docs/flink-connector/flink-connector.md
@@ -83,6 +83,16 @@ INSERT INTO hive_students VALUES (1, 'Alice'), (2, 'Bob');
SELECT * FROM hive_students;
```
+## Catalog naming restrictions
+
+:::caution
+When creating catalogs that will be used with the Flink connector, the catalog
name **cannot start with a number**. This is a Flink limitation. For example:
+- ✅ Valid: `catalog_hive`, `hive_catalog`, `my_catalog_1`
+- ❌ Invalid: `1_catalog`, `123catalog`, `2hive`
+
+If you create a catalog with a name starting with a number, it will not be
accessible from Flink.
+:::
+
## Datatype mapping
Gravitino flink connector support the following datatype mapping between Flink
and Gravitino.
diff --git a/docs/manage-relational-metadata-using-gravitino.md
b/docs/manage-relational-metadata-using-gravitino.md
index 016d44a36b..3c5888197e 100644
--- a/docs/manage-relational-metadata-using-gravitino.md
+++ b/docs/manage-relational-metadata-using-gravitino.md
@@ -46,6 +46,11 @@ It is not recommended to use one data source to create
multiple catalogs,
as multiple catalogs operating on the same source may result in unpredictable
behavior.
:::
+:::caution
+If you plan to use the [Flink
connector](./flink-connector/flink-connector.md), the catalog name **cannot
start with a number**.
+This is a Flink limitation. For example, `catalog_hive` is valid, but
`1_catalog` is not.
+:::
+
:::tip
The code below is an example of creating a Hive catalog. For other relational
catalogs, the code is
similar, but the catalog type, provider, and properties may be different. For
more details, please refer to the related doc.
