Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring Avro schema for Kafka data set

Updated on May 17, 2024

When you configure a Kafka data set, you can choose Apache Avro as your data format for the Kafka message values and message keys. Avro is a lightweight binary message encoding, which relies on schemas to structure the encoded data.

Avro schemas are held in external storage. Your keys and values may have different schemas, which are stored in different registries. Configure an Avro schema by following the steps below.

For more information, see the Apache Avro documentation.

Before you begin: Open your Kafka data set creation form. If you do not have the Kafka data set creation form opened, follow the instructions here: Creating a Kafka data set.
  1. On your Kafka data set creation form, in the Message values or Message keys section, select Avro from the Data format list.
  2. Click the Open icon next to the Avro schema field.
  3. In the Short description field, enter a short description or title.
  4. In the Avro schema field, enter an Avro schema name.
    Your Avro schema name must start with a letter.
  5. Click Create and Oopen.
  6. In the Schema registry section, in the URL field, enter the URL of the registry in which you want to store the schema.
  7. In the Authentication source section, select the authentication option for the registry.
    • To disable authentication, select No authentication.
    • To enable authentication, select Authentication, and then enter a user name and password.
  8. Optional: To associate keys and values with your Avro schema, click Add key-value pair.
  9. Optional: To upload your Avro schema, click the Upload schema button.
    Important: The Avro schema must be in JSON format. The schema file must use the .json extension.
  10. Optional: To use versioning of the schemas, select the Perform schema evolution when reading messages check box. Click Upload different schema, and then upload your second schema.
    Schema evolution ensures backward compatibility of the updated schema with the previous schemas.
  11. Click Save.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us