awswrangler.oracle.connect¶
- awswrangler.oracle.connect(connection: str | None = None, secret_id: str | None = None, catalog_id: str | None = None, dbname: str | None = None, boto3_session: Session | None = None, call_timeout: int | None = 0) oracledb.Connection ¶
Return a oracledb connection from a Glue Catalog Connection.
https://github.com/oracle/python-oracledb
Note
You MUST pass a connection OR secret_id. Here is an example of the secret structure in Secrets Manager: { “host”:”oracle-instance-wrangler.cr4trrvge8rz.us-east-1.rds.amazonaws.com”, “username”:”test”, “password”:”test”, “engine”:”oracle”, “port”:”1521”, “dbname”: “mydb” # Optional }
- 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.
call_timeout (Optional[int]) – This is the time in milliseconds that a single round-trip to the database may take before a timeout will occur. The default is None which means no timeout. This parameter is forwarded to oracledb. https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.call_timeout
- Returns:
oracledb connection.
- Return type:
oracledb.Connection
Examples
>>> import awswrangler as wr >>> con = wr.oracle.connect(connection="MY_GLUE_CONNECTION") >>> with con.cursor() as cursor: >>> cursor.execute("SELECT 1 FROM DUAL") >>> print(cursor.fetchall()) >>> con.close()