fix: use-server-side-cursor is not working #746
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abhishekagrawal-atlan
requested review from
firecast and
inishchith
as code owners
📜 Docstring Coverage ReportRESULT: PASSED (minimum: 30.0%, actual: 75.8%) Detailed Coverage Report |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an issue where the use-server-side-cursor configuration was being ignored in SQL query execution. The fix ensures that when server-side cursors are enabled, database connections are properly configured to use them with appropriate batch sizing.
- Added server-side cursor configuration to SQL query execution
- Imported the
USE_SERVER_SIDE_CURSORconstant to check cursor settings - Applied execution options with
yield_per=100000when server-side cursors are enabled
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Comment on lines
+124
to
+125
| if USE_SERVER_SIDE_CURSOR: | ||
| conn = conn.execution_options(yield_per=100000) |
There was a problem hiding this comment.
The magic number 100000 for yield_per should be extracted to a named constant or made configurable. This hardcoded value makes it difficult to tune performance for different use cases.
📦 Trivy Vulnerability Scan Results
Report Summary
Scan Result Details✅ No vulnerabilities found during the scan for |
📦 Trivy Secret Scan Results
Report Summary
Scan Result Details✅ No secrets found during the scan for |
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
|
🛠 Full Test Coverage Report: https://k.atlan.dev/coverage/application-sdk/pr/746 |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| """ | ||
| with self.engine.connect() as conn: | ||
| if USE_SERVER_SIDE_CURSOR: | ||
| conn = conn.execution_options(yield_per=100000) |
There was a problem hiding this comment.
Bug: Server-Side Cursor Inconsistency and Yield Per Issue
Server-side cursor configuration is only applied in _execute_query, not _read_sql_query. This prevents async database connections from using server-side cursors, creating inconsistent behavior when USE_SERVER_SIDE_CURSOR is enabled. Additionally, the hardcoded yield_per=100000 value doesn't align with self.chunk_size, which could impact performance or memory.
|
🛠 Docs available at: https://k.atlan.dev/application-sdk/fix-use-server-side-cursor |
inishchith
requested changes
Sep 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog
Additional context (e.g. screenshots, logs, links)
Checklist
Copyleft License Compliance
Note
Respect
USE_SERVER_SIDE_CURSORto execute queries withyield_per=100000, avoiding full in-memory fetches.application_sdk/inputs/sql_query.py):USE_SERVER_SIDE_CURSORand, when enabled, setconn.execution_options(yield_per=100000)before running pandas read, enabling server-side cursor/batched fetching.Written by Cursor Bugbot for commit f992d89. This will update automatically on new commits. Configure here.