feat: Add tutorial and advanced page for EncryptedType

Author: ravishan16

docs/advanced/encrypted-type.md

@@ -0,0 +1,19 @@
+# Encrypted Type
+
+Sometimes you need to store sensitive data like secrets, tokens, or personal information in your database in an encrypted format.
+
+You can use the `EncryptedType` from the `sqlalchemy-utils` package to achieve this with SQLModel.
+
+## A Model with an Encrypted Field
+
+You can define a field with `EncryptedType` in your SQLModel model using `sa_column`:
+
+{* ./docs_src/advanced/encrypted_type/tutorial001.py *}
+
+In this example, the `secret_name` field will be automatically encrypted when you save a `Hero` object to the database and decrypted when you access it.
+
+/// tip
+For this to work, you need to have `sqlalchemy-utils` and `cryptography` installed.
+///
+
+For a more detailed walkthrough, including how to create and query data with encrypted fields, check out the [Encrypting Data Tutorial](../tutorial/encrypted-type.md).

docs/tutorial/encrypted-type.md

@@ -0,0 +1,68 @@
+# Encrypting Data
+
+In this tutorial, you'll learn how to encrypt data before storing it in your database using SQLModel and `sqlalchemy-utils`.
+
+## The Scenario
+
+Let's imagine we're building an application to store information about characters from our favorite TV show, Ted Lasso. We want to store their names, secret names (which should be encrypted), and their ages.
+
+## The Code
+
+Here's the complete code to achieve this:
+
+{* ./docs_src/tutorial/encrypted_type/tutorial001.py *}
+
+### Understanding the Code
+
+Let's break down the key parts of the code:
+
+1.  **`EncryptedType`**: We use `EncryptedType` from `sqlalchemy-utils` as a `sa_column` for the `secret_name` field. This tells SQLModel to use this special type for the column in the database.
+
+2.  **Encryption Key**: We provide an encryption key to `EncryptedType`. In a real-world application, you should **never** hardcode the key like this. Instead, you should load it from a secure source like a secret manager or an environment variable.
+
+3.  **`demonstrate_encryption` function**: This function shows the power of `EncryptedType`.
+    *   First, it queries the database directly using raw SQL. When we print the `secret_name` from this query, you'll see the encrypted string, not the original secret name.
+    *   Then, it queries the database using SQLModel. When we access the `secret_name` attribute of the `Character` objects, `EncryptedType` automatically decrypts the data for us, so we get the original, readable secret names.
+
+## How to Test
+
+To run this example, first create a virtual environment:
+
+```bash
+python -m venv venv
+source venv/bin/activate
+```
+
+Then, install the required packages from the `requirements.txt` file:
+
+```bash
+pip install -r docs_src/tutorial/encrypted_type/requirements.txt
+```
+
+Then, you can run the python script:
+
+```bash
+python docs_src/tutorial/encrypted_type/tutorial001.py
+```
+
+## Running the Code
+
+When you run the code, you'll see the following output:
+
+```console
+Creating database and tables...
+Creating characters...
+
+Demonstrating encryption...
+Data as stored in the database:
+Name: Roy Kent, Encrypted Secret Name: b'5dBrkurIL+fEin+1eUBc0A=='
+Name: Jamie Tartt, Encrypted Secret Name: b'CDLkQWx5ezXn+U4kRlVFyQ=='
+Name: Dani Rojas, Encrypted Secret Name: b'SqSjH+biJttbs9zH+DBw8A=='
+
+Data as accessed through SQLModel:
+Name: Roy Kent, Decrypted Secret Name: The Special One
+Name: Jamie Tartt, Decrypted Secret Name: Baby Shark
+Name: Dani Rojas, Decrypted Secret Name: Fútbol is Life
+```
+
+As you can see, `EncryptedType` handles the encryption and decryption for you automatically, making it easy to store sensitive data securely.

docs_src/advanced/encrypted_type/tutorial001.py

@@ -0,0 +1,39 @@
+
+import os
+from typing import Optional
+
+import sqlalchemy
+from sqlalchemy import Column
+from sqlalchemy_utils import EncryptedType
+from sqlalchemy_utils.types.encrypted.encrypted_type import AesEngine
+from sqlmodel import create_engine, Field, Session, SQLModel
+
+
+# For a real application, use a securely managed key
+ENCRYPTION_KEY = "a-super-secret-key"
+
+class Hero(SQLModel, table=True):
+    id: Optional[int] = Field(default=None, primary_key=True)
+    name: str
+    # Because the secret name should stay a secret
+    secret_name: str = Field(
+        sa_column=Column(
+            EncryptedType(
+                sqlalchemy.Unicode,
+                ENCRYPTION_KEY,
+                AesEngine,
+                "pkcs5",
+            )
+        )
+    )
+    age: Optional[int] = None
+
+
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite:///{sqlite_file_name}"
+
+engine = create_engine(sqlite_url)
+
+
+def create_db_and_tables():
+    SQLModel.metadata.create_all(engine)

