docs(postgres): document default TimeZone=UTC session behavior#4344
Open
jeremie0342 wants to merge 1 commit into
Open
docs(postgres): document default TimeZone=UTC session behavior#4344jeremie0342 wants to merge 1 commit into
jeremie0342 wants to merge 1 commit into
Conversation
Adds a "Note: TimeZone" section to PgConnectOptions documentation explaining that SQLx sets the session TimeZone to UTC on connection, why this is done, and how it differs from psql's default behavior (which can surprise users of functions like date_trunc, now, etc.). Closes transact-rs#3226
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a
# Note: TimeZonesection to thePgConnectOptionsdocumentation(
sqlx-postgres/src/options/doc.md).Why
When executing queries whose result depends on the session
TimeZone(e.g.
date_trunc('day', ts)on atimestamptz), users can observedifferent results between SQLx and
psqlagainst the same database.This is expected: SQLx sets the session
TimeZonetoUTConconnection, whereas
psqlinherits the server's default. This behaviorwas previously undocumented on the user-facing API.
Scope
sqlx-postgres/src/options/doc.md# Note: Xpattern used for other gotchas(SSL, Default Host, Unix Domain Sockets)
Closes #3226