@@ -5,27 +5,25 @@ Changes for crate
55Unreleased
66==========
77
8- - The SQLAlchemy dialect has been split off into the ` sqlalchemy-cratedb `_
9- package. See ` Migrate from crate.client to sqlalchemy-cratedb `_ to learn
10- about necessary migration steps.
11- - Returned Python `` datetime `` objects are now always timezone-aware,
12- using UTC by default. This is a possible BREAKING CHANGE: Removed the use
13- of "naive" Python ``datetime `` objects, i.e. instances without `` tzinfo ``
14- attribute set.
8+ - BREAKING CHANGE: The SQLAlchemy dialect has been split off into
9+ the ` sqlalchemy-cratedb `_ package, see notice below.
10+ - Feature: Returned Python `` datetime `` objects are now always timezone-aware,
11+ using UTC by default.
12+ It may be a breaking change for some users of the library that don't expect
13+ to receive "aware" instead of "naive" Python ``datetime `` objects from now
14+ on, i.e. instances with or without the `` tzinfo `` attribute set.
1515 When no ``time_zone `` information is specified when creating a database
1616 connection or cursor, ``datetime `` objects will now use Coordinated
1717 Universal Time (UTC), like CrateDB is storing timestamp values in this
1818 format.
1919 This update is coming from a deprecation of Python's
2020 ``datetime.utcfromtimestamp() ``, which is effectively also phasing out
2121 the use of "naive" timestamp objects in Python, in favor of using
22- timezone-aware objects, also to represent datetimes in UTC. It may be a
23- breaking change for some users of the library that don't expect to
24- receive "aware" ``datetime `` objects from now on.
25- - Configured DB API interface attribute ``threadsafety = 1 ``, which signals
26- "Threads may share the module, but not connections."
27- - Added ``error_trace `` to string representation of an Error to relay
28- server stacktraces into exception messages.
22+ timezone-aware objects, also to represent datetimes in UTC.
23+ - Feature: Configured DB API interface attribute ``threadsafety = 1 ``,
24+ which signals "Threads may share the module, but not connections."
25+ - Feature: Added ``error_trace `` to string representation of an Error,
26+ to relay server stacktraces into exception messages.
2927- Refactoring: The module namespace ``crate.client.test_util `` has been
3028 renamed to ``crate.testing.util ``.
3129- Error handling: At two spots in cursor / value converter handling, where
@@ -35,6 +33,13 @@ Unreleased
3533 namespaces" for the ``crate `` namespace package, see `PEP 420 `_.
3634
3735
36+ .. note ::
37+
38+ For learning about the transition to `sqlalchemy-cratedb `_,
39+ we recommend to read the enumeration of necessary migration steps
40+ at `Migrate from crate.client to sqlalchemy-cratedb `_.
41+
42+
3843.. _Migrate from crate.client to sqlalchemy-cratedb : https://cratedb.com/docs/sqlalchemy-cratedb/migrate-from-crate-client.html
3944.. _PEP 420 : https://peps.python.org/pep-0420/
4045.. _sqlalchemy-cratedb : https://pypi.org/project/sqlalchemy-cratedb/
0 commit comments