mode

Documentation

Index

• Constants
• type Mode
  • func (m Mode) Disabled() bool
  • func (m Mode) NoMetabase() bool
  • func (m Mode) ReadOnly() bool
  • func (m Mode) String() string

Constants

const (
	// ReadWrite is a Mode value for shard that is available
	// for read and write operations. Default shard mode.
	ReadWrite Mode = 0

	// DegradedReadOnly is a Mode value for shard that is set automatically
	// after a certain number of errors is encountered. It is the same as
	// `mode.Degraded` but also is read-only.
	DegradedReadOnly = Degraded | ReadOnly

	// Disabled mode is a mode where a shard is disabled.
	// An existing shard can't have this mode, but it can be used in
	// the configuration or control service commands.
	Disabled = math.MaxUint32
)

Types

type Mode

type Mode uint32

Mode represents enumeration of Shard work modes.

const (
	// ReadOnly is a Mode value for shard that does not
	// accept write operation but is readable.
	ReadOnly Mode = 1 << iota

	// Degraded is a Mode value for shard when the metabase is unavailable.
	// It is hard to perform some modifying operations in this mode, thus it can only be set by an administrator.
	Degraded
)

func (Mode) Disabled

func (m Mode) Disabled() bool

func (Mode) NoMetabase

func (m Mode) NoMetabase() bool

NoMetabase returns true iff m is operating without the metabase.

func (Mode) ReadOnly

func (m Mode) ReadOnly() bool

ReadOnly returns true iff m prohibits modifying operations with shard.

func (Mode) String

func (m Mode) String() string