feat: modernization part 2 #1748

feywind · 2025-12-11T21:57:54Z

This is a follow-up for these two PRs:

This takes care of some missing pieces that were discovered by further discussion:

GcRuleBuilder is a more TypeScript-heavy way to validate ModifyColumnFamilies garbage collection rules, with type checking taking care of a lot of the constraints, and some minimal runtime checking for JavaScript users.
Rather than raw GAPIC, the focus has shifted to selective GAPIC subclasses that can augment them. This is specifically done to assist with RestoreTable and waiting for table consistency.
Data plane samples have been removed, as we don't want to encourage users to use them.
Generated samples and tests have been auto-edited to use the selective GAPIC classes.
Manual sample snippets have been updated to reflect the expected admin access and GcRuleBuilder usage.

There is still a CI issue that will need to be corrected before this can be merged. I don't think it's the result of this change, but I also don't want to chance it.

…ization-2

snippet-bot · 2025-12-11T21:58:00Z

Here is the summary of changes.

You are about to delete 11 region tags.

samples/generated/v2/bigtable.check_and_mutate_row.js:28, tag bigtable_v2_generated_Bigtable_CheckAndMutateRow_async
samples/generated/v2/bigtable.execute_query.js:28, tag bigtable_v2_generated_Bigtable_ExecuteQuery_async
samples/generated/v2/bigtable.generate_initial_change_stream_partitions.js:28, tag bigtable_v2_generated_Bigtable_GenerateInitialChangeStreamPartitions_async
samples/generated/v2/bigtable.mutate_row.js:28, tag bigtable_v2_generated_Bigtable_MutateRow_async
samples/generated/v2/bigtable.mutate_rows.js:28, tag bigtable_v2_generated_Bigtable_MutateRows_async
samples/generated/v2/bigtable.ping_and_warm.js:28, tag bigtable_v2_generated_Bigtable_PingAndWarm_async
samples/generated/v2/bigtable.prepare_query.js:28, tag bigtable_v2_generated_Bigtable_PrepareQuery_async
samples/generated/v2/bigtable.read_change_stream.js:28, tag bigtable_v2_generated_Bigtable_ReadChangeStream_async
samples/generated/v2/bigtable.read_modify_write_row.js:28, tag bigtable_v2_generated_Bigtable_ReadModifyWriteRow_async
samples/generated/v2/bigtable.read_rows.js:28, tag bigtable_v2_generated_Bigtable_ReadRows_async
samples/generated/v2/bigtable.sample_row_keys.js:28, tag bigtable_v2_generated_Bigtable_SampleRowKeys_async

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

generated-files-bot · 2025-12-11T21:58:02Z

Warning: This pull request is touching the following templated files:

README.md - README.md is managed by synthtool. However, a partials file can be used to update the README, e.g.: https://github.com/googleapis/nodejs-storage/blob/main/.readme-partials.yaml

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

…s-bigtable into modernization-2

…ization-2

feywind · 2025-12-17T19:27:23Z

The CI is really not cooperating here (timeouts, quota errors, etc) but the code itself should be okay to review.

mutianf

Where did all the data API examples go?

mutianf · 2026-01-05T18:26:01Z

samples/generated/admin/v2/bigtable_table_admin.check_consistency.js


  // Imports the Admin library
-  const {BigtableTableAdminClient} = require('@google-cloud/bigtable').admin.v2;
+  const {TableAdminClient} = require('@google-cloud/bigtable').admin;


should this sample reflect the new CUJ?

await tableAdmin.waitForConsistency('tablename');

or

const [token] = await tableAdmin.generateConsistencyToken({ name: 'tablename', }); // overload/etc, may be a separate method await tableAdmin.waitForConsistency(token);

mutianf · 2026-01-05T18:27:47Z

samples/generated/admin/v2/bigtable_table_admin.generate_consistency_token.js


  // Instantiates a client
-  const adminClient = new BigtableTableAdminClient();
+  const adminClient = new TableAdminClient();


same here, should this be merged with check_consistency to reflect the newer way of generate consistency token and wait for table to be consistent?

mutianf · 2026-01-05T18:30:43Z

samples/generated/admin/v2/bigtable_table_admin.restore_table.js


  // Instantiates a client
-  const adminClient = new BigtableTableAdminClient();
+  const adminClient = new TableAdminClient();


This also doesn't reflect the new CUJ

mutianf · 2026-01-05T19:06:58Z

samples/tableadmin.js

