Skip to content

Commit fc53420

Browse files
Added a note about localhost in connection.host in README.md (#52)
1 parent dd313a6 commit fc53420

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Currently prebuilt binaries are not available.
1717
- [CMake](https://cmake.org/) 3.20.0+
1818
- [Clang](https://clang.llvm.org/) (`clang-15` / `clang-16` / `clang-17`) or [GCC](https://gcc.gnu.org/) (`gcc-12` / `gcc-13` / `gcc-14`)
1919
- [Boost libraries](https://www.boost.org/) 1.84.0 (git version, not the source tarball)
20-
- [MySQL client library](https://dev.mysql.com/doc/c-api/8.0/en/) 8.0.x (`libmysql`)
20+
- [MySQL client library](https://dev.mysql.com/doc/c-api/8.0/en/) 8.0.x (`libmysqlclient`)
2121
- [CURL library](https://curl.se/libcurl/) (`libcurl`) 8.6.0+
2222
- [AWS SDK for C++](https://aws.amazon.com/sdk-for-cpp/) 1.11.286
2323

@@ -231,7 +231,7 @@ Currently we use the following mapping:
231231
- `trace` - used to print source file name / line number / position from caught exceptions and to print raw data (hex dumps) of binary log events.
232232

233233
#### \<connection\> section
234-
- `<connection.host>` - MySQL server host name (e.g. `127.0.0.1`, `localhost`, `192.168.0.100`, `dbsrv.mydomain.com`, etc.).
234+
- `<connection.host>` - MySQL server host name (e.g. `127.0.0.1`, `192.168.0.100`, `dbsrv.mydomain.com`, etc.). Please do not use `localhost` here as it will be interpreted differently by the `libmysqlclient` and will instruct the library to use Unix socket file for connection instead of TCP protocol - use `127.0.0.1` instead (see [this page](https://dev.mysql.com/doc/c-api/8.0/en/mysql-real-connect.html) for more details).
235235
- `<connection.port>` - MySQL server port (e.g. `3306` - the default MySQL server port).
236236
- `<connection.user>` - the name of the MySQL user that has [REPLICATION SLAVE](https://dev.mysql.com/doc/refman/8.0/en/replication-howto-repuser.html) privilege.
237237
- `<connection.password>` - the password for this MySQL user

0 commit comments

Comments
 (0)