Skip to content

Commit 1956bfc

Browse files
committed
Docs: post-review fixes.
1 parent 01895c0 commit 1956bfc

File tree

3 files changed

+37
-37
lines changed

3 files changed

+37
-37
lines changed

include/devapi/collection_crud.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ namespace internal {
347347
of `add()` method.
348348
349349
Each document must have a unique identifier which is stored in `_id`
350-
filed of the document. Document identifiers are character strings no longer
350+
field of the document. Document identifiers are character strings no longer
351351
than 32 characters. If added document does not have `_id` field, a unique
352352
identifier will be generated for it. Document identifier generated by given
353353
collection add operation can be examined using `Result::getDocumentIds()`

include/mysql_devapi.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ class PUBLIC_API DatabaseObject
163163

164164
/**
165165
Check options for an updatable view.
166-
@see https://dev.mysql.com/doc/refman/5.7/en/view-check-option.html
166+
@see https://dev.mysql.com/doc/refman/en/view-check-option.html
167167
*/
168168

169169
enum class CheckOption
@@ -174,7 +174,7 @@ enum class CheckOption
174174

175175
/**
176176
Algorithms used to process views.
177-
@see https://dev.mysql.com/doc/refman/5.7/en/view-algorithms.html
177+
@see https://dev.mysql.com/doc/refman/en/view-algorithms.html
178178
*/
179179

180180
enum class Algorithm
@@ -186,7 +186,7 @@ enum class Algorithm
186186

187187
/**
188188
View security settings.
189-
@see https://dev.mysql.com/doc/refman/5.7/en/stored-programs-security.html
189+
@see https://dev.mysql.com/doc/refman/en/stored-programs-security.html
190190
*/
191191

192192
enum class SQLSecurity
@@ -238,7 +238,7 @@ class ViewCheckOpt
238238
Specify checks that are done upon insertion of rows into an updatable
239239
view.
240240
241-
@see https://dev.mysql.com/doc/refman/5.7/en/view-check-option.html
241+
@see https://dev.mysql.com/doc/refman/en/view-check-option.html
242242
*/
243243

244244
Executable<Result,Op> withCheckOption(CheckOption option)
@@ -303,7 +303,7 @@ class ViewDefiner
303303
The definer is used to determine access rights for the view. It is specified
304304
as a valid MySQL account name of the form "user@host".
305305
306-
@see https://dev.mysql.com/doc/refman/5.7/en/stored-programs-security.html
306+
@see https://dev.mysql.com/doc/refman/en/stored-programs-security.html
307307
*/
308308
ViewDefinedAs<Op> definer(const string &user)
309309
{
@@ -326,7 +326,7 @@ class ViewSecurity
326326
/**
327327
Specify security characteristics of a view.
328328
329-
@see https://dev.mysql.com/doc/refman/5.7/en/stored-programs-security.html
329+
@see https://dev.mysql.com/doc/refman/en/stored-programs-security.html
330330
*/
331331

332332
ViewDefiner<Op> security(SQLSecurity sec)
@@ -350,7 +350,7 @@ class ViewAlgorithm
350350
/**
351351
Specify algorithm used to process the view.
352352
353-
@see https://dev.mysql.com/doc/refman/5.7/en/view-algorithms.html
353+
@see https://dev.mysql.com/doc/refman/en/view-algorithms.html
354354
*/
355355

356356
ViewSecurity<Op> algorithm(Algorithm alg)

include/mysql_xapi.h

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ mysqlx_opt_type_t;
352352
/**
353353
Constants for defining the View algorithm using
354354
mysqlx_set_view_algorithm() function.
355-
@see https://dev.mysql.com/doc/refman/5.7/en/view-algorithms.html
355+
@see https://dev.mysql.com/doc/refman/en/view-algorithms.html
356356
*/
357357

358358
typedef enum mysqlx_view_algorithm_enum
@@ -366,7 +366,7 @@ typedef enum mysqlx_view_algorithm_enum
366366
/**
367367
Constants for defining the View security using
368368
mysqlx_set_view_security() function.
369-
@see https://dev.mysql.com/doc/refman/5.7/en/stored-programs-security.html
369+
@see https://dev.mysql.com/doc/refman/en/stored-programs-security.html
370370
*/
371371

372372
typedef enum mysqlx_view_security_enum
@@ -379,7 +379,7 @@ typedef enum mysqlx_view_security_enum
379379
/**
380380
Constants for defining the View check options
381381
mysqlx_set_view_security() function.
382-
@see https://dev.mysql.com/doc/refman/5.7/en/view-check-option.html
382+
@see https://dev.mysql.com/doc/refman/en/view-check-option.html
383383
*/
384384

385385
typedef enum mysqlx_view_check_option_enum
@@ -967,7 +967,7 @@ PUBLIC_API mysqlx_result_t * mysqlx_sql_param(mysqlx_session_t *sess,
967967
@return statement handle containing the results and/or error.
968968
NULL can be returned only in case when there are problems
969969
allocating memory, which normally should not happen.
970-
It is very unlikely for this function to end with the error
970+
It is very unlikely for this function to end with an error
971971
because it does not do any parsing, parameter checking etc.
972972
973973
@note To actually execute the SQL query the returned statement has to be
@@ -1025,7 +1025,7 @@ mysqlx_collection_find(mysqlx_collection_t *collection, const char *criteria);
10251025
can be obtained using `mysqlx_error()` function
10261026
10271027
Each document must have a unique identifier which is stored in `_id`
1028-
filed of the document. Document identifiers are character strings no longer
1028+
field of the document. Document identifiers are character strings no longer
10291029
than 32 characters. If added document does not have `_id` field, a unique
10301030
identifier will be generated for it. Document identifier generated by given
10311031
collection add operation can be examined using `mysqlx_fetch_doc_id()`
@@ -1133,8 +1133,8 @@ mysqlx_collection_modify_unset(mysqlx_collection_t *collection,
11331133
@return handle for the newly created FIND statement.
11341134
NULL can be returned only in case when there are problems
11351135
allocating memory, which normally should not happen.
1136-
It is very unlikely for this function to end with the error
1137-
because it does not do any parsing, parameters checking etc.
1136+
It is very unlikely for this function to end with an error
1137+
because it does not do any parsing, parameter checking etc.
11381138
11391139
@note To actually execute the operation, use `mysqlx_execute()`.
11401140
@@ -1227,8 +1227,8 @@ A macro defining a function for setting GROUP BY for FIND operation.
12271227
@return handle for the newly created ADD statement.
12281228
NULL can be returned only in case when there are problems
12291229
allocating memory, which normally should not happen.
1230-
It is very unlikely for this function to end with the error
1231-
because it does not do any parsing, parameters checking etc.
1230+
It is very unlikely for this function to end with an error
1231+
because it does not do any parsing, parameter checking etc.
12321232
12331233
@note To actually execute the operation, use `mysqlx_execute()` after
12341234
specifying documents to be added.
@@ -1277,8 +1277,8 @@ mysqlx_set_add_document(mysqlx_stmt_t *stmt, const char *json_doc);
12771277
@return handle for the newly created REMOVE statement.
12781278
NULL can be returned only in case when there are problems
12791279
allocating memory, which normally should not happen.
1280-
It is very unlikely for this function to end with the error
1281-
because it does not do any parsing, parameters checking etc.
1280+
It is very unlikely for this function to end with an error
1281+
because it does not do any parsing, parameter checking etc.
12821282
12831283
@note To actually execute the statement, use `mysqlx_execute()`
12841284
@@ -1327,8 +1327,8 @@ mysqlx_collection_remove_new(mysqlx_collection_t *collection);
13271327
@return handle for the newly created MODIFY statement.
13281328
NULL can be returned only in case when there are problems
13291329
allocating memory, which normally should not happen.
1330-
It is very unlikely for this function to end with the error
1331-
because it does not do any parsing, parameters checking etc.
1330+
It is very unlikely for this function to end with an error
1331+
because it does not do any parsing, parameter checking etc.
13321332
13331333
@note To actually execute the statement, use `mysqlx_execute()` after
13341334
specifying modifications that should be performed.
@@ -1604,8 +1604,8 @@ mysqlx_table_update(mysqlx_table_t *table,
16041604
@return handle to the newly created SELECT statement.
16051605
NULL can be returned only in case when there are problems
16061606
allocating memory, which normally should not happen.
1607-
It is very unlikely for this function to end with the error
1608-
because it does not do any parsing, parameters checking etc.
1607+
It is very unlikely for this function to end with an error
1608+
because it does not do any parsing, parameter checking etc.
16091609
16101610
@note To actually execute the statement, the returned handle has to be
16111611
given to `mysqlx_execute()`.
@@ -1688,8 +1688,8 @@ A macro defining a function for setting GROUP BY for SELECT operation.
16881688
@return statement handle for the newly created INSERT operation.
16891689
NULL can be returned only in case when there are problems
16901690
allocating memory, which normally should not happen.
1691-
It is very unlikely for this function to end with the error
1692-
because it does not do any parsing, parameters checking etc.
1691+
It is very unlikely for this function to end with an error
1692+
because it does not do any parsing, parameter checking etc.
16931693
16941694
@note To actually execute the SQL query the returned Statement has to be
16951695
given to `mysqlx_execute()`
@@ -1761,8 +1761,8 @@ mysqlx_set_insert_row(mysqlx_stmt_t *stmt, ...);
17611761
@return handle for the newly created DELETE statement.
17621762
NULL can be returned only in case when there are problems
17631763
allocating memory, which normally should not happen.
1764-
It is very unlikely for this function to end with the error
1765-
because it does not do any parsing, parameters checking etc.
1764+
It is very unlikely for this function to end with an error
1765+
because it does not do any parsing, parameter checking etc.
17661766
17671767
@note To actually execute the statement, use `mysqlx_execute()`.
17681768
@@ -1812,8 +1812,8 @@ mysqlx_table_delete_new(mysqlx_table_t *table);
18121812
@return handle for the newly created UPDATE statement.
18131813
NULL can be returned only in case when there are problems
18141814
allocating memory, which normally should not happen.
1815-
It is very unlikely for this function to end with the error
1816-
because it does not do any parsing, parameters checking etc.
1815+
It is very unlikely for this function to end with an error
1816+
because it does not do any parsing, parameter checking etc.
18171817
18181818
@note To actually execute the statement, use `mysqlx_execute()` after
18191819
specifying what updates should it perform.
@@ -2861,7 +2861,7 @@ mysqlx_result_next_warning(mysqlx_result_t *res);
28612861
The definer is used to determine access rights for the view. It is specified
28622862
as a valid MySQL account name of the form "user@host".
28632863
2864-
@see https://dev.mysql.com/doc/refman/5.7/en/stored-programs-security.html
2864+
@see https://dev.mysql.com/doc/refman/en/stored-programs-security.html
28652865
*/
28662866
#define VIEW_DEFINER(D) (void*)VIEW_OPTION_DEFINER, D
28672867

@@ -2954,8 +2954,8 @@ mysqlx_view_create(mysqlx_schema_t *schema, const char *name,
29542954
@return statement handle for view create operation.
29552955
NULL can be returned only in case when there are problems
29562956
allocating memory, which normally should not happen.
2957-
It is very unlikely for this function to end with the error
2958-
because it does not do any parsing, parameters checking etc.
2957+
It is very unlikely for this function to end with an error
2958+
because it does not do any parsing, parameter checking etc.
29592959
29602960
@note To actually execute the statement, the returned handle has to be
29612961
given to `mysqlx_execute()`.
@@ -3040,8 +3040,8 @@ mysqlx_view_modify(mysqlx_schema_t *schema, const char *name,
30403040
@return statement handle for view modify operation.
30413041
NULL can be returned only in case when there are problems
30423042
allocating memory, which normally should not happen.
3043-
It is very unlikely for this function to end with the error
3044-
because it does not do any parsing, parameters checking etc.
3043+
It is very unlikely for this function to end with an error
3044+
because it does not do any parsing, parameter checking etc.
30453045
30463046
@note To actually execute the statement, the returned handle has to be
30473047
given to `mysqlx_execute()`.
@@ -3117,8 +3117,8 @@ mysqlx_view_replace(mysqlx_schema_t *schema, const char *name,
31173117
@return statement handle for view replace operation.
31183118
NULL can be returned only in case when there are problems
31193119
allocating memory, which normally should not happen.
3120-
It is very unlikely for this function to end with the error
3121-
because it does not do any parsing, parameters checking etc.
3120+
It is very unlikely for this function to end with an error
3121+
because it does not do any parsing, parameter checking etc.
31223122
31233123
@note To actually execute the statement, the returned handle has to be
31243124
given to `mysqlx_execute()`.
@@ -3202,7 +3202,7 @@ mysqlx_set_view_security(mysqlx_stmt_t *view_stmt, int security);
32023202
view statement object using `mysqlx_error()` or
32033203
`mysqlx_error_message()`.
32043204
3205-
@see https://dev.mysql.com/doc/refman/5.7/en/stored-programs-security.html
3205+
@see https://dev.mysql.com/doc/refman/en/stored-programs-security.html
32063206
32073207
@ingroup xapi_ddl
32083208
*/

0 commit comments

Comments
 (0)