-      versions: 1,
-    },
-  };
+  const updatedMetadata = GcRuleBuilder.rule({


I wonder if this example can be added to the modifyColumnFamilies example as well?

mutianf · 2026-01-06T14:11:54Z

src/admin/gc-rule-builder.ts

+      throw new Error(
+        GcRuleBuilder.formatErrorParameter(
+          p,
+          'does not appear to be a rule or a union/intersection',


nit: maybe just

Suggested change

'does not appear to be a rule or a union/intersection',

'is not a rule or a union/intersection',

mutianf · 2026-01-06T14:13:32Z

src/admin/gc-rule-builder.ts

+    }
+    if (nonGroupKeys(p).length > 1) {
+      throw new Error(
+        GcRuleBuilder.formatErrorParameter(p, 'is an invalid multiple-rule'),


maybe

Suggested change

GcRuleBuilder.formatErrorParameter(p, 'is an invalid multiple-rule'),

GcRuleBuilder.formatErrorParameter(p, 'is an invalid multiple-rule, please use union or intersection'),

mutianf · 2026-01-06T14:21:17Z

src/admin/table.ts

+ *
+ * While users may create an instance of this class using the standard GAPIC
+ * constructor parameters, it's recommended to obtain one by way of the
+ * Bigtable.getTableAdminClient() method so that authentication and


I'm not sure if I understand this paragraph. In the example I see const adminClient = new TableAdminClient();. Is this section explaining how to get the TableAdminClient from a gapic generated client?

mutianf · 2026-01-06T14:25:58Z

src/admin/table.ts

+   *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+   *   for more details and examples.
+   */
+  async checkOptimizeRestoredTableProgress(


Do we have this in the example?

Also this API looks a bit different from the doc? https://docs.google.com/document/d/14aOXOpEbwpYJe7-p6E-PUgoy0vn4AKI7zP0Man0prLo/edit?tab=t.0

mutianf · 2026-01-06T14:26:15Z

src/admin/table.ts

+   * @param options CallOptions, if desired
+   * @returns A Promise that completes when the table is consistent
+   */
+  async waitForConsistency(


Do we have this in the example?

mutianf · 2026-01-06T14:27:55Z

src/admin/table.ts

+   * Check the status of the long running operation returned when the `restoreTable()`
+   * LRO has concluded.
+   *
+   * This one doesn't get generated in GAPIC, because it's "hidden" in proto


This method is in the public API but GAPIC is an internal detail, will this show up in the generated public doc? I don't think we need to include the details?

feywind added 15 commits November 12, 2025 21:13

feat: update from selective gapic updates

e315220

feat: work in progress on updated admin tools

af2380d

feat: update proposed gcrule builder

a5af05c

feat: more updates on the CUJs

1386820

feat: updates from comments on new modernization features

de68524

fix: implement the rest of the old GcRule rules

edf5710

fix: clean up waitForConsistency

c85d815

docs: typo

6ab7541

fix: a couple more pieces of backwards compat

a1f40d6

samples: don't publish data plane generated samples

f3338b9

feat: move admin builder methods to be more namespaced

c2064de

fix: updated GcRuleBuilder import

61fecdd

build: transform class names for selective gapic

c828192

feat: adjust BigtableAdmin for recent doc updates

795ac42

chore: merge remote-tracking branch 'remotes/origin/main' into modern…

ee02f5e

…ization-2

feywind self-assigned this Dec 11, 2025

feywind requested review from a team as code owners December 11, 2025 21:57

feywind added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Dec 11, 2025

product-auto-label bot added the size: xl Pull request size is extra large. label Dec 11, 2025

product-auto-label bot added the api: bigtable Issues related to the googleapis/nodejs-bigtable API. label Dec 11, 2025

feywind changed the title ~~Modernization part 2~~ feat: modernization part 2 Dec 11, 2025

feywind added owl-bot-copy owlbot:run Add this label to trigger the Owlbot post processor. labels Dec 11, 2025

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 11, 2025

gcf-owl-bot bot added 3 commits December 11, 2025 22:05

🦉 Updates from OwlBot post-processor

cecdfff

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

🦉 Updates from OwlBot post-processor

f1da03f

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Merge branch 'modernization-2' of https://github.com/googleapis/nodej…

5e89e77

…s-bigtable into modernization-2

feywind removed the owl-bot-copy label Dec 11, 2025

fix: owlbot.py updates and resulting fixes

05fd23f

product-auto-label bot added size: l Pull request size is large. and removed size: xl Pull request size is extra large. labels Dec 11, 2025

feywind added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 11, 2025

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 11, 2025

feywind added 3 commits December 12, 2025 14:47

feat: improve the type safety of GcRuleBuilder and add tests

b350d5e

tests: add tests for TableAdmin

3f2eaa4

samples: update GcRule samples for GcRuleBuilder

0140301

feywind added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 12, 2025

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 12, 2025

feywind mentioned this pull request Dec 12, 2025

chore(main): release 6.4.2 #1733

Open

chore: merge remote-tracking branch 'remotes/origin/main' into modern…

95e039f

…ization-2

feywind removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Dec 17, 2025

mutianf reviewed Jan 6, 2026

View reviewed changes

	'does not appear to be a rule or a union/intersection',
	'is not a rule or a union/intersection',

	GcRuleBuilder.formatErrorParameter(p, 'is an invalid multiple-rule'),
	GcRuleBuilder.formatErrorParameter(p, 'is an invalid multiple-rule, please use union or intersection'),

feat: modernization part 2 #1748

Are you sure you want to change the base?

feat: modernization part 2 #1748

Uh oh!

Conversation

feywind commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snippet-bot bot commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

generated-files-bot bot commented Dec 11, 2025

Uh oh!

feywind commented Dec 17, 2025

Uh oh!

mutianf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feywind commented Dec 11, 2025 •

edited

Loading

snippet-bot bot commented Dec 11, 2025 •

edited

Loading