Skip to content

Commit ff81d92

Browse files
karenc-bqkarenc-bq
authored
docs: list all parameters (#416)
1 parent b78f7cb commit ff81d92

File tree

4 files changed

+68
-37
lines changed

4 files changed

+68
-37
lines changed

‎README.md‎

Lines changed: 55 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -80,30 +80,61 @@ and how to integrate it within your project and with your Python driver of choic
8080
[Getting Started page](./docs/GettingStarted.md).
8181

8282
### Connection Properties
83-
The following table lists the common connection properties used with the AWS Advanced Python Wrapper.
84-
85-
| Parameter | Documentation Link |
86-
|----------------------------------------------|:------------------------------------------------------------------------------------------------------------------------:|
87-
| `wrapper_dialect` | [Dialects](./docs/using-the-python-driver/DatabaseDialects.md), and whether you should include it. |
88-
| `plugins` | [Connection Plugin Manager](./docs/using-the-python-driver/UsingThePythonDriver.md#connection-plugin-manager-parameters) |
89-
| `secrets_manager_secret_id` | [SecretsManagerPlugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
90-
| `secrets_manager_region` | [SecretsManagerPlugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
91-
| `enable_failover` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
92-
| `failover_mode` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
93-
| `cluster_instance_host_pattern` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
94-
| `failover_cluster_topology_refresh_rate_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
95-
| `failover_reader_connect_timeout_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
96-
| `failover_timeout_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
97-
| `failover_writer_reconnect_interval_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
98-
| `failure_detection_count` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
99-
| `failure_detection_enabled` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
100-
| `failure_detection_interval_ms` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
101-
| `failure_detection_time_ms` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
102-
| `monitor_disposal_time_ms` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
103-
| `iam_default_port` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
104-
| `iam_host` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
105-
| `iam_region` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
106-
| `iam_expiration` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
83+
The following table lists the connection properties used with the AWS Advanced Python Wrapper.
84+
85+
| Parameter | Documentation Link |
86+
|----------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------:|
87+
| `auxiliary_query_timeout_sec` | [Driver Parameters](./docs/using-the-python-driver/UsingThePythonDriver.md#aws-advanced-python-driver-parameters) |
88+
| `topology_refresh_ms` | [Driver Parameters](./docs/using-the-python-driver/UsingThePythonDriver.md#aws-advanced-python-driver-parameters) |
89+
| `cluster_id` | [Driver Parameters](./docs/using-the-python-driver/UsingThePythonDriver.md#aws-advanced-python-driver-parameters) |
90+
| `cluster_instance_host_pattern` | [Driver Parameters](./docs/using-the-python-driver/UsingThePythonDriver.md#aws-advanced-python-driver-parameters) |
91+
| `wrapper_dialect` | [Dialects](./docs/using-the-python-driver/DatabaseDialects.md), and whether you should include it. |
92+
| `wrapper_driver_dialect` | [Driver Dialect](./docs/using-the-python-driver/DriverDialects.md), and whether you should include it. |
93+
| `plugins` | [Connection Plugin Manager](./docs/using-the-python-driver/UsingThePythonDriver.md#connection-plugin-manager-parameters) |
94+
| `auto_sort_wrapper_plugin_order` | [Connection Plugin Manager](./docs/using-the-python-driver/UsingThePythonDriver.md#connection-plugin-manager-parameters) |
95+
| `profile_name` | [Connection Plugin Manager](./docs/using-the-python-driver/UsingThePythonDriver.md#connection-plugin-manager-parameters) |
96+
| `connect_timeout` | [Network Timeouts](./docs/using-the-python-driver/UsingThePythonDriver.md#network-timeouts) |
97+
| `socket_timeout` | [Network Timeouts](./docs/using-the-python-driver/UsingThePythonDriver.md#network-timeouts) |
98+
| `tcp_keepalive` | [Network Timeouts](./docs/using-the-python-driver/UsingThePythonDriver.md#network-timeouts) |
99+
| `tcp_keepalive_time` | [Network Timeouts](./docs/using-the-python-driver/UsingThePythonDriver.md#network-timeouts) |
100+
| `tcp_keepalive_interval` | [Network Timeouts](./docs/using-the-python-driver/UsingThePythonDriver.md#network-timeouts) |
101+
| `tcp_keepalive_probes` | [Network Timeouts](./docs/using-the-python-driver/UsingThePythonDriver.md#network-timeouts) |
102+
| `enable_failover` | [Failover Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
103+
| `failover_mode` | [Failover Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
104+
| `cluster_instance_host_pattern` | [Failover Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
105+
| `failover_cluster_topology_refresh_rate_sec` | [Failover Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
106+
| `failover_reader_connect_timeout_sec` | [Failover Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
107+
| `failover_timeout_sec` | [Failover Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
108+
| `failover_writer_reconnect_interval_sec` | [Failover Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
109+
| `keep_session_state_on_failover` | [Failover Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
110+
| `failure_detection_count` | [Host Monitoring Plugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
111+
| `failure_detection_enabled` | [Host Monitoring Plugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
112+
| `failure_detection_interval_ms` | [Host Monitoring Plugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
113+
| `failure_detection_time_ms` | [Host Monitoring Plugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
114+
| `monitor_disposal_time_ms` | [Host Monitoring Plugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
115+
| `iam_default_port` | [IAM Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
116+
| `iam_host` | [IAM Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
117+
| `iam_region` | [IAM Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
118+
| `iam_expiration` | [IAM Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
119+
| `secrets_manager_secret_id` | [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
120+
| `secrets_manager_region` | [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
121+
| `secrets_manager_endpoint` | [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
122+
| `reader_host_selector_strategy` | [Connection Strategy](./docs/using-the-python-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#connection-strategies) |
123+
| `db_user` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
124+
| `idp_username` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
125+
| `idp_password` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
126+
| `idp_endpoint` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
127+
| `iam_role_arn` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
128+
| `iam_idp_arn` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
129+
| `iam_region` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
130+
| `idp_name` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
131+
| `idp_port` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
132+
| `rp_identifier` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
133+
| `iam_host` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
134+
| `iam_default_port` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
135+
| `iam_token_expiration` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
136+
| `http_request_connect_timeout` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
137+
| `ssl_secure` | [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md) |
107138

108139
### Using the AWS Advanced Python Driver
109140

‎docs/using-the-python-driver/DriverDialects.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ By default, the driver dialect is determined based on the Connection function pa
1010

1111
## Configuration Parameters
1212

13-
| Name | Required | Description | Example |
14-
|---------------------------------|----------------------|------------------------------------------------------------------------------------------|-------------------------------------------------|
13+
| Name | Required | Description | Example |
14+
|--------------------------|----------------------|------------------------------------------------------------------------------------------|-------------------------------------------|
1515
| `wrapper_driver_dialect` | No (see notes below) | The [driver dialect code](#list-of-available-driver-codes) of the desired target driver. | `DriverDialectCodes.PSYCOPG` or `psycopg` |
1616

1717
> **NOTES:**

0 commit comments

Comments
 (0)