Title: Custom Root Types are detected as NullType by SQLAlchemy · Issue #7 · fastapi/sqlmodel · GitHub
Open Graph Title: Custom Root Types are detected as NullType by SQLAlchemy · Issue #7 · fastapi/sqlmodel
X Title: Custom Root Types are detected as NullType by SQLAlchemy · Issue #7 · 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/7
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Custom Root Types are detected as NullType by 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\nfrom typing import Optional\r\n\r\nfrom sqlmodel import Field, SQLModel, create_engine\r\n\r\nclass MyNewCustomRootType(SQLModel):\r\n __root__ : str\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 my_new_attribute: MyNewCustomRootType \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\nSQLModel.metadata.create_all(engine)\r\n```\r\n\r\n\r\n### Description\r\n\r\n1. Add a type that uses the technique described in the [Custom Root Types](https://pydantic-docs.helpmanual.io/usage/models/#custom-root-types) section of the Pydantic docs.\r\n1. Use this type for a type hint in a model that creates a SQLModel table.\r\n1. Run metadata creation.\r\n1. SQLAlchemy will error out claiming that you didn't set a type (but I did!)\r\n\r\nThis library looks really cool, but my Pydantic models use custom root types in a few places and if I can't use them I'll have to replicate a ton of code over and over again. Is this intentional behavior, or is it possible support for them can be added?\r\n\r\n### Operating System\r\n\r\nLinux, macOS\r\n\r\n### Operating System Details\r\n\r\n_No response_\r\n\r\n### SQLModel Version\r\n\r\n0.0.3\r\n\r\n### Python Version\r\n\r\n3.9.4, 3.8\r\n\r\n### Additional Context\r\n\r\nThe full traceback from trying to run the example in a Repl.it instance:\r\n\r\n```\r\n2021-08-25 02:42:46,495 INFO sqlalchemy.engine.Engine BEGIN (implicit)\r\n2021-08-25 02:42:46,495 INFO sqlalchemy.engine.Engine PRAGMA main.table_info(\"hero\")\r\n2021-08-25 02:42:46,495 INFO sqlalchemy.engine.Engine [raw sql] ()\r\n2021-08-25 02:42:46,496 INFO sqlalchemy.engine.Engine PRAGMA temp.table_info(\"hero\")\r\n2021-08-25 02:42:46,496 INFO sqlalchemy.engine.Engine [raw sql] ()\r\n2021-08-25 02:42:46,497 INFO sqlalchemy.engine.Engine ROLLBACK\r\nTraceback (most recent call last):\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/compiler.py\", line 4031, in visit_create_table\r\n processed = self.process(\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/compiler.py\", line 490, in process\r\n return obj._compiler_dispatch(self, **kwargs)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/visitors.py\", line 81, in _compiler_dispatch\r\n return meth(self, **kw)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/compiler.py\", line 4065, in visit_create_column\r\n text = self.get_column_specification(column, first_pk=first_pk)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/dialects/sqlite/base.py\", line 1424, in get_column_specification\r\n coltype = self.dialect.type_compiler.process(\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/compiler.py\", line 522, in process\r\n return type_._compiler_dispatch(self, **kw)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/visitors.py\", line 81, in _compiler_dispatch\r\n return meth(self, **kw)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/compiler.py\", line 4612, in visit_null\r\n raise exc.CompileError(\r\nsqlalchemy.exc.CompileError: Can't generate DDL for NullType(); did you forget to specify a type on this Column?\r\n\r\nThe above exception was the direct cause of the following exception:\r\n\r\nTraceback (most recent call last):\r\n File \"main.py\", line 21, in \u003cmodule>\r\n SQLModel.metadata.create_all(engine)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/schema.py\", line 4739, in create_all\r\n bind._run_ddl_visitor(\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/future/engine.py\", line 342, in _run_ddl_visitor\r\n conn._run_ddl_visitor(visitorcallable, element, **kwargs)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/engine/base.py\", line 2081, in _run_ddl_visitor\r\n visitorcallable(self.dialect, self, **kwargs).traverse_single(element)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/visitors.py\", line 485, in traverse_single\r\n return meth(obj, **kw)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/ddl.py\", line 846, in visit_metadata\r\n self.traverse_single(\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/visitors.py\", line 485, in traverse_single\r\n return meth(obj, **kw)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/ddl.py\", line 890, in visit_table\r\n self.connection.execute(\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/future/engine.py\", line 280, in execute\r\n return self._execute_20(\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/engine/base.py\", line 1582, in _execute_20\r\n return meth(self, args_10style, kwargs_10style, execution_options)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/ddl.py\", line 77, in _execute_on_connection\r\n return connection._execute_ddl(\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/engine/base.py\", line 1349, in _execute_ddl\r\n compiled = ddl.compile(\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/elements.py\", line 517, in compile\r\n return self._compiler(dialect, **kw)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/ddl.py\", line 29, in _compiler\r\n return dialect.ddl_compiler(dialect, self, **kw)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/compiler.py\", line 455, in __init__\r\n self.string = self.process(self.statement, **compile_kwargs)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/compiler.py\", line 490, in process\r\n return obj._compiler_dispatch(self, **kwargs)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/visitors.py\", line 81, in _compiler_dispatch\r\n return meth(self, **kw)\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/sql/compiler.py\", line 4041, in visit_create_table\r\n util.raise_(\r\n File \"/opt/virtualenvs/python3/lib/python3.8/site-packages/sqlalchemy/util/compat.py\", line 207, in raise_\r\n raise exception\r\nsqlalchemy.exc.CompileError: (in table 'hero', column 'my_new_attribute'): Can't generate DDL for NullType(); did you forget to specify a type on this Column?\r\n\r\n```","author":{"url":"https://github.com/jedieaston","@type":"Person","name":"jedieaston"},"datePublished":"2021-08-25T02:43:49Z","url":"https://github.com/fastapi/sqlmodel/issues/7"}
| 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:fe855f6d-c23d-8c9a-ee3a-a37723a97366 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8930:3E5952:13C812:1C0859:6AFE1671 |
| html-safe-nonce | c5c8de75e141d0c4a59c758b0884ee3367ec212c24efeae58e0dca064a66b846 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4OTMwOjNFNTk1MjoxM0M4MTI6MUMwODU5OjZBRkUxNjcxIiwidmlzaXRvcl9pZCI6Ijc4NzQzOTE5Mzg0NzQ4NDE3MTMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | a4230e555ae871a30cf8f5f0b7ce1e7064cd4c494b05ffb28141ce5beb6b0395 |
| hovercard-subject-tag | issue:978648585 |
| 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/7/issue_layout |
| twitter:image | https://opengraph.githubassets.com/108267e58ddcdbea4f9290693930847886760a074a27b54eb79cb1ad62477233/fastapi/sqlmodel/issues/7 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/108267e58ddcdbea4f9290693930847886760a074a27b54eb79cb1ad62477233/fastapi/sqlmodel/issues/7 |
| 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 | jedieaston |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3cd8a1d79ccbf9aecac62781f79072482a49047fb982b8c9e2ad4aca8bf6a9af |
| 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 | 05539640a34afe6142a519483d78ddd766a1304a |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width