Anthony Romano 219a4e9ad5 clientv3: don't reset keepalive stream on grant failure 8 yıl önce
..
concurrency 4b48876f0e clientv3/concurrency: allow election on prefixes of keys. 8 yıl önce
integration 41e329cd35 *: drop breaking-changes from master branch 8 yıl önce
mirror 1292d453c3 clientv3: fix sync base 8 yıl önce
README.md 0c5bcd5d80 clientv3: fix README, add error handling example 8 yıl önce
auth.go 606d79afc4 clientv3: use failfast and retry wrappers for at-most-once rpcs 8 yıl önce
balancer.go 2435eb9ecd clientv3: balancer panics when call up after close 8 yıl önce
client.go 606d79afc4 clientv3: use failfast and retry wrappers for at-most-once rpcs 8 yıl önce
client_test.go 4a841459f1 clientv3: respect up/down notifications from grpc 8 yıl önce
cluster.go 606d79afc4 clientv3: use failfast and retry wrappers for at-most-once rpcs 8 yıl önce
compact_op.go 76e2bf03b8 etcdctl: v3 compact with physical flag 8 yıl önce
compact_op_test.go 859e336d68 clientv3: configurable physical in compact 8 yıl önce
compare.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
config.go 62f8ec25c0 clientv3: use grpc reconnection logic 8 yıl önce
config_test.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
doc.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
example_auth_test.go ca91f898a2 auth, e2e, clientv3: the root role should be granted access to every key 8 yıl önce
example_cluster_test.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
example_kv_test.go 8bbccf1047 clientv3, ctl3, clientv3/integration: add compact response to compact 8 yıl önce
example_lease_test.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
example_maintenence_test.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
example_test.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
example_watch_test.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
kv.go fe7379f102 clientv3: add Op.prevKV 8 yıl önce
lease.go 219a4e9ad5 clientv3: don't reset keepalive stream on grant failure 7 yıl önce
logger.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
main_test.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
maintenance.go 129b271ff8 clientv3: use grpc.FailFast(false) for all calls 8 yıl önce
op.go f322fe7f0d clientv3, ctlv3: document range end requirement 8 yıl önce
retry.go 606d79afc4 clientv3: use failfast and retry wrappers for at-most-once rpcs 8 yıl önce
sort.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce
txn.go 606d79afc4 clientv3: use failfast and retry wrappers for at-most-once rpcs 8 yıl önce
txn_test.go 7dfe7db243 clientv3: panic if ActiveConnection tries to return non-nil connection 8 yıl önce
watch.go 83b493f945 clientv3: let watchers cancel when reconnecting 8 yıl önce
watch_test.go fd9e07a529 clientv3: update LICENSE header 8 yıl önce

README.md

etcd/clientv3

Godoc

etcd/clientv3 is the official Go etcd client for v3.

Install

go get github.com/coreos/etcd/clientv3

Get started

Create client using clientv3.New:

cli, err := clientv3.New(clientv3.Config{
	Endpoints:   []string{"localhost:2379", "localhost:22379", "localhost:32379"},
	DialTimeout: 5 * time.Second,
})
if err != nil {
	// handle error!
}
defer cli.Close()

etcd v3 uses gRPC for remote procedure calls. And clientv3 uses grpc-go to connect to etcd. Make sure to close the client after using it. If the client is not closed, the connection will have leaky goroutines. To specify client request timeout, pass context.WithTimeout to APIs:

ctx, cancel := context.WithTimeout(context.Background(), timeout)
resp, err := kvc.Put(ctx, "sample_key", "sample_value")
cancel()
if err != nil {
    // handle error!
}
// use the response

etcd uses cmd/vendor directory to store external dependencies, which are to be compiled into etcd release binaries. client can be imported without vendoring. For full compatibility, it is recommended to vendor builds using etcd's vendored packages, using tools like godep, as in vendor directories. For more detail, please read Go vendor design.

Error Handling

etcd client returns 2 types of errors:

  1. context error: canceled or deadline exceeded.
  2. gRPC error: see api/v3rpc/rpctypes.

Here is the example code to handle client errors:

resp, err := kvc.Put(ctx, "", "")
if err != nil {
	switch err {
	case context.Canceled:
		log.Fatalf("ctx is canceled by another routine: %v", err)
	case context.DeadlineExceeded:
		log.Fatalf("ctx is attached with a deadline is exceeded: %v", err)
	case rpctypes.ErrEmptyKey:
		log.Fatalf("client-side error: %v", err)
	default:
		log.Fatalf("bad cluster endpoints, which are not etcd servers: %v", err)
	}
}

Examples

More code examples can be found at GoDoc.