Skip to content

docs: point cqlengine users to coodie for new projects - #1127

Open
fruch wants to merge 1 commit into
scylladb:masterfrom
fruch:docs/point-cqlengine-to-coodie
Open

fruch wants to merge 1 commit into
scylladb:masterfrom
fruch:docs/point-cqlengine-to-coodie

Conversation

@fruch

@fruch fruch commented Oct 11, 2026

Copy link
Copy Markdown

Adds a note at the top of the Object Mapper page (the landing page for all the cqlengine docs) and on the docs index: cqlengine is in maintenance mode, and new projects should use coodie. The note links coodie's cqlengine migration guide.

Why now: coodie is in production in Argus. scylladb/argus#1058 moved its 47 models and 18 UDTs off cqlengine and kept the existing table, type and index names, so no data had to be migrated. scylladb/argus#1106 then moved the backend to coodie.aio. cqlengine has no asyncio API and has had no feature work in years.

Open for maintainers to decide:

  • Whether "maintenance mode" is the right status. If we want to sunset cqlengine fully, a follow-up can add a DeprecationWarning on import and set a removal version.

Docs build checked locally with sphinx-build and no new warnings.

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • I added relevant tests for new features and bug fixes. (docs only)
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • I have provided docstrings for the public items that I want to introduce. (n/a)
  • I have adjusted the documentation in ./docs/source/.
  • I added appropriate Fixes: annotations to PR description. (n/a)

🤖 Generated with Claude Code

Mark cqlengine as maintenance mode in the object mapper docs and
recommend coodie, a Pydantic v2 object mapper built on this driver,
for new projects, with a link to its cqlengine migration guide.
coodie now runs in production in Argus, which moved all of its
models off cqlengine with no data migration.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: QUIET
  • Plan: Advanced
  • Run ID: 09dff20e-6529-4564-8782-5446dea5f2df

📥 Commits

Reviewing files that changed from the base of the PR and between 168e479 and be61d55.


📒 Files selected for processing (2)
  • docs/index.rst
  • docs/object-mapper.rst

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.



📝 Walkthrough

Walkthrough

The documentation now states that cqlengine is in maintenance mode and recommends coodie for new projects. It links to a migration guide and notes that coodie preserves existing table, type, and index names, so data migration is not required. It also states that Argus moved its models to coodie.

Suggested reviewers: dkropachev


Priority: ⬇️ Low

Change: Other

Merge Risk: ⚪ Minimal · up to be61d

The change adds maintenance guidance and a coodie link; no specific user-impacting regression or merge blocker is established.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main documentation change: directing cqlengine users to coodie for new projects.
Description check Passed The description explains the documentation changes, motivation, links, validation performed, and checklist status. Non-applicable items are explicitly marked.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Lorak-mmk

Copy link
Copy Markdown

I would be fine with DeprecationWarning being thrown on cqlengine import - we are not really developing it anyway, and it will be a good first step towards deprecating the driver. WDYT @dkropachev ?

@fruch

fruch commented Oct 12, 2026

Copy link
Copy Markdown
Author

I would be fine with DeprecationWarning being thrown on cqlengine import - we are not really developing it anyway, and it will be a good first step towards deprecating the driver. WDYT @dkropachev ?

I was being conservative here, but that might work as well

@dkropachev

Copy link
Copy Markdown

I would be fine with DeprecationWarning being thrown on cqlengine import - we are not really developing it anyway, and it will be a good first step towards deprecating the driver. WDYT @dkropachev ?

+1, let's do that

@dkropachev
dkropachev marked this pull request as ready for review October 12, 2026 19:06

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants