@google-cloud/pubsub

Cloud Pub/Sub Client Library for Node.js

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@google-cloud/pubsub
510294.3.322 days ago8 years agoMinified + gzip package size for @google-cloud/pubsub in KB

Readme

Google Cloud Platform logorelease level npm version
Cloud Pub/Sub is a fully-managed real-time messaging service that allows you to send and receive messages between independent applications.
This document contains links to an API reference, samples, and other resources useful to developing Node.js applications. For additional help developing Pub/Sub applications, in Node.js and other languages, see our Pub/Sub quickstart, publisher, and subscriber guides.
A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explainedexplained.
Table of contents:
Before you begin Installing the client library Using the client library

Quickstart

Before you begin

  1. Select or create a Cloud Platform projectprojects.
  2. Enable billing for your projectbilling.
  3. Enable the Google Cloud Pub/Sub APIenableapi.
  4. Set up authentication with a service accountauth so you can access the
API from your local workstation.

Installing the client library

npm install @google-cloud/pubsub

Using the client library

// Imports the Google Cloud client library
const {PubSub} = require('@google-cloud/pubsub');

async function quickstart(
  projectId = 'your-project-id', // Your Google Cloud Platform project ID
  topicNameOrId = 'my-topic', // Name for the new topic to create
  subscriptionName = 'my-sub' // Name for the new subscription to create
) {
  // Instantiates a client
  const pubsub = new PubSub({projectId});

  // Creates a new topic
  const [topic] = await pubsub.createTopic(topicNameOrId);
  console.log(`Topic ${topic.name} created.`);

  // Creates a subscription on that new topic
  const [subscription] = await topic.createSubscription(subscriptionName);

  // Receive callbacks for new messages on the subscription
  subscription.on('message', message => {
    console.log('Received message:', message.data.toString());
    process.exit(0);
  });

  // Receive callbacks for errors on the subscription
  subscription.on('error', error => {
    console.error('Received error:', error);
    process.exit(1);
  });

  // Send a message to the topic
  topic.publishMessage({data: Buffer.from('Test message!')});
}

Running gRPC C++ bindings

For some workflows and environments it might make sense to use the C++ gRPC implementation, instead of the default one (see: #770):
To configure @google-cloud/pubsub to use an alternative grpc transport:
  1. npm install grpc, adding grpc as a dependency.
  2. instantiate @google-cloud/pubsub with grpc:
```js
const {PubSub} = require('@google-cloud/pubsub');
const grpc = require('grpc');
const pubsub = new PubSub({grpc});
```

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Commit an Avro-Based Schema | source code | !Open in Cloud Shellshellimg | | Commit an Proto-Based Schema | source code | !Open in Cloud Shellshellimg | | Create an Avro based Schema | source code | !Open in Cloud Shellshellimg | | Create BigQuery Subscription | source code | !Open in Cloud Shellshellimg | | Create a Proto based Schema | source code | !Open in Cloud Shellshellimg | | Create Push Subscription | source code | !Open in Cloud Shellshellimg | | Create Push Subscription With No Wrapper | source code | !Open in Cloud Shellshellimg | | Create Subscription | source code | !Open in Cloud Shellshellimg | | Create Subscription With Dead Letter Policy | source code | !Open in Cloud Shellshellimg | | Create an exactly-once delivery subscription | source code | !Open in Cloud Shellshellimg | | Create Subscription With Filtering | source code | !Open in Cloud Shellshellimg | | Create Subscription with ordering enabled | source code | !Open in Cloud Shellshellimg | | Create Subscription With Retry Policy | source code | !Open in Cloud Shellshellimg | | Create Topic | source code | !Open in Cloud Shellshellimg | | Create Topic With Schema | source code | !Open in Cloud Shellshellimg | | Create Topic With Schema Revisions | source code | !Open in Cloud Shellshellimg | | Delete a previously created schema | source code | !Open in Cloud Shellshellimg | | Delete a Schema Revision | source code | !Open in Cloud Shellshellimg | | Delete Subscription | source code | !Open in Cloud Shellshellimg | | Delete Topic | source code | !Open in Cloud Shellshellimg | | Detach Subscription | source code | !Open in Cloud Shellshellimg | | Get a previously created schema | source code | !Open in Cloud Shellshellimg | | Get a previously created schema revision | source code | !Open in Cloud Shellshellimg | | Get Subscription | source code | !Open in Cloud Shellshellimg | | Get Subscription Policy | source code | !Open in Cloud Shellshellimg | | Get Topic Policy | source code | !Open in Cloud Shellshellimg | | List All Topics | source code | !Open in Cloud Shellshellimg | | List Revisions on a Schema | source code | !Open in Cloud Shellshellimg | | List schemas on a project | source code | !Open in Cloud Shellshellimg | | List Subscriptions | source code | !Open in Cloud Shellshellimg | | List Subscriptions On a Topic | source code | !Open in Cloud Shellshellimg | | Listen For Avro Records | source code | !Open in Cloud Shellshellimg | | Listen For Avro Records With Revisions | source code | !Open in Cloud Shellshellimg | | Listen For Errors | source code | !Open in Cloud Shellshellimg | | Listen For Messages | source code | !Open in Cloud Shellshellimg | | Listen with exactly-once delivery | source code | !Open in Cloud Shellshellimg | | Listen For Protobuf Messages | source code | !Open in Cloud Shellshellimg | | Listen For Messages With Custom Attributes | source code | !Open in Cloud Shellshellimg | | Modify Push Configuration | source code | !Open in Cloud Shellshellimg | | OpenTelemetry Tracing | source code | !Open in Cloud Shellshellimg | | Publish Avro Records to a Topic | source code | !Open in Cloud Shellshellimg | | Publish Batched Messages | source code | !Open in Cloud Shellshellimg | | Publish Message | source code | !Open in Cloud Shellshellimg | | Publish Message With Custom Attributes | source code | !Open in Cloud Shellshellimg | | Publish Ordered Message | source code | !Open in Cloud Shellshellimg | | Publish Protobuf Messages to a Topic | source code | !Open in Cloud Shellshellimg | | Publish with flow control | source code | !Open in Cloud Shellshellimg | | Publish With Retry Settings | source code | !Open in Cloud Shellshellimg | | Quickstart | source code | !Open in Cloud Shellshellimg | | Remove Dead Letter Policy | source code | !Open in Cloud Shellshellimg | | Resume Publish | source code | !Open in Cloud Shellshellimg | | Rollback a Schema | source code | !Open in Cloud Shellshellimg | | Set Subscription IAM Policy | source code | !Open in Cloud Shellshellimg | | Set Topic IAM Policy | source code | !Open in Cloud Shellshellimg | | Subscribe With Flow Control Settings | source code | !Open in Cloud Shellshellimg | | Synchronous Pull | source code | !Open in Cloud Shellshellimg | | Synchronous Pull with delivery attempt. | source code | !Open in Cloud Shellshellimg | | Synchronous Pull With Lease Management | source code | !Open in Cloud Shellshellimg | | Test Subscription Permissions | source code | !Open in Cloud Shellshellimg | | Test Topic Permissions | source code | !Open in Cloud Shellshellimg | | Update Dead Letter Policy | source code | !Open in Cloud Shellshellimg | | Update Topic Schema | source code | !Open in Cloud Shellshellimg | | Validate a schema definition | source code | !Open in Cloud Shellshellimg |
The Google Cloud Pub/Sub Node.js Client API Referenceclient-docs documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js 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. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/pubsub@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.
This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stageslaunchstages

Contributing

Contributions welcome! See the Contributing Guide.
Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0
See LICENSE