(docs) Add "Node.js and Materialize" guide #7543
Merged
Conversation
This file contains 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
msudberg
suggested changes
Jul 28, 2021
|
@msudberg I merged after getting a thumbs-up from Petros, but will integrate your feedback into an update. |
This was referenced Aug 9, 2021
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 guide centralizes and links out to all the reference content necessary for using Node.js with Materialize.
Why: Help developers who are building Node.js applications that interact with Materialize understand how to communicate with Materialize, which concepts (like TAIL and FETCH) to investigate further, and give them some barebones examples to get up and running with a Node.js app and Materialize.
Where more detail may be necessary:
pg-cursorand the node.jsstreamsAPI, but I left this out of the guide because it felt like too much of a leap in complexity from the basic examples provided throughout the rest of the guide. I think we can create either a demo page or a separate article walking through Petros' example.pg-query-streambecause it won't be ready until Petros' PR to the external repo is merged: pg-query-stream: make rows available as soon as possible brianc/node-postgres#2573