You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Implements the new [`IDbColumnSchemaGenerator.GetColumnSchema`](https://docs.microsoft.com/en-us/dotnet/api/system.data.common.idbcolumnschemagenerator.getcolumnschema) interface that returns metadata about the columns in the result set.
Copy file name to clipboardExpand all lines: docs/content/connection-options.md
+27-26Lines changed: 27 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
lastmod: 2016-10-16
2
+
lastmod: 2017-11-06
3
3
date: 2016-10-16
4
4
title: Connection Options
5
5
weight: 30
@@ -22,32 +22,32 @@ These are the basic options that need to be defined to connect to a MySQL databa
22
22
<thead>
23
23
<th style="width: 20%">Name</th>
24
24
<th style="width: 10%">Default</th>
25
-
<th style="width: 70%">Descriotion</th>
25
+
<th style="width: 70%">Description</th>
26
26
</thead>
27
27
<tr>
28
28
<td>Host, Server, Data Source, DataSource, Address, Addr, Network Address</td>
29
29
<td>localhost</td>
30
-
<td>The name or network address of the instance of MySQL to which to connect. Multiple hosts can be specified separated by commas. This can be useful where multiple MySQL servers are configured for replication and you are not concerned about the precise server you are connecting to. No attempt is made by the provider to synchronize writes to the database, so take care when using this option. In Unix environment with Mono, this can be a fully qualified path to a MySQL socket file. With this configuration, the Unix socket is used instead of the TCP/IP socket. Currently, only a single socket name can be given, so accessing MySQL in a replicated environment using Unix sockets is not currently supported.</td>
30
+
<td>The host name or network address of the MySQL Server to which to connect. Multiple hosts can be specified in a comma-delimited list.<br>On Unix-like systems, this can be a fully qualified path to a MySQL socket file, which will cause a Unix socket to be used instead of a TCP/IP socket. Only a single socket name can be specified.</td>
31
31
</tr>
32
32
<tr>
33
33
<td>Port</td>
34
34
<td>3306</td>
35
-
<td>The port MySQL is using to listen for connections.</td>
35
+
<td>The TCP port on which MySQL Server is listening for connections.</td>
36
36
</tr>
37
37
<tr>
38
38
<td>User Id, UserID, Username, Uid, User name, User</td>
39
39
<td></td>
40
-
<td>The MySQL login account being used.</td>
40
+
<td>The MySQL user ID.</td>
41
41
</tr>
42
42
<tr>
43
43
<td>Password, pwd</td>
44
44
<td></td>
45
-
<td>The password for the MySQL account being used.</td>
45
+
<td>The password for the MySQL user.</td>
46
46
</tr>
47
47
<tr>
48
48
<td>Database, Initial Catalog</td>
49
49
<td></td>
50
-
<td>The case-sensitive name of the database to use initially. This is not required.</td>
50
+
<td>(Optional) The case-sensitive name of the initial database to use. This may be required if the MySQL user account only has access rights to particular databases on the server.</td>
51
51
</tr>
52
52
</table>
53
53
@@ -60,58 +60,58 @@ These are the options that need to be used in order to configure a connection to
60
60
<thead>
61
61
<th style="width: 20%">Name</th>
62
62
<th style="width: 10%">Default</th>
63
-
<th style="width: 70%">Descriotion</th>
63
+
<th style="width: 70%">Description</th>
64
64
</thead>
65
65
<tr>
66
66
<td>SSL Mode, SslMode</td>
67
67
<td>Preferred</td>
68
68
<td>This option has the following values:
69
69
<ul>
70
-
<li><b>Preferred</b> - this is the default. Use SSL if the server supports it.</li>
71
-
<li><b>None</b> - do not use SSL.</li>
72
-
<li><b>Required</b> - Always use SSL. Deny connection if server does not support SSL. Do not validate CA or hostname.</li>
73
-
<li><b>VerifyCA</b> - Always use SSL. Validate the CA but tolerate hostname mismatch.</li>
74
-
<li><b>VerifyFull</b> - Always use SSL. Validate CA and hostname.</li>
70
+
<li><b>Preferred</b> - (this is the default). Use SSL if the server supports it.</li>
71
+
<li><b>None</b> - Do not use SSL.</li>
72
+
<li><b>Required</b> - Always use SSL. Deny connection if server does not support SSL. Does not validate CA or hostname.</li>
73
+
<li><b>VerifyCA</b> - Always use SSL. Validates the CA but tolerates hostname mismatch.</li>
74
+
<li><b>VerifyFull</b> - Always use SSL. Validates CA and hostname.</li>
75
75
</ul>
76
76
</td>
77
77
</tr>
78
78
<tr>
79
79
<td>Certificate File, CertificateFile</td>
80
80
<td></td>
81
-
<td>This option specifies the path to a certificate file in a PEM Encoded (.pem) or PKCS #12 (.pfx) format.</td>
81
+
<td>Specifies the path to a certificate file in a PEM Encoded (.pem) or PKCS #12 (.pfx) format.</td>
<td>Specifies a password that is used in conjunction with a certificate specified using the option CertificateFile. Not required if the certificate file is not password protected.</td>
86
+
<td>Specifies the password for the certificate specified using the <code>CertificateFile</code> option. Not required if the certificate file is not password protected.</td>
87
87
</tr>
88
88
<tr>
89
89
<td>CA Certificate File, CACertificateFile</td>
90
90
<td></td>
91
-
<td>This option specifies the path to a CA certificate file in a PEM Encoded (.pem) format. This should be used in with <code>SslMode=VerifyCA</code> or <code>SslMode=VerifyFull</code> to enable verification of a CA certificate that is not trusted by the Operating System's certificate store.</td>
91
+
<td>This option specifies the path to a CA certificate file in a PEM Encoded (.pem) format. This should be used in with <code>SslMode=VerifyCA</code> or <code>SslMode=VerifyFull</code> to enable verification of a CA certificate that is not trusted by the Operating System's certificate store.</td>
92
92
</tr>
93
93
</table>
94
94
95
95
Connection Pooling Options
96
96
--------------------------
97
97
98
-
Connection pooling is enabled by default. These options are used to configure it.
98
+
Connection pooling is enabled by default. These options are used to configure it.
99
99
100
100
<tableclass="table table-striped table-hover">
101
101
<thead>
102
102
<th style="width: 20%">Name</th>
103
103
<th style="width: 10%">Default</th>
104
-
<th style="width: 70%">Descriotion</th>
104
+
<th style="width: 70%">Description</th>
105
105
</thead>
106
106
<tr>
107
107
<td>Pooling</td>
108
108
<td>true</td>
109
-
<td>When true, the MySqlConnection object is drawn from the appropriate pool, or if necessary, is created and added to the appropriate pool. Recognized values are true, false, yes, and no.</td>
109
+
<td>Enables connection pooling. When pooling is enabled, <code>MySqlConnection.Open</code> retrieves an open connection from the poolif one is available (opening a new connection if not), and <code>Close</code>/<code>Dispose</code> returns the open connection to the pool.</td>
110
110
</tr>
111
111
<tr>
112
112
<td>Connection Lifetime, ConnectionLifeTime</td>
113
113
<td>0</td>
114
-
<td>When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. This is useful in clustered configurations to force load balancing between a running server and a server just brought online. A value of zero (0) means pooled connections will never incur a ConnectionLifeTime timeout.</td>
114
+
<td>Controls the maximum length of time a connection to the server can be open. Connections that are returned to the pool are destroyed if it's been more than <code>ConnectionLifeTime</code> seconds since the connection was created. The default value of zero (0) means pooled connections will never incur a ConnectionLifeTime timeout.</td>
115
115
</tr>
116
116
<tr>
117
117
<td>Connection Reset, ConnectionReset </td>
@@ -121,7 +121,7 @@ Connection pooling is enabled by default. These options are used to configure i
<td>The amount of time in seconds that a connection can remain idle in the pool. Any connection that is idle for longer is subject to being closed by a background task that runs every minute, unless there are only MinimumPoolSize connections left in the pool. A value of zero (0) means pooled connections will never incur a ConnectionIdleTimeout.</td>
124
+
<td>The amount of time in seconds that a connection can remain idle in the pool. Any connection that is idle for longer is subject to being closed by a background task that runs every minute, unless there are only MinimumPoolSize connections left in the pool. A value of zero (0) means pooled connections will never incur a ConnectionIdleTimeout, and if the pool grows to its maximum size, it will never get smaller.</td>
125
125
</tr>
126
126
<tr>
127
127
<td>Maximum Pool Size, Max Pool Size, MaximumPoolsize, maxpoolsize</td>
@@ -138,13 +138,13 @@ Connection pooling is enabled by default. These options are used to configure i
138
138
Other Options
139
139
-------------
140
140
141
-
These are the other options that MySqlConnector supports. They are set to sensible defaults and typically do not need to be tweaked.
141
+
These are the other options that MySqlConnector supports. They are set to sensible defaults and typically do not need to be tweaked.
142
142
143
143
<tableclass="table table-striped table-hover">
144
144
<thead>
145
145
<th style="width: 20%">Name</th>
146
146
<th style="width: 10%">Default</th>
147
-
<th style="width: 70%">Descriotion</th>
147
+
<th style="width: 70%">Description</th>
148
148
</thead>
149
149
<tr>
150
150
<td>AllowPublicKeyRetrieval, Allow Public Key Retrieval</td>
@@ -157,7 +157,8 @@ These are the other options that MySqlConnector supports. They are set to sensi
157
157
<tr>
158
158
<td>AllowUserVariables, Allow User Variables</td>
159
159
<td>false</td>
160
-
<td>Setting this to true indicates that the provider expects user variables in the SQL.</td>
160
+
<td>Allows user-defined variables (prefixed with <code>@</code>) to be used in SQL statements. The default value (<code>false</code>)
161
+
only allows <code>@</code>-prefixed names to refer to command parameters.</td>
161
162
</tr>
162
163
<tr>
163
164
<td>Compress, Use Compression, UseCompression</td>
@@ -186,7 +187,7 @@ These are the other options that MySqlConnector supports. They are set to sensi
186
187
<tr>
187
188
<td>Keep Alive, Keepalive</td>
188
189
<td>0</td>
189
-
<td>TCP Keepalive idle time. A value of 0 indicates that the OS Default keepalive settings are used.
190
+
<td>TCP Keepalive idle time. A value of 0 indicates that the OS Default keepalive settings are used.
190
191
On Windows, a value greater than 0 is the idle connection time, measured in seconds, before the first keepalive packet is sent.
191
192
Due to limitations in .NET Core, Unix-based Operating Systems will always use the OS Default keepalive settings.</td>
192
193
</tr>
@@ -224,7 +225,7 @@ These are the other options that MySqlConnector supports. They are set to sensi
224
225
<tr>
225
226
<td>Treat Tiny As Boolean, TreatTinyAsBoolean</td>
226
227
<td>true</td>
227
-
<td>When set to true, tinyint(1) values are returned as booleans. Setting this to false causes tinyint(1) to be returned as sbyte/byte.</td>
228
+
<td>When set to true, tinyint(1) values are returned as booleans. Setting this to false causes tinyint(1) to be returned as sbyte/byte.</td>
Copy file name to clipboardExpand all lines: docs/content/overview/known-issues.md
+2-3Lines changed: 2 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
lastmod: 2017-03-27
2
+
lastmod: 2017-11-06
3
3
date: 2017-03-27
4
4
menu:
5
5
main:
@@ -12,5 +12,4 @@ Known Issues
12
12
============
13
13
14
14
* Not all MySQL data types are supported.
15
-
* Many `MySql.Data` connection string settings are not supported by this library. See [Connection Options](connection-options/) for a list of supported options.
16
-
* Only the `mysql_native_password` and `mysql_old_password` authentication plugins are supported.
15
+
* Some `MySql.Data` connection string settings are not supported by this library. See [Connection Options](connection-options/) for a list of supported options.
0 commit comments