ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[SPARK-32852][SQL][DOC][FOLLOWUP] Revise the documentation of spark.sql.hive.metastore.jars

Browse source 
### What changes were proposed in this pull request?

This is a follow-up for https://github.com/apache/spark/pull/29881.
It revises the documentation of the configuration `spark.sql.hive.metastore.jars`.

### Why are the changes needed?

Fix grammatical error in the doc.
Also, make it more clear that the configuration is effective only when `spark.sql.hive.metastore.jars` is set as `path`

### Does this PR introduce _any_ user-facing change?

No

### How was this patch tested?

Just doc changes.

Closes #30407 from gengliangwang/reviseJarPathDoc.

Authored-by: Gengliang Wang <gengliang.wang@databricks.com>
Signed-off-by: Gengliang Wang <gengliang.wang@databricks.com>
This commit is contained in:
Gengliang Wang 2020-11-18 22:09:40 +08:00
parent 74bd046d17
commit a180e02842
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
sql/hive/src/main/scala/org/apache/spark/sql/hive/HiveUtils.scala
View file

@ -96,17 +96,18 @@ private[spark] object HiveUtils extends Logging {
.createWithDefault("builtin")
val HIVE_METASTORE_JARS_PATH = buildStaticConf("spark.sql.hive.metastore.jars.path")
.doc(s"Comma separated URL of Hive jars, support both local and remote paths," +
s"Such as: " +
s" 1. file://path/to/jar/xxx.jar\n" +
s" 2. hdfs://nameservice/path/to/jar/xxx.jar\n" +
s" 3. /path/to/jar/ (path without URI scheme follow conf `fs.defaultFS`'s URI schema)\n" +
s" 4. [http/https/ftp]://path/to/jar/xxx.jar\n" +
s"Notice: `http/https/ftp` doesn't support wildcard, but other URLs support" +
s"nested path wildcard, Such as: " +
s" 1. file://path/to/jar/*, file://path/to/jar/*/*\n" +
s" 2. hdfs://nameservice/path/to/jar/*, hdfs://nameservice/path/to/jar/*/*\n" +
s"When ${HIVE_METASTORE_JARS.key} is set to `path`, we will use Hive jars configured by this")
.doc(s"""
| Comma-separated paths of the jars that used to instantiate the HiveMetastoreClient.
| This configuration is useful only when `{$HIVE_METASTORE_JARS.key}` is set as `path`.
| The paths can be any of the following format:
| 1. file://path/to/jar/foo.jar
| 2. hdfs://nameservice/path/to/jar/foo.jar
| 3. /path/to/jar/ (path without URI scheme follow conf `fs.defaultFS`'s URI schema)
| 4. [http/https/ftp]://path/to/jar/foo.jar
| Note that 1, 2, and 3 support wildcard. For example:
| 1. file://path/to/jar/*,file://path2/to/jar/*/*.jar
| 2. hdfs://nameservice/path/to/jar/*,hdfs://nameservice2/path/to/jar/*/*.jar
""".stripMargin)
.version("3.1.0")
.stringConf
.toSequence