Skip to content

Commit 18df82f

Browse files
authored
docs: db_groups parameter takes a list, not str (#99)
1 parent a07000e commit 18df82f

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ Connection Parameters
292292
+-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
293293
| database_metadata_current_db_only | bool | Indicates if application supports multi-database datashare catalogs. Default value of True indicates application does not support multi-database datashare catalogs for backwards compatibility | TRUE | No |
294294
+-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
295-
| db_groups | str | A comma-separated list of existing database group names that the DbUser joins for the current session | None | No |
295+
| db_groups | list | A list of existing database group names that the DbUser joins for the current session | None | No |
296296
+-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
297297
| db_user | str | The user ID to use with Amazon Redshift | None | No |
298298
+-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+

redshift_connector/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,8 @@ def connect(
246246
The SSO url for the IdP.
247247
auto_create : Optional[bool]
248248
Indicates whether the user should be created if they do not exist. Default value is `False`.
249-
db_groups : Optional[str]
250-
A comma-separated list of existing database group names that the `db_user` joins for the current session.
249+
db_groups : Optional[List[str]]
250+
A list of existing database group names that the `db_user` joins for the current session.
251251
force_lowercase : Optional[bool]
252252
allow_db_user_override : Optional[bool]
253253
Specifies if the driver uses the `db_user` value from the SAML assertion. TDefault value is `False`.

0 commit comments

Comments
 (0)