Skip to content

Document portable database queries and PostgreSQL support - #846

Draft
mihazs wants to merge 2 commits into
mautic:7.3from
mihazs:postgres-compatibility-docs
Draft

mihazs wants to merge 2 commits into
mautic:7.3from
mihazs:postgres-compatibility-docs

Conversation

@mihazs

@mihazs mihazs commented Oct 15, 2026

Copy link
Copy Markdown

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.3 because the implementation is based on Mautic 7.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

  1. Install docs/requirements.txt with Python 3.13.5 or later and run sphinx-build -b html docs _build/html.
  2. Open _build/html/plugins/database.html and inspect Writing portable database queries.
  3. Compare the helper signatures and collation behavior with the linked core implementation. Check that the query uses a bound parameter and that the migration guidance preserves MySQL/MariaDB support.

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.

Copilot AI balanced review requested due to automatic review settings October 15, 2026 20:33
@coderabbitai

coderabbitai Bot commented Oct 15, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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.

Comment thread docs/plugins/database.rst
Copilot AI balanced review requested due to automatic review settings October 15, 2026 20:46

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Publication requires maintainer coordination while core feature acceptance and Education Team assignment remain outstanding.

0 open findings

1 resolved since last review

🧠 Review effort: Balanced

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.

2 participants