Skip to content

Commit d5aa9bd

Browse files
authored
docs(FIR-45553): Add special consideration readme section (#138)
1 parent 0505365 commit d5aa9bd

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ console.log(rows)
154154
* <a href="#recipes">Recipes</a>
155155
* <a href="#streaming-results">Streaming results</a>
156156
* <a href="#custom-stream-transformers">Custom stream transformers</a>
157-
157+
* <a href="#special-considerations">Special Considerations</a>
158158

159159
<a id="About"></a>
160160
## About
@@ -742,6 +742,15 @@ console.log(statistics);
742742
console.log(rows)
743743
```
744744

745+
<a id="special-considerations"></a>
746+
## Special Considerations
747+
748+
When using the Firebolt Node.js SDK, keep the following considerations in mind:
749+
750+
- **Avoid blocking the event loop**: Node.js runs JavaScript code on a single-threaded event loop. Blocking operations can degrade performance and responsiveness and may lead to networking errors. For more details, see [Don't Block the Event Loop](https://nodejs.org/en/learn/asynchronous-work/dont-block-the-event-loop).
751+
- **Streaming large result sets**: Use the `streamResult` method instead of `fetchResult` for large datasets to avoid memory issues.
752+
- **Environment variables**: Always store sensitive credentials (like `client_id` and `client_secret`) in environment variables rather than hardcoding them in your source code.
753+
745754
## Development process
746755
### Actions before
747756
### Setup env variables

0 commit comments

Comments
 (0)