tisonkun commented on code in PR #17455: URL: https://github.com/apache/pulsar/pull/17455#discussion_r963586106
########## site2/docs/client-libraries-go.md: ########## @@ -716,63 +688,33 @@ scrape_configs: scrape_interval: 10s static_configs: - targets: - - localhost:2112 + - localhost: 2112 ``` Now you can query Pulsar client metrics on Prometheus. ### Consumer configuration - Name | Description | Default -| :-------- | :---------- |:---------- | -| Topic | Topic specify the topic this consumer will subscribe to. This argument is required when constructing the reader. | | -| Topics | Specify a list of topics this consumer will subscribe on. Either a topic, a list of topics or a topics pattern are required when subscribing| | -| TopicsPattern | Specify a regular expression to subscribe to multiple topics under the same namespace. Either a topic, a list of topics or a topics pattern are required when subscribing | | -| AutoDiscoveryPeriod | Specify the interval in which to poll for new partitions or new topics if using a TopicsPattern. | | -| SubscriptionName | Specify the subscription name for this consumer. This argument is required when subscribing | | -| Name | Set the consumer name | | -| Properties | Properties attach a set of application defined properties to the producer This properties will be visible in the topic stats | | -| Type | Select the subscription type to be used when subscribing to the topic. | Exclusive | -| SubscriptionInitialPosition | InitialPosition at which the cursor will be set when subscribe | Latest | -| DLQ | Configuration for Dead Letter Queue consumer policy. | no DLQ | -| MessageChannel | Sets a `MessageChannel` for the consumer. When a message is received, it will be pushed to the channel for consumption | | -| ReceiverQueueSize | Sets the size of the consumer receive queue. | 1000| -| NackRedeliveryDelay | The delay after which to redeliver the messages that failed to be processed | 1min | -| ReadCompacted | If enabled, the consumer will read messages from the compacted topic rather than reading the full message backlog of the topic | false | -| ReplicateSubscriptionState | Mark the subscription as replicated to keep it in sync across clusters | false | -| KeySharedPolicy | Configuration for Key Shared consumer policy. | | -| RetryEnable | Auto retry send messages to default filled DLQPolicy topics | false | -| Interceptors | A chain of interceptors. These interceptors are called at some points defined in the `ConsumerInterceptor` interface. | | -| MaxReconnectToBroker | MaxReconnectToBroker set the maximum retry number of reconnectToBroker. | ultimate | -| Schema | Schema set a custom schema type by passing an implementation of `Schema` | bytes[] | +All available options of `ConsumerOptions` are [here](https://pkg.go.dev/github.com/apache/pulsar-client-go/pulsar#ConsumerOptions). ## Readers Pulsar readers process messages from Pulsar topics. Readers are different from consumers because with readers you need to explicitly specify which message in the stream you want to begin with (consumers, on the other hand, automatically begin with the most recent unacked message). You can [configure](#reader-configuration) Go readers using a `ReaderOptions` object. Here's an example: ```go reader, err := client.CreateReader(pulsar.ReaderOptions{ - Topic: "topic-1", - StartMessageID: pulsar.EarliestMessageID(), + Topic: "topic-1", + StartMessageID: pulsar.EarliestMessageID(), }) if err != nil { - log.Fatal(err) + log.Fatal(err) } defer reader.Close() ``` ### Reader operations -Pulsar Go readers have the following methods available: - -Method | Description | Return type -:------|:------------|:----------- -`Topic()` | Returns the reader's [topic](reference-terminology.md#topic) | `string` -`Next(context.Context)` | Receives the next message on the topic (analogous to the `Receive` method for [consumers](#consumer-operations)). This method blocks until a message is available. | `(Message, error)` -`HasNext()` | Check if there is any message available to read from the current position| (bool, error) -`Close()` | Closes the reader, disabling its ability to receive messages from the broker | `error` -`Seek(MessageID)` | Reset the subscription associated with this reader to a specific message ID | `error` -`SeekByTime(time time.Time)` | Reset the subscription associated with this reader to a specific message publish time | `error` +All available method of `Reader` interface are [here](https://pkg.go.dev/github.com/apache/pulsar-client-go/pulsar#Reader). Review Comment: If this suggestion is accepted, all similar descriptions should be updated also. I did think of the description of the link here, but failed to find a better alternative :) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
