THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
New Protocol Errors
It is proposed to use existing / add these error codes to the protocol.
Error | Description | Requests |
|---|---|---|
TopicAlreadyExists | Topic with this name already exists. | Create |
InvalidTopic (existing) | Topic name contains invalid characters or doesn't exist. | Create, Alter, Delete |
InvalidPartitions | Either partition Partitions field is invalid (e.g. negative) | Create, Alter |
InvalidReplicationFactor | Either replication-factor ReplicationFactor field is invalid (e.g. negative) | Create, |
InvalidReplicaAssignment | Either replication assignment ReplicaAssignment field is invalid (e.g. contains duplicates) |
|
InvalidTopicConfiguration | Either topic-level config setting or value is incorrect. | Create, Alter |
DecreasePartitionsNotAllowed | Invalid partitions Partitions argument: decreasing partitions is prohibited when altering topic. | Alter |
ReassignPartitionsInProgress | Reassign partitions procedure has been already started. | Alter |
Generally, the Admin Client (see section 3) or another request dispatcher should have enough context to provide descriptive error message.
The same notation as in A Guide To The Kafka Protocol is used here.
...
CreateTopicRequest => [TopicName Partitions ReplicationFactor ReplicaAssignment [ConfigEntry]]TopicName => stringPartitions => int32Replicas => int32ReplicaAssignment => [PartitionId [ReplicaId]]ConfigEntry => ConfigKey ConfigValue ConfigKey => string ConfigValue => string |
CreateTopicRequest is a batch asynchronous request to initiate topic creation with either predefined or automatic replica assignment and optionally topic configuration.Request semantics:
- Only one from (
Partitions+ReplicationfactorReplicationFactor),ReplicaAssignmentcan be defined in one instruction. (Note: there is a special use case - automatic topic creation forTopicMetadataRequest, to trigger it user should set client_id=consumer and define only topic name). If both parameters are specified -ReplicaAssignmenttakes precedence. - In case
ReplicaAssignmentis defined number of partitions and replicas will be calculated from the suppliedReplicaAssignment. In case of defined (Partitions+ReplicationFactor) replica assignment will be automatically generated by the server. - Multiple instructions for the same topic in one request will be silently ignored, only the last from the list will be executed.
...
CreateTopicResponse => [TopicName ErrorCode]ErrorCode => int16TopicName => string |
CreateTopicResponse contains a map between topic and topic creation result error code (see New Protocol Errors).
Alter Topic Request
AlterTopicRequest => [TopicName Partitions ReplicationFactor ReplicaAssignment [AddedConfigEntry] [DeletedConfig]]TopicName => string Replicas => int32 Partitions => int32ReplicaAssignment => [PartitionId [ReplicaId]]AddedConfigEntry => ConfigKey ConfigValue ConfigKey => string ConfigValue => string DeletedConfig => string |
AlterTopicRequest is a batch asynchronous request to initiate topic alteration: replication parameters, replica assingment or add/remove topic level configuration.Request semantics:
1. If ReplicaAssignment is defined
ReplicationFactor and Partitions arguments are ignored in this case.
For each partition in ReplicaAssignment:
1.1 If such partition exists and assignment is different from the current replica assignment
It's a "reassign partition" request - add it reassign-partitions json
1.2 If such partition doesn't exist
It's an "add partition" request - change topic metadata in zookeeper to trigger increase partition logic
2. Else if ReplicationFactor is defined
2.1 If Partitions is defined
Regenerate replica assignment for all existing and newly added partitions, goto 1.
2.2 If Partitions is not defined
Regenerate replica assignment only for existing partitions, goto 1.
3. Else if Partitions is defined (ReplicaAssignment and ReplicationFactor are not defined):
3.1 If Partitions is less than current number of partitions return error code IncreasePartitionsNotAllowed
3.2 Otherwise, generate automatically replica assignment for newly added partitions, goto 1.
Multiple instructions for the same topic in one request will be silently ignored, only the last from the list will be executed.
Alter Topic Response
ErrorCode => int16TopicName => string |
AlterTopicResponse is similar to CreateTopicResponse.Delete Topic Request
DeleteTopicRequest => [TopicName]TopicName => string |
DeleteTopicRequest requires only topic names which should be deleted.One
DeleteTopicRequest may include only one topic deletion command Multiple instructions for the same topic with the given name in one batch, otherwise MultipleTopicInstructionsInOneBatch is returnedrequest will be silently ignored, only the last from the list will be executed.Delete Topic Response
ErrorCode => int16TopicName => string |
DeleteTopicResponse is similar to CreateTopicResponse.
Topic Metadata Request V1
TopicMetadataReqeust_V1 => [TopicName]TopicName => string |
TopicMetadataRequest_V1 is an evolved version of TopicMetadataRequest. This request is intended to get actual topic metadata information and verify whether particular admin request (Create, Alter, Delete) has been completed by checking the expected and actual state of the topic.TopicMetadataRequest_V1 requires only topic names. As with the first version, an empty topic name set results in returning information for all existing topics.Also
TopicMetadataRequest_V1 comparing to the previous version doesn't trigger topic creation automatically if the topic with the given name doesn't exist.Topic Metadata Response V1
TopicMetadataResponse_V1 => [Broker][TopicMetadata]Broker => NodeId Host PortNodeId => int32Host => stringPort => int32TopicMetadata => TopicErrorCode TopicName [PartitionMetadata] [ConfigEntry]TopicErrorCode => int16 PartitionMetadata => PartitionErrorCode PartitionId Leader IsrPartitionErrorCode => int16PartitionId => int32Leader => int32ReplicasLag => [int32 int32]Isr => [int32]ConfigEntry => string string |
The new version of TopicMetadataResponse in addition to TopicMetadataResponse_V0 will include topic level configuration for each topic. ISR data is removed because only the leading broker manages this metadata accurately.
...