Skip to content

Commit a3dda06

Browse files
leto-bbqleto-bbq
authored
docs: update query timeout description (#1125)
1 parent 37f5ba2 commit a3dda06

8 files changed

Lines changed: 12 additions & 12 deletions

‎src/UserGuide/Master/Tree/API/Programming-Java-Native-API_apache.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ The Session class has the following fields, which can be set through the constru
502502
| `useSSL` | `boolean` | Whether to enable SSL |
503503
| `trustStore` | `String` | Path to the trust store |
504504
| `trustStorePwd` | `String` | Password for the trust store |
505-
| `queryTimeoutInMs` | `long` | Query timeout in milliseconds |
505+
| `queryTimeoutInMs` | `long` | Query timeout in milliseconds. Default value: -1. A negative value means the server default configuration is used, and 0 disables query timeout. |
506506
| `enableRPCCompression` | `boolean` | Whether to enable RPC compression |
507507
| `connectionTimeoutInMs` | `int` | Connection timeout in milliseconds |
508508
| `zoneId` | `ZoneId` | Time zone setting for the session |
@@ -620,4 +620,4 @@ The Session class has the following fields, which can be set through the constru
620620
| -------------------------- | ----------------------------------------- | ------------------------------------------ |
621621
| `getBackupConfiguration()` | Get backup configuration information | No parameters |
622622
| `fetchAllConnections()` | Get information of all active connections | No parameters |
623-
| `getSystemStatus()` | Get the system status | Deprecated, returns `SystemStatus.NORMAL` |
623+
| `getSystemStatus()` | Get the system status | Deprecated, returns `SystemStatus.NORMAL` |

‎src/UserGuide/Master/Tree/API/Programming-Java-Native-API_timecho.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ The Session class has the following fields, which can be set through the constru
504504
| `useSSL` | `boolean` | Whether to enable SSL |
505505
| `trustStore` | `String` | Path to the trust store |
506506
| `trustStorePwd` | `String` | Password for the trust store |
507-
| `queryTimeoutInMs` | `long` | Query timeout in milliseconds |
507+
| `queryTimeoutInMs` | `long` | Query timeout in milliseconds. Default value: -1. A negative value means the server default configuration is used, and 0 disables query timeout. |
508508
| `enableRPCCompression` | `boolean` | Whether to enable RPC compression |
509509
| `connectionTimeoutInMs` | `int` | Connection timeout in milliseconds |
510510
| `zoneId` | `ZoneId` | Time zone setting for the session |
@@ -622,4 +622,4 @@ The Session class has the following fields, which can be set through the constru
622622
| -------------------------- | ----------------------------------------- | ------------------------------------------ |
623623
| `getBackupConfiguration()` | Get backup configuration information | No parameters |
624624
| `fetchAllConnections()` | Get information of all active connections | No parameters |
625-
| `getSystemStatus()` | Get the system status | Deprecated, returns `SystemStatus.NORMAL` |
625+
| `getSystemStatus()` | Get the system status | Deprecated, returns `SystemStatus.NORMAL` |

‎src/UserGuide/latest/API/Programming-Java-Native-API_apache.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ The Session class has the following fields, which can be set through the constru
502502
| `useSSL` | `boolean` | Whether to enable SSL |
503503
| `trustStore` | `String` | Path to the trust store |
504504
| `trustStorePwd` | `String` | Password for the trust store |
505-
| `queryTimeoutInMs` | `long` | Query timeout in milliseconds |
505+
| `queryTimeoutInMs` | `long` | Query timeout in milliseconds. Default value: -1. A negative value means the server default configuration is used, and 0 disables query timeout. |
506506
| `enableRPCCompression` | `boolean` | Whether to enable RPC compression |
507507
| `connectionTimeoutInMs` | `int` | Connection timeout in milliseconds |
508508
| `zoneId` | `ZoneId` | Time zone setting for the session |
@@ -620,4 +620,4 @@ The Session class has the following fields, which can be set through the constru
620620
| -------------------------- | ----------------------------------------- | ------------------------------------------ |
621621
| `getBackupConfiguration()` | Get backup configuration information | No parameters |
622622
| `fetchAllConnections()` | Get information of all active connections | No parameters |
623-
| `getSystemStatus()` | Get the system status | Deprecated, returns `SystemStatus.NORMAL` |
623+
| `getSystemStatus()` | Get the system status | Deprecated, returns `SystemStatus.NORMAL` |

‎src/UserGuide/latest/API/Programming-Java-Native-API_timecho.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ The Session class has the following fields, which can be set through the constru
504504
| `useSSL` | `boolean` | Whether to enable SSL |
505505
| `trustStore` | `String` | Path to the trust store |
506506
| `trustStorePwd` | `String` | Password for the trust store |
507-
| `queryTimeoutInMs` | `long` | Query timeout in milliseconds |
507+
| `queryTimeoutInMs` | `long` | Query timeout in milliseconds. Default value: -1. A negative value means the server default configuration is used, and 0 disables query timeout. |
508508
| `enableRPCCompression` | `boolean` | Whether to enable RPC compression |
509509
| `connectionTimeoutInMs` | `int` | Connection timeout in milliseconds |
510510
| `zoneId` | `ZoneId` | Time zone setting for the session |
@@ -622,4 +622,4 @@ The Session class has the following fields, which can be set through the constru
622622
| -------------------------- | ----------------------------------------- | ------------------------------------------ |
623623
| `getBackupConfiguration()` | Get backup configuration information | No parameters |
624624
| `fetchAllConnections()` | Get information of all active connections | No parameters |
625-
| `getSystemStatus()` | Get the system status | Deprecated, returns `SystemStatus.NORMAL` |
625+
| `getSystemStatus()` | Get the system status | Deprecated, returns `SystemStatus.NORMAL` |

‎src/zh/UserGuide/Master/Tree/API/Programming-Java-Native-API_apache.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ Session具有如下的字段，可以通过构造函数或Session.Builder方式
501501
| `useSSL` | `boolean` | 是否启用 SSL |
502502
| `trustStore` | `String` | 信任库路径 |
503503
| `trustStorePwd` | `String` | 信任库密码 |
504-
| `queryTimeoutInMs` | `long` | 查询的超时时间，单位毫秒 |
504+
| `queryTimeoutInMs` | `long` | 查询的超时时间，单位毫秒。默认值-1。负数代表采用服务器默认配置，0 代表关闭查询超时功能。 |
505505
| `enableRPCCompression` | `boolean` | 是否启用 RPC 压缩 |
506506
| `connectionTimeoutInMs` | `int` | 连接超时时间，单位毫秒 |
507507
| `zoneId` | `ZoneId` | 会话的时区设置 |

‎src/zh/UserGuide/Master/Tree/API/Programming-Java-Native-API_timecho.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ Session具有如下的字段，可以通过构造函数或Session.Builder方式
501501
| `useSSL` | `boolean` | 是否启用 SSL |
502502
| `trustStore` | `String` | 信任库路径 |
503503
| `trustStorePwd` | `String` | 信任库密码 |
504-
| `queryTimeoutInMs` | `long` | 查询的超时时间，单位毫秒 |
504+
| `queryTimeoutInMs` | `long` | 查询的超时时间，单位毫秒。默认值-1。负数代表采用服务器默认配置，0 代表关闭查询超时功能。 |
505505
| `enableRPCCompression` | `boolean` | 是否启用 RPC 压缩 |
506506
| `connectionTimeoutInMs` | `int` | 连接超时时间，单位毫秒 |
507507
| `zoneId` | `ZoneId` | 会话的时区设置 |

‎src/zh/UserGuide/latest/API/Programming-Java-Native-API_apache.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ Session具有如下的字段，可以通过构造函数或Session.Builder方式
501501
| `useSSL` | `boolean` | 是否启用 SSL |
502502
| `trustStore` | `String` | 信任库路径 |
503503
| `trustStorePwd` | `String` | 信任库密码 |
504-
| `queryTimeoutInMs` | `long` | 查询的超时时间，单位毫秒 |
504+
| `queryTimeoutInMs` | `long` | 查询的超时时间，单位毫秒。默认值-1。负数代表采用服务器默认配置，0 代表关闭查询超时功能。 |
505505
| `enableRPCCompression` | `boolean` | 是否启用 RPC 压缩 |
506506
| `connectionTimeoutInMs` | `int` | 连接超时时间，单位毫秒 |
507507
| `zoneId` | `ZoneId` | 会话的时区设置 |

‎src/zh/UserGuide/latest/API/Programming-Java-Native-API_timecho.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ Session具有如下的字段，可以通过构造函数或Session.Builder方式
501501
| `useSSL` | `boolean` | 是否启用 SSL |
502502
| `trustStore` | `String` | 信任库路径 |
503503
| `trustStorePwd` | `String` | 信任库密码 |
504-
| `queryTimeoutInMs` | `long` | 查询的超时时间，单位毫秒 |
504+
| `queryTimeoutInMs` | `long` | 查询的超时时间，单位毫秒。默认值-1。负数代表采用服务器默认配置，0 代表关闭查询超时功能。 |
505505
| `enableRPCCompression` | `boolean` | 是否启用 RPC 压缩 |
506506
| `connectionTimeoutInMs` | `int` | 连接超时时间，单位毫秒 |
507507
| `zoneId` | `ZoneId` | 会话的时区设置 |

0 commit comments

Comments
 (0)