@google-cloud/bigquery-storage-api 0.1.0

package/README.md

@@ -0,0 +1,111 @@
+[//]: # "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]
+
+> [!IMPORTANT]
+> **Internal API Client**: This library (`@google-cloud/bigquery-storage-api`) is an auto-generated, lightweight GAPIC layer designed as a dependency for the official handwritten client library. End users should install and import **[@google-cloud/bigquery-storage](https://www.npmjs.com/package/@google-cloud/bigquery-storage)** instead.
+
+[//]: # "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-api/samples
+[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-storage-api/CHANGELOG.md
+[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-storage-api

package/build/protos/google/cloud/bigquery/storage/v1/annotations.proto

@@ -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;
+}

package/build/protos/google/cloud/bigquery/storage/v1/arrow.proto

@@ -0,0 +1,89 @@
+// Copyright 2025 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
+//
+//     http://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.
+
+syntax = "proto3";
+
+package google.cloud.bigquery.storage.v1;
+
+option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
+option java_multiple_files = true;
+option java_outer_classname = "ArrowProto";
+option java_package = "com.google.cloud.bigquery.storage.v1";
+option php_namespace = "Google\\Cloud\\BigQuery\\Storage\\V1";
+
+// Arrow schema as specified in
+// https://arrow.apache.org/docs/python/api/datatypes.html
+// and serialized to bytes using IPC:
+// https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc
+//
+// See code samples on how this message can be deserialized.
+message ArrowSchema {
+  // IPC serialized Arrow schema.
+  bytes serialized_schema = 1;
+}
+
+// Arrow RecordBatch.
+message ArrowRecordBatch {
+  // IPC-serialized Arrow RecordBatch.
+  bytes serialized_record_batch = 1;
+
+  // [Deprecated] The count of rows in `serialized_record_batch`.
+  // Please use the format-independent ReadRowsResponse.row_count instead.
+  int64 row_count = 2 [deprecated = true];
+}
+
+// Contains options specific to Arrow Serialization.
+message ArrowSerializationOptions {
+  // Compression codec's supported by Arrow.
+  enum CompressionCodec {
+    // If unspecified no compression will be used.
+    COMPRESSION_UNSPECIFIED = 0;
+
+    // LZ4 Frame (https://github.com/lz4/lz4/blob/dev/doc/lz4_Frame_format.md)
+    LZ4_FRAME = 1;
+
+    // Zstandard compression.
+    ZSTD = 2;
+  }
+
+  // The precision of the timestamp value in the Avro message. This precision
+  // will **only** be applied to the column(s) with the `TIMESTAMP_PICOS` type.
+  enum PicosTimestampPrecision {
+    // Unspecified timestamp precision. The default precision is microseconds.
+    PICOS_TIMESTAMP_PRECISION_UNSPECIFIED = 0;
+
+    // Timestamp values returned by Read API will be truncated to microsecond
+    // level precision. The value will be encoded as Arrow TIMESTAMP type in a
+    // 64 bit integer.
+    TIMESTAMP_PRECISION_MICROS = 1;
+
+    // Timestamp values returned by Read API will be truncated to nanosecond
+    // level precision. The value will be encoded as Arrow TIMESTAMP type in a
+    // 64 bit integer.
+    TIMESTAMP_PRECISION_NANOS = 2;
+
+    // Read API will return full precision picosecond value. The value will be
+    // encoded as a string which conforms to ISO 8601 format.
+    TIMESTAMP_PRECISION_PICOS = 3;
+  }
+
+  // The compression codec to use for Arrow buffers in serialized record
+  // batches.
+  CompressionCodec buffer_compression = 2;
+
+  // Optional. Set timestamp precision option. If not set, the default precision
+  // is microseconds.
+  PicosTimestampPrecision picos_timestamp_precision = 3;
+}

package/build/protos/google/cloud/bigquery/storage/v1/avro.proto

@@ -0,0 +1,81 @@
+// Copyright 2025 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
+//
+//     http://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.
+
+syntax = "proto3";
+
+package google.cloud.bigquery.storage.v1;
+
+option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
+option java_multiple_files = true;
+option java_outer_classname = "AvroProto";
+option java_package = "com.google.cloud.bigquery.storage.v1";
+option php_namespace = "Google\\Cloud\\BigQuery\\Storage\\V1";
+
+// Avro schema.
+message AvroSchema {
+  // Json serialized schema, as described at
+  // https://avro.apache.org/docs/1.8.1/spec.html.
+  string schema = 1;
+}
+
+// Avro rows.
+message AvroRows {
+  // Binary serialized rows in a block.
+  bytes serialized_binary_rows = 1;
+
+  // [Deprecated] The count of rows in the returning block.
+  // Please use the format-independent ReadRowsResponse.row_count instead.
+  int64 row_count = 2 [deprecated = true];
+}
+
+// Contains options specific to Avro Serialization.
+message AvroSerializationOptions {
+  // The precision of the timestamp value in the Avro message. This precision
+  // will **only** be applied to the column(s) with the `TIMESTAMP_PICOS` type.
+  enum PicosTimestampPrecision {
+    // Unspecified timestamp precision. The default precision is microseconds.
+    PICOS_TIMESTAMP_PRECISION_UNSPECIFIED = 0;
+
+    // Timestamp values returned by Read API will be truncated to microsecond
+    // level precision. The value will be encoded as Avro TIMESTAMP type in a
+    // 64 bit integer.
+    TIMESTAMP_PRECISION_MICROS = 1;
+
+    // Timestamp values returned by Read API will be truncated to nanosecond
+    // level precision. The value will be encoded as Avro TIMESTAMP type in a
+    // 64 bit integer.
+    TIMESTAMP_PRECISION_NANOS = 2;
+
+    // Read API will return full precision picosecond value. The value will be
+    // encoded as a string which conforms to ISO 8601 format.
+    TIMESTAMP_PRECISION_PICOS = 3;
+  }
+
+  // Enable displayName attribute in Avro schema.
+  //
+  // The Avro specification requires field names to be alphanumeric.  By
+  // default, in cases when column names do not conform to these requirements
+  // (e.g. non-ascii unicode codepoints) and Avro is requested as an output
+  // format, the CreateReadSession call will fail.
+  //
+  // Setting this field to true, populates avro field names with a placeholder
+  // value and populates a "displayName" attribute for every avro field with the
+  // original column name.
+  bool enable_display_name_attribute = 1;
+
+  // Optional. Set timestamp precision option. If not set, the default precision
+  // is microseconds.
+  PicosTimestampPrecision picos_timestamp_precision = 2;
+}

package/build/protos/google/cloud/bigquery/storage/v1/protobuf.proto

@@ -0,0 +1,48 @@
+// Copyright 2025 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
+//
+//     http://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.
+
+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_multiple_files = true;
+option java_outer_classname = "ProtoBufProto";
+option java_package = "com.google.cloud.bigquery.storage.v1";
+option php_namespace = "Google\\Cloud\\BigQuery\\Storage\\V1";
+
+// ProtoSchema describes the schema of the serialized protocol buffer data rows.
+message ProtoSchema {
+  // Descriptor for input message.  The provided descriptor must be self
+  // contained, such that data rows sent can be fully decoded using only the
+  // single descriptor.  For data rows that are compositions of multiple
+  // independent messages, this means the descriptor may need to be transformed
+  // to only use nested types:
+  // https://developers.google.com/protocol-buffers/docs/proto#nested
+  //
+  // For additional information for how proto types and values map onto BigQuery
+  // see: https://cloud.google.com/bigquery/docs/write-api#data_type_conversions
+  google.protobuf.DescriptorProto proto_descriptor = 1;
+}
+
+message ProtoRows {
+  // A sequence of rows serialized as a Protocol Buffer.
+  //
+  // See https://developers.google.com/protocol-buffers/docs/overview for more
+  // information on deserializing this field.
+  repeated bytes serialized_rows = 1;
+}