Custom Primary Key (id) on rx.Model after upgrading to > 0.9.0

[kamilhepner]

Hi everyone,

I was reviewing the changelog for version 0.9.0 and noticed that the id field is no longer silently dropped when defining a custom primary key. https://github.com/reflex-dev/reflex/releases/tag/v0.9.0

rx.Model default primary key override: defining your own primary key no longer silently drops the built-in id field. If you need custom PKs on a registered SQLModel class, register it via @rx.ModelRegistry.register and declare the table explicitly.

If I understand this correctly, would the following code no longer work as expected?

class Subscription(rx.Model, table=True):

    __table_args__ = (UniqueConstraint("name"),)
    sub_id: int | None = Field(default=None, primary_key=True)
    name: str
    price: float | None
    discount: float | None
    description: str
    info: str
    max_projects: int | None
    max_testers: int | None
    max_storage_gb: float | None

If that’s the case, could someone share an example of how to properly define a custom primary key using the new approach?

Also, out of curiosity to learn: what was the reasoning behind this change? Previously, if a user defines a custom primary key, he assumes that field would be removed automatically, It seems intuitive to drop the id field when a custom primary key is defined. Is that assumption incorrect?

Thanks in advance for the help!