Skip to content

Commit f8ed81e

Browse files
doc: make crud options description more specific
Since `upsert_object` and `upsert_object_many` not support `skip_nullability_check_on_flatten` option [1], `UpsertObjectOpts` is `SimpleOperationOpts` and not `SimpleOperationObjectOpts`, same for many operation. But it is possible to get confused while studying options descriptions. 1. tarantool/crud@7504da3
1 parent d8df65d commit f8ed81e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

crud/options.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ func (opts BaseOpts) EncodeMsgpack(enc *msgpack.Encoder) error {
138138
}
139139

140140
// SimpleOperationOpts describes options for simple CRUD operations.
141+
// It also covers `upsert_object` options.
141142
type SimpleOperationOpts struct {
142143
// Timeout is a `vshard.call` timeout and vshard
143144
// master discovery timeout (in seconds).
@@ -168,7 +169,7 @@ func (opts SimpleOperationOpts) EncodeMsgpack(enc *msgpack.Encoder) error {
168169
}
169170

170171
// SimpleOperationObjectOpts describes options for simple CRUD
171-
// operations with objects.
172+
// operations with objects. It doesn't cover `upsert_object` options.
172173
type SimpleOperationObjectOpts struct {
173174
// Timeout is a `vshard.call` timeout and vshard
174175
// master discovery timeout (in seconds).
@@ -203,6 +204,7 @@ func (opts SimpleOperationObjectOpts) EncodeMsgpack(enc *msgpack.Encoder) error
203204
}
204205

205206
// OperationManyOpts describes options for CRUD operations with many tuples.
207+
// It also covers `upsert_object_many` options.
206208
type OperationManyOpts struct {
207209
// Timeout is a `vshard.call` timeout and vshard
208210
// master discovery timeout (in seconds).
@@ -239,7 +241,7 @@ func (opts OperationManyOpts) EncodeMsgpack(enc *msgpack.Encoder) error {
239241
}
240242

241243
// OperationObjectManyOpts describes options for CRUD operations
242-
// with many objects.
244+
// with many objects. It doesn't cover `upsert_object_many` options.
243245
type OperationObjectManyOpts struct {
244246
// Timeout is a `vshard.call` timeout and vshard
245247
// master discovery timeout (in seconds).

0 commit comments

Comments
 (0)