docs: add instructions to run code samples #374
+36
−13
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
crystall-bitquill
added
the
ready for review
crystall-bitquill
force-pushed
the
docs/run-code-samples
branch
from
2702675 to
7b153b7
Compare
karenc-bq
reviewed
Jan 17, 2025
|
|
||
| Prior to running a sample, all prerequisites for the sample must be met. For example, to run the `aws_iam_authentication_mysql_example.ts` file, you must have an IAM user set up and IAM Authentication must be enabled on the database you specify. See the individual [plugin pages](/docs/using-the-nodejs-wrapper/UsingTheNodejsWrapper.md#list-of-available-plugins) for more information. | ||
|
|
||
| Note than for any failover examples, failover will not be triggered. For example, the `aws_failover_mysql_example.ts` sample demonstrates enabling the failover plugin and failover handling, but will not initiate cluster failover on its own. |
There was a problem hiding this comment.
Suggested change
| Note than for any failover examples, failover will not be triggered. For example, the `aws_failover_mysql_example.ts` sample demonstrates enabling the failover plugin and failover handling, but will not initiate cluster failover on its own. | |
| Note that for any failover examples, failover will not be triggered. For example, the `aws_failover_mysql_example.ts` sample demonstrates enabling the failover plugin and failover handling, but will not initiate cluster failover on its own. |
There was a problem hiding this comment.
We should also provide information on how to initiate cluster failover
There was a problem hiding this comment.
But I am good with this for now as a first draft
karenc-bq
approved these changes
Jan 17, 2025
crystall-bitquill
force-pushed
the
docs/run-code-samples
branch
from
7b153b7 to
c2b6f6e
Compare
sophia-bq
reviewed
Jan 17, 2025
| 1. Ensure all prerequisites have been met. | ||
| 2. Install all required packages with `npm install`. | ||
| 3. Navigate to the `/examples/aws_driver_example` directory. | ||
| 4. Run the command `npx tsx <filename>`. For example, to run the `aws_iam_authentication_mysql_example.ts` file, the command would be `npx tsx aws_iam_authentication_mysql_example.ts`. |
There was a problem hiding this comment.
Suggested change
| 4. Run the command `npx tsx <filename>`. For example, to run the `aws_iam_authentication_mysql_example.ts` file, the command would be `npx tsx aws_iam_authentication_mysql_example.ts`. | |
| 4. Edit any credentials or user specific information in the desired file. For example, set the client properties in the file to match an existing database for the queries to run against. | |
| 5. Run the command `npx tsx <filename>`. For example, to run the `aws_iam_authentication_mysql_example.ts` file, the command would be `npx tsx aws_iam_authentication_mysql_example.ts`. |
There was a problem hiding this comment.
This is just a thought since editing isn't explicitly in the prerequisites section.
docs/Documentation.md
Outdated
| - [Pipelines](../docs/development-guide/Pipelines.md) | ||
| - [Read-Write Splitting Plugin Performance Results](../docs/development-guide/ReadWriteSplittingPerformanceResults.md) | ||
| - [Using The NodeJS Wrapper with Prisma ORM](./../examples/prisma_example/README.md) | ||
| - [Running the AWS Advanced NodeJS Wrapper Code Samples](./../examples/aws_driver_example/README.md) |
There was a problem hiding this comment.
Thoughts on putting this above the Development Guide?
crystall-bitquill
force-pushed
the
docs/run-code-samples
branch
from
c2b6f6e to
211df8e
Compare
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.
Summary
Description
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.