Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Override global statement timeout when creating indexes in Postgres #16085

Merged
merged 5 commits into from
Aug 17, 2023

Conversation

H-Shay
Copy link
Contributor

@H-Shay H-Shay commented Aug 8, 2023

#15853 added a global timeout for long-running Postgres statements, but this may interfere with long-running index creation. This PR adds a local statement timeout to override the global timeout and disable it when creating an index in the background. Fixes #15942.

@H-Shay H-Shay requested a review from a team as a code owner August 8, 2023 17:53
# override the global statement timeout to avoid accidentally squashing
# a long-running index creation process
timeout_sql = "SET LOCAL statement_timeout = 0"
c.execute(timeout_sql)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to set this back to the default, as we're not in a transaction when creating indices I think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the autocommit being on the reason that this isn't in a transaction? The statement timeout only applies for a given transaction - if we are not in a transaction then I wonder if it will have any effect. I will do some digging in the docs but they were pretty scarce on information when I looked into this the first time. Do we have any Postgres/psychopg wizards around who might have some arcane insight into this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the autocommit being on the reason that this isn't in a transaction?

Yes

The statement timeout only applies for a given transaction - if we are not in a transaction then I wonder if it will have any effect.

https://www.postgresql.org/docs/current/sql-set.html says that LOCAL doesn't work outside a transaction, and so we'd need to use SESSION

@H-Shay H-Shay force-pushed the shay/fix_index_timeout branch from 3502fea to c18bc5c Compare August 15, 2023 23:53
@H-Shay H-Shay requested a review from erikjohnston August 16, 2023 16:04
Copy link
Member

@erikjohnston erikjohnston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise looks good

# mypy ignore - `statement_timeout` is defined on PostgresEngine
default_timeout = self.db_pool.engine.statement_timeout # type: ignore[attr-defined]
undo_timeout_sql = f"SET statement_timeout = {default_timeout}"
c.execute(undo_timeout_sql)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be in finally section, so if happens even if index creation raises an exception

@H-Shay H-Shay requested a review from erikjohnston August 16, 2023 18:12
Copy link
Member

@erikjohnston erikjohnston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@erikjohnston erikjohnston merged commit 0377cb4 into develop Aug 17, 2023
@erikjohnston erikjohnston deleted the shay/fix_index_timeout branch August 17, 2023 09:30
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ensure we don't time out background index creation
2 participants