1MONGOC_COLLECTION_VALIDATE(3)      libmongoc     MONGOC_COLLECTION_VALIDATE(3)
2
3
4

NAME

6       mongoc_collection_validate - mongoc_collection_validate()
7
8       WARNING:
9          Deprecated  since version 1.10.0: This helper function is deprecated
10          and should not be used in new code. Run  the  validate  command  di‐
11          rectly with mongoc_client_read_command_with_opts() instead.
12
13

SYNOPSIS

15          bool
16          mongoc_collection_validate (mongoc_collection_t *collection,
17                                      const bson_t *options,
18                                      bson_t *reply,
19                                      bson_error_t *error) BSON_GNUC_DEPRECATED;
20

PARAMETERS

22       • collection: A mongoc_collection_t.
23
24       • options: A bson_t.
25
26       • reply: An optional location for a bson_t.
27
28       • error: An optional location for a bson_error_t or NULL.
29

DESCRIPTION

31       This function is a helper function to execute the validate MongoDB com‐
32       mand.
33
34       Currently, the only supported options are full, which is a boolean  and
35       scandata, also a boolean.
36
37       See the MongoDB documentation for more information on this command.
38

ERRORS

40       Errors are propagated via the error parameter.
41

RETURNS

43       Returns  true  if successful. Returns false and sets error if there are
44       invalid arguments or a server or network error.
45
46       reply is always initialized if it's not NULL and must be destroyed with
47       bson_destroy().
48

AUTHOR

50       MongoDB, Inc
51

53       2017-present, MongoDB, Inc
54
55
56
57
581.24.3                           Aug 17, 2023    MONGOC_COLLECTION_VALIDATE(3)
Impressum