Skip to content

docs: samples for instances should include all necessary code#1720

Merged
gcf-merge-on-green[bot] merged 98 commits intomainfrom
fix-restore-table-sample-5-quality-checks
Sep 18, 2025
Merged

docs: samples for instances should include all necessary code#1720
gcf-merge-on-green[bot] merged 98 commits intomainfrom
fix-restore-table-sample-5-quality-checks

Conversation

@danieljbruce
Copy link
Contributor

Description

The samples for instances do not contain code for fetching the projectId and the admin client, but they should because this isn't a trivial step. This PR ensures the samples include all the code necessary in order for them to be able to work.

Impact

Improves the documentation and makes it more usable

Testing

These are changes to samples tests

Additional Information

Next steps:

  • We should do this for all our samples - make sure the samples don't require any assumptions

danieljbruce and others added 30 commits August 19, 2025 16:11
This commit updates the `backups.restore.js` sample to use the `BigtableTableAdminClient` directly for restoring a table from a backup, instead of going through the handwritten `bigtable.instance().createTableFromBackup()` method.

This change is based on the design document for the Node.js Bigtable Admin API autogeneration.

The corresponding test for the sample in `samples/test/backups.js` has also been updated to pass the correct arguments to the updated sample script.
instance of the admin client should be used
danieljbruce and others added 14 commits September 9, 2025 15:22
…into fix-restore-table-sample-5

# Conflicts:
#	samples/api-reference-doc-snippets/backups.create.js
#	samples/api-reference-doc-snippets/backups.delete.js
#	samples/api-reference-doc-snippets/backups.get.js
#	samples/api-reference-doc-snippets/backups.list.js
#	samples/api-reference-doc-snippets/backups.restore.js
#	samples/api-reference-doc-snippets/backups.update.js
#	samples/api-reference-doc-snippets/family.js
#	samples/api-reference-doc-snippets/instance.js
#	samples/api-reference-doc-snippets/table.js
#	samples/deleteSnippets.js
#	samples/hello-world/index.js
#	samples/tableadmin.js
#	samples/test/backups.js
#	samples/test/deletes.js
#	samples/test/family.js
#	samples/test/filters.js
#	samples/test/functions.js
#	samples/test/reads.js
#	samples/test/row.js
#	samples/test/write.js
@danieljbruce danieljbruce requested a review from a team September 17, 2025 20:48
@danieljbruce danieljbruce requested a review from a team as a code owner September 17, 2025 20:48
@snippet-bot
Copy link

snippet-bot bot commented Sep 17, 2025

Here is the summary of changes.

You are about to add 5 region tags.
You are about to delete 5 region tags.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label bot added size: xl Pull request size is extra large. api: bigtable Issues related to the googleapis/nodejs-bigtable API. samples Issues that are directly related to samples. labels Sep 17, 2025
…into fix-restore-table-sample-5-quality-checks

# Conflicts:
#	samples/instances.js
@product-auto-label product-auto-label bot added size: m Pull request size is medium. and removed size: xl Pull request size is extra large. labels Sep 17, 2025
@danieljbruce danieljbruce added the automerge Merge the pull request once unit tests and other checks pass. label Sep 18, 2025
@gcf-merge-on-green gcf-merge-on-green bot merged commit 456c3d5 into main Sep 18, 2025
26 of 30 checks passed
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Sep 18, 2025
@gcf-merge-on-green gcf-merge-on-green bot deleted the fix-restore-table-sample-5-quality-checks branch September 18, 2025 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigtable Issues related to the googleapis/nodejs-bigtable API. samples Issues that are directly related to samples. size: m Pull request size is medium.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants