Skip to content

[BUG] Unclear documentation example SQLAlchemy Sessions #327

@vorenhoutgithub

Description

@vorenhoutgithub

Describe the bug
Trying to understand the example code for SQLAlchemy sessions as shown currently at https://fastapi-utils.davidmontague.xyz/user-guide/session/
However, the example code is exactly the same and does not show any example.

To Reproduce
Steps to reproduce the behavior:

  1. Go to documentation page

Expected behavior
A clear and concise description of what I need to do to use the fastapi_utils.session.FastAPISessionMaker class, Preferably with annotated code examples.

The line starting with "Next, we set up infrastructure for loading the database uri from the environment:" promises example code, but non is present.

Screenshots

Copied text:

class DBSettings(BaseSettings):
    """Parses variables from environment on instantiation"""

    database_uri: str  # could break up into scheme, username, password, host, db

Environment:
NA

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions