Avro schema definition in Kafka - Mini Project: Build & Apply

Avro Schema Definition for Kafka

📖 Scenario: You are working on a Kafka project where you need to define a data schema using Avro. This schema will describe the structure of messages sent to a Kafka topic about user information.

🎯 Goal: Create an Avro schema that defines a record for user data with specific fields and types.

📋 What You'll Learn

Define an Avro schema as a JSON string

Include a record named User

Add fields name (string), age (int), and email (string)

Set the namespace to com.example.kafka

💡 Why This Matters

🌍 Real World

Avro schemas are used to define the structure of data sent through Kafka topics, ensuring producers and consumers agree on the data format.

💼 Career

Understanding Avro schema definition is important for roles involving data engineering, streaming data pipelines, and Kafka-based system development.

1

Create the basic Avro schema structure

Create a variable called user_schema and assign it a JSON string that starts with { and includes "type": "record" and "name": "User".

Kafka

# Your code here

Hint

Start by creating a string that looks like a JSON object with type and name keys.

2

Add the namespace to the schema

Update the user_schema string to include the "namespace": "com.example.kafka" key-value pair inside the JSON object.

Kafka

user_schema = ''
# Your code here

Hint

Add the namespace key with the exact value inside the JSON string.

3

Add fields to the Avro schema

Modify the user_schema string to include a "fields" array with three fields: {"name": "name", "type": "string"}, {"name": "age", "type": "int"}, and {"name": "email", "type": "string"}.

Kafka

user_schema = ''
# Your code here

Hint

Remember to format the fields as a JSON array inside the string.

4

Print the complete Avro schema

Write a print statement to display the user_schema variable.

Kafka

print()
# Your code here

Hint

Use print(user_schema) to show the schema string.

Practice

1. What is the main purpose of an Avro schema in Kafka?

easy

A. To route messages to different topics

B. To define the structure and data types of messages

C. To compress messages for faster transmission

D. To encrypt messages for security

Solution

1. Step 1: Understand Avro schema role

   An Avro schema describes how data is organized and typed in messages.

2. Step 2: Compare options with schema purpose

   Only defining structure and data types matches the schema's role.

3. Final Answer:

   To define the structure and data types of messages -> Option B

4. Quick Check:

   Avro schema = data structure definition [OK]

Hint: Avro schema describes message format, not security or routing [OK]

Common Mistakes:

• Confusing schema with encryption or compression
• Thinking schema controls message routing
• Assuming schema is for message storage

2. Which of the following is the correct way to start an Avro record schema definition?

easy

A. {"type": "enum", "symbols": ["A", "B"]}

B. {"type": "array", "items": "string"}

C. {"type": "map", "values": "int"}

D. {"type": "record", "name": "User", "fields": []}

Solution

1. Step 1: Identify record schema syntax

   An Avro record schema starts with type "record", a name, and a fields array.

2. Step 2: Match options to record schema

   Only {"type": "record", "name": "User", "fields": []} matches the record schema format correctly.

3. Final Answer:

   {"type": "record", "name": "User", "fields": []} -> Option D

4. Quick Check:

   Record schema = type "record" with name and fields [OK]

Hint: Record schemas always start with type "record" and have fields [OK]

Common Mistakes:

• Using array or map types instead of record
• Missing the name or fields keys
• Confusing enum with record

3. Given this Avro schema snippet:

{"type": "record", "name": "Person", "fields": [{"name": "age", "type": "int"}]}

What is the expected type of the age field in messages?

medium

A. int

B. boolean

C. string

D. float

Solution

1. Step 1: Read the field definition

   The field "age" has type "int" in the schema.

2. Step 2: Determine expected data type

   Messages must have an integer value for "age" as per schema.

3. Final Answer:

   int -> Option A

4. Quick Check:

   Field type "int" means integer value expected [OK]

Hint: Field type in schema directly shows expected data type [OK]

Common Mistakes:

• Assuming string type by default
• Confusing int with float or boolean
• Ignoring the schema field type

4. Identify the error in this Avro schema snippet:

{"type": "record", "name": "Product", "fields": [{"name": "price", "type": "double"}, {"name": "available"}]}

medium

A. Missing type for field "available"

B. Invalid record name

C. Fields array should be empty

D. Type "double" is not allowed

Solution

1. Step 1: Check each field for required keys

   Each field must have a "name" and a "type" key.

2. Step 2: Find missing keys

   The field "available" lacks a "type" key, causing an error.

3. Final Answer:

   Missing type for field "available" -> Option A

4. Quick Check:

   Every field needs a type [OK]

Hint: Every field must have a type key defined [OK]

Common Mistakes:

• Forgetting to add type for all fields
• Thinking record name can be empty
• Assuming double type is invalid

5. You want to add an optional field email of type string with a default empty value to an Avro record schema. Which field definition is correct?

hard

A. {"name": "email", "type": "string"}

B. {"name": "email", "type": ["null", "string"], "default": ""}

C. {"name": "email", "type": ["string", "null"], "default": ""}

D. {"name": "email", "type": ["null", "string"], "default": null}

Solution

1. Step 1: Understand optional field in Avro

   Optional fields use a union type with "null" and the actual type, with a default value matching the first type in the union.

2. Step 2: Check default value and type order

   For default empty string "", the first type must be "string" followed by "null"; {"name": "email", "type": ["string", "null"], "default": ""} matches.

3. Final Answer:

   {"name": "email", "type": ["string", "null"], "default": ""} -> Option C

4. Quick Check:

   Optional with default "" = ["string", "null"] union [OK]

Hint: Union first type must match default; include null for optional [OK]

Common Mistakes:

• Not using union with null for optional fields
• Using null first with string default (invalid)
• Setting default to null when empty string needed