[PR #15195] [MERGED] [PERF] Proper default pooling settings #10548

New Issue

GiteaMirror · 2025-11-11T19:07:44-06:00

GiteaMirror commented

2025-11-11 19:07:44 -06:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15195
Author: @prene
Created: 6/21/2025
Status: ✅ Merged
Merged: 6/21/2025
Merged by: @tjbck

Base: dev ← Head: proper-default-pooling-settings

📝 Commits (1)

63d99ab Change default db pooling

📊 Changes

2 files changed (+8 additions, -6 deletions)

View changed files

📝 backend/open_webui/env.py (+3 -5)
📝 backend/open_webui/internal/db.py (+5 -1)

📄 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/592

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

Changed default pooling to let SQLAlchemy figure out optimal pooling strategy in case DATABASE_POOL_SIZE is not set.

Description

See discussion in https://github.com/open-webui/open-webui/pull/15175

This PR defaults the database pooling setting to "automatic" instead of NullPool for a better out-of-the-box experience, minimizing user frustration with slow API responses when using any db that is not SQLite.

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 currently disables pooling (NullPool) and introduces an unnecessary bottleneck.

This change will:

default SQLAlchemy to chose the proper default pooling setting automatically, in case DATABASE_POOL_SIZE is not set
maintains that DATABASE_POOL_SIZE = 0 will turn off pooling by setting NullPool

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 "auto" removes a harmful and unnecessary performance bottleneck for all users, particularly those connecting to remote databases, where a default of NullPool is nonsense.

Changed

default pooling setting for db connections

Additional Information

See discussion in https://github.com/open-webui/open-webui/pull/15175
https://docs-sqlalchemy.readthedocs.io/ko/latest/core/pooling.html

Screenshots or Videos

[Attach any relevant screenshots or videos demonstrating the changes]

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/15195 **Author:** [@prene](https://github.com/prene) **Created:** 6/21/2025 **Status:** ✅ Merged **Merged:** 6/21/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `proper-default-pooling-settings` --- ### 📝 Commits (1) - [`63d99ab`](https://github.com/open-webui/open-webui/commit/63d99abf41c3fd836af562a9d4bcbd2509261dbc) Change default db pooling ### 📊 Changes **2 files changed** (+8 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/env.py` (+3 -5) 📝 `backend/open_webui/internal/db.py` (+5 -1) </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/592 - [ ] **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? - [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 Changed default pooling to let SQLAlchemy figure out optimal pooling strategy in case DATABASE_POOL_SIZE is not set. ### Description See discussion in https://github.com/open-webui/open-webui/pull/15175 This PR defaults the database pooling setting to "automatic" instead of NullPool for a better out-of-the-box experience, minimizing user frustration with slow API responses when using any db that is not SQLite. 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 currently disables pooling (NullPool) and introduces an unnecessary bottleneck. This change will: - default SQLAlchemy to chose the proper default pooling setting automatically, in case DATABASE_POOL_SIZE is not set - maintains that DATABASE_POOL_SIZE = 0 will turn off pooling by setting NullPool 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 "auto" removes a harmful and unnecessary performance bottleneck for all users, particularly those connecting to remote databases, where a default of NullPool is nonsense. ### Changed - default pooling setting for db connections ### Additional Information See discussion in https://github.com/open-webui/open-webui/pull/15175 https://docs-sqlalchemy.readthedocs.io/ko/latest/core/pooling.html ### Screenshots or Videos - [Attach any relevant screenshots or videos demonstrating the changes] ### 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 2025-11-11 19:07:44 -06:00

GiteaMirror closed this issue

2025-11-11 19:07:44 -06:00

GiteaMirror referenced this issue

2026-04-20 04:14:07 -05:00

[PR #10548] [CLOSED] fix: clicking `Save` in Web Search settings now does not reset RAG_WEB_SEARCH_TRUST_ENV to false #22555

GiteaMirror referenced this issue

2026-04-25 11:18:48 -05:00

[PR #10548] [CLOSED] fix: clicking `Save` in Web Search settings now does not reset RAG_WEB_SEARCH_TRUST_ENV to false #38185

GiteaMirror referenced this issue

2026-04-29 20:01:55 -05:00

[PR #10548] [CLOSED] fix: clicking `Save` in Web Search settings now does not reset RAG_WEB_SEARCH_TRUST_ENV to false #45603