Skip to content

Commit 9997b10

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 10791ef commit 9997b10

4 files changed

Lines changed: 155 additions & 14 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
@@ -60,6 +60,7 @@
6060
*/
6161
public class Column implements GsonPostProcessable {
6262
private static final Logger LOG = LogManager.getLogger(Column.class);
63+
public static final String HIDDEN_COLUMN_PREFIX = "__DORIS_";
6364
// NOTE: you should name hidden column start with '__DORIS_' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
6465
public static final String DELETE_SIGN = "__DORIS_DELETE_SIGN__";
6566
public static final String WHERE_SIGN = "__DORIS_WHERE_SIGN__";

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

Lines changed: 7 additions & 0 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;
@@ -86,6 +87,12 @@ public static void checkPartitionName(String partitionName) throws AnalysisExcep
8687
}
8788

8889
public static void checkColumnName(String columnName) throws AnalysisException {
90+
// if need check another column name prefix, add in `checkColumnNameBypassHiddenColumn`
91+
checkColumnNameBypassHiddenColumn(columnName);
92+
checkColumnNamePrefix(columnName, Column.HIDDEN_COLUMN_PREFIX);
93+
}
94+
95+
public static void checkColumnNameBypassHiddenColumn(String columnName) throws AnalysisException {
8996
if (Strings.isNullOrEmpty(columnName) || !columnName.matches(getColumnNameRegex())) {
9097
ErrorReport.reportAnalysisException(ErrorCode.ERR_WRONG_COLUMN_NAME,
9198
columnName, getColumnNameRegex());

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

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

7274
public ColumnDefinition(String name, DataType type, boolean isKey, AggregateType aggType, boolean isNullable,
7375
Optional<DefaultValue> defaultValue, String comment) {
@@ -231,7 +233,14 @@ private void checkKeyColumnType(boolean isOlap) {
231233
public void validate(boolean isOlap, Set<String> keysSet, Set<String> clusterKeySet, boolean isEnableMergeOnWrite,
232234
KeysType keysType) {
233235
try {
234-
FeNameFormat.checkColumnName(name);
236+
// if enableAddHiddenColumn is true, can add hidden column.
237+
// So does not check if the column name starts with __DORIS_
238+
if (enableAddHiddenColumn) {
239+
FeNameFormat.checkColumnNameBypassHiddenColumn(name);
240+
} else {
241+
FeNameFormat.checkColumnName(name);
242+
}
243+
235244
FeNameFormat.checkColumnCommentLength(comment);
236245
} catch (Exception e) {
237246
throw new AnalysisException(e.getMessage(), e);
@@ -674,35 +683,76 @@ public Column translateToCatalogStyle() {
674683
return column;
675684
}
676685

677-
// hidden column
686+
/**
687+
* add hidden column
688+
*/
678689
public static ColumnDefinition newDeleteSignColumnDefinition() {
679-
return new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false, null, false,
680-
Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)), "doris delete flag hidden column", false);
690+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false, null,
691+
false, Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)),
692+
"doris delete flag hidden column", false);
693+
columnDefinition.setEnableAddHiddenColumn(true);
694+
695+
return columnDefinition;
681696
}
682697

698+
/**
699+
* add hidden column
700+
*/
683701
public static ColumnDefinition newDeleteSignColumnDefinition(AggregateType aggregateType) {
684-
return new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false, aggregateType, false,
685-
Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)), "doris delete flag hidden column", false);
702+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.DELETE_SIGN, TinyIntType.INSTANCE, false,
703+
aggregateType, false, Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)),
704+
"doris delete flag hidden column", false);
705+
columnDefinition.setEnableAddHiddenColumn(true);
706+
707+
return columnDefinition;
686708
}
687709

710+
/**
711+
* add hidden column
712+
*/
688713
public static ColumnDefinition newSequenceColumnDefinition(DataType type) {
689-
return new ColumnDefinition(Column.SEQUENCE_COL, type, false, null, true,
690-
Optional.empty(), "sequence column hidden column", false);
714+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.SEQUENCE_COL, type, false, null,
715+
true, Optional.empty(),
716+
"sequence column hidden column", false);
717+
columnDefinition.setEnableAddHiddenColumn(true);
718+
719+
return columnDefinition;
691720
}
692721

722+
/**
723+
* add hidden column
724+
*/
693725
public static ColumnDefinition newSequenceColumnDefinition(DataType type, AggregateType aggregateType) {
694-
return new ColumnDefinition(Column.SEQUENCE_COL, type, false, aggregateType, true,
695-
Optional.empty(), "sequence column hidden column", false);
726+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.SEQUENCE_COL, type, false, aggregateType,
727+
true, Optional.empty(),
728+
"sequence column hidden column", false);
729+
columnDefinition.setEnableAddHiddenColumn(true);
730+
731+
return columnDefinition;
696732
}
697733

734+
/**
735+
* add hidden column
736+
*/
698737
public static ColumnDefinition newRowStoreColumnDefinition(AggregateType aggregateType) {
699-
return new ColumnDefinition(Column.ROW_STORE_COL, StringType.INSTANCE, false, aggregateType, false,
700-
Optional.of(new DefaultValue("")), "doris row store hidden column", false);
738+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.ROW_STORE_COL, StringType.INSTANCE, false,
739+
aggregateType, false, Optional.of(new DefaultValue("")),
740+
"doris row store hidden column", false);
741+
columnDefinition.setEnableAddHiddenColumn(true);
742+
743+
return columnDefinition;
701744
}
702745

746+
/**
747+
* add hidden column
748+
*/
703749
public static ColumnDefinition newVersionColumnDefinition(AggregateType aggregateType) {
704-
return new ColumnDefinition(Column.VERSION_COL, BigIntType.INSTANCE, false, aggregateType, false,
705-
Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)), "doris version hidden column", false);
750+
ColumnDefinition columnDefinition = new ColumnDefinition(Column.VERSION_COL, BigIntType.INSTANCE, false,
751+
aggregateType, false, Optional.of(new DefaultValue(DefaultValue.ZERO_NUMBER)),
752+
"doris version hidden column", false);
753+
columnDefinition.setEnableAddHiddenColumn(true);
754+
755+
return columnDefinition;
706756
}
707757

708758
public Optional<GeneratedColumnDesc> getGeneratedColumnDesc() {
@@ -717,6 +767,10 @@ public void addGeneratedColumnsThatReferToThis(List<String> list) {
717767
generatedColumnsThatReferToThis.addAll(list);
718768
}
719769

770+
public void setEnableAddHiddenColumn(boolean enableAddHiddenColumn) {
771+
this.enableAddHiddenColumn = enableAddHiddenColumn;
772+
}
773+
720774
private void validateGeneratedColumnInfo() {
721775
// for generated column
722776
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)