connector/catalog/SessionConfigSupport.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.catalog;
0019
0020 import org.apache.spark.annotation.Evolving;
0021
0022 /**
0023  * A mix-in interface for {@link TableProvider}. Data sources can implement this interface to
0024  * propagate session configs with the specified key-prefix to all data source operations in this
0025  * session.
0026  *
0027  * @since 3.0.0
0028  */
0029 @Evolving
0030 public interface SessionConfigSupport extends TableProvider {
0031
0032   /**
0033    * Key prefix of the session configs to propagate, which is usually the data source name. Spark
0034    * will extract all session configs that starts with `spark.datasource.$keyPrefix`, turn
0035    * `spark.datasource.$keyPrefix.xxx -&gt; yyy` into `xxx -&gt; yyy`, and propagate them to all
0036    * data source operations in this session.
0037    */
0038   String keyPrefix();
0039 }