stczwd commented on a change in pull request #28617: URL: https://github.com/apache/spark/pull/28617#discussion_r469183414
########## File path: sql/catalyst/src/main/java/org/apache/spark/sql/connector/catalog/SupportsAtomicPartitionManagement.java ########## @@ -0,0 +1,92 @@ +/* + * 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.spark.sql.connector.catalog; + +import java.util.Map; + +import org.apache.spark.annotation.Experimental; +import org.apache.spark.sql.catalyst.InternalRow; +import org.apache.spark.sql.catalyst.analysis.NoSuchPartitionsException; +import org.apache.spark.sql.catalyst.analysis.PartitionAlreadyExistsException; +import org.apache.spark.sql.catalyst.analysis.PartitionsAlreadyExistException; + +/** + * An atomic partition interface of {@link Table} to operate multiple partitions atomically. + * <p> + * These APIs are used to modify table partition or partition metadata, + * they will change the table data as well. + * ${@link #createPartitions}: + * add an array of partitions and any data they contain to the table + * ${@link #dropPartitions}: + * remove an array of partitions and any data they contain from the table + * + * @since 3.1.0 + */ +@Experimental +public interface SupportsAtomicPartitionManagement extends SupportsPartitionManagement { + + @Override + default void createPartition( + InternalRow ident, + Map<String, String> properties) + throws PartitionAlreadyExistsException, UnsupportedOperationException { + try { + createPartitions(new InternalRow[]{ident}, new Map[]{properties}); + } catch (PartitionsAlreadyExistException e) { + throw new PartitionAlreadyExistsException(e.getMessage()); + } + } + + @Override + default boolean dropPartition(InternalRow ident) { + try { + dropPartitions(new InternalRow[]{ident}); + return true; + } catch (NoSuchPartitionsException e) { + return false; + } + } + + /** + * Create an array of partitions atomically in table. + * <p> + * If any partition already exists, + * the operation of createPartitions need to be safely rolled back. + * + * @param idents an array of new partition identifiers + * @param properties the metadata of the partitions + * @throws PartitionsAlreadyExistException If any partition already exists for the identifier + * @throws UnsupportedOperationException If partition property is not supported + */ + void createPartitions( + InternalRow[] idents, + Map<String, String>[] properties) + throws PartitionsAlreadyExistException, UnsupportedOperationException; + + /** + * Drop an array of partitions atomically from table. + * <p> + * If any partition doesn't exists, + * the operation of dropPartitions need to be safely rolled back. + * + * @param idents an array of partition identifiers + * @throws NoSuchPartitionsException If any partition identifier to drop doesn't exist Review comment: The partitions will be checked before dropPartitions in `AlterTableDropPartitionExec`, thus NoSuchPartitionsException won't need here. It's ok we return boolean. ########## File path: sql/catalyst/src/main/java/org/apache/spark/sql/connector/catalog/SupportsPartitionManagement.java ########## @@ -0,0 +1,113 @@ +/* + * 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.spark.sql.connector.catalog; + +import java.util.Map; + +import org.apache.spark.annotation.Experimental; +import org.apache.spark.sql.catalyst.InternalRow; +import org.apache.spark.sql.catalyst.analysis.NoSuchPartitionException; +import org.apache.spark.sql.catalyst.analysis.PartitionAlreadyExistsException; +import org.apache.spark.sql.types.StructType; + +/** + * A partition interface of {@link Table}. + * A partition is composed of identifier and properties, + * and properties contains metadata information of the partition. + * <p> + * These APIs are used to modify table partition identifier or partition metadata. + * In some cases, they will change the table data as well. + * ${@link #createPartition}: + * add a partition and any data it contains to the table + * ${@link #dropPartition}: + * remove a partition and any data it contains from the table + * ${@link #replacePartitionMetadata}: + * point a partition to a new location, which will swap one location's data for the other + * + * @since 3.1.0 + */ +@Experimental +public interface SupportsPartitionManagement extends Table { + + /** + * @return the partition schema of table + */ + StructType partitionSchema(); Review comment: ok, sound reasonable to me. ########## File path: sql/catalyst/src/main/java/org/apache/spark/sql/connector/catalog/SupportsPartitionManagement.java ########## @@ -0,0 +1,113 @@ +/* + * 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.spark.sql.connector.catalog; + +import java.util.Map; + +import org.apache.spark.annotation.Experimental; +import org.apache.spark.sql.catalyst.InternalRow; +import org.apache.spark.sql.catalyst.analysis.NoSuchPartitionException; +import org.apache.spark.sql.catalyst.analysis.PartitionAlreadyExistsException; +import org.apache.spark.sql.types.StructType; + +/** + * A partition interface of {@link Table}. + * A partition is composed of identifier and properties, + * and properties contains metadata information of the partition. + * <p> + * These APIs are used to modify table partition identifier or partition metadata. + * In some cases, they will change the table data as well. + * ${@link #createPartition}: + * add a partition and any data it contains to the table + * ${@link #dropPartition}: + * remove a partition and any data it contains from the table + * ${@link #replacePartitionMetadata}: + * point a partition to a new location, which will swap one location's data for the other + * + * @since 3.1.0 + */ +@Experimental +public interface SupportsPartitionManagement extends Table { + + /** + * @return the partition schema of table + */ + StructType partitionSchema(); + + /** + * Create a partition in table. + * + * @param ident a new partition identifier + * @param properties the metadata of a partition + * @throws PartitionAlreadyExistsException If a partition already exists for the identifier + * @throws UnsupportedOperationException If partition property is not supported + */ + void createPartition( + InternalRow ident, + Map<String, String> properties) + throws PartitionAlreadyExistsException, UnsupportedOperationException; + + /** + * Drop a partition from table. + * + * @param ident a partition identifier + * @return true if a partition was deleted, false if no partition exists for the identifier + */ + boolean dropPartition(InternalRow ident); + + /** + * Test whether a partition exists using an {@link Identifier identifier} from the table. Review comment: Ah, wrong comment, I change it. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
