Skip to content

Commit 69b6ccb

Browse files
committed
branch-2.1: [Enhancement] reject schema change on hidden columns (apache#53376)
Issue Number: close apache#53019 picked from apache#53376
1 parent e7ee762 commit 69b6ccb

4 files changed

Lines changed: 168 additions & 20 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
@@ -55,6 +55,7 @@
5555
*/
5656
public class Column implements Writable, GsonPostProcessable {
5757
private static final Logger LOG = LogManager.getLogger(Column.class);
58+
public static final String HIDDEN_COLUMN_PREFIX = "__DORIS_";
5859
// NOTE: you should name hidden column start with '__DORIS_' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
5960
public static final String DELETE_SIGN = "__DORIS_DELETE_SIGN__";
6061
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
@@ -19,6 +19,7 @@
1919

2020
import org.apache.doris.alter.SchemaChangeHandler;
2121
import org.apache.doris.analysis.CreateMaterializedViewStmt;
22+
import org.apache.doris.catalog.Column;
2223
import org.apache.doris.datasource.InternalCatalog;
2324
import org.apache.doris.mysql.privilege.Role;
2425
import org.apache.doris.mysql.privilege.RoleManager;
@@ -85,18 +86,29 @@ public static void checkPartitionName(String partitionName) throws AnalysisExcep
8586
}
8687

8788
public static void checkColumnName(String columnName) throws AnalysisException {
89+
// if need check another column name prefix, add in `checkColumnNameBypassHiddenColumn`
90+
checkColumnNameBypassHiddenColumn(columnName);
91+
checkColumnNamePrefix(columnName, Column.HIDDEN_COLUMN_PREFIX);
92+
}
93+
94+
public static void checkColumnNameBypassHiddenColumn(String columnName) throws AnalysisException {
8895
if (Strings.isNullOrEmpty(columnName) || !columnName.matches(getColumnNameRegex())) {
8996
ErrorReport.reportAnalysisException(ErrorCode.ERR_WRONG_COLUMN_NAME,
9097
columnName, getColumnNameRegex());
9198
}
92-
if (columnName.startsWith(SchemaChangeHandler.SHADOW_NAME_PREFIX)) {
93-
ErrorReport.reportAnalysisException(ErrorCode.ERR_WRONG_COLUMN_NAME,
94-
columnName, getColumnNameRegex());
99+
checkColumnNamePrefix(columnName, SchemaChangeHandler.SHADOW_NAME_PREFIX);
100+
checkColumnNamePrefix(columnName, CreateMaterializedViewStmt.MATERIALIZED_VIEW_NAME_PREFIX);
101+
checkColumnNamePrefix(columnName, CreateMaterializedViewStmt.MATERIALIZED_VIEW_AGGREGATE_NAME_PREFIX);
102+
}
103+
104+
private static void checkColumnNamePrefix(String columnName, String prefix) throws AnalysisException {
105+
int prefixLength = prefix.length();
106+
if (columnName.length() < prefixLength) {
107+
return;
95108
}
96-
if (columnName.startsWith(CreateMaterializedViewStmt.MATERIALIZED_VIEW_NAME_PREFIX)
97-
|| columnName.startsWith(CreateMaterializedViewStmt.MATERIALIZED_VIEW_AGGREGATE_NAME_PREFIX)) {
109+
if (columnName.substring(0, prefixLength).equalsIgnoreCase(prefix)) {
98110
throw new AnalysisException(
99-
"Incorrect column name " + columnName + ", column name can't start with 'mv_'/'mva_'");
111+
"Incorrect column name " + columnName + ", column name can't start with '" + prefix + "'");
100112
}
101113
}
102114

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

Lines changed: 70 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ public class ColumnDefinition {
6565
private boolean aggTypeImplicit = false;
6666
private long autoIncInitValue = -1;
6767
private int clusterKeyId = -1;
68+
// if add hidden column, must set enableAddHiddenColumn true
69+
private boolean enableAddHiddenColumn = false;
6870

6971
public ColumnDefinition(String name, DataType type, boolean isKey, AggregateType aggType, boolean isNullable,
7072
Optional<DefaultValue> defaultValue, String comment) {
@@ -131,6 +133,10 @@ public AggregateType getAggType() {
131133
return aggType;
132134
}
133135

136+
public void setEnableAddHiddenColumn(boolean enableAddHiddenColumn) {
137+
this.enableAddHiddenColumn = enableAddHiddenColumn;
138+
}
139+
134140
public void setAggType(AggregateType aggType) {
135141
this.aggType = aggType;
136142
}
@@ -180,7 +186,13 @@ private DataType updateCharacterTypeLength(DataType dataType) {
180186
*/
181187
public void validate(boolean isOlap, Set<String> keysSet, boolean isEnableMergeOnWrite, KeysType keysType) {
182188
try {
183-
FeNameFormat.checkColumnName(name);
189+
// if enableAddHiddenColumn is true, can add hidden column.
190+
// So does not check if the column name starts with __DORIS_
191+
if (enableAddHiddenColumn) {
192+
FeNameFormat.checkColumnNameBypassHiddenColumn(name);
193+
} else {
194+
FeNameFormat.checkColumnName(name);
195+
}
184196
} catch (Exception e) {
185197
throw new AnalysisException(e.getMessage(), e);
186198
}
@@ -639,35 +651,79 @@ public Column translateToCatalogStyle() {
639651
return column;
640652
}
641653

642-
// hidden column
654+
/**
655+
* add hidden column
656+
*/
643657
public static ColumnDefinition newDeleteSignColumnDefinition() {
644-
return new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false, null, false,
645-
Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)), "doris delete flag hidden column", false);
658+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false, null,
659+
false, Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)),
660+
"doris delete flag hidden column", false);
661+
columnDefinition.setEnableAddHiddenColumn(true);
662+
663+
return columnDefinition;
646664
}
647665

