connector/write/LogicalWriteInfo.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.types.StructType;
0022 import org.apache.spark.sql.util.CaseInsensitiveStringMap;
0023
0024 /**
0025  * This interface contains logical write information that data sources can use when generating a
0026  * {@link WriteBuilder}.
0027  *
0028  * @since 3.0.0
0029  */
0030 @Evolving
0031 public interface LogicalWriteInfo {
0032   /**
0033    * the options that the user specified when writing the dataset
0034    */
0035   CaseInsensitiveStringMap options();
0036
0037   /**
0038    * `queryId` is a unique string of the query. It's possible that there are many queries
0039    * running at the same time, or a query is restarted and resumed. {@link BatchWrite} can use
0040    * this id to identify the query.
0041    */
0042   String queryId();
0043
0044   /**
0045    * the schema of the input data from Spark to data source.
0046    */
0047   StructType schema();
0048 }