|
| 1 | +Confluent's Javascript Client for Schema Registry<sup>TM</sup> |
| 2 | +===================================================== |
| 3 | + |
| 4 | +**confluent-kafka-javascript** includes Confluent's JavaScript client for [Schema Registry](https://docs.confluent.io/cloud/current/sr/index.html) and the accompanying package to Confluent's Javascript Client for Apache Kafka |
| 5 | +[Confluent's Javascript Client for Apache Kafka](https://www.npmjs.com/package/@confluentinc/kafka-javascript). This is an **Early Availability** library. The goal is to provide an highly performant, reliable and easy to use JavaScript client in line with other clients such as our [Go](https://github.com/confluentinc/confluent-kafka-go) and [Python](https://github.com/confluentinc/confluent-kafka-python) clients. |
| 6 | + |
| 7 | +<!-- Features: |
| 8 | +- **High performance** - confluent-kafka-javascript is a lightweight wrapper around |
| 9 | +[librdkafka](https://github.com/confluentinc/librdkafka), a finely tuned C |
| 10 | +client. |
| 11 | +- **Reliability** - There are a lot of details to get right when writing an Apache Kafka |
| 12 | +client. We get them right in one place (librdkafka) and leverage this work |
| 13 | +across all of our clients. |
| 14 | +- **Supported** - Commercial support is offered by [Confluent](https://confluent.io/). |
| 15 | +- **Future proof** - Confluent, founded by the |
| 16 | +creators of Kafka, is building a [streaming platform](https://www.confluent.io/product/) |
| 17 | +with Apache Kafka at its core. It's high priority for us that client features keep |
| 18 | +pace with core Apache Kafka and components of the [Confluent Platform](https://www.confluent.io/product/). |
| 19 | +This library leverages the work and concepts from two popular Apache Kafka JavaScript clients: [node-rdkafka](https://github.com/Blizzard/node-rdkafka) and [KafkaJS](https://github.com/tulios/kafkajs). The core is heavily based on the node-rdkafka library, which uses our own [librdkafka](https://github.com/confluentinc/librdkafka) library for core client functionality. However, we leverage a promisified API and a more idiomatic interface, similar to the one in KafkaJS, making it easy for developers to migrate and adopt this client depending on the patterns and interface they prefer. We're very happy to have been able to leverage the excellent work of the many authors of these libraries! |
| 20 | +### This library is currently in limited-availability - it is supported for all usage but for the schema-registry client. |
| 21 | +To use **Schema Registry**, use the existing [kafkajs/confluent-schema-registry](https://github.com/kafkajs/confluent-schema-registry) library that is compatible with this library. For a simple schema registry example, see [sr.js](https://github.com/confluentinc/confluent-kafka-javascript/blob/dev_early_access_development_branch/examples/kafkajs/sr.js). |
| 22 | +**DISCLAIMER:** Although it is compatible with **confluent-kafka-javascript**, Confluent does not own or maintain kafkajs/confluent-schema-registry, and the use and functionality of the library should be considered "as is". |
| 23 | +## Requirements |
| 24 | +The following configurations are supported: |
| 25 | +* Any supported version of Node.js (The two LTS versions, 18 and 20, and the latest versions, 21 and 22). |
| 26 | +* Linux (x64 and arm64) - both glibc and musl/alpine. |
| 27 | +* macOS - arm64/m1. |
| 28 | +* Windows - x64. |
| 29 | +Installation on any of these platforms is meant to be seamless, without any C/C++ compilation required. |
| 30 | +In case your system configuration is not within the supported ones, [a supported version of Python](https://devguide.python.org/versions/) must be available on the system for the installation process. [This is required for the `node-gyp` build tool.](https://github.com/nodejs/node-gyp?tab=readme-ov-file#configuring-python-dependency). |
| 31 | +```bash |
| 32 | +npm install @confluentinc/kafka-javascript |
| 33 | +``` |
| 34 | +Yarn and pnpm support is experimental. |
| 35 | +# Getting Started |
| 36 | +Below is a simple produce example for users migrating from KafkaJS. |
| 37 | +```javascript |
| 38 | +// require('kafkajs') is replaced with require('@confluentinc/kafka-javascript').KafkaJS. |
| 39 | +const { Kafka } = require("@confluentinc/kafka-javascript").KafkaJS; |
| 40 | +async function producerStart() { |
| 41 | + const kafka = new Kafka({ |
| 42 | + kafkaJS: { |
| 43 | + brokers: ['<fill>'], |
| 44 | + ssl: true, |
| 45 | + sasl: { |
| 46 | + mechanism: 'plain', |
| 47 | + username: '<fill>', |
| 48 | + password: '<fill>', |
| 49 | + }, |
| 50 | + } |
| 51 | + }); |
| 52 | + const producer = kafka.producer(); |
| 53 | + await producer.connect(); |
| 54 | + console.log("Connected successfully"); |
| 55 | + const res = [] |
| 56 | + for (let i = 0; i < 50; i++) { |
| 57 | + res.push(producer.send({ |
| 58 | + topic: 'test-topic', |
| 59 | + messages: [ |
| 60 | + { value: 'v222', partition: 0 }, |
| 61 | + { value: 'v11', partition: 0, key: 'x' }, |
| 62 | + ] |
| 63 | + })); |
| 64 | + } |
| 65 | + await Promise.all(res); |
| 66 | + await producer.disconnect(); |
| 67 | + console.log("Disconnected successfully"); |
| 68 | +} |
| 69 | +producerStart(); |
| 70 | +``` |
| 71 | +1. If you're migrating from `kafkajs`, you can use the [migration guide](MIGRATION.md#kafkajs). |
| 72 | +2. If you're migrating from `node-rdkafka`, you can use the [migration guide](MIGRATION.md#node-rdkafka). |
| 73 | +3. If you're starting afresh, you can use the [quickstart guide](QUICKSTART.md). |
| 74 | +An in-depth reference may be found at [INTRODUCTION.md](INTRODUCTION.md). --> |
| 75 | + |
| 76 | +## Contributing |
| 77 | + |
| 78 | +Bug reports and feedback is appreciated in the form of Github Issues. |
| 79 | +For guidelines on contributing please see [CONTRIBUTING.md](CONTRIBUTING.md) |
0 commit comments