Repository navigation
[feature] Support alter database comment and custom properties - #1172
Merged
Merged
Conversation
polyzos
force-pushed
the
main
branch
3 times, most recently
from
August 31, 2025 15:13
d88c76c to
434a4f4
Compare
LiebingYu
force-pushed
the
alter_database
branch
2 times, most recently
from
October 27, 2025 06:05
98ba457 to
c3292f4
Compare
LiebingYu
force-pushed
the
alter_database
branch
from
February 26, 2026 11:20
c3292f4 to
ae84bc6
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds end-to-end support for ALTER DATABASE to update a database’s comment and custom properties across the RPC API, server coordinator, Java client admin, and Flink catalog integration (linked to #1151).
Changes:
- Introduces a new RPC API (
ALTER_DATABASE) with request/response messages and gateway wiring. - Implements server-side handling to apply database property changes and persist them in ZooKeeper.
- Adds client- and Flink-side implementations plus new unit/integration tests for altering database properties/comments.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| fluss-server/src/test/java/org/apache/fluss/server/coordinator/TestCoordinatorGateway.java | Extends test gateway interface with alterDatabase stub. |
| fluss-server/src/main/java/org/apache/fluss/server/zk/ZooKeeperClient.java | Adds ZK helper to update an existing database znode payload. |
| fluss-server/src/main/java/org/apache/fluss/server/utils/ServerRpcMessageUtils.java | Adds PbAlterConfig → DatabaseChange conversions (including comment special-casing). |
| fluss-server/src/main/java/org/apache/fluss/server/entity/DatabasePropertyChanges.java | New internal representation of database property/comment changes. |
| fluss-server/src/main/java/org/apache/fluss/server/coordinator/MetadataManager.java | Adds coordinator logic to apply and persist database changes. |
| fluss-server/src/main/java/org/apache/fluss/server/coordinator/CoordinatorService.java | Adds alterDatabase RPC handler + conversion to DatabasePropertyChanges. |
| fluss-rpc/src/main/proto/FlussApi.proto | Defines AlterDatabaseRequest/Response messages. |
| fluss-rpc/src/main/java/org/apache/fluss/rpc/protocol/ApiKeys.java | Adds new ALTER_DATABASE API key. |
| fluss-rpc/src/main/java/org/apache/fluss/rpc/gateway/AdminGateway.java | Exposes alterDatabase on the admin RPC gateway. |
| fluss-flink/fluss-flink-common/src/test/java/org/apache/fluss/flink/sink/testutils/TestAdminAdapter.java | Updates test adapter interface surface with alterDatabase stub. |
| fluss-flink/fluss-flink-common/src/test/java/org/apache/fluss/flink/catalog/FlinkCatalogTest.java | Adds catalog-level unit coverage for altering database props/comments. |
| fluss-flink/fluss-flink-common/src/test/java/org/apache/fluss/flink/catalog/FlinkCatalogITCase.java | Adds SQL-based IT coverage for ALTER DATABASE ... SET (...). |
| fluss-flink/fluss-flink-common/src/main/java/org/apache/fluss/flink/catalog/FlinkCatalog.java | Implements Flink Catalog#alterDatabase by diffing descriptors into DatabaseChanges. |
| fluss-common/src/main/java/org/apache/fluss/metadata/DatabaseChange.java | New public change model for database alters (set/reset/updateComment). |
| fluss-common/src/main/java/org/apache/fluss/config/FlussConfigUtils.java | Adds shared constant COMMENT_PROP_NAME = "comment". |
| fluss-client/src/test/java/org/apache/fluss/client/admin/FlussAdminITCase.java | Adds IT coverage for admin-side alter database flows. |
| fluss-client/src/main/java/org/apache/fluss/client/utils/ClientRpcMessageUtils.java | Adds DatabaseChange → PbAlterConfig conversion for database alters. |
| fluss-client/src/main/java/org/apache/fluss/client/admin/FlussAdmin.java | Implements Admin#alterDatabase RPC call construction and dispatch. |
| fluss-client/src/main/java/org/apache/fluss/client/admin/Admin.java | Adds new public alterDatabase API to the Admin interface. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
loserwang1024
left a comment
loserwang1024
left a comment
Contributor
There was a problem hiding this comment.
Thanks for your job, I have left some comment.
| } catch (Exception e) { | ||
| Throwable t = ExceptionUtils.stripExecutionException(e); | ||
| if (CatalogExceptionUtils.isDatabaseNotExist(t)) { | ||
| if (!ignoreIfNotExists) { |
Contributor
There was a problem hiding this comment.
admin.alterDatabase(databaseName, databaseChanges, ignoreIfNotExists) already handle ignoreIfNotExists. Thus, just throw exception here
Contributor
Author
There was a problem hiding this comment.
admin.alterDatabase throws org.apache.fluss.exception.DatabaseNotExistException while FlinkCatalog.alterDatabase throws org.apache.flink.table.catalog.exceptions.DatabaseNotExistException. We need to wrap it here like dropDatabase does.
| } | ||
|
|
||
| // alter database request and response | ||
| message AlterDatabaseRequest { |
Contributor
There was a problem hiding this comment.
where is comment? I think comment should be seperated from config_changes, @wuchong , WDYT?
Contributor
Author
There was a problem hiding this comment.
I think we can treat comment as a specific config. Otherwise we should extract comment from List<DatabaseChange> databaseChanges which is a bit of a hassle.
LiebingYu
force-pushed
the
alter_database
branch
2 times, most recently
from
March 3, 2026 12:29
ac67a7e to
eb5c406
Compare
LiebingYu
force-pushed
the
alter_database
branch
from
March 4, 2026 02:55
eb5c406 to
b00c61a
Compare
Contributor
Author
|
CC @loserwang1024. Could you have a look again? I've resolve the comment issue. |
wuchong
reviewed
Mar 18, 2026
wuchong
reviewed
Mar 18, 2026
wxplovecc
pushed a commit
to tongcheng-elong/fluss
that referenced
this pull request
Apr 17, 2026
wxplovecc
pushed a commit
to tongcheng-elong/fluss
that referenced
this pull request
Apr 20, 2026
Ugbot
pushed a commit
to Ugbot/fluss
that referenced
this pull request
Apr 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Linked issue: close #1151
Brief change log
Tests
API and Format
Documentation