connector/write/SupportsDynamicOverwrite.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.sql.connector.write;
0019
0020 import org.apache.spark.annotation.Evolving;
0021
0022 /**
0023  * Write builder trait for tables that support dynamic partition overwrite.
0024  * <p>
0025  * A write that dynamically overwrites partitions removes all existing data in each logical
0026  * partition for which the write will commit new data. Any existing logical partition for which the
0027  * write does not contain data will remain unchanged.
0028  * <p>
0029  * This is provided to implement SQL compatible with Hive table operations but is not recommended.
0030  * Instead, use the {@link SupportsOverwrite overwrite by filter API} to explicitly replace data.
0031  *
0032  * @since 3.0.0
0033  */
0034 @Evolving
0035 public interface SupportsDynamicOverwrite extends WriteBuilder {
0036   /**
0037    * Configures a write to dynamically replace partitions with data committed in the write.
0038    *
0039    * @return this write builder for method chaining
0040    */
0041   WriteBuilder overwriteDynamicPartitions();
0042 }