Skip to content

Commit 540f0d8

Browse files
committed
branch-3.1: [Enhancement] reject schema change on hidden columns (apache#53376)
Issue Number: close apache#53019 picked from apache#53376
1 parent 78689d7 commit 540f0d8

4 files changed

Lines changed: 177 additions & 25 deletions

File tree

‎fe/fe-core/src/main/java/org/apache/doris/catalog/Column.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
*/
6363
public class Column implements GsonPostProcessable {
6464
private static final Logger LOG = LogManager.getLogger(Column.class);
65+
public static final String HIDDEN_COLUMN_PREFIX = "__DORIS_";
6566
// NOTE: you should name hidden column start with '__DORIS_' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
6667
public static final String DELETE_SIGN = "__DORIS_DELETE_SIGN__";
6768
public static final String WHERE_SIGN = "__DORIS_WHERE_SIGN__";

‎fe/fe-core/src/main/java/org/apache/doris/common/FeNameFormat.java‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import org.apache.doris.alter.SchemaChangeHandler;
2121
import org.apache.doris.analysis.CreateMaterializedViewStmt;
2222
import org.apache.doris.analysis.ResourceTypeEnum;
23+
import org.apache.doris.catalog.Column;
2324
import org.apache.doris.datasource.InternalCatalog;
2425
import org.apache.doris.mysql.privilege.Role;
2526
import org.apache.doris.mysql.privilege.RoleManager;
@@ -93,18 +94,29 @@ public static void checkPartitionName(String partitionName) throws AnalysisExcep
9394
}
9495

9596
public static void checkColumnName(String columnName) throws AnalysisException {
97+
// if need check another column name prefix, add in `checkColumnNameBypassHiddenColumn`
98+
checkColumnNameBypassHiddenColumn(columnName);
99+
checkColumnNamePrefix(columnName, Column.HIDDEN_COLUMN_PREFIX);
100+
}
101+
102+
public static void checkColumnNameBypassHiddenColumn(String columnName) throws AnalysisException {
96103
if (Strings.isNullOrEmpty(columnName) || !columnName.matches(getColumnNameRegex())) {
97104
ErrorReport.reportAnalysisException(ErrorCode.ERR_WRONG_COLUMN_NAME,
98105
columnName, getColumnNameRegex());
99106
}
100-
if (columnName.startsWith(SchemaChangeHandler.SHADOW_NAME_PREFIX)) {
101-
ErrorReport.reportAnalysisException(ErrorCode.ERR_WRONG_COLUMN_NAME,
102-
columnName, getColumnNameRegex());
107+
checkColumnNamePrefix(columnName, SchemaChangeHandler.SHADOW_NAME_PREFIX);
108+
checkColumnNamePrefix(columnName, CreateMaterializedViewStmt.MATERIALIZED_VIEW_NAME_PREFIX);
109+
checkColumnNamePrefix(columnName, CreateMaterializedViewStmt.MATERIALIZED_VIEW_AGGREGATE_NAME_PREFIX);
110+
}
111+
112+
private static void checkColumnNamePrefix(String columnName, String prefix) throws AnalysisException {
113+
int prefixLength = prefix.length();
114+
if (columnName.length() < prefixLength) {
115+
return;
103116
}
104-
if (columnName.startsWith(CreateMaterializedViewStmt.MATERIALIZED_VIEW_NAME_PREFIX)
105-
|| columnName.startsWith(CreateMaterializedViewStmt.MATERIALIZED_VIEW_AGGREGATE_NAME_PREFIX)) {
117+
if (columnName.substring(0, prefixLength).equalsIgnoreCase(prefix)) {
106118
throw new AnalysisException(
107-
"Incorrect column name " + columnName + ", column name can't start with 'mv_'/'mva_'");
119+
"Incorrect column name " + columnName + ", column name can't start with '" + prefix + "'");
108120
}
109121
}
110122

‎fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/commands/info/ColumnDefinition.java‎

Lines changed: 79 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ public class ColumnDefinition {
6969
private int clusterKeyId = -1;
7070
private Optional<GeneratedColumnDesc> generatedColumnDesc = Optional.empty();
7171
private Set<String> generatedColumnsThatReferToThis = new HashSet<>();
72+
// if add hidden column, must set enableAddHiddenColumn true
73+
private boolean enableAddHiddenColumn = false;
7274

7375
public ColumnDefinition(String name, DataType type, boolean isKey, AggregateType aggType, boolean isNullable,
7476
Optional<DefaultValue> defaultValue, String comment) {
@@ -232,7 +234,14 @@ private void checkKeyColumnType(boolean isOlap) {
232234
public void validate(boolean isOlap, Set<String> keysSet, Set<String> clusterKeySet, boolean isEnableMergeOnWrite,
233235
KeysType keysType) {
234236
try {
235-
FeNameFormat.checkColumnName(name);
237+
// if enableAddHiddenColumn is true, can add hidden column.
238+
// So does not check if the column name starts with __DORIS_
239+
if (enableAddHiddenColumn) {
240+
FeNameFormat.checkColumnNameBypassHiddenColumn(name);
241+
} else {
242+
FeNameFormat.checkColumnName(name);
243+
}
244+
236245
FeNameFormat.checkColumnCommentLength(comment);
237246
} catch (Exception e) {
238247
throw new AnalysisException(e.getMessage(), e);
@@ -689,43 +698,90 @@ public Column translateToCatalogStyle() {
689698
return column;
690699
}
691700

692-
// hidden column
701+
/**
702+
* add hidden column
703+
*/
693704
public static ColumnDefinition newDeleteSignColumnDefinition() {
694-
return new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false, null, false,
695-
Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)), "doris delete flag hidden column", false);
705+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false, null,
706+
false, Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)),
707+
"doris delete flag hidden column", false);
708+
columnDefinition.setEnableAddHiddenColumn(true);
709+
710+
return columnDefinition;
696711
}
697712

713+
/**
714+
* add hidden column
715+
*/
698716
public static ColumnDefinition newDeleteSignColumnDefinition(AggregateType aggregateType) {
699-
return new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false, aggregateType, false,
700-
Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)), "doris delete flag hidden column", false);
717+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false,
718+
aggregateType, false, Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)),
719+
"doris delete flag hidden column", false);
720+
columnDefinition.setEnableAddHiddenColumn(true);
721+
722+
return columnDefinition;
701723
}
702724

