Title: How to use EncryptedType of SQLAlchemy · Issue #447 · fastapi/sqlmodel · GitHub
Open Graph Title: How to use EncryptedType of SQLAlchemy · Issue #447 · fastapi/sqlmodel
X Title: How to use EncryptedType of SQLAlchemy · Issue #447 · fastapi/sqlmodel
Description: First Check I added a very descriptive title to this issue. I used the GitHub search to find a similar issue and didn't find it. I searched the SQLModel documentation, with the integrated search. I already searched in Google "How to X in...
Open Graph Description: First Check I added a very descriptive title to this issue. I used the GitHub search to find a similar issue and didn't find it. I searched the SQLModel documentation, with the integrated search. I...
X Description: First Check I added a very descriptive title to this issue. I used the GitHub search to find a similar issue and didn't find it. I searched the SQLModel documentation, with the integrated searc...
Opengraph URL: https://github.com/fastapi/sqlmodel/issues/447
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"How to use EncryptedType of SQLAlchemy","articleBody":"### First Check\r\n\r\n- [X] I added a very descriptive title to this issue.\r\n- [X] I used the GitHub search to find a similar issue and didn't find it.\r\n- [X] I searched the SQLModel documentation, with the integrated search.\r\n- [X] I already searched in Google \"How to X in SQLModel\" and didn't find any information.\r\n- [X] I already read and followed all the tutorial in the docs and didn't find an answer.\r\n- [X] I already checked if it is not related to SQLModel but to [Pydantic](https://github.com/samuelcolvin/pydantic).\r\n- [X] I already checked if it is not related to SQLModel but to [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy).\r\n\r\n### Commit to Help\r\n\r\n- [x] I commit to help with one of those options 👆\r\n\r\n### Example Code\r\n\r\n```python\r\nimport os\r\nfrom typing import Optional\r\n\r\nimport sqlalchemy\r\nfrom sqlalchemy import Column\r\nfrom sqlalchemy_utils import EncryptedType\r\nfrom sqlalchemy_utils.types.encrypted.encrypted_type import AesEngine\r\nfrom sqlmodel import create_engine, Field, Session, SQLModel\r\n\r\n\r\n# https://sqlalchemy-utils.readthedocs.io/en/latest/_modules/sqlalchemy_utils/types/encrypted/encrypted_type.html#EncryptedType\r\nclass Hero(SQLModel, table=True):\r\n id: Optional[int] = Field(default=None, primary_key=True)\r\n name: str\r\n # Because the secret name should stay a secret\r\n secret_name: str = Field(\r\n sa_column=Column(\r\n EncryptedType(\r\n sqlalchemy.Unicode,\r\n os.getenv('ENCRYPTION_KEY'),\r\n AesEngine,\r\n 'pkcs5'\r\n )\r\n )\r\n )\r\n age: Optional[int] = None\r\n\r\n\r\nsqlite_file_name = \"database.db\"\r\nsqlite_url = f\"sqlite:///{sqlite_file_name}\"\r\n\r\nengine = create_engine(sqlite_url, echo=True)\r\n\r\n\r\ndef create_db_and_tables():\r\n SQLModel.metadata.create_all(engine)\r\n\r\n\r\ndef create_heroes():\r\n hero_1 = Hero(name=\"Deadpond\", secret_name=\"Dive Wilson\") #\r\n hero_2 = Hero(name=\"Spider-Boy\", secret_name=\"Pedro Parqueador\") #\r\n hero_3 = Hero(name=\"Rusty-Man\", secret_name=\"Tommy Sharp\", age=48) #\r\n\r\n print(\"Before interacting with the database\") #\r\n print(\"Hero 1:\", hero_1) #\r\n print(\"Hero 2:\", hero_2) #\r\n print(\"Hero 3:\", hero_3) #\r\n\r\n with Session(engine) as session: #\r\n session.add(hero_1) #\r\n session.add(hero_2) #\r\n session.add(hero_3) #\r\n\r\n print(\"After adding to the session\") #\r\n print(\"Hero 1:\", hero_1) #\r\n print(\"Hero 2:\", hero_2) #\r\n print(\"Hero 3:\", hero_3) #\r\n\r\n session.commit() #\r\n\r\n print(\"After committing the session\") #\r\n print(\"Hero 1:\", hero_1) #\r\n print(\"Hero 2:\", hero_2) #\r\n print(\"Hero 3:\", hero_3) #\r\n\r\n print(\"After committing the session, show IDs\") #\r\n print(\"Hero 1 ID:\", hero_1.id) #\r\n print(\"Hero 2 ID:\", hero_2.id) #\r\n print(\"Hero 3 ID:\", hero_3.id) #\r\n\r\n print(\"After committing the session, show names\") #\r\n print(\"Hero 1 name:\", hero_1.name) #\r\n print(\"Hero 2 name:\", hero_2.name) #\r\n print(\"Hero 3 name:\", hero_3.name) #\r\n\r\n session.refresh(hero_1) #\r\n session.refresh(hero_2) #\r\n session.refresh(hero_3) #\r\n\r\n print(\"After refreshing the heroes\") #\r\n print(\"Hero 1:\", hero_1) #\r\n print(\"Hero 2:\", hero_2) #\r\n print(\"Hero 3:\", hero_3) #\r\n #\r\n\r\n print(\"After the session closes\") #\r\n print(\"Hero 1:\", hero_1) #\r\n print(\"Hero 2:\", hero_2) #\r\n print(\"Hero 3:\", hero_3) #\r\n\r\n\r\ndef main():\r\n create_db_and_tables()\r\n create_heroes()\r\n\r\n\r\nif __name__ == \"__main__\":\r\n main()\r\n```\r\n\r\n\r\n### Description\r\n\r\n## This code is already working as is!\r\n\r\nI did not find a tutorial for SLQModel on how to encrypt / decrypt data. I also thought of opening a PR to add this to the docu but as this approach uses a separate package ([sqlalchemy_utils](https://sqlalchemy-utils.readthedocs.io/en/latest/data_types.html#module-sqlalchemy_utils.types.encrypted.encrypted_type)) for the column type **EncryptedType** I wanted to ask beforehand if that is wanted.\r\n\r\n### Operating System\r\n\r\nLinux\r\n\r\n### Operating System Details\r\n\r\n_No response_\r\n\r\n### SQLModel Version\r\n\r\n0.0.8\r\n\r\n### Python Version\r\n\r\n3.10.4\r\n\r\n### Additional Context\r\n\r\n_No response_","author":{"url":"https://github.com/ChuckMoe","@type":"Person","name":"ChuckMoe"},"datePublished":"2022-09-12T22:37:28Z","url":"https://github.com/fastapi/sqlmodel/issues/447"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:76859d21-94dd-cb2d-95dd-6f18b6c2add2 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9E5C:2AC56D:668A5A:89D86D:6AFE2900 |
| html-safe-nonce | e985a655bc56120e2af01e2da29227bed3805f1d48a4e065306a02967ca39e10 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RTVDOjJBQzU2RDo2NjhBNUE6ODlEODZEOjZBRkUyOTAwIiwidmlzaXRvcl9pZCI6IjYzNDgyNTAwNTk0NTIwNjYwNDgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 45eb1e414c437eb1e9a3e36cbc48ffa40bfd3c466bd0bf1304505117cf972604 |
| hovercard-subject-tag | issue:1370604077 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/fastapi/sqlmodel/447/issue_layout |
| twitter:image | https://opengraph.githubassets.com/a750860e0223b91c3cbf5ab8ddab47cf6f56bf7110aa83c137c46f27f7c70e7b/fastapi/sqlmodel/issues/447 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/a750860e0223b91c3cbf5ab8ddab47cf6f56bf7110aa83c137c46f27f7c70e7b/fastapi/sqlmodel/issues/447 |
| og:image:alt | First Check I added a very descriptive title to this issue. I used the GitHub search to find a similar issue and didn't find it. I searched the SQLModel documentation, with the integrated search. I... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | ChuckMoe |
| hostname | github.com |
| expected-hostname | github.com |
| None | e973f9ec3625f3faad8cac5c2d11a214b7ffe45f3cc563b828459b290ecaeed3 |
| turbo-cache-control | no-preview |
| go-import | github.com/fastapi/sqlmodel git https://github.com/fastapi/sqlmodel.git |
| octolytics-dimension-user_id | 156354296 |
| octolytics-dimension-user_login | fastapi |
| octolytics-dimension-repository_id | 399495186 |
| octolytics-dimension-repository_nwo | fastapi/sqlmodel |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 399495186 |
| octolytics-dimension-repository_network_root_nwo | fastapi/sqlmodel |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 1f92c367595b9190e0be293896078033886b1913 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width