Merge pull request #539 from ydb-platform/fix-index-type

Fix index type

Author: asmyasnikov

CHANGELOG.md

@@ -1,5 +1,8 @@
 * Fixed `sugar.IsTableExists` with recursive check directory exists
 * Added `sugar.IsDirectoryExists`
+* Changed type of `table/options.IndexType` for type checks
+* Added constants `table/options.IndexTypeGlobal` and `table/options.IndexTypeGlobalAsync`
+* Added `table/options.IndexDescription.Type` field with `table/options.IndexType` type
 
 ## v3.42.6
 * Implemented `driver.RowsColumnTypeDatabaseTypeName` interface in `internal/xsql.rows` struct
@@ -9,7 +12,7 @@
 * Added checks for nil option to all opts range loops
 * Moved content of package `internal/ctxlabels` into `internal/xcontext`
 * Implemented `GRPCStatus` method in `internal/xerrors/transportError`
-* Added different implementations of stacktrace error for grpc errors and other 
+* Added different implementations of stacktrace error for grpc errors and other
 * Dropped `internal/xnet` package as useless
 * Fixed default grpc dial options
 * Replaced single connection for discovery repeater into connection which creates each time for discovery request
@@ -28,7 +31,7 @@
 
 ## v3.42.3
 * Added `credentials.NewStaticCredentials()` static credentials constructor
-* Changed `internal/credentials.NewStaticCredentials()` signature and behaviour for create grpc connection on each call to auth service 
+* Changed `internal/credentials.NewStaticCredentials()` signature and behaviour for create grpc connection on each call to auth service
 * Downgrade `google.golang.org/grpc` to `v1.49.0`
 
 ## v3.42.2
@@ -78,7 +81,7 @@
 * Added `types.TupleItem(types.Value)`, `types.StructFields(types.Value)` and `types.DictValues(types.Value)` funcs (extractors of internal fields of tuple, struct and dict values)
 * Added `types.Value.Yql()` func for getting values string representation as `YQL` literal
 * Added `types.Type.Yql()` func for getting `YQL` representation of type
-* Marked `table/types.WriteTypeStringTo` as deprecated 
+* Marked `table/types.WriteTypeStringTo` as deprecated
 * Added `table/options.WithDataColumns` for supporting covering indexes
 * Supported `balancer` query string parameter in `DSN`
 * Fixed bug with scanning `YSON` value from result set
@@ -105,7 +108,7 @@
 * Allowed writing zero messages to topic writer
 
 ## v3.38.1
-* Fixed deadlock with implicit usage of `internal.table.Client.internalPoolAsyncCloseSession` 
+* Fixed deadlock with implicit usage of `internal.table.Client.internalPoolAsyncCloseSession`
 
 ## v3.38.0
 * Fixed commit errors for experimental topic reader
@@ -126,10 +129,10 @@
 * Changed type of truncated result error from `StreamExecuteScanQuery` to retryable error
 * Added closing sessions if node removed from discovery results
 * Moved session status type from `table/options` package to `table`
-* Changed session status source type from `uint32` to `string` alias 
+* Changed session status source type from `uint32` to `string` alias
 
 ## v3.37.6
-* Added to balancer notifying mechanism for listening in table client event about removing some nodes and closing sessions on them 
+* Added to balancer notifying mechanism for listening in table client event about removing some nodes and closing sessions on them
 * Removed from public client interfaces `closer.Closer` (for exclude undefined behaviour on client-side)
 
 ## v3.37.5
@@ -139,7 +142,7 @@
 * Revert the marking of context errors as required to delete session
 
 ## v3.37.3
-* Fixed alter topic request - stop send empty setSupportedCodecs if customer not set them 
+* Fixed alter topic request - stop send empty setSupportedCodecs if customer not set them
 * Marked the context errors as required to delete session
 * Added log topic api reader for internal logger
 
@@ -185,7 +188,7 @@
 * Moved implementation `sugar.GenerateDeclareSection` to `internal/table`
 * Added transaction trace callbacks and internal logging with them
 * Stored context from `BeginTx` to `internal/xsql` transaction
