THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
CreateTopicRequest => [TopicName Partitions Replicas 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+ReplicasReplicationfactor),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+ReplicasReplicationFactor) 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 Replicas 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, replication factor replica assingment or add/remove topic level configuration.Request semantics:
User can define only one from Partitions, Replicas, ReplicaAssignment, AddedConfigEntry, DeletedConfig. Otherwise, MultipleInstructionsForOneTopic is returned.
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 Partition 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.
One AlterTopicRequest may include only one topic alteration command for the topic with the given name in one batch, otherwise MultipleTopicInstructionsInOneBatch is returned.
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 for the topic with the given name in one batch, otherwise MultipleTopicInstructionsInOneBatch is returned.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 support two admin operations - get topic metadata, and check whether some particular admin command (which are all asynchronous) has been completed.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 won'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 Port (any number of brokers may be returned)NodeId => int32Host => stringPort => int32TopicMetadata => TopicErrorCode TopicName [PartitionMetadata] [ConfigEntry]TopicErrorCode => int16 PartitionMetadata => PartitionErrorCode PartitionId Leader ReplicasLag 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 and replica fetch lag per partition - how far partition replica is behind from the leader replica.
Replication Commands Schema
Preferred Replica Leader Election Request
PreferredReplicaLeaderElectionRequest => [Topic [PartitionId]]Topic => stringPartitionId => int32 |
PreferredReplicaLeaderEleactionRequest initiates preferred replica leader election procedure. Similar to Topic Admin requests this request in intended to be non-blocking. The schema consist of one field - array of partitions for which preferred replica leader should be elected.To start preferred replica leader election procedure for all existing partition an empty partitions array should be sent.
Preferred Replica Leader Election Response
PreferredReplicaLeaderElectionResponse => [Topic ErrorCode]Topic => stringErrorCode => int16 |
PreferredReplicaLeaderElectionResponse is similar to ReassignPartitionsResponse.
Status of the procedure may be checked with TopicMetadataRequest - the head of replicas list field and leader broker should be the same.
...