Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion librarian.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
language: nodejs
version: v0.24.0
version: v0.25.0
repo: googleapis/google-cloud-node
sources:
googleapis:
Expand Down Expand Up @@ -536,6 +536,13 @@ libraries:
copyright_year: "2026"
nodejs:
default_version: v1
- name: google-cloud-bigquery-storage-api
version: 1.0.0
apis:
- path: google/cloud/bigquery/storage/v1
copyright_year: "2026"
nodejs:
package_name: '@google-cloud/bigquery-storage-api'
Comment on lines +544 to +545

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.

high

To avoid naming conflicts with the existing google-cloud-bigquery-storage library (which already uses the metadata name bigquerystorage and pretty name BigQuery Storage), please configure metadata_name_override and name_pretty_override in librarian.yaml under the nodejs section. This will also fix the auto-generated documentation and repository links in the README.md which currently incorrectly point to google-cloud-bigquery-storage instead of google-cloud-bigquery-storage-api.

    nodejs:
      package_name: '@google-cloud/bigquery-storage-api'
      metadata_name_override: bigquerystorage-api
      name_pretty_override: BigQuery Storage API
References
  1. To override the metadata name and pretty name for a library to avoid naming conflicts, configure metadata_name_override and name_pretty_override in librarian.yaml instead of manually editing the generated .repo-metadata.json file.

- name: google-cloud-billing
version: 5.1.2
apis:
Expand Down
14 changes: 14 additions & 0 deletions packages/google-cloud-bigquery-storage-api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
**/*.log
**/node_modules
/.coverage
/coverage
/.nyc_output
/docs/
/out/
/build/
system-test/secrets.js
system-test/*key.json
*.lock
.DS_Store
package-lock.json
__pycache__
55 changes: 55 additions & 0 deletions packages/google-cloud-bigquery-storage-api/.jsdoc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// 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.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **

'use strict';

module.exports = {
opts: {
readme: './README.md',
package: './package.json',
template: './node_modules/jsdoc-fresh',
recurse: true,
verbose: true,
destination: './docs/'
},
plugins: [
'plugins/markdown',
'jsdoc-region-tag'
],
source: {
excludePattern: '(^|\\/|\\\\)[._]',
include: [
'build/src',
'protos'
],
includePattern: '\\.js$'
},
templates: {
copyright: 'Copyright 2026 Google LLC',
includeDate: false,
sourceFiles: false,
systemName: '@google-cloud/bigquery-storage-api',
theme: 'lumen',
default: {
outputSourceFiles: false
}
},
markdown: {
idInHeadings: true
}
};
24 changes: 24 additions & 0 deletions packages/google-cloud-bigquery-storage-api/.nycrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"report-dir": "./.coverage",
"reporter": ["text", "lcov"],
"exclude": [
"**/*-test",
"**/.coverage",
"**/apis",
"**/benchmark",
"**/conformance",
"**/docs",
"**/samples",
"**/scripts",
"**/protos",
"**/test",
"**/*.d.ts",
".jsdoc.js",
"**/.jsdoc.js",
"karma.conf.js",
"webpack-tests.config.js",
"webpack.config.js"
],
"exclude-after-remap": false,
"all": true
}
15 changes: 15 additions & 0 deletions packages/google-cloud-bigquery-storage-api/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"api_id": "bigquerystorage.googleapis.com",
"api_shortname": "bigquerystorage",
"client_documentation": "https://cloud.google.com/nodejs/docs/reference/bigquery-storage-api/latest",
"default_version": "v1",
"distribution_name": "@google-cloud/bigquery-storage-api",
"issue_tracker": "https://issuetracker.google.com/issues/new?component=187149&template=1162659",
"language": "nodejs",
"library_type": "GAPIC_AUTO",
"name": "bigquerystorage",
"name_pretty": "BigQuery Storage",
"product_documentation": "https://cloud.google.com/bigquery/docs",
"release_level": "stable",
"repo": "googleapis/google-cloud-node"
}
108 changes: 108 additions & 0 deletions packages/google-cloud-bigquery-storage-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "The comments you see below are used to generate those parts of the template in later states."
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>

# [BigQuery Storage API: Nodejs Client][homepage]

