Merge pull request #407 add topic examples

Author: rekby

topic/client_e2e_test.go

@@ -20,6 +20,8 @@ import (
 	"github.com/ydb-platform/ydb-go-sdk/v3/topic/topictypes"
 )
 
+const defaultConnectionString = "grpc://localhost:2136/local"
+
 func TestClient_CreateDropTopic(t *testing.T) {
 	ctx := xtest.Context(t)
 	db := connect(t)
@@ -152,7 +154,7 @@ func TestSchemeList(t *testing.T) {
 }
 
 func connect(t testing.TB, opts ...ydb.Option) ydb.Connection {
-	connectionString := "grpc://localhost:2136/local"
+	connectionString := defaultConnectionString
 	if cs := os.Getenv("YDB_CONNECTION_STRING"); cs != "" {
 		connectionString = cs
 	}

topic/example_test.go

@@ -1,19 +1,120 @@
+//nolint:goconst
 package topic_test
 
 import (
 	"context"
 	"fmt"
 	"io/ioutil"
+	"log"
+	"os"
 
 	ydb "github.com/ydb-platform/ydb-go-sdk/v3"
 	"github.com/ydb-platform/ydb-go-sdk/v3/topic/topicoptions"
+	"github.com/ydb-platform/ydb-go-sdk/v3/topic/topictypes"
 )
 
-func Example_topic_read_message() {
+func Example_createTopic() {
 	ctx := context.TODO()
-	db, err := ydb.Open(ctx, "grpcs://localhost:2135/local")
+	connectionString := os.Getenv("YDB_CONNECTION_STRING")
+	if connectionString == "" {
+		connectionString = "grpc://localhost:2136/local"
+	}
+	db, err := ydb.Open(ctx, connectionString)
+	if err != nil {
+		log.Printf("failed connect: %v", err)
+		return
+	}
+	defer db.Close(ctx) // cleanup resources
+
+	err = db.Topic().Create(ctx, "topic-path",
+
+		// optional
+		topicoptions.CreateWithSupportedCodecs(topictypes.CodecRaw, topictypes.CodecGzip),
+
+		// optional
+		topicoptions.CreateWithMinActivePartitions(3),
+	)
+	if err != nil {
+		log.Printf("failed create topic: %v", err)
+		return
+	}
+}
+
+func Example_alterTopic() {
+	ctx := context.TODO()
+	connectionString := os.Getenv("YDB_CONNECTION_STRING")
+	if connectionString == "" {
+		connectionString = "grpc://localhost:2136/local"
+	}
+	db, err := ydb.Open(ctx, connectionString)
+	if err != nil {
+		log.Printf("failed connect: %v", err)
+		return
+	}
+	defer db.Close(ctx) // cleanup resources
+
+	err = db.Topic().Alter(ctx, "topic-path",
+		topicoptions.AlterWithAddConsumers(topictypes.Consumer{
+			Name:            "new-consumer",
+			SupportedCodecs: []topictypes.Codec{topictypes.CodecRaw, topictypes.CodecGzip}, // optional
+		}),
+	)
+	if err != nil {
+		log.Printf("failed alter topic: %v", err)
+		return
+	}
+}
+
+func Example_describeTopic() {
+	ctx := context.TODO()
+	connectionString := os.Getenv("YDB_CONNECTION_STRING")
+	if connectionString == "" {
+		connectionString = "grpc://localhost:2136/local"
+	}
+	db, err := ydb.Open(ctx, connectionString)
+	if err != nil {
+		log.Printf("failed connect: %v", err)
+		return
+	}
+	defer db.Close(ctx) // cleanup resources
+
+	descResult, err := db.Topic().Describe(ctx, "topic-path")
+	if err != nil {
+		log.Printf("failed drop topic: %v", err)
+		return
+	}
+	fmt.Printf("describe: %#v\n", descResult)
+}
+
+func Example_dropTopic() {
+	ctx := context.TODO()
+	connectionString := os.Getenv("YDB_CONNECTION_STRING")
+	if connectionString == "" {
+		connectionString = "grpc://localhost:2136/local"
+	}
+	db, err := ydb.Open(ctx, connectionString)
+	if err != nil {
+		log.Printf("failed connect: %v", err)
+		return
+	}
+	defer db.Close(ctx) // cleanup resources
+
+	err = db.Topic().Drop(ctx, "topic-path")
+	if err != nil {
+		log.Printf("failed drop topic: %v", err)
+		return
+	}
+}
+
+func Example_readMessage() {
+	ctx := context.TODO()
+	connectionString := os.Getenv("YDB_CONNECTION_STRING")
+	if connectionString == "" {
+		connectionString = "grpc://localhost:2136/local"
+	}
+	db, err := ydb.Open(ctx, connectionString)
 	if err != nil {
-		fmt.Printf("failed connect: %v", err)
+		log.Printf("failed connect: %v", err)
 		return
 	}
 	defer db.Close(ctx) // cleanup resources