Tortoise ORM 0.21.7 Documentation

Reference

Reference¶

Set up
- Init app
- The Importance of cleaning up
- Reference
Databases
- DB_URL
- Capabilities
  - tortoise.backends.base.client.Capabilities
    - Parameters
- SQLite
  - Required Parameters
  - Optional parameters:
- PostgreSQL
  - Required Parameters
  - Optional parameters:
- MySQL/MariaDB
  - Required Parameters
  - Optional parameters:
- MSSQL/Oracle
  - Required Parameters
  - Optional parameters:
- Encoding in Oracle:
- Passing in custom SSL Certificates
- Base DB client
  - tortoise.backends.base.client.BaseDBAsyncClient
Models
- Usage
- Improving relational type hinting
- Reference
  - tortoise.models.Model
    - Meta
    - all
    - annotate
    - bulk_create
    - bulk_update
    - clone
    - create
    - delete
    - describe
    - exclude
    - exists
    - fetch_for_list
    - fetch_related
    - filter
    - first
    - get
    - get_or_create
    - get_or_none
    - in_bulk
    - pk
    - raw
    - refresh_from_db
    - register_listener
    - save
    - select_for_update
    - update_from_dict
    - update_or_create
Fields
- Usage
- Reference
- Extending A Field
Indexes
- Usage
- Extending Index
Timezone
- Introduction
  - use_tz
  - timezone
- Reference
Schema Creation
- Parameters
- Raises
- Return type
- Helper Functions
  - tortoise.utils.generate_schema_for_client
    - Parameters
    - Return type
  - tortoise.utils.get_schema_sql
    - Parameters
    - Return type
Query API
- QuerySet
- Foreign Key
- One to One
  - tortoise.fields.relational.OneToOneNullableRelation
  - tortoise.fields.relational.OneToOneRelation
- Many to Many
  - tortoise.fields.relational.ManyToManyRelation
    - add
    - all
    - clear
    - filter
    - limit
    - offset
    - order_by
    - remove
- Filtering
- Complex prefetch
  - tortoise.query_utils.Prefetch
    - Parameters
    - resolve_for_queryset
Manager
- Usage
Functions & Aggregates
- Functions
- Aggregates
- Base function class
  - tortoise.functions.Function
  - tortoise.functions.Aggregate
    - Parameters
- Custom functions
Expressions
- Q Expression
  - tortoise.expressions.Q
    - Parameters
    - AND
    - OR
    - __and__
    - __invert__
    - __or__
    - children
    - filters
    - join_type
    - negate
    - resolve
- F Expression
- Subquery
- RawSQL
- Case-When Expression
  - tortoise.expressions.When
    - Parameters
  - tortoise.expressions.Case
    - Parameters
Transactions
- tortoise.transactions.atomic
  - Parameters
    - connection_name
  - Return type
- tortoise.transactions.in_transaction
  - Parameters
    - connection_name
  - Return type
Connections
- API Reference
  - tortoise.connection.ConnectionHandler
    - all
    - close_all
    - db_config
    - discard
    - get
    - reset
    - set
Exceptions
- tortoise.exceptions.BaseORMException
- tortoise.exceptions.ConfigurationError
- tortoise.exceptions.DBConnectionError
- tortoise.exceptions.DoesNotExist
  - TEMPLATE
- tortoise.exceptions.FieldError
- tortoise.exceptions.IncompleteInstanceError
- tortoise.exceptions.IntegrityError
- tortoise.exceptions.MultipleObjectsReturned
  - TEMPLATE
- tortoise.exceptions.NoValuesFetched
- tortoise.exceptions.NotExistOrMultiple
  - TEMPLATE
- tortoise.exceptions.ObjectDoesNotExistError
- tortoise.exceptions.OperationalError
- tortoise.exceptions.ParamsError
- tortoise.exceptions.TransactionManagementError
- tortoise.exceptions.UnSupportedError
- tortoise.exceptions.ValidationError
Signals
- tortoise.signals.Signals
- tortoise.signals.post_delete
  - Parameters
    - senders
  - Return type
- tortoise.signals.post_save
  - Parameters
    - senders
  - Return type
- tortoise.signals.pre_delete
  - Parameters
    - senders
  - Return type
- tortoise.signals.pre_save
  - Parameters
    - senders
  - Return type
Migration
- Quick Start
- Usage
Validators
- Usage
- Built-in Validators
- Custom Validator
Logging
Router
- Usage
  - Define Router
  - Config Router
TortoiseCLI
- Quick Start
- Usage
- Interactive shell