|
3 | 3 | 1.x Changelog |
4 | 4 | ============= |
5 | 5 |
|
| 6 | +.. changelog:: 1.11.0 |
| 7 | + :date: 2026-05-30 |
| 8 | + |
| 9 | + .. change:: add configurable schema dump settings |
| 10 | + :type: feature |
| 11 | + :pr: 750 |
| 12 | + |
| 13 | + Adds ``SchemaDumpConfig`` for service input conversion, allowing schema |
| 14 | + dumping behavior to be configured once on a service or overridden for a |
| 15 | + single write operation. Pydantic, msgspec, attrs, and dataclass inputs |
| 16 | + now flow through the shared ``schema_dump()`` utility, with options for |
| 17 | + excluding unset values, ``None`` values, defaults, and sentinel values |
| 18 | + while preserving the existing partial-update defaults. |
| 19 | + |
| 20 | + .. change:: deprecate DictProtocol |
| 21 | + :type: misc |
| 22 | + :issue: 583 |
| 23 | + |
| 24 | + Deprecates ``advanced_alchemy.typing.DictProtocol`` and schedules it |
| 25 | + for removal in 2.0. Runtime code should rely on ``has_dict_attribute()`` |
| 26 | + or direct ``__dict__`` duck typing instead of Protocol-based instance |
| 27 | + checks. |
| 28 | + |
| 29 | + .. change:: add choices and boolean filters |
| 30 | + :type: feature |
| 31 | + :pr: 723 |
| 32 | + :issue: 72 |
| 33 | + |
| 34 | + Adds ``ChoicesFilter`` for matching fields against a collection of |
| 35 | + allowed values and ``BooleanFilter`` for optional boolean query |
| 36 | + parameters. Both filters are exported through the public filter API and |
| 37 | + included in ``FilterMap`` for framework integration. |
| 38 | + |
| 39 | + .. change:: add dialect-aware vector columns |
| 40 | + :type: feature |
| 41 | + :pr: 739 |
| 42 | + |
| 43 | + Adds ``Vector`` as a portable column type that selects the native vector |
| 44 | + implementation for Oracle 23ai and PostgreSQL/CockroachDB when |
| 45 | + available, and falls back to JSON storage elsewhere. Returned vector |
| 46 | + values are normalized to ``list[float]`` so callers can use one API |
| 47 | + across supported dialects. |
| 48 | + |
| 49 | + .. change:: add vector distance operators for similarity search |
| 50 | + :type: feature |
| 51 | + :pr: 756 |
| 52 | + |
| 53 | + Adds ``cosine_distance``, ``l2_distance``, ``l1_distance``, and |
| 54 | + ``max_inner_product`` comparator methods to the ``Vector`` type so a |
| 55 | + vector column can be ordered by similarity directly. Each compiles to |
| 56 | + native SQL per dialect — pgvector operators on PostgreSQL/CockroachDB |
| 57 | + and ``VECTOR_DISTANCE`` on Oracle 23ai — and raises a clear |
| 58 | + ``NotImplementedError`` on JSON-fallback dialects. |
| 59 | + |
| 60 | + .. change:: use native Oracle JSON when available |
| 61 | + :type: feature |
| 62 | + :pr: 741 |
| 63 | + |
| 64 | + Updates ``ORA_JSONB`` to prefer SQLAlchemy's native Oracle JSON type on |
| 65 | + Oracle 21c and newer when running with SQLAlchemy 2.1 or newer, while |
| 66 | + keeping the existing BLOB plus ``IS JSON`` check-constraint fallback for |
| 67 | + older SQLAlchemy or Oracle versions. ``JsonB`` is also exposed in the |
| 68 | + Alembic migration templates. |
| 69 | + |
| 70 | + .. change:: add Oracle 23c-aware boolean columns |
| 71 | + :type: feature |
| 72 | + :pr: 742 |
| 73 | + |
| 74 | + Adds ``Bool`` as a dialect-aware boolean type that uses native Oracle |
| 75 | + ``BOOLEAN`` support on Oracle 23c with SQLAlchemy 2.1 or newer, and |
| 76 | + keeps the existing SQLAlchemy boolean behavior everywhere else. The new |
| 77 | + type is exported from ``advanced_alchemy.types`` and added to the |
| 78 | + Alembic migration templates. |
| 79 | + |
| 80 | + .. change:: update Litestar parameter declarations |
| 81 | + :type: feature |
| 82 | + :pr: 746 |
| 83 | + |
| 84 | + Updates Litestar integration code to use the newer parameter marker |
| 85 | + declarations introduced by recent Litestar releases, replacing |
| 86 | + deprecated parameter specification patterns. |
| 87 | + |
| 88 | + .. change:: support Typer 0.26 in the FastAPI CLI integration |
| 89 | + :type: bugfix |
| 90 | + :pr: 748 |
| 91 | + |
| 92 | + Adapts FastAPI CLI registration for Typer 0.26 and newer, where Typer |
| 93 | + no longer accepts external Click command groups directly. The FastAPI |
| 94 | + extension now bridges the existing Click migration command group through |
| 95 | + Typer while preserving both ``database`` and ``db`` command names. |
| 96 | + |
| 97 | + .. change:: correct Litestar server-side session backend docs |
| 98 | + :type: bugfix |
| 99 | + :pr: 749 |
| 100 | + :issue: 707 745 |
| 101 | + |
| 102 | + Corrects the Litestar server-side session guide to show both supported |
| 103 | + database-backed wiring styles: registering ``SQLAlchemyStore`` under the |
| 104 | + session store name, or wiring ``SessionMiddleware`` with an explicit |
| 105 | + ``SQLAlchemyAsyncSessionBackend``. The examples are now executable docs |
| 106 | + coverage so the documented session rows are verified against the |
| 107 | + database. |
| 108 | + |
| 109 | + .. change:: index repository classes in intersphinx inventories |
| 110 | + :type: bugfix |
| 111 | + :pr: 751 |
| 112 | + :issue: 729 |
| 113 | + |
| 114 | + Fixes the repository reference page so repository classes are included |
| 115 | + in the generated ``objects.inv`` inventory for downstream Sphinx |
| 116 | + projects. The memory repository classes are now documented as well, and |
| 117 | + malformed deprecation directives in memory repository docstrings were |
| 118 | + corrected for warning-free docs builds. |
| 119 | + |
| 120 | + .. change:: extract provider dependency utilities |
| 121 | + :type: misc |
| 122 | + :pr: 721 |
| 123 | + :issue: 602 |
| 124 | + |
| 125 | + Moves shared framework dependency helpers into |
| 126 | + ``advanced_alchemy.utils.dependencies``. Litestar and FastAPI provider |
| 127 | + generation now share the same primitives while preserving framework |
| 128 | + specific dependency caches and normalizing multi-field sort defaults |
| 129 | + before building ``OrderBy`` filters. |
| 130 | + |
| 131 | + .. change:: document GUID storage and UUIDv7 usage |
| 132 | + :type: misc |
| 133 | + :pr: 743 |
| 134 | + |
| 135 | + Expands the GUID documentation with Oracle storage details and guidance |
| 136 | + for using UUIDv7 primary keys where time-ordered identifiers improve |
| 137 | + index locality. |
| 138 | + |
| 139 | + .. change:: document custom non-autogenerated primary keys |
| 140 | + :type: misc |
| 141 | + :pr: 754 |
| 142 | + :issue: 649 |
| 143 | + |
| 144 | + Documents how to compose ``DefaultBase`` with ``AuditColumns`` when a |
| 145 | + model needs caller-supplied primary keys instead of autogenerated |
| 146 | + identifiers, including string and integer primary-key examples. |
| 147 | + |
| 148 | + .. change:: document mixin column ordering |
| 149 | + :type: misc |
| 150 | + :pr: 753 |
| 151 | + :issue: 584 |
| 152 | + |
| 153 | + Adds documentation for the ``sort_order`` values used by Advanced |
| 154 | + Alchemy mixins so users can understand the physical column order |
| 155 | + produced for newly-created tables. |
| 156 | + |
| 157 | + |
6 | 158 | .. changelog:: 1.10.0 |
7 | 159 | :date: 2026-05-23 |
8 | 160 |
|
|
0 commit comments