Skip to content

Commit 70eacb1

Browse files
Update postgres params descriptions (#171)
* Update postgres params descriptions; * Update spiceaidocs/docs/data-accelerators/postgres/index.md --------- Co-authored-by: Phillip LeBlanc <phillip@spiceai.io>
1 parent ec46c83 commit 70eacb1

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

  • spiceaidocs/docs

spiceaidocs/docs/data-accelerators/postgres/index.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ The connection to PostgreSQL can be configured by providing the following `param
2525
- `pg_user`: The username to connect with.
2626
- `pg_pass_key`: The secret key containing the password to connect with.
2727
- `pg_pass`: The plain-text password to connect with, ignored if `pg_pass_key` is provided.
28+
- `pg_sslmode`: Optional parameter, specifies the SSL/TLS behavior for the connection, supported values:
29+
- `prefer`: (default) This mode will try to establish a secure SSL connection if possible, but will still connect if the server does not support SSL.
30+
- `required`: This mode requires an SSL connection. If a secure connection cannot be established, server will not connect.
31+
- `disable`: This mode will not attempt to use an SSL connection, even if the server supports it.
32+
- `pg_insecure`: Optional parameter, Allows TLS connectivity to servers with invalid/expired certificates.
2833

2934
Configuration `params` are provided either in the `acceleration` section of a dataset.
3035

@@ -36,10 +41,12 @@ datasets:
3641
engine: postgres
3742
params:
3843
pg_host: localhost
39-
pg_port: 5432
44+
pg_port: '5432'
4045
pg_db: my_database
4146
pg_user: my_user
4247
pg_pass_key: my_secret
48+
pg_sslmode: required
49+
pg_insecure: 'true'
4350
```
4451

4552
Additionally, an `engine_secret` may be provided when configuring a PostgreSQL data store to allow for using a different secret store to specify the password for a dataset using PostgreSQL as both the data source and data store.
@@ -50,7 +57,7 @@ datasets:
5057
name: my_dataset
5158
params:
5259
pg_host: localhost
53-
pg_port: 5432
60+
pg_port: '5432'
5461
pg_db: data_store
5562
pg_user: my_user
5663
pg_pass_key: my_secret
@@ -59,7 +66,7 @@ datasets:
5966
engine_secret: pg_backend
6067
params:
6168
pg_host: localhost
62-
pg_port: 5433
69+
pg_port: '5433'
6370
pg_db: data_store
6471
pg_user: my_user
6572
pg_pass_key: my_secret

spiceaidocs/docs/data-connectors/postgres/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The connection to PostgreSQL can be configured by providing the following `param
2828
- `prefer`: (default) This mode will try to establish a secure SSL connection if possible, but will connect insecurely if the server does not support SSL.
2929
- `required`: This mode requires an SSL connection. If a secure connection cannot be established, server will not connect.
3030
- `disable`: This mode will not attempt to use an SSL connection, even if the server supports it.
31+
- `pg_insecure`: Optional parameter, Allows TLS connectivity to servers with invalid/expired certificates.
3132

3233
Configuration `params` are provided either in the top level `dataset` for a dataset source and federated SQL query, or in the `acceleration` section for a data store.
3334

@@ -41,6 +42,8 @@ datasets:
4142
pg_db: my_database
4243
pg_user: my_user
4344
pg_pass_key: my_secret
45+
pg_sslmode: required
46+
pg_insecure: 'true'
4447
```
4548

4649
Additionally, an `engine_secret` may be provided when configuring a PostgreSQL data store to allow for using a different secret store to specify the password for a dataset using PostgreSQL as both the data source and data store.

0 commit comments

Comments
 (0)