mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
Merge pull request #9169 from gyuho/client-doc
clientv3: document client-side request size limit
This commit is contained in:
commit
ab7cbb0e57
@ -26,7 +26,7 @@ defer cli.Close()
|
|||||||
```
|
```
|
||||||
|
|
||||||
etcd v3 uses [`gRPC`](http://www.grpc.io) for remote procedure calls. And `clientv3` uses
|
etcd v3 uses [`gRPC`](http://www.grpc.io) for remote procedure calls. And `clientv3` uses
|
||||||
[`grpc-go`](https://github.com/grpc/grpc-go) to connect to etcd. Make sure to close the client after using it.
|
[`grpc-go`](https://github.com/grpc/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,
|
If the client is not closed, the connection will have leaky goroutines. To specify client request timeout,
|
||||||
pass `context.WithTimeout` to APIs:
|
pass `context.WithTimeout` to APIs:
|
||||||
|
|
||||||
@ -80,6 +80,10 @@ The etcd client optionally exposes RPC metrics through [go-grpc-prometheus](http
|
|||||||
|
|
||||||
The [namespace](https://godoc.org/github.com/coreos/etcd/clientv3/namespace) package provides `clientv3` interface wrappers to transparently isolate client requests to a user-defined prefix.
|
The [namespace](https://godoc.org/github.com/coreos/etcd/clientv3/namespace) package provides `clientv3` interface wrappers to transparently isolate client requests to a user-defined prefix.
|
||||||
|
|
||||||
|
## Request size limit
|
||||||
|
|
||||||
|
Client request size limit is configurable via `clientv3.Config.MaxCallSendMsgSize` and `MaxCallRecvMsgSize` in bytes. If none given, client request send limit defaults to 2 MiB including gRPC overhead bytes. And receive limit defaults to `math.MaxInt32`.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
More code examples can be found at [GoDoc](https://godoc.org/github.com/coreos/etcd/clientv3).
|
More code examples can be found at [GoDoc](https://godoc.org/github.com/coreos/etcd/clientv3).
|
||||||
|
Loading…
x
Reference in New Issue
Block a user