725+
/**
726+
* add hidden column
727+
*/
703728
public static ColumnDefinition newSequenceColumnDefinition(DataType type) {
704-
return new ColumnDefinition(Column.SEQUENCE_COL, type, false, null, true,
705-
Optional.empty(), "sequence column hidden column", false);
729+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.SEQUENCE_COL, type, false, null,
730+
true, Optional.empty(),
731+
"sequence column hidden column", false);
732+
columnDefinition.setEnableAddHiddenColumn(true);
733+
734+
return columnDefinition;
706735
}
707736

737+
/**
738+
* add hidden column
739+
*/
708740
public static ColumnDefinition newSequenceColumnDefinition(DataType type, AggregateType aggregateType) {
709-
return new ColumnDefinition(Column.SEQUENCE_COL, type, false, aggregateType, true,
710-
Optional.empty(), "sequence column hidden column", false);
741+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.SEQUENCE_COL, type, false, aggregateType,
742+
true, Optional.empty(),
743+
"sequence column hidden column", false);
744+
columnDefinition.setEnableAddHiddenColumn(true);
745+
746+
return columnDefinition;
711747
}
712748

749+
/**
750+
* add hidden column
751+
*/
713752
public static ColumnDefinition newRowStoreColumnDefinition(AggregateType aggregateType) {
714-
return new ColumnDefinition(Column.ROW_STORE_COL, StringType.INSTANCE, false, aggregateType, false,
715-
Optional.of(new DefaultValue("")), "doris row store hidden column", false);
753+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.ROW_STORE_COL, StringType.INSTANCE, false,
754+
aggregateType, false, Optional.of(new DefaultValue("")),
755+
"doris row store hidden column", false);
756+
columnDefinition.setEnableAddHiddenColumn(true);
757+
758+
return columnDefinition;
716759
}
717760

761+
/**
762+
* add hidden column
763+
*/
718764
public static ColumnDefinition newVersionColumnDefinition(AggregateType aggregateType) {
719-
return new ColumnDefinition(Column.VERSION_COL, BigIntType.INSTANCE, false, aggregateType, false,
720-
Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)), "doris version hidden column", false);
765+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.VERSION_COL, BigIntType.INSTANCE, false,
766+
aggregateType, false, Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)),
767+
"doris version hidden column", false);
768+
columnDefinition.setEnableAddHiddenColumn(true);
769+
770+
return columnDefinition;
721771
}
722772

