Repository navigation
Conversation
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
Comment |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documentation must identify the proposed support and helpers as provisional until core feature acceptance.
1 open finding
What changed in this PR
Adds Plugin developer guidance for portable database queries alongside the proposed PostgreSQL implementation.
Changes:
- Adds a parameterized DBAL query using the shared case-insensitive matching helper.
- Explains pattern matching, PostgreSQL collation behavior, and migration portability.
| File | Description |
|---|---|
| docs/plugins/database.rst | Adds portable query examples and PostgreSQL compatibility guidance. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Description
Document portable database queries for Plugin developers alongside the proposed Mautic 7.x PostgreSQL implementation. The existing entities/schema page gains a parameterized DBAL query using
DatabasePlatform::getCaseInsensitiveLike(), negative matching and regular-expression guidance, PostgreSQL collation behavior, and migration portability requirements.This is a draft companion to the PostgreSQL core implementation derived from mautic/mautic#15926. Core implementation: mautic/mautic#17854. Targeting
7.3because the implementation is based on Mautic7.x; these APIs must not be documented as released before the feature is accepted.Validation: full Sphinx HTML build passed with the repository's pinned requirements on Python 3.13. The example passed PHP syntax checking inside the application container, and the rendered HTML contains the new section and query example. Vale adds no warnings or errors compared with the original page; 98 pre-existing spelling errors and two warnings remain, with two new suggestions about parentheses around expanded abbreviations. The initial full build reports 293 existing warnings, none attributed to this changed page.
Steps to review
docs/requirements.txtwith Python 3.13.5 or later and runsphinx-build -b html docs _build/html._build/html/plugins/database.htmland inspect Writing portable database queries.Linked issue
Related: mautic/mautic#15926.
Draft readiness: no Education Team issue assignment has been obtained. Maintainer triage/assignment and acceptance of the core feature remain outstanding under this repository's contribution guide.
Screenshots or screen recordings
No product interface changes. Existing documentation page rendered locally.