feat: Add streaming (stream_each) support for PostgreSQL and MySQL#16
Merged
feat: Add streaming (stream_each) support for PostgreSQL and MySQL#16
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
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.
This PR adds a new
.stream_eachmethod to SimpleQuery’s Builder, providing row-by-row retrieval for large datasets in bothPostgreSQL(via cursors) andMySQL(via themysql2gem’s streaming mode). This prevents loading entire result sets into memory at once, offering significant memory and performance benefits for multi-million-row queries.Key Changes
PostgresStream&MysqlStreamModules – Separated logic into dedicated modules:stream_each_postgres(batch_size, &block)usesDECLARE ... CURSORandFETCH... in a transaction.stream_each_mysql(&block)usesraw_conn.query(sql, stream: true, cache_rows: false, as: :hash)from mysql2.Builder Integration –
.stream_each(batch_size: 1000, &block)dispatches to eitherPostgresorMySQLmethod based on the adapter, raising an error if neither.Tests – Unit tests for each module (PostgresStream, MysqlStream) plus an integration test verifying
Builder#stream_each.Performance Gains
Our benchmarks show
.stream_eachcan use~30-50%less memory than AR’sfind_each, with2-3×faster iteration on large datasets.Usage Example:
This yields each row individually, preventing large memory spikes.