scyllaclient

Documentation

Index

• Constants
• type Client
  • func (c *Client) HostDatacenter(ctx context.Context, host string) (dc string, err error)
  • func (c *Client) Status(ctx context.Context) (NodeStatusInfoSlice, error)
• type CommandStatus
• type NodeState
  • func (s NodeState) String() string
• type NodeStatus
  • func (s NodeStatus) String() string
• type NodeStatusInfo
  • func (s NodeStatusInfo) IsUN() bool
• type NodeStatusInfoSlice
  • func (s NodeStatusInfoSlice) Datacenter(dcs []string) NodeStatusInfoSlice
  • func (s NodeStatusInfoSlice) DownHosts() []string
  • func (s NodeStatusInfoSlice) Hosts() []string
  • func (s NodeStatusInfoSlice) LiveHosts() []string
• type ReplicationStrategy
• type Ring
  • func (r Ring) Datacenters() []string
• type ScyllaFeatures
• type TokenRange
• type Unit

Constants

const (
	LocalStrategy           = "org.apache.cassandra.locator.LocalStrategy"
	SimpleStrategy          = "org.apache.cassandra.locator.SimpleStrategy"
	NetworkTopologyStrategy = "org.apache.cassandra.locator.NetworkTopologyStrategy"
)

Replication strategies

const (
	Murmur3Partitioner = "org.apache.cassandra.dht.Murmur3Partitioner"
)

Partitioners

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func (*Client) HostDatacenter

func (c *Client) HostDatacenter(ctx context.Context, host string) (dc string, err error)

HostDatacenter looks up the datacenter that the given host belongs to.

func (*Client) Status

func (c *Client) Status(ctx context.Context) (NodeStatusInfoSlice, error)

type CommandStatus

type CommandStatus string

CommandStatus specifies a result of a command

const (
	CommandRunning    CommandStatus = "RUNNING"
	CommandSuccessful CommandStatus = "SUCCESSFUL"
	CommandFailed     CommandStatus = "FAILED"
)

Command statuses

type NodeState

type NodeState string

NodeState represents nodetool State=Normal/Leaving/Joining/Moving

const (
	NodeStateNormal  NodeState = ""
	NodeStateLeaving NodeState = "LEAVING"
	NodeStateJoining NodeState = "JOINING"
	NodeStateMoving  NodeState = "MOVING"
)

NodeState enumeration

func (NodeState) String

func (s NodeState) String() string

type NodeStatus

type NodeStatus bool

NodeStatus represents nodetool Status=Up/Down.

const (
	NodeStatusUp   NodeStatus = true
	NodeStatusDown NodeStatus = false
)

NodeStatus enumeration

func (NodeStatus) String

func (s NodeStatus) String() string

type NodeStatusInfo

type NodeStatusInfo struct {
	Datacenter string
	HostID     string
	Addr       string
	Status     NodeStatus
	State      NodeState
}

NodeStatusInfo represents a nodetool status line.

func (NodeStatusInfo) IsUN

func (s NodeStatusInfo) IsUN() bool

IsUN returns true if host is Up and NORMAL meaning it's a fully functional live node.

type NodeStatusInfoSlice

type NodeStatusInfoSlice []NodeStatusInfo

NodeStatusInfoSlice adds functionality to Status response.

func (NodeStatusInfoSlice) Datacenter

func (s NodeStatusInfoSlice) Datacenter(dcs []string) NodeStatusInfoSlice

Datacenter resturns sub slice containing only nodes from given datacenters.

func (NodeStatusInfoSlice) DownHosts

func (s NodeStatusInfoSlice) DownHosts() []string

DownHosts returns slice of address of nodes that are down.

func (NodeStatusInfoSlice) Hosts

func (s NodeStatusInfoSlice) Hosts() []string

Hosts returns slice of address of all nodes.

func (NodeStatusInfoSlice) LiveHosts

func (s NodeStatusInfoSlice) LiveHosts() []string

LiveHosts returns slice of address of nodes in UN state.

type ReplicationStrategy

type ReplicationStrategy string

ReplicationStrategy specifies type of a keyspace replication strategy.

type Ring

type Ring struct {
	Tokens      []TokenRange
	HostDC      map[string]string
	Replication ReplicationStrategy
}

Ring describes token ring of a keyspace.

func (Ring) Datacenters

func (r Ring) Datacenters() []string

Datacenters returs a list of datacenters the keyspace is replicated in.

type ScyllaFeatures

type ScyllaFeatures struct {
	RowLevelRepair bool
}

ScyllaFeatures specifies features supported by the Scylla version.

type TokenRange

type TokenRange struct {
	StartToken int64
	EndToken   int64
	Replicas   []string
}

TokenRange describes replicas of a token (range).

type Unit

type Unit struct {
	Keyspace string
	Tables   []string
}

Unit describes keyspace and some tables in that keyspace.