tree: 3c9bf1c8bbc752396eee3acda69d77b5ad89db24 [path history] [tgz]
  1. README.md
  2. auth.go
  3. client.go
  4. client_test.go
  5. clientv3util/
  6. cluster.go
  7. compact_op.go
  8. compact_op_test.go
  9. compare.go
  10. concurrency/
  11. config.go
  12. doc.go
  13. example_auth_test.go
  14. example_cluster_test.go
  15. example_kv_test.go
  16. example_lease_test.go
  17. example_maintenence_test.go
  18. example_metrics_test.go
  19. example_test.go
  20. example_watch_test.go
  21. health_balancer.go
  22. health_balancer_test.go
  23. integration/
  24. kv.go
  25. lease.go
  26. leasing/
  27. logger.go
  28. logger_test.go
  29. main_test.go
  30. maintenance.go
  31. mirror/
  32. namespace/
  33. naming/
  34. op.go
  35. op_test.go
  36. options.go
  37. ordering/
  38. ready_wait.go
  39. retry.go
  40. sort.go
  41. txn.go
  42. txn_test.go
  43. watch.go
  44. watch_test.go
  45. yaml/
vendor/github.com/coreos/etcd/clientv3/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 := cli.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 := cli.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)
	}
}

Metrics

The etcd client optionally exposes RPC metrics through go-grpc-prometheus. See the examples.

Namespacing

The namespace package provides clientv3 interface wrappers to transparently isolate client requests to a user-defined prefix.

Examples

More code examples can be found at GoDoc.