Expand documentation

[tomchristie]

In particular:

• More examples of queries.
• Examples of using JSON field.
• Examples with joining tables.
• Getting PK of inserted rows.
• Properly document return types of the databases API.

[tomchristie]

See also #31

[mivade]

Getting PK of inserted rows.

Is this currently possible?

[mivade]

Digging into the code, it looks like it is in the same way as with SQLAlchemy (i.e., it gets returned when calling execute on an insert statement). Unfortunately this doesn't always return the primary key though. For example, with SQLite, the last "rowid" gets returned which corresponds to an integer primary key (in cases where the primary key is an integer) or the "undeclared" ROWID column: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.lastrowid

[brainless]

Hey everyone, I am using databases for two of my products and would like to work on the documentation issue. I see this is still open. Since this GitHub issue is very old I would like to know if the issue points are still valid. I will go through the documentation again today just to double check. Any pointers would be helpful as I am a bit hesitant to contribute to such an important project. Thanks

[hp0404]

@brainless would be great tbh, currently stuck with joining tables :)

[Pk13055]

Is there any update on this? This is a pretty good async library, but lack of documentation (+ generic name) makes it difficult to find/google anything complex..