Skip to content
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.

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

Update docs to use postgres + psycopg in order to avoid known issues with psycopg2 #1701

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sfc-gh-gtokernliang
Copy link
Contributor

@sfc-gh-gtokernliang sfc-gh-gtokernliang commented Dec 17, 2024

Description

#1685 raises a known issue where SQLalchemy postgres + psycopg2 has issues due to psycopg2 not converting np floats to a storable format by default - see sqlalchemy/sqlalchemy#11712. This is fixed out of the box with psycopg >= 3.2 (and demonstrated to be working in #1685), so this PR aims to update the docs to guide users down this smoother path instead.

Other details good to know for developers

It doesn't look like we're directly depending on psycopg2, so no package updates were made

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to
    not work as expected)
  • New Tests
  • This change includes re-generated golden test results
  • This change requires a documentation update

Important

Update documentation and tests to use psycopg for PostgreSQL connections, replacing psycopg2.

  • Documentation:
    • Update PostgreSQL connection examples to use psycopg instead of psycopg2 in release_blog_1dot.md and index.md.
    • Modify example connection strings to postgresql+psycopg:// format.
  • Tests:
    • Update test database connection string to use psycopg in test_database.py.

This description was created by Ellipsis for a926618. It will automatically update as commits are pushed.

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Dec 17, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant