Merge pull request #61 from aerospike/FMWK-297-document-configuration…

…-properties FMWK-297 Document driver configuration properties
aerospike · Dec 20, 2023 · af00297 · af00297
2 parents 87ecbb7 + 3300a5b
commit af00297
Showing 1 changed file with 30 additions and 17 deletions.
diff --git a/docs/params.md b/docs/params.md
@@ -4,25 +4,38 @@ The Aerospike JDBC driver can be configured through the JDBC connection URL. For
 
 `jdbc:aerospike:localhost/test?sendKey=true&durableDelete=true&expiration=-1`
 
-The parameters need to match fields of the [Aerospike Java client's](https://javadoc.io/doc/com.aerospike/aerospike-client/latest/index.html)
-`Policy`, `ClientPolicy`, `WritePolicy` classes, which take `int` or `boolean`
-values.
+For detailed information about configuration properties, see the following sections.
+
+## Aerospike Java client configuration
 
-## Parameters
+The parameters need to match fields of the [Aerospike Java client's](https://javadoc.io/doc/com.aerospike/aerospike-client/latest/index.html)
+`Policy` and its subclasses, which take `String`, `int` or `boolean` values.
 
 The optional configuration parameters include the following
 
-| Param | Default | Description | Aerospike Java Client |
-|-------|---------|-------------|-----------------------|
-| `useBoolBin` | `true` | Use the boolean data type | `Value.UseBoolBin` |
-| `compress` | `false` | Use zlib compression on commands to the server | `Policy.compress` |
-| `connectTimeout` | 0 | Socket connect timeout in milliseconds | `Policy.connectTimeout` |
-| `loginTimeout` | 5000 | Login timeout in milliseconds | `ClientPolicy.loginTimeout` |
-| `tendInterval` | 1000 | Interval in milliseconds between cluster tends | `ClientPolicy.tendInterval` |
-| `timeout` | 1000 | Cluster tend info call timeout in milliseconds | `ClientPolicy.timeout` |
-| `totalTimeout` | 0 | Total transaction timeout in milliseconds | `Policy.totalTimeout` |
-| `useServicesAlternate` | `false` | Use "services-alternate" instead of "services" for cluster tending | `ClientPolicy.useServicesAlternate` |
-| `sendKey` | `false` | Send user key on both reads and writes | `Policy.sendKey` |
-| `durableDelete` | `false` | If the transaction results in a record deletion, leave a tombstone for the record | `Policy.durableDelete` |
-| `expiration` | 0 | 0 : use namespace `default-ttl`; -1: never expire; -2 don't change the ttl; otherwise seconds till expiration | `Policy.expiration` |
+| Param                | Default | Description                                                                                                   | Aerospike Java Client               |
+|----------------------|---------|---------------------------------------------------------------------------------------------------------------|-------------------------------------|
+| useBoolBin           | `true`  | Use the boolean data type                                                                                     | `Value.UseBoolBin`                  |
+| compress             | `false` | Use zlib compression on commands to the server                                                                | `Policy.compress`                   |
+| connectTimeout       | 0       | Socket connect timeout in milliseconds                                                                        | `Policy.connectTimeout`             |
+| loginTimeout         | 5000    | Login timeout in milliseconds                                                                                 | `ClientPolicy.loginTimeout`         |
+| tendInterval         | 1000    | Interval in milliseconds between cluster tends                                                                | `ClientPolicy.tendInterval`         |
+| timeout              | 1000    | Cluster tend info call timeout in milliseconds                                                                | `ClientPolicy.timeout`              |
+| totalTimeout         | 0       | Total transaction timeout in milliseconds                                                                     | `Policy.totalTimeout`               |
+| useServicesAlternate | `false` | Use "services-alternate" instead of "services" for cluster tending                                            | `ClientPolicy.useServicesAlternate` |
+| sendKey              | `false` | Send user key on both reads and writes                                                                        | `Policy.sendKey`                    |
+| durableDelete        | `false` | If the transaction results in a record deletion, leave a tombstone for the record                             | `Policy.durableDelete`              |
+| expiration           | 0       | 0 : use namespace `default-ttl`; -1: never expire; -2 don't change the ttl; otherwise seconds till expiration | `Policy.expiration`                 |
+
+## JDBC Driver configuration
+
+The following parameters configure the internal state of the driver.
+Their default values are sufficient in most cases.
+Consider setting a custom value if really necessary.
 
+| Param                   | Default | Description                                                            |
+|-------------------------|---------|------------------------------------------------------------------------|
+| recordSetQueueCapacity  | 256     | The capacity of the record queue for asynchronous Aerospike operations |
+| recordSetTimeoutMs      | 1000    | Timeout for the asynchronous queue write operation in milliseconds     |
+| metadataCacheTtlSeconds | 3600    | Database metadata cache TTL in seconds                                 |
+| schemaBuilderMaxRecords | 1000    | The number of records to be used to build the table schema             |