connector/write/WriteBuilder.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.connector.catalog.Table;
0022 import org.apache.spark.sql.connector.catalog.TableCapability;
0023 import org.apache.spark.sql.connector.write.streaming.StreamingWrite;
0024
0025 /**
0026  * An interface for building the {@link BatchWrite}. Implementations can mix in some interfaces to
0027  * support different ways to write data to data sources.
0028  *
0029  * Unless modified by a mixin interface, the {@link BatchWrite} configured by this builder is to
0030  * append data without affecting existing data.
0031  *
0032  * @since 3.0.0
0033  */
0034 @Evolving
0035 public interface WriteBuilder {
0036
0037   /**
0038    * Returns a {@link BatchWrite} to write data to batch source. By default this method throws
0039    * exception, data sources must overwrite this method to provide an implementation, if the
0040    * {@link Table} that creates this write returns {@link TableCapability#BATCH_WRITE} support in
0041    * its {@link Table#capabilities()}.
0042    */
0043   default BatchWrite buildForBatch() {
0044     throw new UnsupportedOperationException(getClass().getName() +
0045       " does not support batch write");
0046   }
0047
0048   /**
0049    * Returns a {@link StreamingWrite} to write data to streaming source. By default this method
0050    * throws exception, data sources must overwrite this method to provide an implementation, if the
0051    * {@link Table} that creates this write returns {@link TableCapability#STREAMING_WRITE} support
0052    * in its {@link Table#capabilities()}.
0053    */
0054   default StreamingWrite buildForStreaming() {
0055     throw new UnsupportedOperationException(getClass().getName() +
0056       " does not support streaming write");
0057   }
0058 }