storage

Documentation

Index

• Variables
• func ConvertShardRoleToPB(role ShardRole) clusterpb.ShardRole
• type Cluster
• type ClusterID
• type ClusterState
• type ClusterView
• type CreateClusterRequest
• type CreateClusterViewRequest
• type CreateOrUpdateNodeRequest
• type CreateSchemaRequest
• type CreateShardViewsRequest
• type CreateTableRequest
• type DeleteTableRequest
• type GetClusterViewRequest
• type GetClusterViewResult
• type GetTableRequest
• type GetTableResult
• type ListClustersResult
• type ListNodesRequest
• type ListNodesResult
• type ListSchemasRequest
• type ListSchemasResult
• type ListShardViewsRequest
• type ListShardViewsResult
• type ListTableRequest
• type ListTablesResult
• type Node
• type NodeState
• type NodeStats
• type Options
• type PartitionInfo
• type Schema
• type SchemaID
• type ShardID
• type ShardNode
• type ShardRole
  • func ConvertShardRolePB(role clusterpb.ShardRole) ShardRole
• type ShardView
• type Storage
  • func NewStorageWithEtcdBackend(client *clientv3.Client, rootPath string, opts Options) Storage
• type Table
  • func (t Table) IsPartitioned() bool
• type TableID
• type UpdateClusterViewRequest
• type UpdateShardViewRequest

Variables

var (
	ErrEncode = coderr.NewCodeError(coderr.Internal, "storage encode")
	ErrDecode = coderr.NewCodeError(coderr.Internal, "storage decode")

	ErrCreateSchemaAgain         = coderr.NewCodeError(coderr.Internal, "storage create schemas")
	ErrCreateClusterAgain        = coderr.NewCodeError(coderr.Internal, "storage create cluster")
	ErrCreateClusterViewAgain    = coderr.NewCodeError(coderr.Internal, "storage create cluster view")
	ErrUpdateClusterViewConflict = coderr.NewCodeError(coderr.Internal, "storage update cluster view")
	ErrCreateTableAgain          = coderr.NewCodeError(coderr.Internal, "storage create tables")
	ErrDeleteTableAgain          = coderr.NewCodeError(coderr.Internal, "storage delete table")
	ErrCreateShardViewAgain      = coderr.NewCodeError(coderr.Internal, "storage create shard view")
	ErrUpdateShardViewConflict   = coderr.NewCodeError(coderr.Internal, "storage update shard view")
)

Functions

func ConvertShardRoleToPB

func ConvertShardRoleToPB(role ShardRole) clusterpb.ShardRole

Types

type Cluster

type Cluster struct {
	ID                ClusterID
	Name              string
	MinNodeCount      uint32
	ReplicationFactor uint32
	ShardTotal        uint32
	CreatedAt         uint64
}

type ClusterID

type ClusterID uint32

type ClusterState

type ClusterState int

const (
	ClusterStateEmpty ClusterState = iota + 1
	ClusterStateStable
)

type ClusterView

type ClusterView struct {
	ClusterID  ClusterID
	Version    uint64
	State      ClusterState
	ShardNodes []ShardNode
	CreatedAt  uint64
}

type CreateClusterRequest

type CreateClusterRequest struct {
	Cluster Cluster
}

type CreateClusterViewRequest

type CreateClusterViewRequest struct {
	ClusterView ClusterView
}

type CreateOrUpdateNodeRequest

type CreateOrUpdateNodeRequest struct {
	ClusterID ClusterID
	Node      Node
}

type CreateSchemaRequest

type CreateSchemaRequest struct {
	ClusterID ClusterID
	Schema    Schema
}

type CreateShardViewsRequest

type CreateShardViewsRequest struct {
	ClusterID  ClusterID
	ShardViews []ShardView
}

type CreateTableRequest

type CreateTableRequest struct {
	ClusterID ClusterID
	SchemaID  SchemaID
	Table     Table
}

type DeleteTableRequest

type DeleteTableRequest struct {
	ClusterID ClusterID
	SchemaID  SchemaID
	TableName string
}

type GetClusterViewRequest

type GetClusterViewRequest struct {
	ClusterID ClusterID
}

type GetClusterViewResult

type GetClusterViewResult struct {
	ClusterView ClusterView
}

type GetTableRequest

type GetTableRequest struct {
	ClusterID ClusterID
	SchemaID  SchemaID
	TableName string
}

type GetTableResult

type GetTableResult struct {
	Table  Table
	Exists bool
}

type ListClustersResult

type ListClustersResult struct {
	Clusters []Cluster
}

type ListNodesRequest

type ListNodesRequest struct {
	ClusterID ClusterID
}

type ListNodesResult

type ListNodesResult struct {
	Nodes []Node
}

type ListSchemasRequest

type ListSchemasRequest struct {
	ClusterID ClusterID
}

type ListSchemasResult

type ListSchemasResult struct {
	Schemas []Schema
}

type ListShardViewsRequest