666+
/**
667+
* add hidden column
668+
*/
648669
public static ColumnDefinition newDeleteSignColumnDefinition(AggregateType aggregateType) {
649-
return new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false, aggregateType, false,
650-
Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)), "doris delete flag hidden column", false);
670+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false,
671+
aggregateType, false, Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)),
672+
"doris delete flag hidden column", false);
673+
columnDefinition.setEnableAddHiddenColumn(true);
674+
675+
return columnDefinition;
651676
}
652677

678+
/**
679+
* add hidden column
680+
*/
653681
public static ColumnDefinition newSequenceColumnDefinition(DataType type) {
654-
return new ColumnDefinition(Column.SEQUENCE_COL, type, false, null, true,
655-
Optional.empty(), "sequence column hidden column", false);
682+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.SEQUENCE_COL, type, false, null,
683+
true, Optional.empty(),
684+
"sequence column hidden column", false);
685+
columnDefinition.setEnableAddHiddenColumn(true);
686+
687+
return columnDefinition;
656688
}
657689

690+
/**
691+
* add hidden column
692+
*/
658693
public static ColumnDefinition newSequenceColumnDefinition(DataType type, AggregateType aggregateType) {
659-
return new ColumnDefinition(Column.SEQUENCE_COL, type, false, aggregateType, true,
660-
Optional.empty(), "sequence column hidden column", false);
694+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.SEQUENCE_COL, type, false, aggregateType,
695+
true, Optional.empty(),
696+
"sequence column hidden column", false);
697+
columnDefinition.setEnableAddHiddenColumn(true);
698+
699+
return columnDefinition;
661700
}
662701

702+
/**
703+
* add hidden column
704+
*/
663705
public static ColumnDefinition newRowStoreColumnDefinition(AggregateType aggregateType) {
664-
return new ColumnDefinition(Column.ROW_STORE_COL, StringType.INSTANCE, false, aggregateType, false,
665-
Optional.of(new DefaultValue("")), "doris row store hidden column", false);
706+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.ROW_STORE_COL, StringType.INSTANCE, false,
707+
aggregateType, false, Optional.of(new DefaultValue("")),
708+
"doris row store hidden column", false);
709+
columnDefinition.setEnableAddHiddenColumn(true);
710+
711+
return columnDefinition;
666712
}
667713

714+
/**
715+
* add hidden column
716+
*/
668717
public static ColumnDefinition newVersionColumnDefinition(AggregateType aggregateType) {
669-
return new ColumnDefinition(Column.VERSION_COL, BigIntType.INSTANCE, false, aggregateType, false,
670-
Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)), "doris version hidden column", false);
718+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.VERSION_COL, BigIntType.INSTANCE, false,
719+
aggregateType, false, Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)),
720+
"doris version hidden column", false);
721+
columnDefinition.setEnableAddHiddenColumn(true);
722+
723+
return columnDefinition;
671724
}
672725

726+
public long getAutoIncInitValue() {
727+
return autoIncInitValue;
728+
}
673729
}
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)