Create a record in the DB and returns the object. .. code-block:: python3 user = await User.create(name="...", email=".

Fetches a single record for a Model type using the provided filter parameters. .. code-block:: python3 user = await Use

Generates a QuerySet with the filter applied. :param args: Q functions containing constraints. Will be AND'ed. :param kwargs

Returns the complete QuerySet.

Annotates the result set with extra Functions/Aggregations/Expressions. :param kwargs: Parameter name and the Function/Aggregation t

Make QuerySet returns list of tuples for given args instead of objects. If call after `.get()`, `.get_or_none()` or `.first()` retur

Generates a QuerySet that returns the first record.

Adds one or more of ``instances`` to the relation. If it is already added, it will be silently ignored. :raises Operational

Creates/Updates the current model object. :param update_fields: If provided, it should be a tuple/list of fields by name.

Accept args to filter by in format like this: .. code-block:: python3 .order_by('name', '-tournament__name') S

Update all objects in QuerySet with given kwargs. .. admonition: Example: .. code-block:: py3 await Em

Sets up Tortoise-ORM: loads apps and models, configures database connections but does not connect to the database yet. The actual con

Return count of objects in queryset instead of objects.

Function to build `Pydantic Model <https://docs.pydantic.dev/latest/concepts/models/>`__ off Tortoise Model. :param cls: The Tortoise Model

Returns the SQL query that will be executed. By default, it will return the query with placeholders, but if you set `params_inline=Tr

Fetch related fields. .. code-block:: python3 User.fetch_related("emails", "manager") :param args: The related

Transaction context manager. You can run your code inside ``async with in_transaction():`` statement to run it into one transaction. If

Quote an identifier for the given dialect.

Helper to reset Tortoise state before each test. Note: We MUST NOT set Tortoise.apps = None or Tortoise._inited = False because these are cla

Helper to teardown Tortoise state after each test.

Create a model instance without validation, DB checks, or FK restrictions. This creates a "detached" instance that has the right sha

Returns a field by dialect override. :param dialect: The requested SQL Dialect. :param key: The attribute/method name.

Like ``.fetch_related()`` on instance, but works on all objects in QuerySet. :raises FieldError: If the field to prefetch on is not

Execute DDL SQL. Subclasses may override for backend-specific handling. If ``collect_sql`` is True, append the SQL to ``collected_sql`` inste

Fetch ONLY the specified fields to create a partial model. Persisting changes on the model is allowed only when: * All the

Generate schemas according to models provided to ``.init()`` method. Will fail if schemas already exists, so it's not recommended to

Get the currently active TortoiseContext, or None if no context is active. Checks the contextvar first (for proper isolation), then falls ba

Generates the SQL schema for the given client. :param client: The DB client to generate Schema SQL for :param safe: When set to true, cr

Make QuerySet returns list of dict or tuple with group by. Must call before .values() or .values_list()

Describes the given list of models or ALL registered models. :param serializable: ``False`` if you want raw python objec

Bulk insert operation: .. note:: The bulk insert operation will do the minimum to ensure that the object cre

Limits QuerySet to given length. :raises ParamsError: Limit should be non-negative number.

Returns a serializable pydantic model instance built from the provided model instance. .. note:: This will prefetch all

Simple async runner that cleans up DB connections on exit. This is meant for simple scripts. Usage:: from tortoise import Torto

Converts from the Python type to the DB type. :param value: Current python value in model. :param instance: Model class or M

Helper to reset Tortoise state before each test. Note: We MUST NOT set Tortoise.apps = None or Tortoise._inited = False because these are cla

Deletes the current model object. :param using_db: Specific DB connection to use instead of default bound :raises Operation

Return True/False whether record exists with the provided filter parameters. .. code-block:: python3 result = await Use

Initialize Tortoise for SQLite and return SQL statements.

Generates a QuerySet with the filter applied that returns the first record. :params orderings: Fields to order by.

Generates a QuerySet with the filter applied that returns the last record. :params orderings: Fields to order by.

Fetches a single record for a Model type using the provided filter parameters or None. .. code-block:: python3 user = a

Removes one or more of ``instances`` from the relation. :raises OperationalError: remove() was called with no instances.

Get SQL statement containing the given text.

Build models with Meta.schema='custom' for testing.

Resolves the logical Q chain into the parts of a SQL statement. :param model: The Model this Q Expression should be resolved on.

Return a PyPika table for this model.

Async context manager for isolated test database setup. This is the recommended way to set up Tortoise ORM for testing with pytest. Each

Get the connection storage dict for the current task context.

Get the ConnectionHandler from the current context. This is a convenience function. Prefer accessing connections directly via context: `

Query offset for QuerySet. :raises ParamsError: Offset should be non-negative number.

Create a model class dynamically for migration tests.

Resolve model field names to database column names. For FK fields like 'organization', returns the DB column 'organization_id'. For r

Clears ALL relations.

Sets the given alias to the provided connection object for the current task. :param conn_alias: The alias to set the connection for.