-* Added automatically generated declare section to query text in `database/sql` usage 
+* Added automatically generated declare section to query text in `database/sql` usage
 * Removed supports `sql.LevelSerializable`
 * Added `retry.Do` helper for retry custom lambda with `database/sql` without transactions
 * Removed `retry.WithTxOptions` option (only default isolation supports)
@@ -195,21 +198,21 @@
 * Added metadata to `trace.Driver.OnInvoke` and `trace.Driver.OnNewStream` done events
 
 ## v3.34.0
-* Improved the `xsql` errors mapping to `driver.ErrBadConn` 
+* Improved the `xsql` errors mapping to `driver.ErrBadConn`
 * Extended `retry.DoTx` test for to achieve equivalence with `retry.Retry` behaviour
 * Added `database/sql` events for tracing `database/sql` driver events
 * Added internal logging for `database/sql` events
 * Supports `YDB_LOG_DETAILS` environment variable for specify scope of log messages
 * Removed support of `YDB_LOG_NO_COLOR` environment variable
 * Changed default behaviour of internal logger to without coloring
 * Fixed coloring (to true) with environment variable `YDB_LOG_SEVERITY_LEVEL`
-* Added `ydb.WithStaticCredentials(user, password)` option for make static credentials 
+* Added `ydb.WithStaticCredentials(user, password)` option for make static credentials
 * Supports static credentials as part of connection string (dsn - data source name)
 * Changed minimal supported version of go from 1.14 to 1.16 (required for jwt library)
 
 
 ## v3.33.0
-* Added `retry.DoTx` helper for retrying `database/sql` transactions 
+* Added `retry.DoTx` helper for retrying `database/sql` transactions
 * Implemented `database/sql` driver over `ydb-go-sdk`
 * Marked as deprecated `trace.Table.OnPoolSessionNew` and `trace.Table.OnPoolSessionClose` events
 * Added `trace.Table.OnPoolSessionAdd` and `trace.Table.OnPoolSessionRemove` events
@@ -223,7 +226,7 @@
 
 ## v3.32.0
 * Refactored `trace.Topic` (experimental) handlers
-* Fixed signature and names of helpers in `topic/topicsugar` package 
+* Fixed signature and names of helpers in `topic/topicsugar` package
 * Allowed parallel reading and committing topic messages
 
 ## v3.31.0
@@ -244,10 +247,10 @@
 * Added touching of last updated timestamp in existing conns on stage of applying new endpoint list
 
 ## v3.29.3
-* Reverted `xerrors.IsTransportError(err)` behaviour for raw grpc errors to false 
+* Reverted `xerrors.IsTransportError(err)` behaviour for raw grpc errors to false
 
 ## v3.29.2
-* Enabled server-side session balancing for sessions created from internal session pool 
+* Enabled server-side session balancing for sessions created from internal session pool
 * Removed unused public `meta.Meta` methods
 * Renamed `meta.Meta.Meta(ctx)` public method to `meta.Meta.Context(ctx)`
 * Reverted default balancer to `balancers.RandomChoice()`
@@ -267,12 +270,12 @@
 
 ## v3.28.1
 * Marked dial errors as retryable
-* Supported node pessimization on dialing errors  
+* Supported node pessimization on dialing errors
 * Marked error from `Invoke` and `NewStream` as retryable if request not sended to server
 
 ## v3.28.0
 * Added `sugar.GenerateDeclareSection()` helper for make declare section in `YQL`
-* Added check when parameter name not started from `$` and automatically prepends it to name 
+* Added check when parameter name not started from `$` and automatically prepends it to name
 * Refactored connection closing
 
 ## v3.27.0

internal/table/session.go

@@ -294,7 +294,10 @@ func (s *session) CreateTable(
 		}
 	}
 	_, err = s.tableService.CreateTable(ctx, &request)
-	return xerrors.WithStackTrace(err)
+	if err != nil {
+		return xerrors.WithStackTrace(err)
+	}
+	return nil
 }
 
 // DescribeTable describes table at given path.