type ListShardViewsRequest struct {
	ClusterID ClusterID
	ShardIDs  []ShardID
}

type ListShardViewsResult

type ListShardViewsResult struct {
	ShardViews []ShardView
}

type ListTableRequest

type ListTableRequest struct {
	ClusterID ClusterID
	SchemaID  SchemaID
}

type ListTablesResult

type ListTablesResult struct {
	Tables []Table
}

type Node

type Node struct {
	Name          string
	NodeStats     NodeStats
	LastTouchTime uint64
	State         NodeState
}

type NodeState

type NodeState int

const (
	NodeStateOnline NodeState = iota + 1
	NodeStateOffline
)

type NodeStats

type NodeStats struct {
	Lease       uint32
	Zone        string
	NodeVersion string
}

type Options

type Options struct {
	// MaxScanLimit is the max limit of the number of keys in a scan.
	MaxScanLimit int
	// MinScanLimit is the min limit of the number of keys in a scan.
	MinScanLimit int
}

type PartitionInfo

type PartitionInfo struct {
	Info *clusterpb.PartitionInfo
}

type Schema

type Schema struct {
	ID        SchemaID
	ClusterID ClusterID
	Name      string
	CreatedAt uint64
}

type SchemaID

type SchemaID uint32

type ShardID

type ShardID uint32

type ShardNode

type ShardNode struct {
	ID        ShardID
	ShardRole ShardRole
	NodeName  string
}

type ShardRole

type ShardRole int

const (
	ShardRoleLeader ShardRole = iota + 1
	ShardRoleFollower
)

func ConvertShardRolePB

func ConvertShardRolePB(role clusterpb.ShardRole) ShardRole

type ShardView

type ShardView struct {
	ShardID   ShardID
	Version   uint64
	TableIDs  []TableID
	CreatedAt uint64
}

type Storage

type Storage interface {
	// ListClusters list all clusters.
	ListClusters(ctx context.Context) (ListClustersResult, error)
	// CreateCluster create new cluster, return error if cluster already exists.
	CreateCluster(ctx context.Context, req CreateClusterRequest) error

	// CreateClusterView create cluster view.
	CreateClusterView(ctx context.Context, req CreateClusterViewRequest) error
	// GetClusterView get cluster view by cluster id.
	GetClusterView(ctx context.Context, req GetClusterViewRequest) (GetClusterViewResult, error)
	// UpdateClusterView update cluster view.
	UpdateClusterView(ctx context.Context, req UpdateClusterViewRequest) error

	// ListSchemas list all schemas in specified cluster.
	ListSchemas(ctx context.Context, req ListSchemasRequest) (ListSchemasResult, error)
	// CreateSchema create schema in specified cluster.
	CreateSchema(ctx context.Context, req CreateSchemaRequest) error

	// CreateTable create new table in specified cluster and schema, return error if table already exists.
	CreateTable(ctx context.Context, req CreateTableRequest) error
	// GetTable get table by table name in specified cluster and schema.
	GetTable(ctx context.Context, req GetTableRequest) (GetTableResult, error)
	// ListTables list all tables in specified cluster and schema.
	ListTables(ctx context.Context, req ListTableRequest) (ListTablesResult, error)
	// DeleteTable delete table by table name in specified cluster and schema.
	DeleteTable(ctx context.Context, req DeleteTableRequest) error

	// CreateShardViews create shard views in specified cluster.
	CreateShardViews(ctx context.Context, req CreateShardViewsRequest) error
	// ListShardViews list all shard views in specified cluster.
	ListShardViews(ctx context.Context, req ListShardViewsRequest) (ListShardViewsResult, error)
	// UpdateShardView update shard views in specified cluster.
	UpdateShardView(ctx context.Context, req UpdateShardViewRequest) error

	// ListNodes list all nodes in specified cluster.
	ListNodes(ctx context.Context, req ListNodesRequest) (ListNodesResult, error)
	// CreateOrUpdateNode create or update node in specified cluster.
	CreateOrUpdateNode(ctx context.Context, req CreateOrUpdateNodeRequest) error
}

Storage defines the storage operations on the ceresdb cluster meta info.

func NewStorageWithEtcdBackend

func NewStorageWithEtcdBackend(client *clientv3.Client, rootPath string, opts Options) Storage

NewStorageWithEtcdBackend creates a new storage with etcd backend.

type Table

type Table struct {
	ID            TableID
	Name          string
	SchemaID      SchemaID
	CreatedAt     uint64
	PartitionInfo PartitionInfo
}

func (Table) IsPartitioned

func (t Table) IsPartitioned() bool

type TableID

type TableID uint64

type UpdateClusterViewRequest

type UpdateClusterViewRequest struct {
	ClusterID     ClusterID
	ClusterView   ClusterView
	LatestVersion uint64
}

type UpdateShardViewRequest

type UpdateShardViewRequest struct {
	ClusterID     ClusterID
	ShardView     ShardView
	LatestVersion uint64
}