1.0 Release updates (tortoise#2087)

* 1.0 Release updates

* Remove obsolete funding

* Update readme

Author: abondar

.github/FUNDING.yml

@@ -7,53 +7,61 @@ Changelog
 
 .. rst-class:: emphasize-children
 
-0.26
-====
+1.0
+===
 
-0.26.0 (unreleased)
--------------------
+1.0.0
+-----
 
 .. warning::
 
-    This release contains **breaking changes** as part of the context-first architecture migration.
+    This is a **major release** with breaking changes.
     Please read the :ref:`migration_guide` before upgrading.
 
 Breaking Changes
 ^^^^^^^^^^^^^^^^
+- **Minimum Python version raised to 3.10** (was 3.9). (#2062)
 - **``use_tz`` now defaults to ``True``** (was ``False``). Set ``use_tz=False`` explicitly if you need naive datetimes.
-- **Context-first architecture**: All ORM state now lives in ``TortoiseContext`` instances
-- **Removed** legacy test classes: ``test.TestCase``, ``test.IsolatedTestCase``, ``test.TruncationTestCase``, ``test.SimpleTestCase``
-- **Removed** legacy test helpers: ``initializer()``, ``finalizer()``, ``env_initializer()``, ``getDBConfig()``
-- **Changed** ``Tortoise.init()`` now returns ``TortoiseContext`` (previously returned ``None``)
-- **Changed** Multiple separate ``asyncio.run()`` calls in sequence require explicit context management due to ContextVar scoping (uncommon pattern, see migration guide). The typical single ``asyncio.run(main())`` pattern continues to work unchanged.
+- **Context-first architecture**: All ORM state now lives in ``TortoiseContext`` instances. ``Tortoise.init()`` returns a ``TortoiseContext`` (previously returned ``None``). Multiple separate ``asyncio.run()`` calls require explicit context management; the typical single ``asyncio.run(main())`` pattern works unchanged.
+- **Removed legacy test infrastructure**: ``test.TestCase``, ``test.IsolatedTestCase``, ``test.TruncationTestCase``, ``test.SimpleTestCase``, ``initializer()``, ``finalizer()``, ``env_initializer()``, ``getDBConfig()``. Use ``tortoise_test_context()`` with pytest instead.
+- **Removed ``pytz`` dependency**: Timezone handling now uses the standard library ``zoneinfo`` module. Tortoise APIs return ``ZoneInfo`` objects instead of ``pytz`` timezones. (#2023)
+- **``DatetimeField``/``TimeField`` with ``auto_now=True``** no longer implicitly sets ``auto_now_add=True``. In practice ``auto_now=True`` alone still sets the value on every save (including creation), so this is unlikely to affect most users. The internal flag coupling was removed for correctness.
+- **Shell extras required**: Interactive shell dependencies are now optional. Install with ``pip install tortoise-orm[ipython]`` or ``pip install tortoise-orm[ptpython]``.
 
 Added
 ^^^^^
-- ``TortoiseContext`` - explicit context manager for ORM state
-- ``tortoise_test_context()`` - modern pytest fixture helper for test isolation
-- ``get_connection(alias)`` - function to get connection by alias from current context
-- ``get_connections()`` - function to get the ConnectionHandler from current context
-- ``Tortoise.close_connections()`` - class method to close all connections
-- ``Tortoise.is_inited()`` - explicit method version of ``Tortoise._inited`` property
+- **Native migrations framework** with CLI commands: ``tortoise makemigrations``, ``tortoise migrate``, ``tortoise sqlmigrate``. Supports ``RunPython``, ``RunSQL``, reversible migrations, and multi-app projects. (#2061)
+- **Database schema support** for PostgreSQL and MSSQL (on MySQL maps to database name) — tables can live in non-default schemas (e.g., ``warehouse.inventory``), with cross-schema relations and migration support. (#2084)
+- **PostgreSQL full-text search**: ``TSVectorField``, ``SearchVector``, ``SearchQuery``, ``SearchRank``, ``SearchHeadline`` expressions, and GIN/GiST index support. (#2065)
+- **Query API** (``tortoise.query_api``) for building and executing custom pypika queries against models, with ``Model.get_table()`` classmethod. (#2064)
+- ``TortoiseContext`` — explicit context manager for ORM state with full isolation. (#2069)
+- ``tortoise_test_context()`` — modern pytest fixture helper for test isolation. (#2069)
+- ``get_connection(alias)`` / ``get_connections()`` — functions to access connections from current context.
+- ``Tortoise.close_connections()`` — restored (was deprecated in 0.19) as the canonical way to close connections, now context-aware.
+- ``Tortoise.is_inited()`` — explicit method version of ``Tortoise._inited`` property.
+- ``ForeignKeyField`` and ``ManyToManyField`` now accept a model class directly, not just string references. (#2027)
+- ``DateField`` now supports ``__year`` / ``__month`` / ``__day`` filters. (#2067)
 
 Changed
 ^^^^^^^
-- Framework integrations (FastAPI, Starlette, Sanic, etc.) now use ``Tortoise.close_connections()`` internally
-- ``ConnectionHandler`` now uses instance-based ContextVar storage (each context has isolated connections)
-- ``Tortoise.apps`` and ``Tortoise._inited`` now use ``classproperty`` descriptor (no metaclass)
-- **Shell command now uses optional dependencies**: Install with ``pip install tortoise-orm[ipython]`` (recommended) or ``pip install tortoise-orm[ptpython]`` to enable. IPython is preferred over ptpython. Both shells are supported.
-- **DatetimeField and TimeField behavior change**: Fields with ``auto_now=True`` no longer incorrectly set ``auto_now_add=True`` internally.
-- feat: foreignkey to model type (#2027)
-- refactor: remove `pytz` and use standard library `zoneinfo` (#2023)
+- Framework integrations (FastAPI, Starlette, Sanic, etc.) now use ``Tortoise.close_connections()`` internally.
+- ``ConnectionHandler`` uses per-instance ContextVar storage for context isolation.
+- ``Tortoise.apps`` and ``Tortoise._inited`` are now ``classproperty`` descriptors.
+- Performance optimizations for model hydration, object construction, and query building. (#2078)
+- Pydantic model creator internals cleaned up: removed legacy validator, improved computed field handling. (#2079)
 
 Deprecated
 ^^^^^^^^^^
-- ``from tortoise import connections`` - use ``get_connection()`` / ``get_connections()`` functions instead (still works but deprecated)
+- ``from tortoise import connections`` — use ``get_connection()`` / ``get_connections()`` instead (still works but deprecated).
 
 Fixed
 ^^^^^
-- ``use_tz=False`` now correctly preserves naive datetimes instead of silently making them timezone-aware (#631)
-- Fix annotations being selected in ValuesListQuery despite not specified in `.values_list` fields list (#2059)
+- ``use_tz=False`` now correctly preserves naive datetimes instead of silently making them timezone-aware. (#631)
+- Annotations incorrectly selected in ``ValuesListQuery`` when not specified in ``.values_list()`` fields. (#2059)
+- M2M filtering broken when two relations point to the same target model. (#2083)
+- Pydantic incorrectly marking fields with default values as ``Optional``. (#2082)
+- ``Model.in_bulk`` type annotation now supports any primary key type. (#2075)
+- Migration bug fixes: field serialization, operation ordering, and ``sqlmigrate`` command added. (#2076)
 
 0.25
 ====

CHANGELOG.rst

@@ -20,18 +20,14 @@ Tortoise ORM is an easy-to-use ``asyncio`` ORM *(Object Relational Mapper)* insp
 
 You can find the docs at `Documentation <https://tortoise.github.io>`_
 
-.. note::
-   Tortoise ORM is a young project and breaking changes are to be expected.
-   We keep a `Changelog <https://tortoise.github.io/CHANGELOG.html>`_ and it will have possible breakage clearly documented.
-
 Tortoise ORM supports CPython 3.10 and later for SQLite, MySQL, PostgreSQL, Microsoft SQL Server, and Oracle.
 
 Why was Tortoise ORM built?
 ---------------------------
 
 Tortoise ORM was built to provide a lightweight, async-native Object-Relational Mapper for Python with a familiar Django-like API.
 
-Tortoise ORM performs well when compared to other Python ORMs. In `our benchmarks <https://github.com/tortoise/orm-benchmarks>`_, where we measure different read and write operations (rows/sec, more is better), it's trading places with Pony ORM:
+Tortoise ORM performs well when compared to other Python ORMs. Here are `our benchmarks <https://github.com/tortoise/orm-benchmarks>`_ on PostgreSQL 17, where we measure different read and write operations (rows/sec, more is better):
 
 .. image:: https://raw.githubusercontent.com/tortoise/tortoise-orm/develop/docs/ORM_Perf.png
     :target: https://github.com/tortoise/orm-benchmarks
@@ -191,9 +187,21 @@ Learn more at the `documentation site <https://tortoise.github.io>`_
 Migrations
 ==========
 
-Tortoise ORM ships with built-in migrations and a CLI. See the
-`migrations documentation <https://tortoise.github.io/migration.html>`_ for
-setup, commands, and examples.
+Tortoise ORM ships with a built-in migration framework and CLI.
+Autodetect model changes, generate migration files, and apply them:
+
+.. code-block:: shell
+
+    tortoise init                # create migration packages
+    tortoise makemigrations      # detect changes and generate migrations
+    tortoise migrate             # apply pending migrations
+    tortoise sqlmigrate app 001  # preview SQL without executing
+
+Migrations support ``RunPython`` and ``RunSQL`` for data migrations, offline migration generation,
+reversible operations, and multi-app and multi db-schema projects.
+
+See the `migrations documentation <https://tortoise.github.io/migration.html>`_ for
+full setup and examples.
 
 Contributing
 ============

README.rst

@@ -104,6 +104,16 @@ List migration heads on disk.
     tortoise heads
     tortoise heads users
 
+sqlmigrate
+----------
+
+Print the SQL statements for a specific migration without executing them.
+
+.. code-block:: shell
+
+    tortoise sqlmigrate users 0001_initial
+    tortoise sqlmigrate users 0001_initial --backward
+
 shell
 -----
 

docs/ORM_Perf.png

@@ -42,9 +42,9 @@ If your application has multiple database connections configured, you must pass
 
 .. code-block:: python3
 
-   from tortoise.connection import connections
+   from tortoise.connection import get_connection
 
-   db = connections.get("analytics")
+   db = get_connection("analytics")
    result = await execute_pypika(query, using_db=db)
 
 Rows Affected Semantics

docs/cli.rst

@@ -6,6 +6,11 @@ Getting started
 
 Installation
 ===============
+
+.. note::
+
+    Tortoise ORM requires **Python 3.10** or later.
+
 The following table shows the available installation options for different databases (note that there are multiple options of clients for some databases):
 
 .. list-table:: Available Installation Options

docs/direct_queries.rst

@@ -112,6 +112,16 @@ List migration heads on disk.
 
     tortoise heads
 
+sqlmigrate
+----------
+
+Print the SQL for a migration without executing it.
+
+.. code-block:: shell
+
+    tortoise sqlmigrate models 0001_initial
+    tortoise sqlmigrate models 0001_initial --backward
+
 Migration files
 ===============
 

docs/getting_started.rst

@@ -257,7 +257,7 @@ The ``Meta`` class
 In event model we got some more fields, that could be interesting for us.
 
 ``fields.ForeignKeyField('models.Tournament', related_name='events')``
-    Here we create foreign key reference to tournament. We create it by referring to model by it's literal, consisting of app name and model name. ``models`` is default app name, but you can change it in ``class Meta`` with ``app = 'other'``.
+    Here we create foreign key reference to tournament. You can refer to the model either by string literal (``"app_name.ModelName"``) or by passing the model class directly (e.g. ``fields.ForeignKeyField(Tournament)``). String references are required for forward references where the target model is not yet defined. ``models`` is default app name, but you can change it in ``class Meta`` with ``app = 'other'``.
 ``related_name``
     Is keyword argument, that defines field for related query on referenced models, so with that you could fetch all tournaments's events with like this:
 

docs/migration.rst

@@ -12,6 +12,30 @@ Here we create connection to SQLite database client and then we discover & initi
 ``generate_schema`` generates schema on empty database.
 There is also the default option when generating the schemas to set the ``safe`` parameter to ``True`` which will only insert the tables if they don't already exist.
 
+Non-default Database Schemas
+============================
+
+Tortoise ORM supports placing tables in non-default database schemas on PostgreSQL and MSSQL
+(on MySQL, ``schema`` maps to a separate database name via `` `db`.`table` `` syntax).
+Set the ``schema`` attribute in a model's ``Meta`` class:
+
+.. code-block:: python3
+
+    class Product(Model):
+        name = fields.CharField(max_length=200)
+
+        class Meta:
+            schema = "catalog"
+
+    class Inventory(Model):
+        product = fields.ForeignKeyField("models.Product")
+        quantity = fields.IntField()
+
+        class Meta:
+            schema = "warehouse"
+
+Cross-schema foreign keys work automatically. The migration framework also handles schema-qualified
+tables, including schema creation when needed.
 
 Helper Functions
 ================