Make code samples conform to rubric #1295
Assignees
Labels
api: spanner
Issues related to the googleapis/nodejs-spanner API.
priority: p3
Desirable enhancement or fix. May not be included in next release.
samples
Issues that are directly related to samples.
type: cleanup
An internal cleanup or hygiene concern.
Comments
skuruppu
added
type: cleanup
product-auto-label
bot
added
api: spanner
|
For the record, the samples with the following region tags still need the command line tool support as they appear in the getting started guide:
|
gcf-merge-on-green bot
pushed a commit
that referenced
this issue
Jun 30, 2021
This PR Contains Indexing Samples that covers the new Canonical format. It does not remove the old samples. Towards #1295
olavloite
added a commit
that referenced
this issue
Jul 8, 2021
feat: implement request and transaction tagging fix: resolve conflicts build: add generated-files bot config (#1352) This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/a8c8456e-ad55-437d-a21c-2a0857049024/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.) Source-Link: googleapis/synthtool@e6f3d54 Source-Link: googleapis/synthtool@04573fd chore: add SECURITY.md (#1351) chore: add SECURITY.md chore: re-generated to pick up changes from self (#1354) This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/af2f31a3-fd48-4502-8b32-6f442ac8825e/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.) test: enable numeric integration tests on emulator (#1358) The emulator now supports the `NUMERIC` data type. deps: bump google-gax to latest (#1359) Version 2.11.0 and later of google-gax contains a fix that should reduce memory consumption somewhat when opening and closing clients multiple times. Updates #1306 samples: added comments for timeout settings (#1355) fix: lint issue (#1372) chore(deps): update dependency @types/node to v14 (#1374) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@types/node](https://togithub.com/DefinitelyTyped/DefinitelyTyped) | [`^10.3.0` -> `^14.0.0`](https://renovatebot.com/diffs/npm/@types%2fnode/10.17.60/14.17.0) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- 📅 **Schedule**: "after 9am and before 3pm" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻️ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-spanner). fix: ensure table funcs accept gaxOptions directly (#1371) chore(deps): update dependency sinon to v11 (#1376) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [sinon](https://sinonjs.org/) ([source](https://togithub.com/sinonjs/sinon)) | [`^10.0.0` -> `^11.0.0`](https://renovatebot.com/diffs/npm/sinon/10.0.0/11.1.0) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- <details> <summary>sinonjs/sinon</summary> [Compare Source](https://togithub.com/sinonjs/sinon/compare/v11.0.0...31be9a5d5a4762ef01cb195f29024616dfee9ce8) \================== - Add sinon.promise() implementation ([#​2369](https://togithub.com/sinonjs/sinon/issues/2369)) - Set wrappedMethod on getters/setters ([#​2378](https://togithub.com/sinonjs/sinon/issues/2378)) - \[Docs] Update fake-server usage & descriptions ([#​2365](https://togithub.com/sinonjs/sinon/issues/2365)) - Fake docs improvement ([#​2360](https://togithub.com/sinonjs/sinon/issues/2360)) - Update nise to 5.1.0 (fixed [#​2318](https://togithub.com/sinonjs/sinon/issues/2318)) [Compare Source](https://togithub.com/sinonjs/sinon/compare/v10.0.1...v11.0.0) \================== - Explicitly use samsam 6.0.2 with fix for [#​2345](https://togithub.com/sinonjs/sinon/issues/2345) - Update most packages ([#​2371](https://togithub.com/sinonjs/sinon/issues/2371)) - Update compatibility docs ([#​2366](https://togithub.com/sinonjs/sinon/issues/2366)) - Update packages (includes breaking fake-timers change, see [#​2352](https://togithub.com/sinonjs/sinon/issues/2352)) - Warn of potential memory leaks ([#​2357](https://togithub.com/sinonjs/sinon/issues/2357)) - Fix clock test errors [Compare Source](https://togithub.com/sinonjs/sinon/compare/v10.0.0...v10.0.1) \================== - Upgrade sinon components (bumps y18n to 4.0.1) - Bump y18n from 4.0.0 to 4.0.1 </details> --- 📅 **Schedule**: "after 9am and before 3pm" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻️ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-spanner). docs: align timeout values with documentation (#1379) The timeout values in the sample do not correspond with the official documentation surrounding the sample: https://cloud.google.com/spanner/docs/custom-timeout-and-retry#node chore: migrate to owl bot (#1380) * chore: migrate to owl bot * chore: copy files from googleapis-gen 46f25fb1121747b994ff5818963fda84b5e6bfd3 * chore: run the post processor * 🦉 Updates from OwlBot * chore: update post processor docker image * 🦉 Updates from OwlBot Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> docs: add missing JSDoc for table API (#1382) feat: support setting `optimizerStatisticsPackage` (#1225) `optimizerStatisticsPackage` can be set in `QueryOptions` when running Cloud Spanner queries. Can be configured through the following mechanisms: 1. Through the `SPANNER_OPTIMIZER_STATISTICS_PACKAGE` environment variable. 1. At `Database` level using `spanner.instance('instance-name').database('database-name', sessionPoolOptions, queryOptions)`. 1. At query level using `ExecuteSqlRequest.queryOptions`. If the options are configured through multiple mechanisms then: 1. Options set at an environment variable level will override options configured at the `Database` level. 1. Options set at a query-level will override options set at either the `Database` or environment variable level. If no options are set, the optimizer statistics package will default to: 1. The optimizer statistics package the database is pinned to in the backend. 1. If the database is not pinned to a specific statistics package, then the Cloud Spanner backend will use the "latest" version. docs: improve doc for gaxoptions (#1384) chore: Report warning on `.github/workflows/ci.yaml` (#1110) (#1385) * fix: Report warning on `.github/workflows/ci.yaml` Not all files in `.github/workflows` are managed, only `ci.yaml`. Related false-positive: googleapis/repo-automation-bots#1952 (comment) * fix: Report warning on `.github/workflows/ci.yaml` Not all files in `.github/workflows` are managed, only `ci.yaml`. Source-Link: googleapis/synthtool@2430f8d Post-Processor: gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:14aaee566d6fc07716bb92da416195156e47a4777e7d1cd2bb3e28c46fe30fe2 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> chore: release 5.8.0 (#1383) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> fix: unknown errors should not be retried (#1388) Unknown errors that are returned during a transaction should not cause the entire transaction to be automatically retried, as there is no absolute guarantee that the initial attempt did not succeed. A `Transaction Outcome Unknown` (or other Unknown) error could be returned by the `Commit` RPC, and in that case there is a possibility that the transaction was actually committed. Fixes #1387 chore(nodejs): use cloud-rad publication process (#1112) (#1391) VERSION is used in @google-cloud/cloud-rad to publish ref docs for a particular version. Pass VERSION in via Stubby or Fusion. Source-Link: googleapis/synthtool@740366b Post-Processor: gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:bbdd52de226c00df3356cdf25460397b429ab49552becca645adbc412f6a4ed5 build: add auto-approve to Node libraries (#1100) (#1393) * build: add auto-approve to Node libraries Co-authored-by: Benjamin E. Coe <[email protected]> Source-Link: googleapis/synthtool@5cae043 Post-Processor: gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:65aa68f2242c172345d7c1e780bced839bfdc344955d6aa460aa63b4481d93e5 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Benjamin E. Coe <[email protected]> chore: release 5.8.1 (#1389) :robot: I have created a release \*beep\* \*boop\* --- * unknown errors should not be retried ([#1388](https://www.github.com/googleapis/nodejs-spanner/issues/1388)) ([1d6f4e2](https://www.github.com/googleapis/nodejs-spanner/commit/1d6f4e2923bc1ac20c0a73c342332ec2ae259812)), closes [#1387](https://www.github.com/googleapis/nodejs-spanner/issues/1387) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). fix: lint chore(nodejs): remove api-extractor dependencies (#1395) build: remove errant comma (#1113) (#1396) Source-Link: googleapis/synthtool@41ccd8c Post-Processor: gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:c9c7828c165b1985579098978877935ee52dda2b1b538087514fd24fa2443e7a feat(spanner): add processing_units to Instance resource (#1398) PiperOrigin-RevId: 378758342 Source-Link: googleapis/googleapis@d869871 Source-Link: googleapis/googleapis-gen@54cfa76 chore: release 5.9.0 (#1399) :robot: I have created a release \*beep\* \*boop\* --- * **spanner:** add processing_units to Instance resource ([#1398](https://www.github.com/googleapis/nodejs-spanner/issues/1398)) ([878cd3f](https://www.github.com/googleapis/nodejs-spanner/commit/878cd3f1596526b6e4e2457babd3dc2c2add11ad)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). fix: make request optional in all cases (#1400) ... chore: update gapic-generator-ruby to the latest commit chore: release gapic-generator-typescript 1.5.0 Committer: @miraleung PiperOrigin-RevId: 380641501 Source-Link: googleapis/googleapis@076f7e9 Source-Link: googleapis/googleapis-gen@27e4c88 chore(codegen): add JSON type (#1403) * feat(spanner): add JSON type PiperOrigin-RevId: 381156241 Source-Link: googleapis/googleapis@fb5c4fb Source-Link: googleapis/googleapis-gen@b99c170 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/master/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> chore: release 5.9.1 (#1401) :robot: I have created a release \*beep\* \*boop\* --- * make request optional in all cases ([#1400](https://www.github.com/googleapis/nodejs-spanner/issues/1400)) ([0b78770](https://www.github.com/googleapis/nodejs-spanner/commit/0b78770bfef6f463abb0f336999f7dfd61b5b2fe)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). build(node): don't throw on deprecation in unit tests (#1405) Fixes #1134 🦕 Removes the commit body and relative PR# from the commit message. For example, for this commit: googleapis/synthtool@9763f20 `post-processor-changes.txt` would contain ``` build: enable npm for php/python builds Source-Link: googleapis/synthtool@9763f20 ``` instead of ``` build: enable npm for php/python builds (#1133) * build: enable npm for php/python builds * update comment Source-Link: googleapis/synthtool@9763f20 ``` Source-Link: googleapis/synthtool@e934b93 Post-Processor: gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:805e2e389eafefa5ed484c30b83a7a875e6b1c7ee125d812e8b01ecc531c3fac fix: typos Revert "feat: generate protos" This reverts commit 0400361. test: add mock server test for tagging fix: reset buffered chunked value before retry (#1397) * fix: reset buffered chunked value before retry Retrying a stream of PartialResultSets must correctly reset to the last state that it had when it received a PartialResultSet with a resume token. That means: 1. The pending value that should be merged with the next result should be reset to the pending value of the last PartialResultSet with a resume token. 2. The stream must correctly check for the existence of a resume token. 3. The stream must ensure that all values that are already in the pipeline must be handled before resetting the stream to the last resume token to ensure that no PartialResultSet is added twice to the stream. Fixes #1392 Co-authored-by: Alex <[email protected]> chore: release 5.9.2 (#1406) :robot: I have created a release \*beep\* \*boop\* --- * reset buffered chunked value before retry ([#1397](https://www.github.com/googleapis/nodejs-spanner/issues/1397)) ([da2ca7b](https://www.github.com/googleapis/nodejs-spanner/commit/da2ca7b15539119fada7869c206ad24460d8edfa)), closes [#1392](https://www.github.com/googleapis/nodejs-spanner/issues/1392) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). docs: fix the broken link and improve jsdocs (#1402) Fixes #1378 build(node): do not throw on deprecation (#1140) (#1408) Refs googleapis/nodejs-service-usage#22 Source-Link: googleapis/synthtool@6d26b13 Post-Processor: gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:e59b73e911585903ee6b8a1c5246e93d9e9463420f597b6eb2e4b616ee8a0fee fix(deps): require google-gax v2.17.0 (#1409) chore: release 5.9.3 (#1410) :robot: I have created a release \*beep\* \*boop\* --- * **deps:** require google-gax v2.17.0 ([#1409](https://www.github.com/googleapis/nodejs-spanner/issues/1409)) ([080d82f](https://www.github.com/googleapis/nodejs-spanner/commit/080d82f455324d2010187904532032e7905e14ac)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). feat: create instances with processing units (#1279) Only one of processing units or nodes should be specified. samples: indexing samples conform to rubric (#1347) This PR Contains Indexing Samples that covers the new Canonical format. It does not remove the old samples. Towards #1295 fix: replace projectId placeholder in formatted names (#1407) The `{{projectId}}` placeholder was only replaced in the names of the objects that were included in the requests, and not in the headers and formatted names. This would cause the `CLOUD_RESOURCE_HEADER` to be filled with the `{{projectId}}` placeholder instead of the actual value. As the actual project ID is gotten through an async method, and the constructor and `instance` methods are synchronous, we can only replace the actual values once it is retrieved for the first request. Fixes #1375 chore: release 5.10.0 (#1411) :robot: I have created a release \*beep\* \*boop\* --- * create instances with processing units ([#1279](https://www.github.com/googleapis/nodejs-spanner/issues/1279)) ([05c2135](https://www.github.com/googleapis/nodejs-spanner/commit/05c213522a32627186ad9b474b416c1b9996df1f)) * replace projectId placeholder in formatted names ([#1407](https://www.github.com/googleapis/nodejs-spanner/issues/1407)) ([4364d2b](https://www.github.com/googleapis/nodejs-spanner/commit/4364d2b25638384a6a1bea2e283b1219b4e5cdf3)), closes [#1375](https://www.github.com/googleapis/nodejs-spanner/issues/1375) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). build: auto-approve renovate-bot PRs for minor updates (#1145) (#1413) Source-Link: googleapis/synthtool@39652e3 Post-Processor: gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:41d5457ff79c3945782ab7e23bf4d617fd7bf3f2b03b6d84808010f7d2e10ca2 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> feat(spanner): add leader_options to InstanceConfig and default_leader to Database (#1414) * feat(spanner): add leader_options to InstanceConfig and default_leader to Database PiperOrigin-RevId: 382409094 Source-Link: googleapis/googleapis@2c6e4dd Source-Link: googleapis/googleapis-gen@ba248c5 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/master/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> chore: release 5.11.0 (#1415) :robot: I have created a release \*beep\* \*boop\* --- * **spanner:** add leader_options to InstanceConfig and default_leader to Database ([#1414](https://www.github.com/googleapis/nodejs-spanner/issues/1414)) ([e67adc2](https://www.github.com/googleapis/nodejs-spanner/commit/e67adc281d603d741af49d957eff05fd4184d38e)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). fix: add close method to Spanner client (#1416) Adds a close method to the Spanner client that will (try to) clean up the resources it has in use. Towards #1306 chore: release 5.11.1 (#1417) :robot: I have created a release \*beep\* \*boop\* --- * add close method to Spanner client ([#1416](https://www.github.com/googleapis/nodejs-spanner/issues/1416)) ([69cd0b4](https://www.github.com/googleapis/nodejs-spanner/commit/69cd0b474ab6c836724813fd8bea88ec2e1ac9f5)), closes [#1306](https://www.github.com/googleapis/nodejs-spanner/issues/1306) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). fix: set transaction tag after begin fix: include transactionTag for single commits
|
@asthamohta just for reference, I have internal changes pending submission to update the following samples to point to the new samples created in #1347:
Even after these changes are submitted, you may not be able to delete the old version of the sample if it's still used in the Node.js getting started guide as per #1295 (comment). Before deleting old samples, you also need to make sure that translated docs pages are picking up the new link to the sample. |
|
Got it. Thanks Shanika |
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Spanner code samples should conform to the rubric.
The text was updated successfully, but these errors were encountered: