Skip to content

Commit 80a5355

Browse files
committed
update docs
1 parent 5d15b6e commit 80a5355

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

modules/generic/README.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,20 @@ A more advance use-case, where we are using a FastAPI container that is using Re
5050
... response = client.get(f"/get/{test_data['key']}")
5151
... assert response.status_code == 200, "Failed to get data"
5252
... assert response.json() == {"key": test_data["key"], "value": test_data["value"]}
53+
54+
.. autoclass:: testcontainers.generic.SqlContainer
55+
.. title:: testcontainers.generic.SqlContainer
56+
57+
SQL container that is using :code:`SqlContainer`
58+
59+
.. doctest::
60+
61+
>>> from testcontainers.generic import SqlContainer
62+
>>> from sqlalchemy import text
63+
>>> import sqlalchemy
64+
65+
>>> with SqlContainer(image="postgres:15-alpine", port=5432, username="test", password="test", dbname="test") as postgres:
66+
... engine = sqlalchemy.create_engine(postgres.get_connection_url())
67+
... with engine.connect() as conn:
68+
... result = conn.execute(text("SELECT 1"))
69+
... assert result.scalar() == 1
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
from .server import ServerContainer # noqa: F401
2+
from .sql import SqlContainer # noqa: F401

0 commit comments

Comments
 (0)