@@ -410,11 +413,19 @@ func (s *session) DescribeTable(
 
 	indexes := make([]options.IndexDescription, len(result.Indexes))
 	for i, idx := range result.GetIndexes() {
+		var typ options.IndexType
+		switch idx.Type.(type) {
+		case *Ydb_Table.TableIndexDescription_GlobalAsyncIndex:
+			typ = options.IndexTypeGlobalAsync
+		case *Ydb_Table.TableIndexDescription_GlobalIndex:
+			typ = options.IndexTypeGlobal
+		}
 		indexes[i] = options.IndexDescription{
 			Name:         idx.GetName(),
 			IndexColumns: idx.GetIndexColumns(),
 			DataColumns:  idx.GetDataColumns(),
 			Status:       idx.GetStatus(),
+			Type:         typ,
 		}
 	}
 

table/example_test.go

@@ -166,7 +166,7 @@ func Example_alterTable() {
 				options.WithAddIndex("idx_series_series_id",
 					options.WithIndexColumns("series_id"),
 					options.WithDataColumns("title"),
-					options.WithIndexType(options.GlobalAsyncIndex()),
+					options.WithIndexType(options.GlobalIndex()),
 				),
 				options.WithDropIndex("idx_series_title"),
 				options.WithAlterAttribute("hello", "world"),

table/options/models.go

@@ -40,6 +40,7 @@ type IndexDescription struct {
 	IndexColumns []string
 	DataColumns  []string
 	Status       Ydb_Table.TableIndexDescription_Status
+	Type         IndexType
 }
 
 //nolint:unused
@@ -270,32 +271,34 @@ func NewPartitioningSettings(ps *Ydb_Table.PartitioningSettings) PartitioningSet
 	}
 }
 
-type IndexType interface {
-	setup(*indexDesc)
-}
-
-type globalIndex struct{}
+type (
+	IndexType uint8
+)
 
-func GlobalIndex() IndexType {
-	return globalIndex{}
-}
+const (
+	IndexTypeGlobal = IndexType(iota)
+	IndexTypeGlobalAsync
+)
 
-func (globalIndex) setup(d *indexDesc) {
-	d.Type = &Ydb_Table.TableIndex_GlobalIndex{
-		GlobalIndex: new(Ydb_Table.GlobalIndex),
+func (t IndexType) ApplyIndexOption(d *indexDesc) {
+	switch t {
+	case IndexTypeGlobal:
+		d.Type = &Ydb_Table.TableIndex_GlobalIndex{
+			GlobalIndex: &Ydb_Table.GlobalIndex{},
+		}
+	case IndexTypeGlobalAsync:
+		d.Type = &Ydb_Table.TableIndex_GlobalAsyncIndex{
+			GlobalAsyncIndex: &Ydb_Table.GlobalAsyncIndex{},
+		}
 	}
 }
 
-type globalAsyncIndex struct{}
-
-func GlobalAsyncIndex() IndexType {
-	return globalAsyncIndex{}
+func GlobalIndex() IndexType {
+	return IndexTypeGlobal
 }
 
-func (globalAsyncIndex) setup(d *indexDesc) {
-	d.Type = &Ydb_Table.TableIndex_GlobalAsyncIndex{
-		GlobalAsyncIndex: new(Ydb_Table.GlobalAsyncIndex),
-	}
+func GlobalAsyncIndex() IndexType {
+	return IndexTypeGlobalAsync
 }
 
 type PartitioningMode byte

table/options/options.go

@@ -219,16 +219,8 @@ func WithDataColumns(columns ...string) IndexOption {
 	return dataColumns(columns)
 }
 
-type indexType struct {
-	t IndexType
-}
-
-func (i indexType) ApplyIndexOption(d *indexDesc) {
-	i.t.setup(d)
-}
-
 func WithIndexType(t IndexType) IndexOption {
-	return indexType{t: t}
+	return t
 }
 
 type columnFamilies []ColumnFamily