client

type Auth interface {
	// AuthEnable enables auth of an etcd cluster.
	AuthEnable() (*AuthEnableResponse, error)

	// AuthDisable disables auth of an etcd cluster.
	AuthDisable() (*AuthDisableResponse, error)

	// AuthStatus returns the status of auth of an etcd cluster.
	AuthStatus() (*AuthStatusResponse, error)

	// Authenticate login and get token
	Authenticate(name string, password string) (*AuthenticateResponse, error)

	// UserAdd adds a new user to an etcd cluster.
	UserAdd(name string, password string) (*AuthUserAddResponse, error)

	// UserAddWithOptions adds a new user to an etcd cluster with some options.
	UserAddWithOptions(name string, password string, opt *UserAddOptions) (*AuthUserAddResponse, error)

	// UserGet gets a detailed information of a user.
	UserGet(name string) (*AuthUserGetResponse, error)

	// UserList gets a list of all users.
	UserList() (*AuthUserListResponse, error)

	// UserDelete deletes a user from an etcd cluster.
	UserDelete(name string) (*AuthUserDeleteResponse, error)

	// UserChangePassword changes a password of a user.
	UserChangePassword(name string, password string) (*AuthUserChangePasswordResponse, error)

	// UserGrantRole grants a role to a user.
	UserGrantRole(user string, role string) (*AuthUserGrantRoleResponse, error)

	// UserRevokeRole revokes a role of a user.
	UserRevokeRole(name string, role string) (*AuthUserRevokeRoleResponse, error)

	// RoleAdd adds a new role to an etcd cluster.
	RoleAdd(name string) (*AuthRoleAddResponse, error)

	// RoleGet gets a detailed information of a role.
	RoleGet(role string) (*AuthRoleGetResponse, error)

	// RoleList gets a list of all roles.
	RoleList() (*AuthRoleListResponse, error)

	// RoleDelete deletes a role.
	RoleDelete(role string) (*AuthRoleDeleteResponse, error)

	// RoleGrantPermission grants a permission to a role.
	RoleGrantPermission(name string, key, rangeEnd []byte, permType PermissionType) (*AuthRoleGrantPermissionResponse, error)

	// RoleRevokePermission revokes a permission from a role.
	RoleRevokePermission(role string, key, rangeEnd []byte) (*AuthRoleRevokePermissionResponse, error)
}

type AuthDisableResponse xlineapi.AuthDisableResponse

type AuthEnableResponse xlineapi.AuthEnableResponse

type AuthRoleAddResponse xlineapi.AuthRoleAddResponse

type AuthRoleDeleteResponse xlineapi.AuthRoleDeleteResponse

type AuthRoleGetResponse xlineapi.AuthRoleGetResponse

type AuthRoleGrantPermissionResponse xlineapi.AuthRoleGrantPermissionResponse

type AuthRoleListResponse xlineapi.AuthRoleListResponse

type AuthRoleRevokePermissionResponse xlineapi.AuthRoleRevokePermissionResponse

type AuthStatusResponse xlineapi.AuthStatusResponse

type AuthUserAddResponse xlineapi.AuthUserAddResponse

type AuthUserChangePasswordResponse xlineapi.AuthUserChangePasswordResponse

type AuthUserDeleteResponse xlineapi.AuthUserDeleteResponse

type AuthUserGetResponse xlineapi.AuthUserGetResponse

type AuthUserGrantRoleResponse xlineapi.AuthUserGrantRoleResponse

type AuthUserListResponse xlineapi.AuthUserListResponse

type AuthUserRevokeRoleResponse xlineapi.AuthUserRevokeRoleResponse

type AuthenticateResponse xlineapi.AuthenticateResponse

type ClientConfig struct {
	// Curp client wait sync timeout
	WaitSyncedTimeout time.Duration

	// Curp client propose request timeout
	ProposeTimeout time.Duration

	// Curp client initial retry interval
	InitialRetryTimeout time.Duration

	// Curp client max retry interval
	MaxRetryTimeout time.Duration

	// Curp client retry interval
	RetryCount int

	// Whether to use exponential backoff in retries
	UseBackoff *bool
}

