cloud-fan commented on code in PR #38113: URL: https://github.com/apache/spark/pull/38113#discussion_r991733035
########## sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/DataSourceOptions.scala: ########## @@ -0,0 +1,66 @@ +/* + * 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.catalyst + +/** + * Interface defines the following methods for a data source: + * - register a new option name + * - retrieve all registered option names + * - valid a given option name + * - get alternative option name if any + */ +trait DataSourceOptions { + // Option -> Alternative Option if any + private val validOptions = collection.mutable.Map[String, Option[String]]() + + /** + * Register a new Option. + */ + protected def newOption(name: String): String = { + validOptions += (name -> None) + name + } + + /** + * Register a new Option with an alternative name. + * @param name Option name + * @param alternative Alternative option name + */ + protected def newOption(name: String, alternative: String): Unit = { + // Register both of the options Review Comment: how can we know which one is the primary one? for example, ``` val charset = parameters.getOrElse(ENCODING, parameters.getOrElse(CHARSET, StandardCharsets.UTF_8.name())) ``` ENCODING is the primary once as it will be respected if both are set. ########## sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/DataSourceOptions.scala: ########## @@ -0,0 +1,66 @@ +/* + * 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.catalyst + +/** + * Interface defines the following methods for a data source: + * - register a new option name + * - retrieve all registered option names + * - valid a given option name + * - get alternative option name if any + */ +trait DataSourceOptions { + // Option -> Alternative Option if any + private val validOptions = collection.mutable.Map[String, Option[String]]() + + /** + * Register a new Option. + */ + protected def newOption(name: String): String = { + validOptions += (name -> None) + name + } + + /** + * Register a new Option with an alternative name. + * @param name Option name + * @param alternative Alternative option name + */ + protected def newOption(name: String, alternative: String): Unit = { + // Register both of the options Review Comment: how can we know which one is the primary one? for example, ``` val charset = parameters.getOrElse(ENCODING, parameters.getOrElse(CHARSET, StandardCharsets.UTF_8.name())) ``` ENCODING is the primary one as it will be respected if both are set. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
