[PR #15175] [CLOSED] [Perf] Default database pool size to 1 #62600

Closed
opened 2026-05-06 06:49:24 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15175
Author: @prene
Created: 6/20/2025
Status: Closed

Base: devHead: default-database-pool-to-one


📝 Commits (1)

  • 975273c Default database pooling to 1

📊 Changes

1 file changed (+3 additions, -3 deletions)

View changed files

📝 backend/open_webui/env.py (+3 -3)

📄 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?

https://github.com/open-webui/docs/pull/589

  • 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

Default DATABASE_POOL_SIZE=1

Description

This PR defaults the database pooling setting to 1 instead of 0 for a better out-of-the-box experience, minimizing user frustration.

Why?

It seems that some users, especially those using non-local databases, see slow response times from the API. One reason is that DATABASE_POOL_SIZE must be manually set to something that is appropriate for the anticipated workload. However, defaulting DATABASE_POOL_SIZE to 0 (= disabling pooling all together) introduces an unnecessary bottleneck.

By changing the default to DATABASE_POOL_SIZE=1, we ensure that a single, persistent connection is established and then reused for subsequent requests, instead of disabling pooling (= opening new db connections for every request, which introduces a lot of overhead).

I argue that this change provides a much better out-of-the-box experience. While users are still encouraged to configure the database pool size based on their specific needs and expected workload to handle concurrent requests efficiently, defaulting to 1 removes a harmful and unnecessary performance bottleneck for all users, particularly those connecting to remote databases.

Changed

  • default DATABASE_POOL_SIZE=1

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/15175 **Author:** [@prene](https://github.com/prene) **Created:** 6/20/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `default-database-pool-to-one` --- ### 📝 Commits (1) - [`975273c`](https://github.com/open-webui/open-webui/commit/975273c757d1860a681016077d8482a7441fa047) Default database pooling to 1 ### 📊 Changes **1 file changed** (+3 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/env.py` (+3 -3) </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? https://github.com/open-webui/docs/pull/589 - [ ] **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 Default DATABASE_POOL_SIZE=1 ### Description This PR defaults the database pooling setting to 1 instead of 0 for a better out-of-the-box experience, minimizing user frustration. Why? It seems that some users, especially those using non-local databases, see slow response times from the API. One reason is that DATABASE_POOL_SIZE must be manually set to something that is appropriate for the anticipated workload. However, defaulting DATABASE_POOL_SIZE to 0 (= disabling pooling all together) introduces an unnecessary bottleneck. By changing the default to DATABASE_POOL_SIZE=1, we ensure that a single, persistent connection is established and then reused for subsequent requests, instead of disabling pooling (= opening new db connections for every request, which introduces a lot of overhead). I argue that this change provides a much better out-of-the-box experience. While users are still encouraged to configure the database pool size based on their specific needs and expected workload to handle concurrent requests efficiently, defaulting to 1 **removes a harmful and unnecessary performance bottleneck** for all users, particularly those connecting to remote databases. ### Changed - default DATABASE_POOL_SIZE=1 ### 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>
GiteaMirror added the pull-request label 2026-05-06 06:49:24 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#62600