type ClientOptions struct {
	// User is a pair values of name and password
	User UserCredentials
	// Timeout settings for the curp client
	CurpTimeout ClientConfig
}

type Cluster interface {
	// MemberList lists the current cluster membership.
	MemberList(ctx context.Context) (*MemberListResponse, error)

	// MemberAdd adds a new member into the cluster.
	MemberAdd(ctx context.Context, peerAddrs []string) (*MemberAddResponse, error)

	// MemberAddAsLearner adds a new learner member into the cluster.
	MemberAddAsLearner(ctx context.Context, peerAddrs []string) (*MemberAddResponse, error)

	// MemberRemove removes an existing member from the cluster.
	MemberRemove(ctx context.Context, id uint64) (*MemberRemoveResponse, error)

	// MemberUpdate updates the peer addresses of the member.
	MemberUpdate(ctx context.Context, id uint64, peerAddrs []string) (*MemberUpdateResponse, error)

	// MemberPromote promotes a member from raft learner (non-voting) to raft voting member.
	MemberPromote(ctx context.Context, id uint64) (*MemberPromoteResponse, error)
}

type Cmp xlineapi.Compare

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

type CompactResponse xlineapi.CompactionResponse

type CompareResult int

type CompareTarget int

type Curp interface {
	// Propose the request to servers, if use_fast_path is false, it will wait for the synced index
	Propose(cmd *xlineapi.Command, useFastPath bool) (*proposeRes, error)

	// Generate a propose id
	GenProposeID() (*curpapi.ProposeId, error)
}

type DeleteResponse xlineapi.DeleteRangeResponse

type KV interface {
	// Put puts a key-value pair into xline.
	// When passed WithLease(), Put will attaches a lease ID to a key in 'Put' request.
	// When passed WithPrevKV(), Put will returns the previous key-value pair before the event happens.
	// When passed WithIgnoreValue(), Put will updates the key using its current value.
	// When passed WithIgnoreLease(), Put will updates the key using its current lease.
	Put(key, val []byte, opts ...OpOption) (*PutResponse, error)

	// Range retrieves keys.
	// By default, Range will return the value for "key", if any.
	// When passed WithRange(), Range will returns the keys in the range [key, end).
	// When passed WithFromKey(), Range will returns keys greater than or equal to the key.
	// When passed WithPrefix(), Range will returns keys that begin with the key.
	// When passed WithLimit(), Range will returns keys is bounded by limit.
	// When passed WithRev() with rev > 0, Range will returns key at the given revision.
	// When passed WithSort(), Range will returns keys be sorted.
	// When passed WithSerializable(), Range will makes 'Range' request serializable. By default, it's linearizable.
	// When passed WithKeysOnly(), Range will returns only the keys and the corresponding values will be omitted.
	// When passed WithCountOnly(), Range will returns only the count of keys.
	// When passed WithMinModRev(), Range will returns keys with modification revisions less than the given revision.
	// When passed WithMaxModRev(), Range will returns keys with modification revisions greater than the given revision.
	// When passed WithMinCreateRev(), Range will returns keys with creation revisions less than the given revision.
	// When passed WithMaxCreateRev(), Range will returns keys with creation revisions greater than the given revision.
	Range(key []byte, opts ...OpOption) (*RangeResponse, error)

	// Delete deletes a key, or optionally using WithRange(end), [key, end).
	// When passed WithPrevKV(), Delete will returns the previous key-value pair before the event happens.
	Delete(key string, opts ...OpOption) (*DeleteResponse, error)

	// Txn creates a transaction.
	Txn() Txn

	// Compact compacts xline KV history before the given rev.
	// When passed WithPhysical(), Compact will wait until all compacted entries are removed from the etcd server's storage.
	Compact(rev int64, opts ...OpOption) (*CompactResponse, error)
}

