roryqi commented on code in PR #10874: URL: https://github.com/apache/gravitino/pull/10874#discussion_r3161121957
########## core/src/main/java/org/apache/gravitino/catalog/HierarchicalSchemaUtil.java: ########## @@ -0,0 +1,154 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.gravitino.catalog; + +import com.google.common.base.Preconditions; +import java.util.ArrayList; +import java.util.List; +import java.util.regex.Pattern; +import org.apache.commons.lang3.StringUtils; +import org.apache.gravitino.Config; +import org.apache.gravitino.Configs; +import org.apache.gravitino.GravitinoEnv; + +/** + * Utility class for hierarchical schema name conversions. + * + * <p>Gravitino supports nested namespace semantics where a logical schema name like {@code A:B:C} + * (using a configurable external separator, default {@code :}) is mapped to a physical schema name + * {@code A.B.C} stored in {@code EntityStore} using {@code .} as the internal separator. + * + * <p>Schema names in {@code EntityStore} never contain the external separator; the external + * separator is only used at the API boundary and in catalog capability validation. + */ +public final class HierarchicalSchemaUtil { + + /** The internal separator used in EntityStore for nested schema names. */ + private static final String PHYSICAL_SEPARATOR = "."; + + private HierarchicalSchemaUtil() {} + + /** + * Returns the configured external schema separator from the server configuration. All code that + * needs the separator should use this method instead of reading the config directly. + * + * @return the configured separator string (default {@code ":"}) + */ + public static String schemaSeparator() { + Config config = GravitinoEnv.getInstance().config(); + if (config == null) { + return Configs.SCHEMA_SEPARATOR.getDefaultValue(); + } + String separator = config.get(Configs.SCHEMA_SEPARATOR); + return StringUtils.defaultIfBlank(separator, Configs.SCHEMA_SEPARATOR.getDefaultValue()); + } + + /** + * Converts a logical schema path (using the external separator) to a physical schema name (using + * {@code .} as separator) suitable for storage in EntityStore. + * + * <p>Example: {@code "A:B:C"} with separator {@code ":"} → {@code "A.B.C"} + * + * @param logicalPath the logical schema path using the external separator + * @param separator the external separator configured on the server + * @return the physical schema name using {@code .} as separator + */ + public static String logicalToPhysical(String logicalPath, String separator) { + Preconditions.checkArgument( + StringUtils.isNotBlank(logicalPath), "logicalPath must not be blank"); + Preconditions.checkArgument(StringUtils.isNotBlank(separator), "separator must not be blank"); + return logicalPath.replace(separator, PHYSICAL_SEPARATOR); + } + + /** + * Converts a physical schema name (using {@code .} as separator) back to the logical schema path + * using the configured external separator. + * + * <p>Example: {@code "A.B.C"} with separator {@code ":"} → {@code "A:B:C"} + * + * @param physicalName the physical schema name using {@code .} as separator + * @param separator the external separator configured on the server + * @return the logical schema path using the external separator + */ + public static String physicalToLogical(String physicalName, String separator) { + Preconditions.checkArgument( + StringUtils.isNotBlank(physicalName), "physicalName must not be blank"); + Preconditions.checkArgument(StringUtils.isNotBlank(separator), "separator must not be blank"); + return physicalName.replace(PHYSICAL_SEPARATOR, separator); + } + + /** + * Returns whether a schema name is a nested path (contains the external separator). + * + * @param name the schema name to test + * @param separator the external separator + * @return {@code true} if the name contains the external separator + */ + public static boolean isNested(String name, String separator) { + return StringUtils.isNotBlank(name) && name.contains(separator); + } + + /** + * Returns all ancestor schema names of the given schema name, ordered from outermost to innermost + * (but excluding the name itself). Returns an empty list for top-level (non-nested) schemas. + * + * <p>Example: {@code "A:B:C"} with separator {@code ":"} → {@code ["A", "A:B"]} + * + * @param schemaName the schema name to find ancestors for + * @param separator the external separator + * @return ancestor names from outermost to innermost, or empty list if not nested + */ + public static List<String> getAncestorNames(String schemaName, String separator) { + Preconditions.checkArgument(StringUtils.isNotBlank(schemaName), "schemaName must not be blank"); + Preconditions.checkArgument(StringUtils.isNotBlank(separator), "separator must not be blank"); + String[] parts = schemaName.split(Pattern.quote(separator), -1); + List<String> ancestors = new ArrayList<>(); + for (int i = 1; i < parts.length; i++) { + ancestors.add(String.join(separator, java.util.Arrays.copyOf(parts, i))); + } Review Comment: Accepted. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
