22 Commits

Author SHA1 Message Date
Sebastián Ramírez
c92fe5018e
Add docs dependency markdown-include-variants (#1129) 2024-10-07 23:05:27 +02:00
Sebastián Ramírez
c96d6b791c
📝 Add docs for virtual environments and environment variables, update contributing (#1082) 2024-08-23 14:03:39 -05:00
Sebastián Ramírez
cd1fb5e4ae
📝 Update links from github.com/tiangolo/sqlmodel to github.com/fastapi/sqlmodel (#1064) 2024-08-12 14:09:56 -05:00
Sebastián Ramírez
8c8988f333
📝 Add docs about repo management and team (#1059) 2024-08-09 16:27:10 -05:00
Sebastián Ramírez
badebd51c1
🔧 Update MkDocs previews (#1058) 2024-08-09 12:18:10 -05:00
Sebastián Ramírez
970492487a
👷 Upgrade build docs configs (#1047)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2024-08-09 00:13:10 +00:00
Sebastián Ramírez
9b632de28a
🔧 Enable auto dark mode (#1046) 2024-08-04 00:55:34 +00:00
Esteban Maya
86ab09f7ec
Add support for cascade delete relationships: cascade_delete, ondelete, and passive_deletes (#983)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-07-20 21:08:06 -05:00
Esteban Maya
95936bb508
Add official UUID support, docs and tests, internally using new SQLAlchemy 2.0 types (#992)
*  Add UUID support from sqlalchemy 2.0 update

* ⚰️ Remove dead code for GUID old support

* 📝 Add documentation for UUIDs

* 🧪 Add test for UUIDs field definition and support

* 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks

* ✏️ Fix prerequisites docs for uuid

* ♻️ Update UUID source examples for consistency

Keep consistency with other examples, functions without parameters, and printing info that shows and explains the UUID results (and can also be tested later)

* 📝 Add source examples for selecting UUIDs with session.get()

* 📝 Re-structure UUID docs

* Explain the concepts at the beggining before using them.
* Explain how UUIDs can be used and trusted.
* Explain why UUIDs could be generated on the code, and how they can be used for distributed systems.
* Explain how UUIDs can prevent information leakage.
* Warn about UUIDs storage size.
* Explain that uuid is part of the standard library.
* Explain how default_factory works.
* Explain that creating an instance would generate a new UUID, before it is sent to the DB. This is included and shown in the example, the UUID is printed before saving to the DB.
* Remove sections about other operations that would behave the same as other fields and don't need additional info from what was explained in previous chapters.
* Add two examples to select using UUIDs, similar to the previous ones, mainly to be able to use them in the tests and ensure that it all works, even when SQLite stores the values as strings but the where() or the session.get() receive UUID values (ensure SQLAlchemy does the conversion correctly for SQLite).
* Add an example terminal run of the code, with comments.
* Simplify the ending to keep only the information that wasn't there before, just the "Learn More" with links.

*  Refactor tests with new printed code, extract and check that UUIDs are used in the right places.

*  Add tests for the new extra UUID examples, for session.get()

* 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks

* 📝 Rename variable in example for Python 3.7+ for consistency with 3.10+ (I missed that change before)

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2024-07-16 20:52:03 -05:00
Sebastián Ramírez
fa12c5d87b
Add new method sqlmodel_update() to update models in place, including an update parameter for extra data (#804) 2024-02-17 14:49:39 +01:00
Sebastián Ramírez
276bcf788c
🔧 Update docs build setup, add support for sponsors, add sponsor GOVCERT.LU (#720) 2023-12-04 13:00:47 +01:00
Sebastián Ramírez
33c5e5c98d
🔧 Show line numbers in docs during local development (#714)
🔧 Show line numbers during local development
2023-11-28 23:41:03 +01:00
Sebastián Ramírez
a95bd3873d
🔧 Update config with new pymdown extensions (#712)
* 🔧 Update config with new pymdown extensions

* 📝 Update admonition blocks syntax

* 📝 Update syntax for tabs with new pymdown extensions
2023-11-28 21:50:33 +01:00
Sebastián Ramírez
810236c26c
⬆️ Upgrade analytics (#558) 2023-02-21 11:02:18 +00:00
Sebastián Ramírez
e523e1e4c3
📝 Add Jina's QA Bot to the docs to help people that want to ask quick questions (#263)
Co-authored-by: yanlong.wang <yanlong.wang@naiver.org>
Co-authored-by: Han Xiao <han.xiao@jina.ai>
2022-04-16 11:24:53 +02:00
Sebastián Ramírez
c873aa3930
🔧 Upgrade MkDocs Material and update configs (#217) 2022-01-08 17:49:07 +01:00
Sebastián Ramírez
155c6178cd
Document indexes and make them opt-in (#205) 2021-12-28 11:48:03 +01:00
robcxyz
580f372059
Add support for Decimal fields from Pydantic and SQLAlchemy (#103)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2021-12-13 12:30:20 +01:00
Sebastián Ramírez
14a9788eb1
🔧 Split MkDocs insiders build in CI to support building from PRs (#186) 2021-12-13 11:47:07 +01:00
Lehoczky Zoltán
82935cae9f
🐛Fix docs light/dark theme switcher (#1)
* 🐛Fix tooltip text for theme switcher

* 🔧 Update lightbulb icon

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
2021-12-03 11:23:20 +01:00
Sebastián Ramírez
55259b3c8b
🔧 Add MkDocs Material social cards (#90) 2021-11-30 17:27:50 +01:00
Sebastián Ramírez
f2487f82e9 🔧 Add MkDocs config 2021-08-24 15:19:55 +02:00