Skip to content

docs: add timeout setting documentation #411

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 3 commits into from
Jan 13, 2025
Merged

docs: add timeout setting documentation #411

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
348e675
add timeout setting documentation
stepansergeevitch Jan 10, 2025
2cc1afd
address comments
stepansergeevitch Jan 13, 2025
831be9b
Merge branch 'main' into add_timeout_documentation
stepansergeevitch Jan 13, 2025
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
17 changes: 17 additions & 0 deletions docsrc/Connecting_and_queries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,3 +626,20 @@ You can import this module as follows:

from datetime import datetime

Execution timeout
==============================

The Firebolt Python SDK allows you to set a timeout for query execution.
In order to do this, you can call the :meth:`Cursor.execute` or :meth:`Cursor.executemany` function with the
``timeout_seconds`` parameter provided. In case the timeout will be reached before the query execution finishes, the
function will raise a ``QueryTimeoutError`` exception.

::

cursor.execute(
"SELECT * FROM test_table;",
timeout_seconds=5
)

**Warning**: If running multiple queries, and one of queries times out, all the previous queries will not be rolled back and their result will persist. All the remaining queries will be cancelled.

Loading