Skip to content

Update postgres params descriptions #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 28, 2024
+13 −3
Merged

Update postgres params descriptions #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
559f7bf
Update postgres params descriptions;
ewgenius Mar 28, 2024
cc88b6e
Update spiceaidocs/docs/data-accelerators/postgres/index.md
phillipleblanc Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions spiceaidocs/docs/data-accelerators/postgres/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ The connection to PostgreSQL can be configured by providing the following `param
- `pg_user`: The username to connect with.
- `pg_pass_key`: The secret key containing the password to connect with.
- `pg_pass`: The plain-text password to connect with, ignored if `pg_pass_key` is provided.
- `pg_sslmode`: Optional parameter, specifies the SSL/TLS behavior for the connection, supported values:
- `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.
- `required`: This mode requires an SSL connection. If a secure connection cannot be established, server will not connect.
- `disable`: This mode will not attempt to use an SSL connection, even if the server supports it.
- `pg_insecure`: Optional parameter, Allows TLS connectivity to servers with invalid/expired certificates.

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

Expand All @@ -36,10 +41,12 @@ datasets:
engine: postgres
params:
pg_host: localhost
pg_port: 5432
pg_port: '5432'
pg_db: my_database
pg_user: my_user
pg_pass_key: my_secret
pg_sslmode: required
pg_insecure: 'true'
```

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.
Expand All @@ -50,7 +57,7 @@ datasets:
name: my_dataset
params:
pg_host: localhost
pg_port: 5432
pg_port: '5432'
pg_db: data_store
pg_user: my_user
pg_pass_key: my_secret
Expand All @@ -59,7 +66,7 @@ datasets:
engine_secret: pg_backend
params:
pg_host: localhost
pg_port: 5433
pg_port: '5433'
pg_db: data_store
pg_user: my_user
pg_pass_key: my_secret
Expand Down
3 changes: 3 additions & 0 deletions spiceaidocs/docs/data-connectors/postgres/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ The connection to PostgreSQL can be configured by providing the following `param
- `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.
- `required`: This mode requires an SSL connection. If a secure connection cannot be established, server will not connect.
- `disable`: This mode will not attempt to use an SSL connection, even if the server supports it.
- `pg_insecure`: Optional parameter, Allows TLS connectivity to servers with invalid/expired certificates.

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.

Expand All @@ -41,6 +42,8 @@ datasets:
pg_db: my_database
pg_user: my_user
pg_pass_key: my_secret
pg_sslmode: required
pg_insecure: 'true'
```

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.
Expand Down