Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Update includes for docs/advanced/uuid.md #1151

Merged
merged 2 commits into from
Oct 27, 2024
Merged

📝 Update includes for docs/advanced/uuid.md #1151

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
975fc2e
📝 Update includes for `docs/advanced/uuid.md`
tiangolo Oct 26, 2024
5cf5d5d
Merge branch 'main' into include-uuid
tiangolo Oct 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
172 changes: 4 additions & 168 deletions docs/advanced/uuid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,45 +80,7 @@ We don't call `uuid.uuid4()` ourselves in the code (we don't put the parenthesis

This means that the UUID will be generated in the Python code, **before sending the data to the database**.

//// tab | Python 3.10+

```Python hl_lines="1 7"
{!./docs_src/advanced/uuid/tutorial001_py310.py[ln:1-10]!}

# Code below omitted 👇
```

////

//// tab | Python 3.7+

```Python hl_lines="1 8"
{!./docs_src/advanced/uuid/tutorial001.py[ln:1-11]!}

# Code below omitted 👇
```

////

/// details | 👀 Full file preview

//// tab | Python 3.10+

```Python
{!./docs_src/advanced/uuid/tutorial001_py310.py!}
```

////

//// tab | Python 3.7+

```Python
{!./docs_src/advanced/uuid/tutorial001.py!}
```

////

///
{* ./docs_src/advanced/uuid/tutorial001_py310.py ln[1:10] hl[1,7] *}

Pydantic has support for <a href="https://docs.pydantic.dev/latest/api/standard_library_types/#uuid" class="external-link" target="_blank">`UUID` types</a>.

Expand All @@ -132,99 +94,15 @@ As `uuid.uuid4` will be called when creating the model instance, even before sen

And that **same ID (a UUID)** will be saved in the database.

//// tab | Python 3.10+

```Python hl_lines="5 7 9 14"
# Code above omitted 👆

{!./docs_src/advanced/uuid/tutorial001_py310.py[ln:23-34]!}

# Code below omitted 👇
```

////

//// tab | Python 3.7+

```Python hl_lines="5 7 9 14"
# Code above omitted 👆

{!./docs_src/advanced/uuid/tutorial001.py[ln:24-35]!}

# Code below omitted 👇
```

////

/// details | 👀 Full file preview

//// tab | Python 3.10+

```Python
{!./docs_src/advanced/uuid/tutorial001_py310.py!}
```

////

//// tab | Python 3.7+

```Python
{!./docs_src/advanced/uuid/tutorial001.py!}
```

////

///
{* ./docs_src/advanced/uuid/tutorial001_py310.py ln[23:34] hl[25,27,29,34] *}

### Select a Hero

We can do the same operations we could do with other fields.

For example we can **select a hero by ID**:

//// tab | Python 3.10+

```Python hl_lines="15"
# Code above omitted 👆

{!./docs_src/advanced/uuid/tutorial001_py310.py[ln:37-54]!}

# Code below omitted 👇
```

////

//// tab | Python 3.7+

```Python hl_lines="15"
# Code above omitted 👆

{!./docs_src/advanced/uuid/tutorial001.py[ln:38-55]!}

# Code below omitted 👇
```

////

/// details | 👀 Full file preview

//// tab | Python 3.10+

```Python
{!./docs_src/advanced/uuid/tutorial001_py310.py!}
```

////

//// tab | Python 3.7+

```Python
{!./docs_src/advanced/uuid/tutorial001.py!}
```

////

///
{* ./docs_src/advanced/uuid/tutorial001_py310.py ln[37:54] hl[49] *}

/// tip

Expand All @@ -238,49 +116,7 @@ SQLModel (actually SQLAlchemy) will take care of making it work. ✨

We could also select by ID with `session.get()`:

//// tab | Python 3.10+

```Python hl_lines="15"
# Code above omitted 👆

{!./docs_src/advanced/uuid/tutorial002_py310.py[ln:37-54]!}

# Code below omitted 👇
```

////

//// tab | Python 3.7+

```Python hl_lines="15"
# Code above omitted 👆

{!./docs_src/advanced/uuid/tutorial002.py[ln:38-55]!}

# Code below omitted 👇
```

////

/// details | 👀 Full file preview

//// tab | Python 3.10+

```Python
{!./docs_src/advanced/uuid/tutorial002_py310.py!}
```

////

//// tab | Python 3.7+

```Python
{!./docs_src/advanced/uuid/tutorial002.py!}
```

////

///
{* ./docs_src/advanced/uuid/tutorial002_py310.py ln[37:53] hl[49] *}

The same way as with other fields, we could update, delete, etc. 🚀

Expand Down