c7ef602 Provide more detailed information to the user upon database connection failure
📊 Changes
1 file changed (+1 additions, -0 deletions)
View changed files
📝backend/open_webui/internal/db.py (+1 -0)
📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Changelog Entry
Description
Enhances the error message during Peewee database migrations to provide users with a helpful hint for troubleshooting connection failures.
Added
None
Changed
The handle_peewee_migration function in backend/open_webui/internal/db.py now logs a warning message suggesting that special characters in the database password should be URL-encoded if the connection fails.
Deprecated
None
Removed
None
Fixed
Improves the user experience by providing clearer guidance for resolving a common database connection issue related to special characters in passwords.
Security
None
Breaking Changes
BREAKING CHANGE:None
Additional Information
None
Screenshots or Videos
None
Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/open-webui/open-webui/pull/15148
**Author:** [@jackthgu](https://github.com/jackthgu)
**Created:** 6/19/2025
**Status:** ✅ Merged
**Merged:** 6/20/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `none-dbconnect-warning-message`
---
### 📝 Commits (1)
- [`c7ef602`](https://github.com/open-webui/open-webui/commit/c7ef6025afa36918c4fac0c0fa3b7095d4312330) Provide more detailed information to the user upon database connection failure
### 📊 Changes
**1 file changed** (+1 additions, -0 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/internal/db.py` (+1 -0)
</details>
### 📄 Description
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Have you written and run sufficient tests to validate the changes?
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
- Enhances the error message during Peewee database migrations to provide users with a helpful hint for troubleshooting connection failures.
### Added
- None
### Changed
- The `handle_peewee_migration` function in `backend/open_webui/internal/db.py` now logs a warning message suggesting that special characters in the database password should be URL-encoded if the connection fails.
### Deprecated
- None
### Removed
- None
### Fixed
- Improves the user experience by providing clearer guidance for resolving a common database connection issue related to special characters in passwords.
### Security
- None
### Breaking Changes
- **BREAKING CHANGE**:None
---
### Additional Information
- None
### Screenshots or Videos
- None
### Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/15148
Author: @jackthgu
Created: 6/19/2025
Status: ✅ Merged
Merged: 6/20/2025
Merged by: @tjbck
Base:
dev← Head:none-dbconnect-warning-message📝 Commits (1)
c7ef602Provide more detailed information to the user upon database connection failure📊 Changes
1 file changed (+1 additions, -0 deletions)
View changed files
📝
backend/open_webui/internal/db.py(+1 -0)📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
Added
Changed
handle_peewee_migrationfunction inbackend/open_webui/internal/db.pynow logs a warning message suggesting that special characters in the database password should be URL-encoded if the connection fails.Deprecated
Removed
Fixed
Security
Breaking Changes
Additional Information
Screenshots or Videos
Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.