kk_etcd

Documentation

Index

• func AllKVsBackup() (error, *kk_etcd_models.AllKVsBackupResponse)
• func AllKVsRestore(param *kk_etcd_models.AllKVsRestoreParam) (error, *kk_etcd_models.AllKVsRestoreResponse)
• func CheckKeyExist(key string) error
• func GetClient() *clientv3.Client
• func GetGrpcClient[T any](serverName string, ...) (conn *grpc.ClientConn, client T, err error)
• func GetJson(key string, structPtr any) error
• func GetYaml(key string, structPtr any) error
• func KVDel(param *kk_etcd_models.KVDelParam) (error, *kk_etcd_models.KVDelResponse)
• func KVGet(param *kk_etcd_models.KVGetParam) (error, *kk_etcd_models.KVGetResponse)
• func KVList(param *kk_etcd_models.KVListParam) (error, *kk_etcd_models.KVListResponse)
• func KVPut(param *kk_etcd_models.KVPutParam) (error, *kk_etcd_models.KVPutResponse)
• func PutExistUpdateJson(key string, structPtr any) error
• func PutExistUpdateYaml(key string, structPtr any) error
• func PutJson(key string, structPtr any) error
• func PutYaml(key string, structPtr any) error
• func RegisterService(registration *kk_etcd_models.ServerRegistration) error
• func ServerList(param *kk_etcd_models.ServerListParam) (*kk_etcd_models.PBListServer, error)
• func Snapshot() (error, *kk_etcd_models.SnapshotResponse)
• func SnapshotInfo(param *kk_etcd_models.SnapshotInfoParam) (error, *kk_etcd_models.SnapshotInfoResponse)
• func SnapshotRestore() (error, *kk_etcd_models.SnapshotRestoreResponse)
• func UpdateJson(key string, structPtr any) error
• func UpdateYaml(key string, structPtr any) error
• func WatchServerList(ctx context.Context, serverType kk_etcd_models.ServerType, serverName string, ...) (err error)
• type CloseFunc
  • func InitClient(cfg *InitClientConfig) (CloseFunc, error)
• type InitClientConfig
  • func (x *InitClientConfig) Check()

Functions

func AllKVsBackup

func AllKVsBackup() (error, *kk_etcd_models.AllKVsBackupResponse)

func AllKVsRestore

func AllKVsRestore(param *kk_etcd_models.AllKVsRestoreParam) (error, *kk_etcd_models.AllKVsRestoreResponse)

AllKVsRestore will overwrite exist kv

func CheckKeyExist

func CheckKeyExist(key string) error

func GetClient

func GetClient() *clientv3.Client

func GetGrpcClient

func GetGrpcClient[T any](serverName string,
	clientBuilder func(grpcConn grpc.ClientConnInterface) (client T),
	opts ...grpc.DialOption) (conn *grpc.ClientConn, client T, err error)

GetGrpcClient get grpc client for serverName

don't forget to close conn conn.Close()

func GetJson

func GetJson(key string, structPtr any) error

GetJson get json from etcd and unmarshal to structPtr eg: GetJson("configKey", &Config)

func GetYaml

func GetYaml(key string, structPtr any) error

GetYaml get yaml from etcd and unmarshal to structPtr eg: GetYaml("configKey", &Config)

func KVDel

func KVDel(param *kk_etcd_models.KVDelParam) (error, *kk_etcd_models.KVDelResponse)

func KVGet

func KVGet(param *kk_etcd_models.KVGetParam) (error, *kk_etcd_models.KVGetResponse)

func KVList

func KVList(param *kk_etcd_models.KVListParam) (error, *kk_etcd_models.KVListResponse)

func KVPut

func KVPut(param *kk_etcd_models.KVPutParam) (error, *kk_etcd_models.KVPutResponse)

func PutExistUpdateJson

func PutExistUpdateJson(key string, structPtr any) error

func PutExistUpdateYaml

func PutExistUpdateYaml(key string, structPtr any) error

func PutJson

func PutJson(key string, structPtr any) error

PutJson put struct to etcd in json format, key should not exist

func PutYaml

func PutYaml(key string, structPtr any) error

PutYaml put struct to etcd in yaml format, key should not exist recommend: use PutJson instead which is more efficient

func RegisterService

func RegisterService(registration *kk_etcd_models.ServerRegistration) error

RegisterService register service to etcd

func ServerList

func ServerList(param *kk_etcd_models.ServerListParam) (*kk_etcd_models.PBListServer, error)

ServerList serverName, should with prefix key_prefix.ServiceGrpc or key_prefix.ServiceHttp only give prefix to get all service list

func Snapshot

func Snapshot() (error, *kk_etcd_models.SnapshotResponse)

func SnapshotInfo

func SnapshotInfo(param *kk_etcd_models.SnapshotInfoParam) (error, *kk_etcd_models.SnapshotInfoResponse)

func SnapshotRestore

func SnapshotRestore() (error, *kk_etcd_models.SnapshotRestoreResponse)

func UpdateJson

func UpdateJson(key string, structPtr any) error

UpdateJson update struct in etcd, key should exist

func UpdateYaml

func UpdateYaml(key string, structPtr any) error

UpdateYaml update struct in etcd, key should exist

func WatchServerList

func WatchServerList(ctx context.Context, serverType kk_etcd_models.ServerType, serverName string, serverListChan chan<- *kk_etcd_models.PBListServer) (err error)

WatchServerList watch server list change

Types

type CloseFunc

type CloseFunc func() error

func InitClient

func InitClient(cfg *InitClientConfig) (CloseFunc, error)

type InitClientConfig

type InitClientConfig struct {
	Endpoints []string
	UserName  string
	Password  string
	DebugMode bool
}

func (*InitClientConfig) Check

func (x *InitClientConfig) Check()