connector/read/V1Scan.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.read;
0019
0020 import org.apache.spark.annotation.Unstable;
0021 import org.apache.spark.sql.SQLContext;
0022 import org.apache.spark.sql.sources.BaseRelation;
0023 import org.apache.spark.sql.sources.TableScan;
0024
0025 /**
0026  * A trait that should be implemented by V1 DataSources that would like to leverage the DataSource
0027  * V2 read code paths.
0028  *
0029  * This interface is designed to provide Spark DataSources time to migrate to DataSource V2 and
0030  * will be removed in a future Spark release.
0031  *
0032  * @since 3.0.0
0033  */
0034 @Unstable
0035 public interface V1Scan extends Scan {
0036
0037   /**
0038    * Create an `BaseRelation` with `TableScan` that can scan data from DataSource v1 to RDD[Row].
0039    *
0040    * @since 3.0.0
0041    */
0042   <T extends BaseRelation & TableScan> T toV1TableScan(SQLContext context);
0043 }