|
| 1 | +[//]: # "This README.md file is auto-generated, all changes to this file will be lost." |
| 2 | +[//]: # "The comments you see below are used to generate those parts of the template in later states." |
| 3 | +<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"/> |
| 4 | + |
| 5 | +# [BigQuery Storage API: Nodejs Client][homepage] |
| 6 | + |
| 7 | +[//]: # "releaseLevel" |
| 8 | + |
| 9 | +[](https://www.npmjs.org/package/@google-cloud/bigquery-storage) |
| 10 | + |
| 11 | +BigQuery Storage API client for Node.js |
| 12 | + |
| 13 | +[//]: # "partials.introduction" |
| 14 | + |
| 15 | +A comprehensive list of changes in each version may be found in |
| 16 | +[the CHANGELOG][homepage_changelog]. |
| 17 | + |
| 18 | +* [BigQuery Storage API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/storage/latest) |
| 19 | +* [BigQuery Storage API Documentation](https://cloud.google.com/bigquery/docs/reference/storage/) |
| 20 | + |
| 21 | +Read more about the client libraries for Cloud APIs, including the older |
| 22 | +Google APIs Client Libraries, in [Client Libraries Explained][explained]. |
| 23 | + |
| 24 | +[explained]: https://cloud.google.com/apis/docs/client-libraries-explained |
| 25 | + |
| 26 | +**Table of contents:** |
| 27 | + |
| 28 | +* [Quickstart](#quickstart) |
| 29 | + * [Before you begin](#before-you-begin) |
| 30 | + * [Installing the client library](#installing-the-client-library) |
| 31 | + |
| 32 | +* [Versioning](#versioning) |
| 33 | +* [Contributing](#contributing) |
| 34 | +* [License](#license) |
| 35 | + |
| 36 | +## Quickstart |
| 37 | +### Before you begin |
| 38 | + |
| 39 | +1. [Select or create a Cloud Platform project][projects]. |
| 40 | +1. [Enable billing for your project][billing]. |
| 41 | +1. [Enable the BigQuery Storage API API][enable_api]. |
| 42 | +1. [Set up authentication][auth] so you can access the |
| 43 | + API from your local workstation. |
| 44 | +### Installing the client library |
| 45 | + |
| 46 | +```bash |
| 47 | +npm install @google-cloud/bigquery-storage |
| 48 | +``` |
| 49 | + |
| 50 | +[//]: # "partials.body" |
| 51 | + |
| 52 | +## Samples |
| 53 | + |
| 54 | +Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample. |
| 55 | + |
| 56 | +[//]: # "samples" |
| 57 | + |
| 58 | +## Supported Node.js Versions |
| 59 | + |
| 60 | +Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule). |
| 61 | +Libraries are compatible with all current _active_ and _maintenance_ versions of |
| 62 | +Node.js. |
| 63 | +If you are using an end-of-life version of Node.js, we recommend that you update |
| 64 | +as soon as possible to an actively supported LTS version. |
| 65 | + |
| 66 | +Google's client libraries support legacy versions of Node.js runtimes on a |
| 67 | +best-efforts basis with the following warnings: |
| 68 | + |
| 69 | +* Legacy versions are not tested in continuous integration. |
| 70 | +* Some security patches and features cannot be backported. |
| 71 | +* Dependencies cannot be kept up-to-date. |
| 72 | + |
| 73 | +Client libraries targeting some end-of-life versions of Node.js are available, and |
| 74 | +can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag). |
| 75 | +The dist-tags follow the naming convention `legacy-(version)`. |
| 76 | +For example, `npm install @google-cloud/bigquery-storage@legacy-8` installs client libraries |
| 77 | +for versions compatible with Node.js 8. |
| 78 | + |
| 79 | +## Versioning |
| 80 | + |
| 81 | +This library follows [Semantic Versioning](http://semver.org/). |
| 82 | + |
| 83 | +More Information: [Google Cloud Platform Launch Stages][launch_stages] |
| 84 | + |
| 85 | +[launch_stages]: https://cloud.google.com/terms/launch-stages |
| 86 | + |
| 87 | +## Contributing |
| 88 | + |
| 89 | +Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md). |
| 90 | + |
| 91 | +Please note that this `README.md` |
| 92 | +and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`) |
| 93 | +are generated from a central template. |
| 94 | + |
| 95 | +## License |
| 96 | + |
| 97 | +Apache Version 2.0 |
| 98 | + |
| 99 | +See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE) |
| 100 | + |
| 101 | +[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png |
| 102 | +[projects]: https://console.cloud.google.com/project |
| 103 | +[billing]: https://support.google.com/cloud/answer/6293499#enable-billing |
| 104 | +[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=bigquerystorage.googleapis.com |
| 105 | +[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local |
| 106 | +[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-storage/samples |
| 107 | +[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-storage/CHANGELOG.md |
| 108 | +[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-storage |
0 commit comments