call_timeout_async.py

# -----------------------------------------------------------------------------
# Copyright (c) 2023, 2024, Oracle and/or its affiliates.
#
# This software is dual-licensed to you under the Universal Permissive License
# (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
# 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
# either license.
#
# If you elect to accept the software under the Apache License, Version 2.0,
# the following applies:
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------
# call_timeout_async.py
#
# An asynchronous version of call_timeout.py
#
# Demonstrates the use of the feature that enables round trips to the database
# to time out if a specified amount of time (in milliseconds) has passed
# without a response from the database.
# -----------------------------------------------------------------------------

import asyncio

import oracledb
import sample_env


async def main():
    connection = await oracledb.connect_async(
        user=sample_env.get_main_user(),
        password=sample_env.get_main_password(),
        dsn=sample_env.get_connect_string(),
        params=sample_env.get_connect_params(),
    )

    connection.call_timeout = 2000
    print("Call timeout set at", connection.call_timeout, "milliseconds...")

    with connection.cursor() as cursor:
        (today,) = await connection.fetchone("select sysdate from dual")
        print("Fetch of current date before timeout:", today)

        # dbms_session.sleep() replaces dbms_lock.sleep() from Oracle Database
        # 18c
        sleep_proc_name = (
            "dbms_session.sleep"
            if int(connection.version.split(".")[0]) >= 18
            else "dbms_lock.sleep"
        )

        print("Sleeping...should time out...")
        try:
            await cursor.callproc(sleep_proc_name, (3,))
        except oracledb.DatabaseError as e:
            print("ERROR:", e)

        (today,) = await connection.fetchone("select sysdate from dual")
        print("Fetch of current date after timeout:", today)


asyncio.run(main())