Skip to content

Commit c0dc7b9

Browse files
committed
docs + fix typos
1 parent 2115d9b commit c0dc7b9

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

docs/pagination.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
``` py title="example.py" hl_lines="25 26 27"
2121
from fastapi import FastAPI
2222
from fastsqla import Base, Paginate, Page, lifespan
23-
from pydantic import BaseModel
23+
from pydantic import BaseModel, ConfigDict
2424
from sqlalchemy import select
2525
from sqlalchemy.orm import Mapped, mapped_column
2626

@@ -34,7 +34,7 @@ class Hero(Base):
3434
age: Mapped[int]
3535

3636

37-
class HeroModel(HeroBase):
37+
class HeroModel(BaseModel):
3838
model_config = ConfigDict(from_attributes=True)
3939
id: int
4040
name: str

docs/setup.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Setup
22

3-
To configure just using environment variables, check [`lifespan`][fastsqla.lifespan].
3+
FastSQLA provides two ways to configure your SQLAlchemy database connection:
44

5-
To configure programatically, check [`new_lifespan`][fastsqla.new_lifespan]
5+
- **Environment variables** ([`lifespan`][fastsqla.lifespan]): Simple configuration
6+
following [12-factor app](https://12factor.net/config) principles, ideal for most use cases.
7+
- **Programmatic** ([`new_lifespan`][fastsqla.new_lifespan]): Direct SQLAlchemy engine
8+
configuration for advanced customization needs
69

710
## `fastsqla.lifespan`
811

@@ -20,7 +23,7 @@ The only required key is **`SQLALCHEMY_URL`**, which defines the database URL. I
2023
specifies the database driver in the URL's scheme and allows embedding driver parameters
2124
in the query string. Example:
2225

23-
sqlite+aiosqlite:////tmp/test.db?check_same_thread=false
26+
sqlite+aiosqlite:////tmp/test.db
2427

2528
All parameters of [`sqlalchemy.create_engine`][] can be configured by setting environment
2629
variables, with each parameter name prefixed by **`SQLALCHEMY_`**.
@@ -46,8 +49,8 @@ variables, with each parameter name prefixed by **`SQLALCHEMY_`**.
4649
[`pool_size`][sqlalchemy.create_engine.params.pool_size] of 50:
4750

4851
```bash
49-
export sqlalchemy_url=sqlite+aiosqlite:///tmp/test.db?check_same_thread=false
50-
export sqlalchemy_pool_size=10
52+
export sqlalchemy_url=sqlite+aiosqlite:///tmp/test.db
53+
export sqlalchemy_pool_size=50
5154
```
5255

5356
3. :simple-mariadb: MariaDB url using [`aiomysql`][sqlalchemy.dialects.mysql.aiomysql]
@@ -65,4 +68,4 @@ variables, with each parameter name prefixed by **`SQLALCHEMY_`**.
6568
::: fastsqla.new_lifespan
6669
options:
6770
heading_level: false
68-
show_source: false
71+
show_source: false

src/fastsqla.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ def new_lifespan(url: str | None = None, **kw):
9191
from fastsqla import new_lifespan
9292
9393
lifespan = new_lifespan(
94-
"sqlite+aiosqlite:///app/db.sqlite"), connect_args={"autocommit": False}
94+
"sqlite+aiosqlite:///app/db.sqlite", connect_args={"autocommit": False}
9595
)
9696
9797
app = FastAPI(lifespan=lifespan)

0 commit comments

Comments
 (0)