type Lease interface {
	// Grant creates a new lease.
	// When passed WithID(), Grant will used to specify the lease ID, otherwise it is automatically generated.
	Grant(ttl int64, opts ...LeaseOption) (*LeaseGrantResponse, error)

	// Revoke revokes the given lease.
	Revoke(id int64) (*LeaseRevokeResponse, error)

	// KeepAlive attempts to keep the given lease alive forever.
	KeepAlive(ctx context.Context, id int64) (<-chan *LeaseKeepAliveResponse, error)

	// KeepAliveOnce renews the lease once. The response corresponds to the first message from calling KeepAlive.
	// In most of the cases, Keepalive should be used instead of KeepAliveOnce.
	KeepAliveOnce(id int64) (*LeaseKeepAliveResponse, error)

	// TimeToLive retrieves the lease information of the given lease ID.
	// When passed WithAttachedKeys(), TimeToLive will list the keys attached to the given lease ID.
	TimeToLive(id int64, opts ...LeaseOption) (*LeaseTimeToLiveResponse, error)

	// Leases retrieves all leases.
	Leases() (*LeaseLeasesResponse, error)
}

type LeaseGrantResponse xlineapi.LeaseGrantResponse

type LeaseKeepAliveResponse xlineapi.LeaseKeepAliveResponse

type LeaseLeasesResponse xlineapi.LeaseLeasesResponse

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

type LeaseOption func(*LeaseOp)

type LeaseRevokeResponse xlineapi.LeaseRevokeResponse

type LeaseTimeToLiveResponse xlineapi.LeaseTimeToLiveResponse

type Lock interface {
	// Acquires a distributed shared lock on a given named lock.
	// On success, it will return a unique key that exists so long as the
	// lock is held by the caller. This key can be used in conjunction with
	// transactions to safely ensure updates to Xline only occur while holding
	// lock ownership. The lock is held until Unlock is called on the key or the
	// lease associate with the owner expires.
	Lock(request LockRequest) (*xlineapi.LockResponse, error)

	// Takes a key returned by Lock and releases the hold on lock. The
	// next Lock caller waiting for the lock will then be woken up and given
	// ownership of the lock.
	UnLock(request *xlineapi.UnlockRequest) (*xlineapi.UnlockResponse, error)
}

type LockRequest struct {
	// The Inner request
	Inner *xlineapi.LockRequest
	// The TTL of the lease that attached to the lock
	TTL int64
}

type Maintenance interface {
	// Gets a snapshot over a stream
	Snapshot() (SnapshotClient, error)
}

type Member xlineapi.Member

type MemberAddResponse xlineapi.MemberAddResponse

type MemberListResponse xlineapi.MemberListResponse

type MemberPromoteResponse xlineapi.MemberPromoteResponse

type MemberRemoveResponse xlineapi.MemberRemoveResponse

type MemberUpdateResponse xlineapi.MemberUpdateResponse

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

type OpOption func(*Op)

type PermissionType xlineapi.Permission_Type

type PutResponse xlineapi.PutResponse

type RangeResponse xlineapi.RangeResponse

type ServerId = uint64

type SnapshotClient xlineapi.Maintenance_SnapshotClient

type SortOption struct {
	Target SortTarget
	Order  SortOrder
}

type SortOrder int

type SortTarget int

type Txn interface {
	// When takes a list of comparison. When all comparisons passed in succeed,
	// the operations passed into Then() will be executed. Or the operations
	// passed into Else() will be executed.
	When(cs ...Cmp) Txn

	// AndThen takes a list of operations. The Ops list will be executed, if the
	// comparisons passed in If() succeed.
	AndThen(ops ...Op) Txn

	// OrElse takes a list of operations. The Ops list will be executed, if the
	// comparisons passed in If() fail.
	OrElse(ops ...Op) Txn

	// Commit tries to commit the transaction.
	Commit() (*TxnResponse, error)
}

type TxnResponse xlineapi.TxnResponse

type UserAddOptions xlineapi.UserAddOptions

type UserCredentials struct {
	// Username
	Name string
	// Password
	Password string
}

type Watch interface {
	// Watches for events happening or that have happened.
	Watch(ctx context.Context, key []byte) (<-chan *WatchResponse, error)
}

type WatchResponse xlineapi.WatchResponse