Skip to content
This repository was archived by the owner on Mar 5, 2026. It is now read-only.

docs: change README to show Write veneer#452

Merged
alvarowolfx merged 14 commits intogoogleapis:mainfrom
alvarowolfx:docs-readme-write-api
May 9, 2024
Merged

docs: change README to show Write veneer#452
alvarowolfx merged 14 commits intogoogleapis:mainfrom
alvarowolfx:docs-readme-write-api

Conversation

@alvarowolfx
Copy link
Copy Markdown
Contributor

@alvarowolfx alvarowolfx commented May 3, 2024

This PR adds a workaround to show Storage Write API as example on the README of this repo by adding another sample on the quickstart.js file.

We still keep the bigquerystorage_quickstart sample to use the Read API, as that's what is being used in all languages and docs.

@alvarowolfx alvarowolfx requested review from a team and Linchin May 3, 2024 19:25
@alvarowolfx alvarowolfx added the owlbot:run Add this label to trigger the Owlbot post processor. label May 3, 2024
@snippet-bot
Copy link
Copy Markdown

snippet-bot Bot commented May 3, 2024

No region tags are edited in this PR.

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: m Pull request size is medium. api: bigquerystorage Issues related to the googleapis/nodejs-bigquery-storage API. labels May 3, 2024
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label May 3, 2024
@alvarowolfx alvarowolfx added the owlbot:run Add this label to trigger the Owlbot post processor. label May 3, 2024
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label May 3, 2024
@alvarowolfx alvarowolfx added the owlbot:run Add this label to trigger the Owlbot post processor. label May 3, 2024
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label May 3, 2024
@product-auto-label product-auto-label Bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels May 3, 2024
@alvarowolfx alvarowolfx removed the request for review from Linchin May 3, 2024 19:46
@generated-files-bot
Copy link
Copy Markdown

generated-files-bot Bot commented May 3, 2024

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

@alvarowolfx alvarowolfx added the owlbot:run Add this label to trigger the Owlbot post processor. label May 3, 2024
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label May 3, 2024
@alvarowolfx alvarowolfx added the owlbot:run Add this label to trigger the Owlbot post processor. label May 6, 2024
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label May 6, 2024
@alvarowolfx alvarowolfx requested review from shollyman and yirutang May 6, 2024 20:11
Comment thread .readme-partials.yaml Outdated
try {
const dataset = bigquery.dataset(datasetId);
const table = await dataset.table(tableId);
const [metadata] = await table.getMetadata();
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's go with GetWriteStream here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add once #453 is merged

Comment thread .readme-partials.yaml
@alvarowolfx alvarowolfx added the owlbot:run Add this label to trigger the Owlbot post processor. label May 7, 2024
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label May 7, 2024
Copy link
Copy Markdown
Contributor

@shollyman shollyman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mostly just comments feedback. I didn't copy all comments to all files but they're likely relevant.

Comment thread .readme-partials.yaml Outdated
> Node.js idiomatic client for [BigQuery Storage](https://cloud.google.com/bigquery).

The BigQuery Storage product is divided into two major APIs: Write and Read API.
Both BigQuery Storage APIs does not provide functionality related to managing
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strange structure to this sentence. Possibly just want to remove the "Both" at the beginning and s/APIs/API/?

Comment thread .readme-partials.yaml Outdated

async function bigqueryStorageWriteQuickstart() {
/**
* TODO(developer): Uncomment the following lines before ru nning the sample.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/ru nning/running/

Comment thread .readme-partials.yaml
Comment thread .readme-partials.yaml Outdated
@alvarowolfx alvarowolfx added the owlbot:run Add this label to trigger the Owlbot post processor. label May 8, 2024
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label May 8, 2024
@alvarowolfx alvarowolfx merged commit 7e5e8cc into googleapis:main May 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api: bigquerystorage Issues related to the googleapis/nodejs-bigquery-storage API. size: l Pull request size is large.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants