Skip to content

Commit 8f6b4f1

Browse files
claudespiceclaudespice
committed
fix: Remove unsupported pg_sslmode value 'allow' from Postgres docs
The connection pool rejects 'allow' with an InvalidParameterError — the match arm at postgrespool.rs:280 only accepts disable, require, prefer, verify-ca, and verify-full. Users setting pg_sslmode: allow get a runtime error. Removed from all 16 affected files (8 connector + 8 accelerator across vNext and versioned docs). Verified against datafusion-table-providers at rev f4f864d — core/src/sql/db_connection_pool/postgrespool.rs:279-288
1 parent d1bf5cf commit 8f6b4f1

16 files changed

Lines changed: 8 additions & 16 deletions

File tree

  • website
    • docs/components
    • versioned_docs
      • version-1.10.x/components
      • version-1.11.x/components
      • version-1.5.x/components
      • version-1.6.x/components
      • version-1.7.x/components
      • version-1.8.x/components
      • version-1.9.x/components

‎website/docs/components/data-accelerators/postgres/index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ The connection to PostgreSQL can be configured by providing the following `param
3737
- `require`: This mode requires a TLS connection.
3838
- `prefer`: (default) This mode will try to establish a secure TLS connection if possible, but will connect insecurely if the server does not support TLS.
3939
- `disable`: This mode will not attempt to use a TLS connection, even if the server supports it.
40-
- `allow`: This mode will try a non-TLS connection first, then retry with TLS if the server requires it.
4140
- `pg_sslrootcert`: Optional. Path to a custom PEM certificate file that the connector will trust.
4241
- `pg_connection_pool_min`: Optional. The minimum number of connections to keep open in the pool, lazily created when requested. Default is `5`.
4342
- `connection_pool_size`: Optional. The maximum number of connections created in the connection pool. Default is `10`.

‎website/docs/components/data-connectors/postgres/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The connection to PostgreSQL can be configured by providing the following `param
108108
| `pg_db` | The name of the database to connect to. |
109109
| `pg_user` | The username to connect with. |
110110
| `pg_pass` | The password to connect with. Use the [secret replacement syntax](../../components/secret-stores) to load the password from a secret store, e.g. `${secrets:my_pg_pass}`. |
111-
| `pg_sslmode` | Optional. Specifies the SSL/TLS behavior for the connection, supported values:<br /> <ul><li>`verify-full`: (default) This mode requires an SSL connection, a valid root certificate, and the server host name to match the one specified in the certificate.</li><li>`verify-ca`: This mode requires a TLS connection and a valid root certificate.</li><li>`require`: This mode requires a TLS connection.</li><li>`prefer`: This mode will try to establish a secure TLS connection if possible, but will connect insecurely if the server does not support TLS.</li><li>`disable`: This mode will not attempt to use a TLS connection, even if the server supports it.</li><li>`allow`: This mode will try a non-TLS connection first, then retry with TLS if the server requires it.</li></ul> |
111+
| `pg_sslmode` | Optional. Specifies the SSL/TLS behavior for the connection, supported values:<br /> <ul><li>`verify-full`: (default) This mode requires an SSL connection, a valid root certificate, and the server host name to match the one specified in the certificate.</li><li>`verify-ca`: This mode requires a TLS connection and a valid root certificate.</li><li>`require`: This mode requires a TLS connection.</li><li>`prefer`: This mode will try to establish a secure TLS connection if possible, but will connect insecurely if the server does not support TLS.</li><li>`disable`: This mode will not attempt to use a TLS connection, even if the server supports it.</li></ul> |
112112
| `pg_sslrootcert` | Optional. Path to a custom PEM certificate file, or inline PEM content, that the connector will trust when `pg_sslmode` is `verify-ca` or `verify-full`. |
113113
| `pg_connection_pool_min_idle` | Optional. The minimum number of idle connections to keep open in the pool. Default is `1`. |
114114
| `connection_pool_size` | Optional. The maximum number of connections created in the connection pool. Default is `5`. |

