Documentation: Improve page about migrating to sqlalchemy-cratedb
#179
Conversation
amotl
added
documentation
docs/migrate-from-crate-client.md
Outdated
| `crate.client.sqlalchemy`, you will need to import the same symbols from | ||
| `sqlalchemy_cratedb` from now on. | ||
| a drop-in replacement with no noticeable changes. In November 2024, | ||
| `crate-1.0.0` has been released, which dropped including the SQLAlchemy |
There was a problem hiding this comment.
which dropped including
Not super clear, maybe could be rephrased?
There was a problem hiding this comment.
Sure, thanks. @kneth: Coming up with improvement proposals right away will tremendously help.
There was a problem hiding this comment.
Maybe something like
With the release of
crate-1.0.0in November 2024, the support of the SQLAlchemy dialect was dropped. See the "Upgrade procedure" section for further information.
There was a problem hiding this comment.
Thank you very much. I've used your suggestion 1:1, and compressed it by a few more words.
With the release of
crate-1.0.0in November 2024, the SQLAlchemy dialect was
dropped from this package. See the "Upgrade procedure" section for further
information.
amotl
force-pushed
the
amo/improve-migration-notes
branch
from
59f6be1 to
2464550
Compare
About
The first iteration of this page has been rough. The second one intends to improve the situation.
Preview
https://sqlalchemy-cratedb--179.org.readthedocs.build/migrate-from-crate-client.html
Review
Please advise if you think matters can be conveyed better, best using concrete suggestions.