awswrangler.redshift.connect

awswrangler.redshift.connect(connection: Optional[str] = None, secret_id: Optional[str] = None, catalog_id: Optional[str] = None, dbname: Optional[str] = None, boto3_session: Optional[Session] = None, ssl: bool = True, timeout: Optional[int] = None, max_prepared_statements: int = 1000, tcp_keepalive: bool = True) → Connection

Return a redshift_connector connection from a Glue Catalog or Secret Manager.

Note

You MUST pass a connection OR secret_id. Here is an example of the secret structure in Secrets Manager: { “host”:”my-host.us-east-1.redshift.amazonaws.com”, “username”:”test”, “password”:”test”, “engine”:”redshift”, “port”:”5439”, “dbname”: “mydb” }

https://github.com/aws/amazon-redshift-python-driver

Parameters

  • connection (Optional[str]) – Glue Catalog Connection name.

  • secret_id (Optional[str]:) – Specifies the secret containing the connection details that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

  • catalog_id (str, optional) – The ID of the Data Catalog. If none is provided, the AWS account ID is used by default.

  • dbname (Optional[str]) – Optional database name to overwrite the stored one.

  • boto3_session (boto3.Session(), optional) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.

  • ssl (bool) – This governs SSL encryption for TCP/IP sockets. This parameter is forward to redshift_connector. https://github.com/aws/amazon-redshift-python-driver

  • timeout (Optional[int]) – This is the time in seconds before the connection to the server will time out. The default is None which means no timeout. This parameter is forward to redshift_connector. https://github.com/aws/amazon-redshift-python-driver

  • max_prepared_statements (int) – This parameter is forward to redshift_connector. https://github.com/aws/amazon-redshift-python-driver

  • tcp_keepalive (bool) – If True then use TCP keepalive. The default is True. This parameter is forward to redshift_connector. https://github.com/aws/amazon-redshift-python-driver

Returns

redshift_connector connection.

Return type

redshift_connector.Connection

Examples

Fetching Redshift connection from Glue Catalog

>>> import awswrangler as wr
>>> con = wr.redshift.connect("MY_GLUE_CONNECTION")
>>> with con.cursor() as cursor:
>>>     cursor.execute("SELECT 1")
>>>     print(cursor.fetchall())
>>> con.close()

Fetching Redshift connection from Secrets Manager

>>> import awswrangler as wr
>>> con = wr.redshift.connect(secret_id="MY_SECRET")
>>> with con.cursor() as cursor:
>>>     cursor.execute("SELECT 1")
>>>     print(cursor.fetchall())
>>> con.close()