[PR #17162] [MERGED] perf: fix N+1 query issue in get_tools method #39971

New Issue

GiteaMirror · 2026-04-25T12:23:00-05:00

GiteaMirror commented

2026-04-25 12:23:00 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/17162
Author: @sihyeonn
Created: 9/2/2025
Status: ✅ Merged
Merged: 9/3/2025
Merged by: @tjbck

Base: dev ← Head: perf/sh-tools

📝 Commits (1)

03d1d2a perf: fix N+1 query issue in get_tools method

📊 Changes

1 file changed (+9 additions, -2 deletions)

View changed files

📝 backend/open_webui/models/tools.py (+9 -2)

📄 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

Fixed a critical N+1 query performance issue in the get_tools method where user information was being fetched individually for each tool. This optimization repletes multiple individual user queries with a single batch query, significantly improving database performance and reducing query load.

This completes the comprehensive N+1 query optimization across all major listing endpoints (prompts, knowledge bases, models, and tools), ensuring consistent performance improvements throughout the application.

Changed

Modified get_tools method in ToolsTable class to use batch user fetching
Implemented dictionary-based O(1) user lookup instead of individual queries
Reduced database query count from 1+N to 1+1 pattern for tools listings
Applied consistent optimization pattern matching prompts, knowledge bases, and models modules

Fixed

Fixed N+1 query problem causing excessive database load when retrieving tools with user information
Improved response times for tools list endpoints through optimized database access patterns
Enhanced scalability for applications with large numbers of tools and users

Additional Information

File affected: backend/open_webui/models/tools.py (lines 145-165)
Query optimization: Changed from 1 + N queries to 1 + 1 queries
Performance impact: Up to 99%+ reduction in database queries for large datasets
Memory efficiency: Duplicate user_id filtering prevents redundant data fetching

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/17162 **Author:** [@sihyeonn](https://github.com/sihyeonn) **Created:** 9/2/2025 **Status:** ✅ Merged **Merged:** 9/3/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `perf/sh-tools` --- ### 📝 Commits (1) - [`03d1d2a`](https://github.com/open-webui/open-webui/commit/03d1d2a88b12043086d489090bb9c14594f7de68) perf: fix N+1 query issue in get_tools method ### 📊 Changes **1 file changed** (+9 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/models/tools.py` (+9 -2) </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? - [x] **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 Fixed a critical N+1 query performance issue in the `get_tools` method where user information was being fetched individually for each tool. This optimization repletes multiple individual user queries with a single batch query, significantly improving database performance and reducing query load. This completes the comprehensive N+1 query optimization across all major listing endpoints (prompts, knowledge bases, models, and tools), ensuring consistent performance improvements throughout the application. ### Changed - Modified `get_tools` method in `ToolsTable` class to use batch user fetching - Implemented dictionary-based O(1) user lookup instead of individual queries - Reduced database query count from 1+N to 1+1 pattern for tools listings - Applied consistent optimization pattern matching prompts, knowledge bases, and models modules ### Fixed - Fixed N+1 query problem causing excessive database load when retrieving tools with user information - Improved response times for tools list endpoints through optimized database access patterns - Enhanced scalability for applications with large numbers of tools and users --- ### Additional Information - **File affected:** `backend/open_webui/models/tools.py` (lines 145-165) - **Query optimization:** Changed from `1 + N` queries to `1 + 1` queries - **Performance impact:** Up to 99%+ reduction in database queries for large datasets - **Memory efficiency:** Duplicate user_id filtering prevents redundant data fetching ### 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-04-25 12:23:00 -05:00

GiteaMirror closed this issue

2026-04-25 12:23:01 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#39971