[//]: # "releaseLevel"

[![npm version](https://img.shields.io/npm/v/@google-cloud/bigquery-storage-api.svg)](https://www.npmjs.org/package/@google-cloud/bigquery-storage-api)

BigQuery Storage API client for Node.js

[//]: # "partials.introduction"

A comprehensive list of changes in each version may be found in
[the CHANGELOG][homepage_changelog].

* [BigQuery Storage API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/storage/latest)
* [BigQuery Storage API Documentation](https://cloud.google.com/bigquery/docs/reference/storage/)

Read more about the client libraries for Cloud APIs, including the older
Google APIs Client Libraries, in [Client Libraries Explained][explained].

[explained]: https://cloud.google.com/apis/docs/client-libraries-explained

**Table of contents:**

* [Quickstart](#quickstart)
* [Before you begin](#before-you-begin)
* [Installing the client library](#installing-the-client-library)

* [Versioning](#versioning)
* [Contributing](#contributing)
* [License](#license)

## Quickstart
### Before you begin

1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the BigQuery Storage API API][enable_api].
1. [Set up authentication][auth] so you can access the
API from your local workstation.
### Installing the client library

```bash
npm install @google-cloud/bigquery-storage-api
```

[//]: # "partials.body"

## Samples

Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.

[//]: # "samples"

## Supported Node.js Versions

Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).
Libraries are compatible with all current _active_ and _maintenance_ versions of
Node.js.
If you are using an end-of-life version of Node.js, we recommend that you update
as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a
best-efforts basis with the following warnings:

* Legacy versions are not tested in continuous integration.
* Some security patches and features cannot be backported.
* Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
The dist-tags follow the naming convention `legacy-(version)`.
For example, `npm install @google-cloud/bigquery-storage-api@legacy-8` installs client libraries
for versions compatible with Node.js 8.

## Versioning

This library follows [Semantic Versioning](http://semver.org/).

More Information: [Google Cloud Platform Launch Stages][launch_stages]

[launch_stages]: https://cloud.google.com/terms/launch-stages

## Contributing

Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).

Please note that this `README.md`
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
are generated from a central template.

## License

Apache Version 2.0

See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)

[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=bigquerystorage.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-storage/samples
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-storage/CHANGELOG.md
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-storage
63 changes: 63 additions & 0 deletions packages/google-cloud-bigquery-storage-api/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
{
"name": "@google-cloud/bigquery-storage-api",
"version": "0.1.0",
"description": "Storage client for Node.js",
"repository": {
"type": "git",
"directory": "packages/google-cloud-bigquery-storage-api",
"url": "https://github.com/googleapis/google-cloud-node.git"
},
"license": "Apache-2.0",
"author": "Google LLC",
"main": "build/src/index.js",
"files": [
"build/src",
"build/protos"
],
"keywords": [
"google apis client",
"google api client",
"google apis",
"google api",
"google",
"google cloud platform",
"google cloud",
"cloud",
"google storage",
"storage",
"big query read",
"big query write"
],
"scripts": {
"clean": "gts clean",
"compile": "tsc -p . && cp -r protos build/ && minifyProtoJson",
"compile-protos": "compileProtos src",
"docs": "jsdoc -c .jsdoc.js",
"fix": "gts fix",
"lint": "gts check",
"prepare": "npm run compile-protos && npm run compile",
"system-test": "c8 mocha --config ../../.mocharc.cjs --no-parallel build/system-test",
"test": "c8 mocha --config ../../.mocharc.cjs build/test"
},
"dependencies": {
"google-gax": "^5.1.1-rc.1"
},
"devDependencies": {
"@types/mocha": "^10.0.10",
"@types/node": "^22.18.12",
"@types/sinon": "^20.0.0",
"c8": "^10.1.3",
"gapic-tools": "^1.0.3",
"gts": "^6.0.2",
"jsdoc": "^4.0.5",
"jsdoc-fresh": "^5.0.2",
"jsdoc-region-tag": "^4.0.1",
"mocha": "^11.7.4",
"pack-n-play": "^4.2.1",
"typescript": "5.8.3",
"sinon": "^20.0.0"
},
"engines": {
"node": ">=18"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
syntax = "proto3";

package google.cloud.bigquery.storage.v1;

import "google/protobuf/descriptor.proto";

option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
option java_package = "com.google.cloud.bigquery.storage.v1";
option java_multiple_files = true;
option java_outer_classname = "AnnotationsProto";
option php_namespace = "Google\\Cloud\\BigQuery\\Storage\\V1";

extend google.protobuf.FieldOptions {
// Setting the column_name extension allows users to reference
// bigquery column independently of the field name in the protocol buffer
// message.
//
// The intended use of this annotation is to reference a destination column
// named using characters unavailable for protobuf field names (e.g. unicode
// characters).
//
// More details about BigQuery naming limitations can be found here:
// https://cloud.google.com/bigquery/docs/schemas#column_names
//
// This extension is currently experimental.
optional string column_name = 454943157;
}
Loading
Loading