Skip to content

Commit 0397b98

Browse files
address CR
1 parent f667902 commit 0397b98

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -617,8 +617,8 @@ await database.delete();
617617
<a id="streaming-results"></a>
618618
### Streaming results
619619

620-
Streaming can only be used with a v2 connection and only using the execute stream method.
621-
The streamResult method from normal the normal execute method returns an in-memory stream of result, rather than dynamically fetching them from the response.
620+
Streaming can only be used with a v2 connection and only using the `executeStream` method.
621+
The streamResult method for the normal `execute` method returns an in-memory stream of result, rather than dynamically fetching them from the response. This is further explained in the [in-memory stream](#in-memory-stream) section.
622622

623623
The recommended way to consume query results is by using streams with standard events:
624624
* `data.on('meta')`
@@ -665,7 +665,7 @@ data.on("error", error => {
665665
});
666666

667667
```
668-
```typescript
668+
669669

670670
<a id="custom-stream-transformers"></a>
671671
### Custom stream transformers
@@ -708,7 +708,11 @@ data.pipe(serializedStream).pipe(process.stdout);
708708
<a id="in-memory-stream"></a>
709709
### In-memory stream
710710

711-
When using the streamResult method on the object returned from a simple execute method, the driver will return an in-memory stream of the result. This is useful for small result sets, but not recommended for large result sets.
711+
When using the streamResult method on the object returned from a simple execute method, the driver will return
712+
an in-memory stream of the result. This is useful for small result sets, but not recommended for large result sets.
713+
714+
In this case the whole result will be first fetched in memory and then made available via streamResult.
715+
This is done for compatibility reasons and has no performance benefits compared to using fetchResult
712716

713717
```typescript
714718
const firebolt = Firebolt();

0 commit comments

Comments
 (0)