docs_src/tutorial/encrypted_type/requirements.txt

@@ -0,0 +1,3 @@
+sqlmodel
+sqlalchemy-utils
+cryptography

docs_src/tutorial/encrypted_type/tutorial001.py

@@ -0,0 +1,96 @@
+# Import necessary modules
+import os
+from typing import Optional
+
+import sqlalchemy
+from sqlalchemy import Column, text
+from sqlalchemy_utils import EncryptedType
+from sqlalchemy_utils.types.encrypted.encrypted_type import AesEngine
+from sqlmodel import create_engine, Field, Session, SQLModel, select
+
+# Define a secret key for encryption.
+# In a real application, this key should be stored securely and not hardcoded.
+# For example, you could load it from an environment variable or a secret management service.
+ENCRYPTION_KEY = "a-super-secret-key"
+
+# Define the Character model
+# This model represents a table named 'character' in the database.
+class Character(SQLModel, table=True):
+    id: Optional[int] = Field(default=None, primary_key=True)
+    name: str
+    # The secret_name field is encrypted in the database.
+    # We use EncryptedType from sqlalchemy-utils for this.
+    secret_name: str = Field(
+        sa_column=Column(
+            EncryptedType(
+                sqlalchemy.Unicode,
+                ENCRYPTION_KEY,
+                AesEngine,
+                "pkcs5",
+            )
+        )
+    )
+    age: Optional[int] = None
+
+# Define the database URL and create the engine
+# We are using a SQLite database for this example.
+sqlite_file_name = "database.db"
+sqlite_url = f"sqlite:///{sqlite_file_name}"
+engine = create_engine(sqlite_url)
+
+# This function creates the database and the Character table.
+# It first drops the existing table to ensure a clean state for the example.
+def create_db_and_tables():
+    SQLModel.metadata.drop_all(engine)
+    SQLModel.metadata.create_all(engine)
+
+# This function creates some sample characters and adds them to the database.
+def create_characters():
+    # Create instances of the Character model
+    roy_kent = Character(name="Roy Kent", secret_name="The Special One", age=40)
+    jamie_tartt = Character(name="Jamie Tartt", secret_name="Baby Shark", age=25)
+    dani_rojas = Character(name="Dani Rojas", secret_name="Fútbol is Life", age=23)
+
+    # Use a session to interact with the database
+    with Session(engine) as session:
+        # Add the characters to the session
+        session.add(roy_kent)
+        session.add(jamie_tartt)
+        session.add(dani_rojas)
+
+        # Commit the changes to the database
+        session.commit()
+
+# This function demonstrates how the encryption works.
+def demonstrate_encryption():
+    with Session(engine) as session:
+        # Query the database directly to see the encrypted data
+        # We use a raw SQL query for this.
+        statement = text("SELECT name, secret_name FROM character")
+        results = session.exec(statement).all()
+        print("Data as stored in the database:")
+        for row in results:
+            # The secret_name will be an encrypted string.
+            print(f"Name: {row.name}, Encrypted Secret Name: {row.secret_name}")
+
+        # Query through SQLModel to see the decrypted data
+        # SQLModel will automatically decrypt the secret_name.
+        statement = select(Character)
+        characters = session.exec(statement).all()
+        print("\nData as accessed through SQLModel:")
+        for character in characters:
+            # The secret_name will be the original, decrypted string.
+            print(f"Name: {character.name}, Decrypted Secret Name: {character.secret_name}")
+
+# The main function that runs the example.
+def main():
+    print("Creating database and tables...")
+    create_db_and_tables()
+    print("Creating characters...")
+    create_characters()
+    print("\nDemonstrating encryption...")
+    demonstrate_encryption()
+
+# Run the main function when the script is executed.
+if __name__ == "__main__":
+    main()

mkdocs.yml

@@ -87,6 +87,7 @@ nav:
       - tutorial/limit-and-offset.md
       - tutorial/update.md
       - tutorial/delete.md
+      - tutorial/encrypted-type.md
       - Connect Tables - JOIN:
         - tutorial/connect/index.md
         - tutorial/connect/create-connected-tables.md
@@ -128,6 +129,7 @@ nav:
       - advanced/index.md
       - advanced/decimal.md
       - advanced/uuid.md
+      - advanced/encrypted-type.md
   - Resources:
     - resources/index.md
     - help.md