Skip to content

Please add transactions to the Engines -> SQLiteEngine documentation #1274

@badlydrawnrob

Description

@badlydrawnrob

It could be clearer how to get up and running with SQLite quickly ...

Generally there's normally some example of db.open() and db.close() wherever the SQLite documentation is, as well as options to have it all in one function rather than every route. You've got a great example on the tutorials documentation but that's buried quite deep in the docs.

Postgres has it's connection_pool() examples, so on the SQLiteEngine page it'd make sense to have (a) a link to the FastAPI tutorial, and (b) an isolated example that'd work with any implementation. It'd also be nice to consolidate the tutorials a little better, as currently the main site's documentation link points to the root Read the Docs page and not the Read the Docs: tutorials page (which also doesn't have a backlink to YouTube videos).

Finally, the from piccolo.engine import engine_finder docs could also be improved and easier to locate, but it doesn't seem you're using it in the FastAPI tutorials link above so I guess that's optional?

I'm happy to write some .md you could use for the docs if it helps.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions