-
Notifications
You must be signed in to change notification settings - Fork 301
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
Remove sqlalchemy dependency from postgres connection check #340
Closed
+126
−32
Closed
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update README.rst
Note that Postgres container no longer depends on SqlAlchemy Remove reference to unsupported version of postgres Show an example of using the `driver` parameter
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,14 +43,30 @@ Getting Started | |
>>> from testcontainers.postgres import PostgresContainer | ||
>>> import sqlalchemy | ||
|
||
>>> with PostgresContainer("postgres:9.5") as postgres: | ||
... engine = sqlalchemy.create_engine(postgres.get_connection_url()) | ||
>>> with PostgresContainer("postgres:latest") as postgres: | ||
... psql_url = postgres.get_connection_url() # postgresql+psycopg2://test:test@localhost:61472/test | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's remove the comment because the url will vary depending on the environment. |
||
... engine = sqlalchemy.create_engine(psql_url) | ||
... result = engine.execute("select version()") | ||
... version, = result.fetchone() | ||
>>> version | ||
'PostgreSQL 9.5...' | ||
'PostgreSQL ......' | ||
|
||
The snippet above will spin up a postgres database in a container. The :code:`get_connection_url()` convenience method returns a :code:`sqlalchemy` compatible url we use to connect to the database and retrieve the database version. | ||
|
||
.. doctest:: | ||
|
||
>>> import asyncpg | ||
>>> from testcontainers.postgres import PostgresContainer | ||
|
||
>>> with PostgresContainer("postgres:latest", driver=None) as postgres: | ||
... psql_url = container.get_connection_url() # postgresql://test:test@localhost:61472/test | ||
... with asyncpg.create_pool(dsn=psql_url,server_settings={"jit": "off"}) as pool: | ||
... conn = await pool.acquire() | ||
... ret = await conn.fetchval("SELECT 1") | ||
... assert ret == 1 | ||
|
||
This snippet does the same, however the driver is set to None, to influence the :code:`get_connection_url()` convenience method. Note, that the :code:`sqlalchemy` package is no longer a dependency to launch the Postgres container, so your project must provide support for the specified driver. | ||
|
||
The snippet above will spin up a postgres database in a container. The :code:`get_connection_url()` convenience method returns a :code:`sqlalchemy` compatible url we use to connect to the database and retrieve the database version. | ||
|
||
Installation | ||
------------ | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's stick with 9.5 here. Pinning the version in the docs is to ensure that things don't accidentally break because one of the dependencies changed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to https://www.postgresql.org/support/versioning/, 9.5 is not supported anymore, the oldest supported version is 11. My suggestion would be to go with 15 and then have another 5 years until the docs have to be changed... :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, let's bump to 15.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... so now 16 :-)