fix #206: document dataframe specific options to override Redis conne…

…ction settings in SparkSession
RedisLabs · Feb 9, 2020 · e60a0c3 · e60a0c3
1 parent 585c44e
commit e60a0c3
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/dataframe.md b/doc/dataframe.md
@@ -341,6 +341,11 @@ root
 | max.pipeline.size      | maximum number of commands per pipeline (used to batch commands)                          | `Int`                 | 100     |
 | scan.count             | count option of SCAN command (used to iterate over keys)                                  | `Int`                 | 100     |
 | iterator.grouping.size | the number of items to be grouped when iterating over underlying RDD partition            | `Int`                 | 1000    |
+| host                   | overrides `spark.redis.host` configured in SparkSession (if set, any other connection setting from SparkSession is ignored )                        | `String`              | `localhost`    |
+| port                   | overrides `spark.redis.port` configured in SparkSession (if set, any other connection setting from SparkSession is ignored )                        | `Int`                 | `6379`         |
+| auth                   | overrides `spark.redis.auth` configured in SparkSession (if set, any other connection setting from SparkSession is ignored )                        | `String`              | -              |
+| dbNum                  | overrides `spark.redis.dbNum` configured in SparkSession (if set, any other connection setting from SparkSession is ignored )                       | `Int`                 | `0`            |
+| timeout                | overrides `spark.redis.timeout` configured in SparkSession (if set, any other connection setting from SparkSession is ignored )                     | `Int`                 | `2000`         |
 
 
 ## Known limitations