Table Of Contents¶
- Tortoise ORM
- Getting started
- Reference
- Set up
- Databases
- Models
- Usage
- Improving relational type hinting
- Reference
- tortoise.models.Model
- Meta
- all
- annotate
- bulk_create
- bulk_update
- clone
- construct
- create
- delete
- describe
- earliest
- exclude
- exists
- fetch_for_list
- fetch_related
- filter
- first
- get
- get_or_create
- get_or_none
- get_table
- in_bulk
- last
- latest
- pk
- raw
- refresh_from_db
- register_listener
- save
- select_for_update
- update_from_dict
- update_or_create
- tortoise.models.Model
- Fields
- Usage
- Reference
- Base Field
- Data Fields
- tortoise.fields.data.BigIntField
- tortoise.fields.data.BinaryField
- tortoise.fields.data.BooleanField
- tortoise.fields.data.CharEnumField
- tortoise.fields.data.CharField
- tortoise.fields.data.DateField
- tortoise.fields.data.DatetimeField
- tortoise.fields.data.DecimalField
- tortoise.fields.data.FloatField
- tortoise.fields.data.IntEnumField
- tortoise.fields.data.IntField
- tortoise.fields.data.JSONField
- tortoise.fields.data.SmallIntField
- tortoise.fields.data.TextField
- tortoise.fields.data.TimeDeltaField
- tortoise.fields.data.TimeField
- tortoise.fields.data.UUIDField
- Relational Fields
- DB Default Expressions
- DB Specific Fields
- Extending A Field
- Indexes
- Timezone
- Introduction
- Reference
- tortoise.timezone.ZoneInfo
- tortoise.timezone.get_default_timezone
- tortoise.timezone.get_timezone
- tortoise.timezone.get_use_tz
- tortoise.timezone.is_aware
- tortoise.timezone.is_naive
- tortoise.timezone.localtime
- tortoise.timezone.make_aware
- tortoise.timezone.make_naive
- tortoise.timezone.now
- tortoise.timezone.parse_timezone
- Schema Creation
- Query API
- QuerySet
- tortoise.queryset.QuerySetSingle
- tortoise.queryset.QuerySet
- __getitem__
- all
- annotate
- bulk_create
- bulk_update
- count
- delete
- distinct
- earliest
- exclude
- exists
- explain
- filter
- first
- force_index
- get
- get_or_none
- group_by
- in_bulk
- last
- latest
- limit
- offset
- only
- order_by
- prefetch_related
- raw
- resolve_filters
- resolve_ordering
- select_for_update
- select_related
- sql
- update
- use_index
- using_db
- values
- values_list
- tortoise.queryset.BulkCreateQuery
- tortoise.queryset.BulkUpdateQuery
- tortoise.queryset.CountQuery
- tortoise.queryset.DeleteQuery
- tortoise.queryset.ExistsQuery
- tortoise.queryset.FieldSelectQuery
- tortoise.queryset.RawSQLQuery
- tortoise.queryset.UpdateQuery
- tortoise.queryset.ValuesListQuery
- tortoise.queryset.ValuesQuery
- Foreign Key
- One to One
- Many to Many
- Filtering
- Complex prefetch
- QuerySet
- Direct PyPika Queries
- Manager
- Functions & Aggregates
- Expressions
- Transactions
- Connections
- Exceptions
- tortoise.exceptions.BaseORMException
- tortoise.exceptions.ConfigurationError
- tortoise.exceptions.DBConnectionError
- tortoise.exceptions.DoesNotExist
- tortoise.exceptions.FieldError
- tortoise.exceptions.IncompleteInstanceError
- tortoise.exceptions.IntegrityError
- tortoise.exceptions.MultipleObjectsReturned
- tortoise.exceptions.NoValuesFetched
- tortoise.exceptions.NotExistOrMultiple
- tortoise.exceptions.ObjectDoesNotExistError
- tortoise.exceptions.OperationalError
- tortoise.exceptions.ParamsError
- tortoise.exceptions.TransactionManagementError
- tortoise.exceptions.UnSupportedError
- tortoise.exceptions.ValidationError
- Signals
- Migrations
- Validators
- Usage
- Built-in Validators
- tortoise.validators.CommaSeparatedIntegerListValidator
- tortoise.validators.MaxLengthValidator
- tortoise.validators.MaxValueValidator
- tortoise.validators.MinLengthValidator
- tortoise.validators.MinValueValidator
- tortoise.validators.NumericValidator
- tortoise.validators.RegexValidator
- tortoise.validators.Validator
- tortoise.validators.validate_ipv46_address
- tortoise.validators.validate_ipv4_address
- tortoise.validators.validate_ipv6_address
- Custom Validator
- Logging
- Router
- Tortoise CLI
- Examples
- Contrib
- Linters
- Pydantic serialisation
- Testing Support
- Tortoise-ORM FastAPI integration
- Tortoise-ORM Quart integration
- Tortoise-ORM Sanic integration
- Tortoise-ORM Starlette integration
- Tortoise-ORM aiohttp integration
- MySQL
- Postgres
- Tortoise-ORM BlackSheep integration
- Migration Guide: Tortoise 1.0
- Changelog
- 1.1
- 1.0
- 0.25
- 0.24
- 0.22
- 0.21
- 0.20
- 0.19
- 0.17
- 0.16
- 0.15
- 0.14
- 0.13
- 0.12
- 0.11
- 0.10
- 0.9 & older
- Roadmap
- Contribution Guide
- Thanks