Skip to content

Commit 70a4848

Browse files
committed
docs: 8.0.6 updates
1 parent 9f19b67 commit 70a4848

File tree

8 files changed

+35
-36
lines changed

8 files changed

+35
-36
lines changed

README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ You can find the documentation on the MySQL website at
4747
<http://dev.mysql.com/doc/dev/connector-cpp/>
4848

4949
For the new features/bugfix history, see release notes at
50-
<https://dev.mysql.com/doc/relnotes/connector-cpp/en/news-8-0-5.html>.
50+
<https://dev.mysql.com/doc/relnotes/connector-cpp/en/news-8-0.html>.
5151
Note that the initial releases used major version 2.0.
5252

5353
CONTACT

include/devapi/collection_crud.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ struct Collection_add_base
112112
Each document must have a unique identifier which is stored in `_id`
113113
field of the document. Document identifiers are character strings no longer
114114
than 32 characters. If added document does not have `_id` field, a unique
115-
identifier will be generated for it. Document identifier generated by given
115+
identifier is generated for it. Document identifier generated by given
116116
collection add operation can be examined using `Result::getDocumentIds()`
117117
method. Generated document identifiers are string of 32 hexadecimal digits,
118118
like this one `0512020981044082E6119DFA0E4C0584`.

include/devapi/common.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ namespace internal {
369369
class is_range
370370
{
371371
/*
372-
Note: This overload will be taken into account only if std::begin(X) and
372+
Note: This overload is taken into account only if std::begin(X) and
373373
std::end(X) expressions are valid.
374374
*/
375375
template <class X>

include/devapi/crud.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
4444
Limit< Offset< Executable<...> > >
4545
46-
will represent operation for which first .limit() can be called, followed by
46+
represents an operation for which first .limit() can be called, followed by
4747
.offset() and then finally .execute(). See classes like
4848
Collection_find_base in collection_crud.h for more examples.
4949

include/devapi/document.h

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -388,8 +388,7 @@ class PUBLIC_API Value : public internal::Printable
388388
/**
389389
@name Conversion to C++ Types
390390
391-
Attempt to convert value of non-compatible type will
392-
throw an error.
391+
Attempt to convert value of non-compatible type throws an error.
393392
*/
394393
//@{
395394

@@ -585,16 +584,16 @@ class ExprValue
585584
as expression.
586585
587586
If `s` is a string value, then in contexts where values are
588-
expected, `expr(s)` will treat `s` as a DevAPI expression. For
587+
expected, `expr(s)` treats `s` as a DevAPI expression. For
589588
example statement
590589
591590
table.select("foo > 1").execute();
592591
593-
will return string `"foo > 1"` for each row in the table while
592+
returns the string `"foo 1"` for each row in the table while
594593
595594
table.select(expr("foo > 1")).execute();
596595
597-
will return true/false, depending on the value of the expression.
596+
returns true/false, depending on the value of the expression.
598597
599598
@ingroup devapi
600599
*/

include/devapi/result.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ namespace internal {
185185
Result res = operation.execute();
186186
~~~~~~
187187
188-
Storing another result in `Result` instance will overwrite
188+
Storing another result in `Result` instance overwrites
189189
previous result.
190190
191191
@todo Implement other methods for getting information about
@@ -371,7 +371,7 @@ class PUBLIC_API Column
371371
it could be confusing with the multi-byte charsets.
372372
For instance with UTF8MB4 the length of VARCHAR(100)
373373
column is returned as 400 because each character is
374-
4 bytes long.
374+
4 bytes long.
375375
*/
376376

377377
unsigned long getLength() const;
@@ -481,8 +481,8 @@ class PUBLIC_API RowResult
481481
Return all remaining rows
482482
483483
%Result of this method can be stored in an STL container such as
484-
`std::list<Row>`. Rows that have been fetched using fetchOne() will not
485-
be available when calling fetchAll()
484+
`std::list<Row>`. Rows that have already been fetched using fetchOne() are
485+
not available when calling fetchAll()
486486
*/
487487

488488
RowList fetchAll()
@@ -499,7 +499,7 @@ class PUBLIC_API RowResult
499499
/*
500500
Iterate over rows (range-for support).
501501
502-
Rows that have been fetched using iterator will not be available when
502+
Rows that have been fetched using iterator are not available when
503503
calling fetchOne() or fetchAll()
504504
*/
505505

@@ -663,8 +663,8 @@ class PUBLIC_API DocResult
663663
Return all remaining documents.
664664
665665
%Result of this method can be stored in an STL container such as
666-
`std::list<DbDoc>`. Documents that have been fetched using fetchOne() will
667-
not be available when calling fetchAll()
666+
`std::list<DbDoc>`. Documents that have been fetched using fetchOne() are
667+
not available when calling fetchAll()
668668
*/
669669

670670
DocList fetchAll()
@@ -684,7 +684,7 @@ class PUBLIC_API DocResult
684684
/*
685685
Iterate over documents (range-for support).
686686
687-
Documents that have been fetched using iterator will not be available when
687+
Documents that have been fetched using iterator are not available when
688688
calling fetchOne() or fetchAll()
689689
*/
690690

include/mysql_common.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158
use standard C++ library classes as components. For example, we use
159159
std::shared_ptr<> a lot. We can not modify standard library headers to export
160160
these classes. As is the common practice, we ignore this issue assuming that
161-
the code that uses our connector will be built with the same C++ runtime
161+
the code that uses our connector is built with the same C++ runtime
162162
implementation as the one used to build the connector. To silence the warnings,
163163
uses of standard library classes in our public API classes should be surrounded
164164
with DLL_WARNINGS_PUSH/POP macros.

include/mysql_devapi.h

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ namespace mysqlx {
120120
121121
When creating Schema object, by default no checks are made that
122122
it actually exists in the database. Operation that is executed
123-
on the server and involves such non-existent schema will throw
123+
on the server and involves such non-existent schema throws
124124
an error at execution time.
125125
126126
@ingroup devapi
@@ -170,9 +170,9 @@ class PUBLIC_API Schema
170170
/**
171171
Return `Collection` object representing named collection in
172172
the schema. If `check_exists` is true and named collection
173-
does not exist, an error will be thrown. Otherwise, if named
174-
collection does not exist, the returned object will refer
175-
to non-existent collection.
173+
does not exist, an error is thrown. Otherwise, if named
174+
collection does not exist, the returned object refers
175+
to a non-existent collection.
176176
177177
@note Checking existence of the collection involves
178178
communication with the server. If `check_exists` is false,
@@ -184,8 +184,8 @@ class PUBLIC_API Schema
184184

185185
/**
186186
Return `Table` object representing table or view in the schema.
187-
If `check_exists` is true and table does not exist, an error will be thrown.
188-
Otherwise, if table does not exists, the returned object will refer
187+
If `check_exists` is true and table does not exist, an error is thrown.
188+
Otherwise, if table does not exists, the returned object refers
189189
to non-existent table.
190190
191191
@note Checking existence of the table involves
@@ -254,9 +254,9 @@ class PUBLIC_API Schema
254254
/**
255255
Drop given collection from the schema.
256256
257-
This method will silently succeed if given collection does not exist.
257+
This method silently succeeds if given collection does not exist.
258258
259-
@note If table name is passed to the method, it will behave like
259+
@note If table name is passed to the method, it behaves like
260260
dropTable().
261261
*/
262262

@@ -265,11 +265,11 @@ class PUBLIC_API Schema
265265
/**
266266
Drop given table from the schema.
267267
268-
This method will silently succeed if given table does not exist. If given
269-
table is a view (isView() returns true) then it will not be dropped (and no
268+
This method silently succeeds if given table does not exist. If given
269+
table is a view (isView() returns true) then it is not dropped (and no
270270
error is reported) - use dropView() instead.
271271
272-
@note If collection name is passed to the method, it will behave like
272+
@note If collection name is passed to the method, it behaves like
273273
dropCollection().
274274
*/
275275

@@ -278,7 +278,7 @@ class PUBLIC_API Schema
278278
/**
279279
Drop given view from the schema.
280280
281-
This method will silently succeed if given view does not exist. This is
281+
This method silently succeeds if given view does not exist. This is
282282
also the case when a name of non-view object, such as table or collection
283283
was given (as a view with the given name does not exist).
284284
*/
@@ -660,9 +660,9 @@ DLL_WARNINGS_PUSH
660660
are thrown from session constructor.
661661
662662
It is possible to specify several hosts when creating a session. In that
663-
case failed connection to one of the hosts will trigger fail-over attempt
663+
case failed connection to one of the hosts triggers fail-over attempt
664664
to connect to a different host in the list. Only if none of the hosts could
665-
be contacted, session creation will fail. It is also possible to specify
665+
be contacted, session creation fails. It is also possible to specify
666666
priorities for the hosts in the list which determine the order in which
667667
hosts are tried (see `SessionOption::PRIORITY`).
668668
@@ -734,7 +734,7 @@ class PUBLIC_API Session
734734
Get named schema object in a given session.
735735
736736
The object does not have to exist in the database.
737-
Errors will be thrown if one tries to use non-existing
737+
Error is thrown if one tries to use a non-existing
738738
schema.
739739
*/
740740

@@ -743,7 +743,7 @@ class PUBLIC_API Session
743743
/**
744744
Get named schema object in a given session.
745745
746-
Errors will be thrown if one tries to use non-existing
746+
Error is thrown if one tries to use a non-existing
747747
schema with check_existence = true.
748748
*/
749749

@@ -770,7 +770,7 @@ class PUBLIC_API Session
770770
/**
771771
Drop the schema.
772772
773-
Errors will be thrown if schema doesn't exist,
773+
Error is thrown if the schema doesn't exist,
774774
*/
775775

776776
void dropSchema(const string &name);
@@ -818,7 +818,7 @@ class PUBLIC_API Session
818818
/**
819819
Closes current session.
820820
821-
After a session is closed, any call to other method will throw Error.
821+
After a session is closed, any call to other method throws Error.
822822
*/
823823

824824
void close()

0 commit comments

Comments
 (0)