Skip to content

[docs] Document project sql --file flag - #2476

Open
shopware-docs-updater[bot] wants to merge 3 commits into
mainfrom
docs/project-sql-file-flag-ba09e9082af0bbe9
Open

[docs] Document project sql --file flag#2476
shopware-docs-updater[bot] wants to merge 3 commits into
mainfrom
docs/project-sql-file-flag-ba09e9082af0bbe9

Conversation

@shopware-docs-updater

@shopware-docs-updater shopware-docs-updater Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

This pull request adds documentation for running a SQL script from a file using the --file flag in the shopware-cli project sql command. The new section explains how to use the flag, its restrictions, and error handling for missing files.

Documentation updates:

  • Added a section describing the --file flag, including usage instructions, restrictions (cannot be combined with a query argument), and behavior when the file is missing, in products/tools/cli/project-commands/sql.md.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Aug 24, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 658c02f
Preview: https://developer-documentation-k68zmr68d-shopware-frontends.vercel.app
Workflow run: #5018

@shyim

Copy link
Copy Markdown
Member

Copilot rebase there is a dedicated sql.md page for this feature

…s.md

Co-authored-by: shyim <6224096+shyim@users.noreply.github.com>

Copilot AI commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Copilot rebase there is a dedicated sql.md page for this feature

Done — rebased onto main, reverted the SQL section from helper-commands.md, and added the --file documentation to the dedicated sql.md page instead.

@shyim

Copy link
Copy Markdown
Member

Copilot resolve the merge conflicts in this pull request

Co-authored-by: shyim <6224096+shyim@users.noreply.github.com>

Copilot AI commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Copilot resolve the merge conflicts in this pull request

Merge conflicts resolved — merged origin/main into the branch and kept the --file section in sql.md.

@shyim
Soner (shyim) marked this pull request as ready for review August 24, 2026 09:31
Copilot AI lite review requested due to automatic review settings August 24, 2026 09:31
@github-actions

Copy link
Copy Markdown
Contributor

📢 Developer Announcement Recommendation

Recommendation: ❌ No Announcement Recommended

No developer announcement signals were detected.

This PR does not appear to introduce developer-facing changes that require a community announcement.

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.

Pull request overview

Adds documentation to the Shopware CLI docs for shopware-cli project sql, specifically covering the newly introduced --file flag for executing SQL scripts from disk.

Changes:

  • Documented running a SQL script via the new --file flag, including its usage constraints.
  • Expanded the existing project sql documentation with an additional section describing file-based script execution.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread products/tools/cli/project-commands/sql.md
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