coordination

Documentation

Overview

Example

ctx := context.TODO()
db, err := ydb.Open(ctx, "grpcs://localhost:2135/local")
if err != nil {
	fmt.Printf("failed to connect: %v", err)
	return
}
defer db.Close(ctx) // cleanup resources
// create node
err = db.Coordination().CreateNode(ctx, "/local/test", coordination.NodeConfig{
	Path:                     "",
	SelfCheckPeriodMillis:    1000,
	SessionGracePeriodMillis: 1000,
	ReadConsistencyMode:      coordination.ConsistencyModeRelaxed,
	AttachConsistencyMode:    coordination.ConsistencyModeRelaxed,
	RatelimiterCountersMode:  coordination.RatelimiterCountersModeDetailed,
})
if err != nil {
	fmt.Printf("failed to create node: %v", err)
	return
}
defer db.Coordination().DropNode(ctx, "/local/test")
e, c, err := db.Coordination().DescribeNode(ctx, "/local/test")
if err != nil {
	fmt.Printf("failed to describe node: %v", err)
	return
}
fmt.Printf("node description: %+v\nnode config: %+v\n", e, c)

Index

• type Client
• type ConsistencyMode
  • func (t ConsistencyMode) String() string
  • func (t ConsistencyMode) To() Ydb_Coordination.ConsistencyMode
• type NodeConfig
• type RatelimiterCountersMode
  • func (t RatelimiterCountersMode) String() string
  • func (t RatelimiterCountersMode) To() Ydb_Coordination.RateLimiterCountersMode

Examples

• Package

Types

type Client

type Client interface {
	CreateNode(ctx context.Context, path string, config NodeConfig) (err error)
	AlterNode(ctx context.Context, path string, config NodeConfig) (err error)
	DropNode(ctx context.Context, path string) (err error)
	DescribeNode(ctx context.Context, path string) (_ *scheme.Entry, _ *NodeConfig, err error)
}

type ConsistencyMode

type ConsistencyMode uint

const (
	ConsistencyModeUnset ConsistencyMode = iota
	ConsistencyModeStrict
	ConsistencyModeRelaxed
)

func (ConsistencyMode) String

func (t ConsistencyMode) String() string

func (ConsistencyMode) To

func (t ConsistencyMode) To() Ydb_Coordination.ConsistencyMode

type NodeConfig

type NodeConfig struct {
	Path                     string
	SelfCheckPeriodMillis    uint32
	SessionGracePeriodMillis uint32
	ReadConsistencyMode      ConsistencyMode
	AttachConsistencyMode    ConsistencyMode
	RatelimiterCountersMode  RatelimiterCountersMode
}

type RatelimiterCountersMode

type RatelimiterCountersMode uint

const (
	RatelimiterCountersModeUnset RatelimiterCountersMode = iota
	RatelimiterCountersModeAggregated
	RatelimiterCountersModeDetailed
)

func (RatelimiterCountersMode) String

func (t RatelimiterCountersMode) String() string

func (RatelimiterCountersMode) To

func (t RatelimiterCountersMode) To() Ydb_Coordination.RateLimiterCountersMode