scheme

Documentation

Overview

Example

ctx := context.TODO()
db, err := ydb.Open(ctx, "grpc://localhost:2136/local")
if err != nil {
	fmt.Printf("failed to connect: %v", err)
	return
}
defer db.Close(ctx) // cleanup resources
err = db.Scheme().MakeDirectory(ctx, "/local/test")
if err != nil {
	fmt.Printf("failed to make directory: %v", err)
}
d, err := db.Scheme().ListDirectory(ctx, "/local/test")
if err != nil {
	fmt.Printf("failed to list directory: %v", err)
}
fmt.Printf("list directory: %+v\n", d)

Index

• type Client
• type Directory
• type Entry
  • func InnerConvertEntry(y *Ydb_Scheme.Entry) *Entry
  • func (e *Entry) From(y *Ydb_Scheme.Entry)
  • func (e *Entry) IsBlockStoreVolume() bool
  • func (e *Entry) IsColumnTable() bool
  • func (e *Entry) IsCoordinationNode() bool
  • func (e *Entry) IsDatabase() bool
  • func (e *Entry) IsDirectory() bool
  • func (e *Entry) IsPersQueueGroup() bool
  • func (e *Entry) IsRtmrVolume() bool
  • func (e *Entry) IsTable() bool
  • func (e *Entry) IsTopic() bool
• type EntryType
  • func (t EntryType) String() string
• type Permissions
  • func (p Permissions) To(y *Ydb_Scheme.Permissions)
• type PermissionsOption
  • func WithChangeOwner(owner string) PermissionsOption
  • func WithClearPermissions() PermissionsOption
  • func WithGrantPermissions(p Permissions) PermissionsOption
  • func WithRevokePermissions(p Permissions) PermissionsOption
  • func WithSetPermissions(p Permissions) PermissionsOption

Examples

• Package

Types

type Client

type Client interface {
	Database() string

	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)
	ModifyPermissions(ctx context.Context, path string, opts ...PermissionsOption) (err error)
}

type Directory

type Directory struct {
	Entry
	Children []Entry
}

type Entry

type Entry struct {
	Name                 string
	Owner                string
	Type                 EntryType
	Permissions          []Permissions
	EffectivePermissions []Permissions
}

func InnerConvertEntry

func InnerConvertEntry(y *Ydb_Scheme.Entry) *Entry

func (*Entry) From

func (e *Entry) From(y *Ydb_Scheme.Entry)

func (*Entry) IsBlockStoreVolume

func (e *Entry) IsBlockStoreVolume() bool

func (*Entry) IsColumnTable

func (e *Entry) IsColumnTable() bool

func (*Entry) IsCoordinationNode

func (e *Entry) IsCoordinationNode() bool

func (*Entry) IsDatabase

func (e *Entry) IsDatabase() bool

func (*Entry) IsDirectory

func (e *Entry) IsDirectory() bool

func (*Entry) IsPersQueueGroup

func (e *Entry) IsPersQueueGroup() bool

func (*Entry) IsRtmrVolume

func (e *Entry) IsRtmrVolume() bool

func (*Entry) IsTable

func (e *Entry) IsTable() bool

func (*Entry) IsTopic

func (e *Entry) IsTopic() bool

type EntryType

type EntryType uint

const (
	EntryTypeUnknown EntryType = iota
	EntryDirectory
	EntryTable
	EntryPersQueueGroup
	EntryDatabase
	EntryRtmrVolume
	EntryBlockStoreVolume
	EntryCoordinationNode
	EntryTopic
	EntryColumnStore
	EntryColumnTable
)

func (EntryType) String

func (t EntryType) String() string

type Permissions

type Permissions struct {
	Subject         string
	PermissionNames []string
}

func (Permissions) To

func (p Permissions) To(y *Ydb_Scheme.Permissions)

type PermissionsOption

type PermissionsOption func(permissionsDesc)

func WithChangeOwner

func WithChangeOwner(owner string) PermissionsOption

func WithClearPermissions

func WithClearPermissions() PermissionsOption

func WithGrantPermissions

func WithGrantPermissions(p Permissions) PermissionsOption

func WithRevokePermissions

func WithRevokePermissions(p Permissions) PermissionsOption

func WithSetPermissions

func WithSetPermissions(p Permissions) PermissionsOption