Merge pull request #28 from ydb-platform/scheme

Publish scheme Client interface (move from internal)

Author: asmyasnikov

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.1.0
+* published scheme Client interface
+
 ## 3.0.1
 * refactored integration tests
 * fixed table retry trace calls

connection.go

@@ -12,7 +12,7 @@ import (
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/dial"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/discovery"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/ratelimiter"
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/scheme"
+	"github.com/ydb-platform/ydb-go-sdk/v3/scheme"
 	"github.com/ydb-platform/ydb-go-sdk/v3/table"
 )
 

coordiantion.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/coordination"
 	internal "github.com/ydb-platform/ydb-go-sdk/v3/internal/coordination"
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/scheme"
+	"github.com/ydb-platform/ydb-go-sdk/v3/scheme"
 )
 
 type lazyCoordination struct {

internal/coordination/coordination.go

@@ -10,7 +10,7 @@ import (
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/cluster"
 	"github.com/ydb-platform/ydb-go-sdk/v3/coordination"
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/scheme"
+	"github.com/ydb-platform/ydb-go-sdk/v3/scheme"
 )
 
 type Client interface {

internal/meta/version.go

@@ -1,5 +1,5 @@
 package meta
 
 const (
-	Version = "ydb-go-sdk/3.0.1"
+	Version = "ydb-go-sdk/3.1.0"
 )

internal/scheme/options.go

@@ -7,52 +7,10 @@ type permissionsDesc struct {
 	actions []*Ydb_Scheme.PermissionsAction
 }
 
-func permissions(p Permissions) *Ydb_Scheme.Permissions {
-	var y Ydb_Scheme.Permissions
-	p.to(&y)
-	return &y
+func (p *permissionsDesc) SetClear(clear bool) {
+	p.clear = clear
 }
 
-type PermissionsOption func(*permissionsDesc)
-
-func WithClearPermissions() PermissionsOption {
-	return func(p *permissionsDesc) {
-		p.clear = true
-	}
-}
-func WithGrantPermissions(p Permissions) PermissionsOption {
-	return func(d *permissionsDesc) {
-		d.actions = append(d.actions, &Ydb_Scheme.PermissionsAction{
-			Action: &Ydb_Scheme.PermissionsAction_Grant{
-				Grant: permissions(p),
-			},
-		})
-	}
-}
-func WithRevokePermissions(p Permissions) PermissionsOption {
-	return func(d *permissionsDesc) {
-		d.actions = append(d.actions, &Ydb_Scheme.PermissionsAction{
-			Action: &Ydb_Scheme.PermissionsAction_Revoke{
-				Revoke: permissions(p),
-			},
-		})
-	}
-}
-func WithSetPermissions(p Permissions) PermissionsOption {
-	return func(d *permissionsDesc) {
-		d.actions = append(d.actions, &Ydb_Scheme.PermissionsAction{
-			Action: &Ydb_Scheme.PermissionsAction_Set{
-				Set: permissions(p),
-			},
-		})
-	}
-}
-func WithChangeOwner(owner string) PermissionsOption {
-	return func(d *permissionsDesc) {
-		d.actions = append(d.actions, &Ydb_Scheme.PermissionsAction{
-			Action: &Ydb_Scheme.PermissionsAction_ChangeOwner{
-				ChangeOwner: owner,
-			},
-		})
-	}
+func (p *permissionsDesc) AppendAction(action *Ydb_Scheme.PermissionsAction) {
+	p.actions = append(p.actions, action)
 }

internal/scheme/options_test.go

@@ -4,30 +4,32 @@ import (
 	"testing"
 
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb_Scheme"
+
+	"github.com/ydb-platform/ydb-go-sdk/v3/scheme"
 )
 
 func TestSchemeOptions(t *testing.T) {
 	{
-		opts := []PermissionsOption{
-			WithClearPermissions(),
-			WithChangeOwner("ow"),
-			WithGrantPermissions(Permissions{
+		opts := []scheme.PermissionsOption{
+			scheme.WithClearPermissions(),
+			scheme.WithChangeOwner("ow"),
+			scheme.WithGrantPermissions(scheme.Permissions{
 				Subject:         "grant",
 				PermissionNames: []string{"a", "b", "c"},
 			}),
-			WithSetPermissions(Permissions{
+			scheme.WithSetPermissions(scheme.Permissions{
 				Subject:         "set",
 				PermissionNames: []string{"d"},
 			}),
-			WithRevokePermissions(Permissions{
+			scheme.WithRevokePermissions(scheme.Permissions{
 				Subject:         "revoke",
 				PermissionNames: []string{"e"},
 			}),
 		}
 
 		var desc permissionsDesc
-		for _, opt := range opts {
-			opt(&desc)
+		for _, o := range opts {
+			o(&desc)
 		}
 
 		if !desc.clear {

internal/scheme/scheme.go

@@ -9,98 +9,9 @@ import (
 	"github.com/ydb-platform/ydb-go-genproto/protos/Ydb_Scheme"
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/cluster"
+	"github.com/ydb-platform/ydb-go-sdk/v3/scheme"
 )
 
-type Client interface {
-	Scheme
-
-	CleanupDatabase(ctx context.Context, prefix string, names ...string) error
-	EnsurePathExists(ctx context.Context, path string) error
-}
-
-type Scheme interface {
-	DescribePath(ctx context.Context, path string) (e Entry, err error)
-	MakeDirectory(ctx context.Context, path string) (err error)
-	ListDirectory(ctx context.Context, path string) (d Directory, err error)
-	RemoveDirectory(ctx context.Context, path string) (err error)
-
-	Close(ctx context.Context) error
-}
-
-type EntryType uint
-
-const (
-	EntryTypeUnknown EntryType = iota
-	EntryDirectory
-	EntryTable
-	EntryPersQueueGroup
-	EntryDatabase
-	EntryRtmrVolume
-	EntryBlockStoreVolume
-	EntryCoordinationNode
-)
-
-func (t EntryType) String() string {
-	switch t {
-	default:
-		return "Unknown"
-	case EntryDirectory:
-		return "Directory"
-	case EntryTable:
-		return "Table"
-	case EntryPersQueueGroup:
-		return "PersQueueGroup"
-	case EntryDatabase:
-		return "Name"
-	case EntryRtmrVolume:
-		return "RtmrVolume"
-	case EntryBlockStoreVolume:
-		return "BlockStoreVolume"
-	case EntryCoordinationNode:
-		return "CoordinationNode"
-	}
-}
-
-type Permissions struct {
-	Subject         string
-	PermissionNames []string
-}
-
-type Entry struct {
-	Name                 string
-	Owner                string
-	Type                 EntryType
-	Permissions          []Permissions
-	EffectivePermissions []Permissions
-}
-
-func (e *Entry) IsDirectory() bool {
-	return e.Type == EntryDirectory
-}
-func (e *Entry) IsTable() bool {
-	return e.Type == EntryTable
-}
-func (e *Entry) IsPersQueueGroup() bool {
-	return e.Type == EntryPersQueueGroup
-}
-func (e *Entry) IsDatabase() bool {
-	return e.Type == EntryDatabase
-}
-func (e *Entry) IsRtmrVolume() bool {
-	return e.Type == EntryRtmrVolume
-}
-func (e *Entry) IsBlockStoreVolume() bool {
-	return e.Type == EntryBlockStoreVolume
-}
-func (e *Entry) IsCoordinationNode() bool {
-	return e.Type == EntryCoordinationNode
-}
-
-type Directory struct {
-	Entry
-	Children []Entry
-}
-
 type client struct {
 	cluster cluster.Cluster
 	service Ydb_Scheme_V1.SchemeServiceClient
@@ -110,7 +21,7 @@ func (c *client) Close(_ context.Context) error {
 	return nil
 }
 
-func New(c cluster.Cluster) Scheme {
+func New(c cluster.Cluster) scheme.Scheme {
 	return &client{
 		cluster: c,
 		service: Ydb_Scheme_V1.NewSchemeServiceClient(c),
@@ -131,9 +42,9 @@ func (c *client) RemoveDirectory(ctx context.Context, path string) (err error) {
 	return err
 }
 
-func (c *client) ListDirectory(ctx context.Context, path string) (Directory, error) {
+func (c *client) ListDirectory(ctx context.Context, path string) (scheme.Directory, error) {
 	var (
-		d        Directory
+		d        scheme.Directory
 		err      error
 		response *Ydb_Scheme.ListDirectoryResponse
 		result   Ydb_Scheme.ListDirectoryResult
@@ -148,13 +59,13 @@ func (c *client) ListDirectory(ctx context.Context, path string) (Directory, err
 	if err != nil {
 		return d, err
 	}
-	d.from(result.Self)
-	d.Children = make([]Entry, len(result.Children))
+	d.From(result.Self)
+	d.Children = make([]scheme.Entry, len(result.Children))
 	putEntry(d.Children, result.Children)
 	return d, nil
 }
 
-func (c *client) DescribePath(ctx context.Context, path string) (e Entry, err error) {
+func (c *client) DescribePath(ctx context.Context, path string) (e scheme.Entry, err error) {
 	var (
 		response *Ydb_Scheme.DescribePathResponse
 		result   Ydb_Scheme.DescribePathResult
@@ -169,14 +80,14 @@ func (c *client) DescribePath(ctx context.Context, path string) (e Entry, err er
 	if err != nil {
 		return e, err
 	}
-	e.from(result.Self)
+	e.From(result.Self)
 	return e, nil
 }
 
-func (c *client) ModifyPermissions(ctx context.Context, path string, opts ...PermissionsOption) (err error) {
+func (c *client) ModifyPermissions(ctx context.Context, path string, opts ...scheme.PermissionsOption) (err error) {
 	var desc permissionsDesc
-	for _, opt := range opts {
-		opt(&desc)
+	for _, o := range opts {
+		o(&desc)
 	}
 	_, err = c.service.ModifyPermissions(ctx, &Ydb_Scheme.ModifyPermissionsRequest{
 		Path:             path,
@@ -186,70 +97,8 @@ func (c *client) ModifyPermissions(ctx context.Context, path string, opts ...Per
 	return err
 }
 
-func (e *Entry) from(y *Ydb_Scheme.Entry) {
-	var (
-		n = len(y.Permissions)
-		m = len(y.EffectivePermissions)
-		p = make([]Permissions, n+m)
-	)
-	putPermissions(p[:n], y.Permissions)
-	putPermissions(p[n:], y.EffectivePermissions)
-	*e = Entry{
-		Name:                 y.Name,
-		Owner:                y.Owner,
-		Type:                 entryType(y.Type),
-		Permissions:          p[0:n],
-		EffectivePermissions: p[n:m],
-	}
-}
-
-func entryType(t Ydb_Scheme.Entry_Type) EntryType {
-	switch t {
-	case Ydb_Scheme.Entry_DIRECTORY:
-		return EntryDirectory
-	case Ydb_Scheme.Entry_TABLE:
-		return EntryTable
-	case Ydb_Scheme.Entry_PERS_QUEUE_GROUP:
-		return EntryPersQueueGroup
-	case Ydb_Scheme.Entry_DATABASE:
-		return EntryDatabase
-	case Ydb_Scheme.Entry_RTMR_VOLUME:
-		return EntryRtmrVolume
-	case Ydb_Scheme.Entry_BLOCK_STORE_VOLUME:
-		return EntryBlockStoreVolume
-	case Ydb_Scheme.Entry_COORDINATION_NODE:
-		return EntryCoordinationNode
-	default:
-		return EntryTypeUnknown
-	}
-}
-
-func (p Permissions) to(y *Ydb_Scheme.Permissions) {
-	y.Subject = p.Subject
-	y.PermissionNames = p.PermissionNames
-}
-
-func (p *Permissions) from(y *Ydb_Scheme.Permissions) {
-	*p = Permissions{
-		Subject:         y.Subject,
-		PermissionNames: y.PermissionNames,
-	}
-}
-
-func putEntry(dst []Entry, src []*Ydb_Scheme.Entry) {
+func putEntry(dst []scheme.Entry, src []*Ydb_Scheme.Entry) {
 	for i, e := range src {
-		(dst[i]).from(e)
+		(dst[i]).From(e)
 	}
 }
-
-func putPermissions(dst []Permissions, src []*Ydb_Scheme.Permissions) {
-	for i, p := range src {
-		(dst[i]).from(p)
-	}
-}
-
-func InnerConvertEntry(y *Ydb_Scheme.Entry) *Entry {
-	res := &Entry{}
-	res.from(y)
-	return res
-}

scheme.go

@@ -8,7 +8,8 @@ import (
 	"sync"
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/errors"
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/scheme"
+	internal "github.com/ydb-platform/ydb-go-sdk/v3/internal/scheme"
+	"github.com/ydb-platform/ydb-go-sdk/v3/scheme"
 	"github.com/ydb-platform/ydb-go-sdk/v3/table"
 )
 
@@ -24,6 +25,11 @@ type lazyScheme struct {
 	m      sync.Mutex
 }
 
+func (s *lazyScheme) ModifyPermissions(ctx context.Context, path string, opts ...scheme.PermissionsOption) (err error) {
+	s.init()
+	return s.client.ModifyPermissions(ctx, path, opts...)
+}
+
 func (s *lazyScheme) Close(ctx context.Context) error {
 	s.m.Lock()
 	defer s.m.Unlock()
@@ -39,7 +45,7 @@ func (s *lazyScheme) Close(ctx context.Context) error {
 func (s *lazyScheme) init() {
 	s.m.Lock()
 	if s.client == nil {
-		s.client = scheme.New(s.db)
+		s.client = internal.New(s.db)
 	}
 	s.m.Unlock()
 }