docs: All samples should include all necessary code #1721
+324
−236
Conversation
This file contains hidden or 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
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
This reverts commit c71b50c.
…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
…into fix-restore-table-sample-5-quality-checks # Conflicts: # samples/instances.js
…into fix-restore-table-sample-5-quality-checks-2
|
Here is the summary of changes. You are about to add 12 region tags.
You are about to delete 12 region tags.
This comment is generated by snippet-bot.
|
product-auto-label
bot
added
api: bigtable
danieljbruce
commented
Sep 18, 2025
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. |
There was a problem hiding this comment.
For pretty much all the samples in this section we are pulling:
const {Bigtable, GCRuleMaker} = require('@google-cloud/bigtable');
const {BigtableTableAdminClient} = require('@google-cloud/bigtable').v2;
const adminClient = new BigtableTableAdminClient();
into the samples and indenting the code that contains a sample so that these declarations can be done multiple times.
danieljbruce
added
the
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
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.
Description
This PR is an extension of #1720. The basic idea is that the rest of the samples should include all the code necessary to get the sample running.
Impact
It makes it easier for users to use our samples.
Testing
These are changes to the samples so they are covered by samples tests