spark SupportsOverwriteV2 源码

  • 2022-10-20
  • 浏览 (271)

spark SupportsOverwriteV2 代码

文件路径:/sql/catalyst/src/main/java/org/apache/spark/sql/connector/write/SupportsOverwriteV2.java

/*
 * 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.write;

import org.apache.spark.annotation.Evolving;
import org.apache.spark.sql.connector.expressions.filter.AlwaysTrue;
import org.apache.spark.sql.connector.expressions.filter.Predicate;

/**
 * Write builder trait for tables that support overwrite by filter.
 * <p>
 * Overwriting data by filter will delete any data that matches the filter and replace it with data
 * that is committed in the write.
 *
 * @since 3.4.0
 */
@Evolving
public interface SupportsOverwriteV2 extends WriteBuilder, SupportsTruncate {

  /**
   * Checks whether it is possible to overwrite data from a data source table that matches filter
   * expressions.
   * <p>
   * Rows should be overwritten from the data source iff all of the filter expressions match.
   * That is, the expressions must be interpreted as a set of filters that are ANDed together.
   *
   * @param predicates V2 filter expressions, used to match data to overwrite
   * @return true if the delete operation can be performed
   *
   * @since 3.4.0
   */
  default boolean canOverwrite(Predicate[] predicates) {
    return true;
  }

  /**
   * Configures a write to replace data matching the filters with data committed in the write.
   * <p>
   * Rows must be deleted from the data source if and only if all of the filters match. That is,
   * filters must be interpreted as ANDed together.
   *
   * @param predicates filters used to match data to overwrite
   * @return this write builder for method chaining
   */
  WriteBuilder overwrite(Predicate[] predicates);

  @Override
  default WriteBuilder truncate() {
    return overwrite(new Predicate[] { new AlwaysTrue() });
  }
}

相关信息

spark 源码目录

相关文章

spark BatchWrite 源码

spark DataWriter 源码

spark DataWriterFactory 源码

spark DeltaBatchWrite 源码

spark DeltaWrite 源码

spark DeltaWriteBuilder 源码

spark DeltaWriter 源码

spark DeltaWriterFactory 源码

spark LogicalWriteInfo 源码

spark PhysicalWriteInfo 源码

0  赞