723-
// used in CreateTableInfo.validate(), specify the default value as DefaultValue.NULL_DEFAULT_VALUE
724-
// becasue ColumnDefinition.validate() will check that bitmap type column don't set default value
725-
// and then set the default value of that column to bitmap_empty()
773+
/**
774+
* used in CreateTableInfo.validate(), specify the default value as DefaultValue.NULL_DEFAULT_VALUE
775+
* becasue ColumnDefinition.validate() will check that bitmap type column don't set default value
776+
* and then set the default value of that column to bitmap_empty()
777+
*/
726778
public static ColumnDefinition newSkipBitmapColumnDef(AggregateType aggregateType) {
727-
return new ColumnDefinition(Column.SKIP_BITMAP_COL, BitmapType.INSTANCE, false, aggregateType, false,
728-
Optional.of(DefaultValue.BITMAP_EMPTY_DEFAULT_VALUE), "doris skip bitmap hidden column", false);
779+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.SKIP_BITMAP_COL, BitmapType.INSTANCE, false,
780+
aggregateType, false, Optional.of(DefaultValue.BITMAP_EMPTY_DEFAULT_VALUE),
781+
"doris skip bitmap hidden column", false);
782+
columnDefinition.setEnableAddHiddenColumn(true);
783+
784+
return columnDefinition;
729785
}
730786

731787
public Optional<GeneratedColumnDesc> getGeneratedColumnDesc() {
@@ -740,6 +796,10 @@ public void addGeneratedColumnsThatReferToThis(List<String> list) {
740796
generatedColumnsThatReferToThis.addAll(list);
741797
}
742798

799+
public void setEnableAddHiddenColumn(boolean enableAddHiddenColumn) {
800+
this.enableAddHiddenColumn = enableAddHiddenColumn;
801+
}
802+
743803
private void validateGeneratedColumnInfo() {
744804
// for generated column
745805
if (generatedColumnDesc.isPresent()) {
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
19+
suite("test_alter_table_on_hidden_column", "schema_change") {
20+
def tableName = "alter_table_hidden_column"
21+
22+
sql "DROP TABLE IF EXISTS ${tableName}"
23+
sql """
24+
CREATE TABLE IF NOT EXISTS ${tableName} (
25+
k1 INT,
26+
value1 INT,
27+
value2 INT,
28+
value3 INT
29+
)
30+
DUPLICATE KEY (k1)
31+
DISTRIBUTED BY HASH(k1) BUCKETS 1
32+
properties(
33+
"replication_num" = "1"
34+
);
35+
"""
36+
37+
// rename hidden column
38+
try {
39+
sql "ALTER TABLE ${tableName} RENAME COLUMN __DORIS_VERSION_COL__ test;"
40+
} catch (Exception ex) {
41+
assert("${ex}".contains("Do not support rename hidden column"))
42+
}
43+
44+
// drop hidden column
45+
try {
46+
sql "ALTER TABLE ${tableName} DROP COLUMN __DORIS_VERSION_COL__;"
47+
} catch (Exception ex) {
48+
assert("${ex}".contains("Do not support drop hidden column"))
49+
}
50+
51+
// add a column name starting with __DORIS_
52+
try {
53+
sql "ALTER TABLE ${tableName} ADD COLUMN __DORIS_VERSION_COL__ bigint;"
54+
} catch (Exception ex) {
55+
assert("${ex}".contains("column name can't start with"))
56+
}
57+
58+
// add columns, a column name starting with __DORIS_
59+
try {
60+
sql "ALTER TABLE ${tableName} ADD COLUMN (c1 int, __DORIS_VERSION_COL__ bigint);"
61+
} catch (Exception ex) {
62+
assert("${ex}".contains("column name can't start with"))
63+
}
64+
65+
// modify hidden column comment
66+
try {
67+
sql "ALTER TABLE ${tableName} MODIFY COLUMN __DORIS_VERSION_COL__ COMMENT 'test';"
68+
} catch (Exception ex) {
69+
assert("${ex}".contains("Unknown column"))
70+
}
71+
72+
// modify hidden column type
73+
try {
74+
sql "ALTER TABLE ${tableName} MODIFY COLUMN __DORIS_VERSION_COL__ VARCHAR(64);"
75+
} catch (Exception ex) {
76+
assert("${ex}".contains("column name can't start with"))
77+
}
78+
79+
}

0 commit comments

Comments
 (0)