Skip to content

v0.12.0

Choose a tag to compare

@grigi grigi released this 11 Jun 10:59

Tortoise ORM now supports non-autonumber primary keys.

This is a big feature change. It should not break any existing implementations.

We currently support single (non-composite) primary keys of any indexable field type, but only these field types are recommended:

  • IntField
  • BigIntField
  • CharField
  • UUIDField

The primary key will be accessible through a reserved field pk which will be an alias of whichever field has been nominated as a primary key.
The alias field can be used as a field name when doing filtering e.g. .filter(pk=...) etc...

One must define a primary key by setting a pk parameter to True.
If you don't define a primary key, we will create a primary key of type IntField with name of id for you.