Title: How to preload relationship attributes to access outside of session? · Issue #130 · fastapi/sqlmodel · GitHub
Open Graph Title: How to preload relationship attributes to access outside of session? · Issue #130 · fastapi/sqlmodel
X Title: How to preload relationship attributes to access outside of session? · Issue #130 · 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/130
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"How to preload relationship attributes to access outside of session?","articleBody":"### First Check\n\n- [X] I added a very descriptive title to this issue.\n- [X] I used the GitHub search to find a similar issue and didn't find it.\n- [X] I searched the SQLModel documentation, with the integrated search.\n- [X] I already searched in Google \"How to X in SQLModel\" and didn't find any information.\n- [X] I already read and followed all the tutorial in the docs and didn't find an answer.\n- [X] I already checked if it is not related to SQLModel but to [Pydantic](https://github.com/samuelcolvin/pydantic).\n- [X] I already checked if it is not related to SQLModel but to [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy).\n\n### Commit to Help\n\n- [X] I commit to help with one of those options 👆\n\n### Example Code\n\n```python\n# Data base set up. Copied from:\r\n# https://sqlmodel.tiangolo.com/tutorial/relationship-attributes/back-populates/\r\n\r\nfrom typing import List, Optional\r\n\r\nfrom sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select\r\n\r\n\r\nclass Team(SQLModel, table=True):\r\n id: Optional[int] = Field(default=None, primary_key=True)\r\n name: str\r\n headquarters: str\r\n\r\n heroes: List[\"Hero\"] = Relationship(back_populates=\"team\")\r\n\r\n\r\nclass Hero(SQLModel, table=True):\r\n id: Optional[int] = Field(default=None, primary_key=True)\r\n name: str\r\n secret_name: str\r\n age: Optional[int] = None\r\n\r\n team_id: Optional[int] = Field(default=None, foreign_key=\"team.id\")\r\n team: Optional[Team] = Relationship(back_populates=\"heroes\")\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=False)\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 with Session(engine) as session:\r\n team_preventers = Team(name=\"Preventers\", headquarters=\"Sharp Tower\")\r\n team_z_force = Team(name=\"Z-Force\", headquarters=\"Sister Margaret’s Bar\")\r\n\r\n hero_deadpond = Hero(\r\n name=\"Deadpond\", secret_name=\"Dive Wilson\", team=team_z_force\r\n )\r\n hero_rusty_man = Hero(\r\n name=\"Rusty-Man\", secret_name=\"Tommy Sharp\", age=48, team=team_preventers\r\n )\r\n hero_spider_boy = Hero(name=\"Spider-Boy\", secret_name=\"Pedro Parqueador\")\r\n session.add(hero_deadpond)\r\n session.add(hero_rusty_man)\r\n session.add(hero_spider_boy)\r\n session.commit()\r\n\r\n session.refresh(hero_deadpond)\r\n session.refresh(hero_rusty_man)\r\n session.refresh(hero_spider_boy)\r\n\r\n\r\n hero_spider_boy.team = team_preventers\r\n session.add(hero_spider_boy)\r\n session.commit()\r\n session.refresh(hero_spider_boy)\r\n\r\n\r\n hero_black_lion = Hero(name=\"Black Lion\", secret_name=\"Trevor Challa\", age=35)\r\n hero_sure_e = Hero(name=\"Princess Sure-E\", secret_name=\"Sure-E\")\r\n team_wakaland = Team(\r\n name=\"Wakaland\",\r\n headquarters=\"Wakaland Capital City\",\r\n heroes=[hero_black_lion, hero_sure_e],\r\n )\r\n session.add(team_wakaland)\r\n session.commit()\r\n session.refresh(team_wakaland)\r\n\r\n hero_tarantula = Hero(name=\"Tarantula\", secret_name=\"Natalia Roman-on\", age=32)\r\n hero_dr_weird = Hero(name=\"Dr. Weird\", secret_name=\"Steve Weird\", age=36)\r\n hero_cap = Hero(\r\n name=\"Captain North America\", secret_name=\"Esteban Rogelios\", age=93\r\n )\r\n\r\n team_preventers.heroes.append(hero_tarantula)\r\n team_preventers.heroes.append(hero_dr_weird)\r\n team_preventers.heroes.append(hero_cap)\r\n session.add(team_preventers)\r\n session.commit()\r\n session.refresh(hero_tarantula)\r\n session.refresh(hero_dr_weird)\r\n session.refresh(hero_cap)\r\n\r\n\r\ndef main():\r\n create_db_and_tables()\r\n create_heroes()\r\n\r\n\r\nmain()\r\n\r\n\r\n# Within session I can access heroes.\r\nwith Session(engine) as session:\r\n team = session.exec(select(Team)).first()\r\n print(team.heroes)\r\n\r\n# [Hero(id=1, age=None, name='Deadpond', secret_name='Dive Wilson', team_id=1)]\r\n\r\n\r\n# Outside of session I cannot.\r\nwith Session(engine) as session:\r\n team = session.exec(select(Team)).first()\r\n \r\nprint(team.heroes)\r\n\r\n# ---------------------------------------------------------------------------\r\n# DetachedInstanceError Traceback (most recent call last)\r\n# /var/folders/38/ccm_21tj43v1ntn9ks9vyy740000gn/T/ipykernel_7846/3037874887.py in \u003cmodule>\r\n# 3 team = session.exec(select(Team)).first()\r\n# 4 \r\n# ----> 5 print(team.heroes)\r\n# \r\n# ~/Library/Caches/pypoetry/virtualenvs/flask-webapp-VRI2aZnU-py3.9/lib/python3.9/site-packages/sqlalchemy/orm/attributes.py in __get__(self, instance, owner)\r\n# 479 replace_context=err,\r\n# 480 )\r\n# --> 481 return self.impl.get(state, dict_)\r\n# 482 \r\n# 483 \r\n# \r\n# ~/Library/Caches/pypoetry/virtualenvs/flask-webapp-VRI2aZnU-py3.9/lib/python3.9/site-packages/sqlalchemy/orm/attributes.py in get(self, state, dict_, passive)\r\n# 924 return PASSIVE_NO_RESULT\r\n# 925 \r\n# --> 926 value = self._fire_loader_callables(state, key, passive)\r\n# 927 \r\n# 928 if value is PASSIVE_NO_RESULT or value is NO_VALUE:\r\n# \r\n# ~/Library/Caches/pypoetry/virtualenvs/flask-webapp-VRI2aZnU-py3.9/lib/python3.9/site-packages/sqlalchemy/orm/attributes.py in _fire_loader_callables(self, state, key, # passive)\r\n# 960 return callable_(state, passive)\r\n# 961 elif self.callable_:\r\n# --> 962 return self.callable_(state, passive)\r\n# 963 else:\r\n# 964 return ATTR_EMPTY\r\n# \r\n# ~/Library/Caches/pypoetry/virtualenvs/flask-webapp-VRI2aZnU-py3.9/lib/python3.9/site-packages/sqlalchemy/orm/strategies.py in _load_for_state(self, state, passive, loadopt, # extra_criteria)\r\n# 841 return attributes.PASSIVE_NO_RESULT\r\n# 842 \r\n# --> 843 raise orm_exc.DetachedInstanceError(\r\n# 844 \"Parent instance %s is not bound to a Session; \"\r\n# 845 \"lazy load operation of attribute '%s' cannot proceed\"\r\n# \r\n# DetachedInstanceError: Parent instance \u003cTeam at 0x1162a8400> is not bound to a Session; lazy load operation of attribute 'heroes' cannot proceed (Background on this error at: https://sqlalche.me/e/14/bhk3)\n```\n\n\n### Description\n\nI am using sqlmodel with flask. I would like to pre-load the relationship attributes for a given object before passing that object into a jinja2 template. The challenge is I can't figure out how to pre-load the attributes.\r\n\r\nIn my example code, how can I get the last line to execute without throwing an error?\r\n\r\n```python\r\n# Outside of session I cannot.\r\nwith Session(engine) as session:\r\n team = session.exec(select(Team)).first()\r\n \r\nprint(team.heroes)\r\n```\n\n### Operating System\n\nmacOS\n\n### Operating System Details\n\nmacOS Big Sur 11.3.1\n\n### SQLModel Version\n\n0.0.4\n\n### Python Version\n\n3.9.4\n\n### Additional Context\n\nIn reference to my tweet :) https://twitter.com/TheReaLSamlam/status/1447779469221974016","author":{"url":"https://github.com/SamEdwardes","@type":"Person","name":"SamEdwardes"},"datePublished":"2021-10-12T21:53:45Z","url":"https://github.com/fastapi/sqlmodel/issues/130"}
| 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:7dca4c42-04b4-71ab-8094-2e2fafecdaef |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | E77E:C0B36:133642:1A6694:6AFE0539 |
| html-safe-nonce | 04d2e9dd91063b9470aa1f14a07c174ff84b6539dccac3a11886182d93767b1b |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFNzdFOkMwQjM2OjEzMzY0MjoxQTY2OTQ6NkFGRTA1MzkiLCJ2aXNpdG9yX2lkIjoiMTU2OTc3OTkyOTY2MTE3OTE5MyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | f0ef0562acb993748eece315b3c0ccc0ef55fe0d80eaef0defd5ebc865e45b44 |
| hovercard-subject-tag | issue:1024472893 |
| 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/130/issue_layout |
| twitter:image | https://opengraph.githubassets.com/613cc967774e8e8d188d790c5c6a4e41e319f4f7a98a96ecfaed2226228acc1e/fastapi/sqlmodel/issues/130 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/613cc967774e8e8d188d790c5c6a4e41e319f4f7a98a96ecfaed2226228acc1e/fastapi/sqlmodel/issues/130 |
| 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 | SamEdwardes |
| hostname | github.com |
| expected-hostname | github.com |
| None | 86d46ece7c3d9b0562692f81a135cb55ad6a1c82c93ab1ac874d2f1b46b28958 |
| 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 | 5c18e6799976b7bc2f21178024289bb98edbcc85 |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width