Skip to content

feat(postgres): support query_timeout dialect option #13258

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
sdepold merged 3 commits into from
Oct 17, 2021
Merged

feat(postgres): support query_timeout dialect option #13258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4b91cb
Add query_timeout option to postgres dialectOptions
kamal-brill May 6, 2021
3110c92
fix: lint issues in the test file
kamal-brill Jun 26, 2021
7999e82
Merge branch 'main' into main
sdepold Oct 17, 2021
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
4 changes: 3 additions & 1 deletion lib/dialects/postgres/connection-manager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,10 @@ class ConnectionManager extends AbstractConnectionManager {
// This should help with backends incorrectly considering idle clients to be dead and prematurely disconnecting them.
// this feature has been added in pg module v6.0.0, check pg/CHANGELOG.md
'keepAlive',
// Times out queries after a set time in milliseconds. Added in pg v7.3
// Times out queries after a set time in milliseconds in the database end. Added in pg v7.3
'statement_timeout',
// Times out queries after a set time in milliseconds in client end, query would be still running in database end.
'query_timeout',
// Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds. Added in pg v7.17.0 only supported in postgres >= 10
'idle_in_transaction_session_timeout'
]));
Expand Down
8 changes: 8 additions & 0 deletions test/integration/dialects/postgres/connection-manager.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ if (dialect.match(/^postgres/)) {
// `notice` is Postgres's default
expect(result[0].client_min_messages).to.equal('notice');
});

it('should time out the query request when the query runs beyond the configured query_timeout', async () => {
const sequelize = Support.createSequelizeInstance({
dialectOptions: { query_timeout: 100 }
});
const error = await sequelize.query('select pg_sleep(2)').catch(e => e);
expect(error.message).to.equal('Query read timeout');
});
});

describe('Dynamic OIDs', () => {
Expand Down