spark LogicalWriteInfo 源码

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

spark LogicalWriteInfo 代码

文件路径:/sql/catalyst/src/main/java/org/apache/spark/sql/connector/write/LogicalWriteInfo.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 java.util.Optional;

import org.apache.spark.annotation.Evolving;
import org.apache.spark.sql.types.StructType;
import org.apache.spark.sql.util.CaseInsensitiveStringMap;

/**
 * This interface contains logical write information that data sources can use when generating a
 * {@link WriteBuilder}.
 *
 * @since 3.0.0
 */
@Evolving
public interface LogicalWriteInfo {
  /**
   * the options that the user specified when writing the dataset
   */
  CaseInsensitiveStringMap options();

  /**
   * {@code queryId} is a unique string of the query. It's possible that there are many queries
   * running at the same time, or a query is restarted and resumed. {@link BatchWrite} can use
   * this id to identify the query.
   */
  String queryId();

  /**
   * the schema of the input data from Spark to data source.
   */
  StructType schema();

  /**
   * the schema of the ID columns from Spark to data source.
   */
  default Optional<StructType> rowIdSchema() {
    throw new UnsupportedOperationException(
        getClass().getName() + " does not implement rowIdSchema");
  }

  /**
   * the schema of the input metadata from Spark to data source.
   */
  default Optional<StructType> metadataSchema() {
    throw new UnsupportedOperationException(
        getClass().getName() + " does not implement metadataSchema");
  }
}

相关信息

spark 源码目录

相关文章

spark BatchWrite 源码

spark DataWriter 源码

spark DataWriterFactory 源码

spark DeltaBatchWrite 源码

spark DeltaWrite 源码

spark DeltaWriteBuilder 源码

spark DeltaWriter 源码

spark DeltaWriterFactory 源码

spark PhysicalWriteInfo 源码

spark RequiresDistributionAndOrdering 源码

0  赞