Skip to content

Commit bd921b7

Browse files
committed
Document CharSet connection string option. Fixes #630
1 parent 29ed01f commit bd921b7

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/content/connection-options.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,11 @@ These are the other options that MySqlConnector supports. They are set to sensib
225225
<td>Sets the <c>program_name</c> connection attribute passed to MySQL Server. This value may be displayed by diagnostic tools,
226226
e.g., as the “Program” column in “Client Connections” in <a href="https://www.mysql.com/products/workbench/">MySQL Workbench</a>.</td>
227227
</tr>
228+
<tr>
229+
<td>CharSet, Character Set, CharacterSet</td>
230+
<td></td>
231+
<td>MySqlConnector always uses <code>utf8mb4</code> to send and receive strings from MySQL Server. This option may be specified (for backwards compatibility) but it will be ignored.</td>
232+
</tr>
228233
<tr>
229234
<td>Compress, Use Compression, UseCompression</td>
230235
<td>false</td>

docs/content/tutorials/migrating-from-connector-net.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ MySqlConnector has some different default connection string options:
2929
<td>When using <code>sha256_password</code> authentication, this option allows the RSA public key to be retrieved from the server
3030
(when not using a secure connection). It’s <code>false</code> by default to avoid disclosing the password to a malicious proxy.</td>
3131
</tr>
32+
<tr>
33+
<td><code>CharacterSet</code>, <code>CharSet</code></td>
34+
<td>Ignored; <code>utf8mb4</code> is always used</td>
35+
<td>(server-defined)</td>
36+
<td>MySqlConnector always uses <code>utf8mb4</code> to send and receive strings from MySQL Server. This option may be specified (for backwards compatibility) but it will be ignored.</td>
37+
</tr>
3238
<tr>
3339
<td><code>ConnectionReset</code></td>
3440
<td>Default is <code>true</code></td>

0 commit comments

Comments
 (0)