connector/write/SupportsOverwrite.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 import org.apache.spark.sql.sources.AlwaysTrue$;
0022 import org.apache.spark.sql.sources.Filter;
0023
0024 /**
0025  * Write builder trait for tables that support overwrite by filter.
0026  * <p>
0027  * Overwriting data by filter will delete any data that matches the filter and replace it with data
0028  * that is committed in the write.
0029  *
0030  * @since 3.0.0
0031  */
0032 @Evolving
0033 public interface SupportsOverwrite extends WriteBuilder, SupportsTruncate {
0034   /**
0035    * Configures a write to replace data matching the filters with data committed in the write.
0036    * <p>
0037    * Rows must be deleted from the data source if and only if all of the filters match. That is,
0038    * filters must be interpreted as ANDed together.
0039    *
0040    * @param filters filters used to match data to overwrite
0041    * @return this write builder for method chaining
0042    */
0043   WriteBuilder overwrite(Filter[] filters);
0044
0045   @Override
0046   default WriteBuilder truncate() {
0047     return overwrite(new Filter[] { AlwaysTrue$.MODULE$ });
0048   }
0049 }