QBStreamOptions

Index

Properties

• chunkSize
• mapResults
• mergeResults
• rawResults

Properties

optionalchunkSize

chunkSize?: number = 100 on dialects that honor it.

How many rows to fetch in one round-trip. Lower values will result in more queries and network bandwidth, but less memory usage. Higher values will result in fewer queries and network bandwidth, but higher memory usage. Note that the results are iterated one row at a time regardless of this value.

Honored on PostgreSQL (cursor-based fetch), MSSQL (tedious stream chunk size) and Oracle (mapped to fetchArraySize). Ignored on MySQL, MariaDB, SQLite and libSQL, where the underlying driver already streams row-by-row with no batching knob.

optionalmapResults

mapResults?: boolean = true

Results are mapped to entities, if you set mapResults: false you will get POJOs instead.

optionalmergeResults

mergeResults?: boolean = true

When populating to-many relations, the ORM streams fully merged entities instead of yielding every row. You can opt out of this behavior by specifying mergeResults: false. This will yield every row from the SQL result, but still mapped to entities, meaning that to-many collections will contain at most one item, and you will get duplicate root entities when they have multiple items in the populated collection.

optionalrawResults

rawResults?: boolean = false

When enabled, the driver will return the raw database results without renaming the fields to match the entity property names.