‎website/versioned_docs/version-1.10.x/components/data-accelerators/postgres/index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ The connection to PostgreSQL can be configured by providing the following `param
3333
- `require`: This mode requires a TLS connection.
3434
- `prefer`: (default) This mode will try to establish a secure TLS connection if possible, but will connect insecurely if the server does not support TLS.
3535
- `disable`: This mode will not attempt to use a TLS connection, even if the server supports it.
36-
- `allow`: This mode will try a non-TLS connection first, then retry with TLS if the server requires it.
3736
- `pg_sslrootcert`: Optional parameter specifying the path to a custom PEM certificate that the connector will trust.
3837
- `pg_connection_pool_min`: Optional. The minimum number of connections to keep open in the pool, lazily created when requested. Default is `5`.
3938
- `connection_pool_size`: Optional. The maximum number of connections created in the connection pool. Default is `10`.

‎website/versioned_docs/version-1.10.x/components/data-connectors/postgres/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The connection to PostgreSQL can be configured by providing the following `param
6868
| `pg_db` | The name of the database to connect to. |
6969
| `pg_user` | The username to connect with. |
7070
| `pg_pass` | The password to connect with. Use the [secret replacement syntax](../secret-stores) to load the password from a secret store, e.g. `${secrets:my_pg_pass}`. |
71-
| `pg_sslmode` | Optional. Specifies the SSL/TLS behavior for the connection, supported values:<br /> <ul><li>`verify-full`: This mode requires an SSL connection, a valid root certificate, and the server host name to match the one specified in the certificate.</li><li>`verify-ca`: This mode requires a TLS connection and a valid root certificate.</li><li>`require`: This mode requires a TLS connection.</li><li>`prefer`: (default) This mode will try to establish a secure TLS connection if possible, but will connect insecurely if the server does not support TLS.</li><li>`disable`: This mode will not attempt to use a TLS connection, even if the server supports it.</li><li>`allow`: This mode will try a non-TLS connection first, then retry with TLS if the server requires it.</li></ul> |
71+
| `pg_sslmode` | Optional. Specifies the SSL/TLS behavior for the connection, supported values:<br /> <ul><li>`verify-full`: This mode requires an SSL connection, a valid root certificate, and the server host name to match the one specified in the certificate.</li><li>`verify-ca`: This mode requires a TLS connection and a valid root certificate.</li><li>`require`: This mode requires a TLS connection.</li><li>`prefer`: (default) This mode will try to establish a secure TLS connection if possible, but will connect insecurely if the server does not support TLS.</li><li>`disable`: This mode will not attempt to use a TLS connection, even if the server supports it.</li></ul> |
7272
| `pg_sslrootcert` | Optional parameter specifying the path to a custom PEM certificate that the connector will trust. |
7373
| `pg_connection_pool_min_idle` | Optional. The minimum number of idle connections to keep open in the pool. Default is `1`. |
7474
| `connection_pool_size` | Optional. The maximum number of connections to keep open in the connection pool. Default is `5`. |

‎website/versioned_docs/version-1.11.x/components/data-accelerators/postgres/index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ The connection to PostgreSQL can be configured by providing the following `param
3333
- `require`: This mode requires a TLS connection.
3434
- `prefer`: (default) This mode will try to establish a secure TLS connection if possible, but will connect insecurely if the server does not support TLS.
3535
- `disable`: This mode will not attempt to use a TLS connection, even if the server supports it.
36-
- `allow`: This mode will try a non-TLS connection first, then retry with TLS if the server requires it.
3736
- `pg_sslrootcert`: Optional parameter specifying the path to a custom PEM certificate that the connector will trust.
3837
- `pg_connection_pool_min`: Optional. The minimum number of connections to keep open in the pool, lazily created when requested. Default is `5`.
3938
- `connection_pool_size`: Optional. The maximum number of connections created in the connection pool. Default is `10`.

‎website/versioned_docs/version-1.11.x/components/data-connectors/postgres/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ The connection to PostgreSQL can be configured by providing the following `param
109109
| `pg_db` | The name of the database to connect to. |
110110
| `pg_user` | The username to connect with. |
111111
| `pg_pass` | The password to connect with. Use the [secret replacement syntax](../../components/secret-stores) to load the password from a secret store, e.g. `${secrets:my_pg_pass}`. |
112-
| `pg_sslmode` | Optional. Specifies the SSL/TLS behavior for the connection, supported values:<br /> <ul><li>`verify-full`: This mode requires an SSL connection, a valid root certificate, and the server host name to match the one specified in the certificate.</li><li>`verify-ca`: This mode requires a TLS connection and a valid root certificate.</li><li>`require`: This mode requires a TLS connection.</li><li>`prefer`: (default) This mode will try to establish a secure TLS connection if possible, but will connect insecurely if the server does not support TLS.</li><li>`disable`: This mode will not attempt to use a TLS connection, even if the server supports it.</li><li>`allow`: This mode will try a non-TLS connection first, then retry with TLS if the server requires it.</li></ul> |
112+
| `pg_sslmode` | Optional. Specifies the SSL/TLS behavior for the connection, supported values:<br /> <ul><li>`verify-full`: This mode requires an SSL connection, a valid root certificate, and the server host name to match the one specified in the certificate.</li><li>`verify-ca`: This mode requires a TLS connection and a valid root certificate.</li><li>`require`: This mode requires a TLS connection.</li><li>`prefer`: (default) This mode will try to establish a secure TLS connection if possible, but will connect insecurely if the server does not support TLS.</li><li>`disable`: This mode will not attempt to use a TLS connection, even if the server supports it.</li></ul> |
113113
| `pg_sslrootcert` | Optional parameter specifying the path to a custom PEM certificate that the connector will trust. |
114114
| `pg_connection_pool_min_idle` | Optional. The minimum number of idle connections to keep open in the pool. Default is `1`. |
115115
| `connection_pool_size` | Optional. The maximum number of connections to keep open in the connection pool. Default is `5`. |

0 commit comments

Comments
 (0)