Merge pull request #322 from ydb-platform/topic-typos

Topic typos

Author: asmyasnikov

CHANGELOG.md

@@ -1,4 +1,5 @@
-* Allow read and commit messages in parallel
+* Fixed signature/name of helpers in topic/topicsugar package 
+* Allowed read and commit messages in parallel
 
 ## v3.31.0
 * Extended the ydb.Connection interface with experimental db.Topic() client (control plane and reader API)

internal/topic/topicreaderinternal/batch.go

@@ -94,7 +94,8 @@ func newBatchFromStream(decoders decoderMap, session *partitionSession, sb rawto
 	return newBatch(session, messages)
 }
 
-// Context is cancelled when partition of message will stop to read.
+// Context is cancelled when code should stop to process messages batch
+// for example - lost connection to server or receive stop partition signal without graceful flag
 //
 // Experimental
 //

topic/reader_e2e_test.go

@@ -42,10 +42,10 @@ func TestReadMessages(t *testing.T) {
 	t.Logf("msg: %#v", msg)
 
 	require.NoError(t, err)
-	err = msg.UnmarshalTo(topicsugar.ConsumeWithCallback(func(data []byte) error {
+	err = topicsugar.ReadMessageDataWithCallback(msg, func(data []byte) error {
 		t.Log("Content:", string(data))
 		return nil
-	}))
+	})
 	require.NoError(t, err)
 
 	sendCDCMessage(ctx, t, db)

topic/topicoptions/topicoptions_reader.go

@@ -101,6 +101,8 @@ func WithCommitCountTrigger(count int) ReaderOption {
 }
 
 // WithBatchReadMinCount
+// prefer min count messages in batch
+// sometimes batch can contain fewer messages, for example if local buffer is full and SDK can't receive more messages
 //
 // Experimental
 //

topic/topicreader/doc.go

@@ -0,0 +1,5 @@
+// Package topicreader provide Reader to receive messages from YDB topics
+// More examples in examples repository
+//
+// https://github.com/ydb-platform/ydb-go-examples/tree/master/topic/topicreader
+package topicreader

topic/topicreader/reader.go

@@ -68,6 +68,8 @@ type Message = topicreaderinternal.PublicMessage
 type MessageContentUnmarshaler = topicreaderinternal.PublicMessageContentUnmarshaler
 
 // Commit receive Message, Batch of single offset
+// It can be fast (by default) or sync and waite response from server
+// see topicoptions.CommitMode for details
 //
 // Experimental
 //