xk6-kafka

---

Class: SchemaRegistry

Defined in: index.d.ts:496

Classdesc

Schema Registry is a client for Schema Registry and handles serdes.

Example

// In init context
const writer = new Writer({
  brokers: ["localhost:9092"],
  topic: "my-topic",
  autoCreateTopic: true,
});

const schemaRegistry = new SchemaRegistry({
  url: "localhost:8081",
});

const keySchema = schemaRegistry.createSchema({
  version: 0,
  element: KEY,
  subject: "...",
  schema: "...",
  schemaType: "AVRO",
});

const valueSchema = schemaRegistry.createSchema({
  version: 0,
  element: VALUE,
  subject: "...",
  schema: "...",
  schemaType: "AVRO",
});

// In VU code (default function)
writer.produce({
  messages: [
    {
      key: schemaRegistry.serialize({
        data: "key",
        schema: keySchema,
        schemaType: SCHEMA_TYPE_AVRO,
      }),
      value: schemaRegistry.serialize({
        data: "value",
        schema: valueSchema,
        schemaType: SCHEMA_TYPE_AVRO,
      }),
    },
  ],
});

Constructors

Constructor

new SchemaRegistry(schemaRegistryConfig): SchemaRegistry

Defined in: index.d.ts:503

Parameters

schemaRegistryConfig

SchemaRegistryConfig

Schema Registry configuration.

Returns

SchemaRegistry

• SchemaRegistry instance.

Methods

createSchema()

createSchema(schema): Schema

Defined in: index.d.ts:517

Parameters

schema

Schema

Schema configuration.

Returns

Schema

• Schema.

Method

Create or update a schema on Schema Registry.

---

deserialize()

deserialize(container): any

Defined in: index.d.ts:538

Parameters

container

Container

Container including data, schema and schemaType.

Returns

any

• Deserialized data as string, byte array or JSON object.

Method

Deserializes the given data and schema into its original form.

---

getSchema()

getSchema(schema): Schema

Defined in: index.d.ts:510

Parameters

schema

Schema

Schema configuration.

Returns

Schema

• Schema.

Method

Get a schema from Schema Registry by version and subject.

---

getSubjectName()

getSubjectName(subjectNameConfig): string

Defined in: index.d.ts:524

Parameters

subjectNameConfig

SubjectNameConfig

Subject name configuration.

Returns

string

• Subject name.

Method

Returns the subject name for the given SubjectNameConfig.

---

serialize()

serialize(container): Uint8Array

Defined in: index.d.ts:531

Parameters

container

Container

Container including data, schema and schemaType.

Returns

Uint8Array

• Serialized data as byte array.

Method

Serializes the given data and schema into a byte array.