diff --git a/docs/userguide_2.0.md b/docs/userguide_2.0.md index 22ac47765..7f2e979a3 100644 --- a/docs/userguide_2.0.md +++ b/docs/userguide_2.0.md @@ -178,7 +178,7 @@ Set `isolationLevel` to `NONE` to avoid large single transactions which might le | `spark.tispark.grpc.framesize` | `2147483647` | The maximum frame size of gRPC response in bytes (default 2G) | | `spark.tispark.grpc.timeout_in_sec` | `10` | The gRPC timeout time in seconds | | `spark.tispark.plan.allow_agg_pushdown` | `true` | Whether aggregations are allowed to push down to TiKV (in case of busy TiKV nodes) | -| `spark.tispark.plan.allow_index_read` | `true` | Whether index is enabled in planning (which might cause heavy pressure on TiKV) | +| `spark.tispark.plan.allow_index_read` | `true` | Whether index is enabled in planning | | `spark.tispark.index.scan_batch_size` | `20000` | The number of row key in batch for the concurrent index scan | | `spark.tispark.index.scan_concurrency` | `5` | The maximal number of threads for index scan that retrieves row keys (shared among tasks inside each JVM) | | `spark.tispark.table.scan_concurrency` | `512` | The maximal number of threads for table scan (shared among tasks inside each JVM) | diff --git a/docs/userguide_3.0.md b/docs/userguide_3.0.md index ee1042c33..97f25bff8 100644 --- a/docs/userguide_3.0.md +++ b/docs/userguide_3.0.md @@ -237,7 +237,7 @@ spark.sql("select t1.id,t2.id from spark_catalog.default.t t1 left join tidb_cat | `spark.tispark.grpc.framesize` | `2147483647` | The maximum frame size of gRPC response in bytes (default 2G) | | `spark.tispark.grpc.timeout_in_sec` | `180` | The gRPC timeout time in seconds | | `spark.tispark.plan.allow_agg_pushdown` | `true` | Whether aggregations are allowed to push down to TiKV (in case of busy TiKV nodes) | -| `spark.tispark.plan.allow_index_read` | `true` | Whether index is enabled in planning (which might cause heavy pressure on TiKV) | +| `spark.tispark.plan.allow_index_read` | `true` | Whether index is enabled in planning | | `spark.tispark.index.scan_batch_size` | `20000` | The number of row key in batch for the concurrent index scan | | `spark.tispark.index.scan_concurrency` | `5` | The maximal number of threads for index scan that retrieves row keys (shared among tasks inside each JVM) | | `spark.tispark.table.scan_concurrency` | `512` | The maximal number of threads for table scan (shared among tasks inside each JVM) |