Skip to content

Commit

Permalink
Add MySqlConnectionStringBuilder documentation.
Browse files Browse the repository at this point in the history
Add XML doc-comments for each property, and a [Description] attribute for property grid consumers.
  • Loading branch information
bgrainger committed Sep 10, 2021
1 parent 4bea884 commit 40cfee9
Show file tree
Hide file tree
Showing 62 changed files with 537 additions and 115 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AllowLoadLocalInfile property

# MySqlConnectionStringBuilder.AllowLoadLocalInfile property

Allows the `LOAD DATA LOCAL` command to request files from the client.

```csharp
public bool AllowLoadLocalInfile { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AllowPublicKeyRetrieval property

# MySqlConnectionStringBuilder.AllowPublicKeyRetrieval property

Allows the client to automatically request the RSA public key from the server.

```csharp
public bool AllowPublicKeyRetrieval { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AllowUserVariables property

# MySqlConnectionStringBuilder.AllowUserVariables property

Allows user-defined variables (prefixed with `@`) to be used in SQL statements.

```csharp
public bool AllowUserVariables { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AllowZeroDateTime property

# MySqlConnectionStringBuilder.AllowZeroDateTime property

Returns `DATETIME` fields as [`MySqlDateTime`](../../MySqlDateTimeType/) objects instead of DateTime objects.

```csharp
public bool AllowZeroDateTime { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.ApplicationName property

# MySqlConnectionStringBuilder.ApplicationName property

Sets the `program_name` connection attribute passed to MySQL Server.

```csharp
public string ApplicationName { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AutoEnlist property

# MySqlConnectionStringBuilder.AutoEnlist property

Automatically enlists this connection in any active TransactionScope.

```csharp
public bool AutoEnlist { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CancellationTimeout property

# MySqlConnectionStringBuilder.CancellationTimeout property

The length of time (in seconds) to wait for a query to be canceled when [`CommandTimeout`](../../MySqlCommand/CommandTimeout/) expires, or zero for no timeout.

```csharp
public int CancellationTimeout { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CertificateFile property

# MySqlConnectionStringBuilder.CertificateFile property

The path to a certificate file in PKCS #12 (.pfx) format containing a bundled Certificate and Private Key used for mutual authentication.

```csharp
public string CertificateFile { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CertificatePassword property

# MySqlConnectionStringBuilder.CertificatePassword property

The password for the certificate specified using the [`CertificateFile`](../CertificateFile/) option. Not required if the certificate file is not password protected.

```csharp
public string CertificatePassword { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CertificateStoreLocation property

# MySqlConnectionStringBuilder.CertificateStoreLocation property

Uses a certificate from the specified Certificate Store on the machine. The default value of None means the certificate store is not used; a value of CurrentUser or LocalMachine uses the specified store.

```csharp
public MySqlCertificateStoreLocation CertificateStoreLocation { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CertificateThumbprint property

# MySqlConnectionStringBuilder.CertificateThumbprint property

Specifies which certificate should be used from the Certificate Store specified in [`CertificateStoreLocation`](../CertificateStoreLocation/). This option must be used to indicate which certificate in the store should be used for authentication.

```csharp
public string CertificateThumbprint { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CharacterSet property

# MySqlConnectionStringBuilder.CharacterSet property

Supported for backwards compatibility; MySqlConnector always uses `utf8mb4`.

```csharp
public string CharacterSet { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.ConnectionIdlePingTime property

# MySqlConnectionStringBuilder.ConnectionIdlePingTime property

The delay (in seconds) before idle connections are pinged (to determine liveness) when being retrieved from the pool.

```csharp
public uint ConnectionIdlePingTime { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.ConnectionIdleTimeout property

# MySqlConnectionStringBuilder.ConnectionIdleTimeout property

The amount of time (in seconds) that a connection can remain idle in the pool.

```csharp
public uint ConnectionIdleTimeout { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.ConnectionLifeTime property

# MySqlConnectionStringBuilder.ConnectionLifeTime property

The maximum lifetime (in seconds) for any connection, or `0` for no lifetime limit.

```csharp
public uint ConnectionLifeTime { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.ConnectionProtocol property

# MySqlConnectionStringBuilder.ConnectionProtocol property

The protocol to use to connect to the MySQL Server.

```csharp
public MySqlConnectionProtocol ConnectionProtocol { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.ConnectionReset property

# MySqlConnectionStringBuilder.ConnectionReset property

Whether connections are reset when being retrieved from the pool.

```csharp
public bool ConnectionReset { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@ title: MySqlConnectionStringBuilder.ContainsKey method

# MySqlConnectionStringBuilder.ContainsKey method

Whether this [`MySqlConnectionStringBuilder`](../../MySqlConnectionStringBuilderType/) contains a set option with the specified name.

```csharp
public override bool ContainsKey(string keyword)
```

| parameter | description |
| --- | --- |
| keyword | The option name. |

## Return Value

`true` if an option with that name is set; otherwise, `false`.

## See Also

* class [MySqlConnectionStringBuilder](../../MySqlConnectionStringBuilderType/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.ConvertZeroDateTime property

# MySqlConnectionStringBuilder.ConvertZeroDateTime property

Whether invalid `DATETIME` fields should be converted to MinValue.

```csharp
public bool ConvertZeroDateTime { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.Database property

# MySqlConnectionStringBuilder.Database property

(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.

```csharp
public string Database { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.DateTimeKind property

# MySqlConnectionStringBuilder.DateTimeKind property

The `DateTimeKind` to use when deserializing `DATETIME` values.

```csharp
public MySqlDateTimeKind DateTimeKind { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.DefaultCommandTimeout property

# MySqlConnectionStringBuilder.DefaultCommandTimeout property

The length of time (in seconds) each command can execute before the query is cancelled on the server, or zero to disable timeouts.

```csharp
public uint DefaultCommandTimeout { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.ForceSynchronous property

# MySqlConnectionStringBuilder.ForceSynchronous property

Forces all async methods to execute synchronously. This can be useful for debugging.

```csharp
public bool ForceSynchronous { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: MySqlConnectionStringBuilder.GetProperties method
---

# MySqlConnectionStringBuilder.GetProperties method

Fills in *propertyDescriptors* with information about the available properties on this object.

```csharp
protected override void GetProperties(Hashtable propertyDescriptors)
```

| parameter | description |
| --- | --- |
| propertyDescriptors | The collection of PropertyDescriptor objects to populate. |

## See Also

* class [MySqlConnectionStringBuilder](../../MySqlConnectionStringBuilderType/)
* namespace [MySqlConnector](../../MySqlConnectionStringBuilderType/)
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)

<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.GuidFormat property

# MySqlConnectionStringBuilder.GuidFormat property

Determines which column type (if any) should be read as a Guid.

```csharp
public MySqlGuidFormat GuidFormat { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.IgnoreCommandTransaction property

# MySqlConnectionStringBuilder.IgnoreCommandTransaction property

Does not check the [`Transaction`](../../MySqlCommand/Transaction/) property for validity when executing a command.

```csharp
public bool IgnoreCommandTransaction { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.IgnorePrepare property

# MySqlConnectionStringBuilder.IgnorePrepare property

Ignores calls to [`Prepare`](../../MySqlCommand/Prepare/) and `PrepareAsync`.

```csharp
public bool IgnorePrepare { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.InteractiveSession property

# MySqlConnectionStringBuilder.InteractiveSession property

Instructs the MySQL server that this is an interactive session.

```csharp
public bool InteractiveSession { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@ title: MySqlConnectionStringBuilder indexer

# MySqlConnectionStringBuilder indexer

Retrieves an option value by name.

```csharp
public override object this[string key] { get; set; }
```

| parameter | description |
| --- | --- |
| key | The option name. |

## Return Value

That option's value, if set.

## See Also

* class [MySqlConnectionStringBuilder](../../MySqlConnectionStringBuilderType/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.Keepalive property

# MySqlConnectionStringBuilder.Keepalive property

TCP Keepalive idle time (in seconds), or 0 to use OS defaults.

```csharp
public uint Keepalive { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.LoadBalance property

# MySqlConnectionStringBuilder.LoadBalance property

Specifies how load is distributed across backend servers.

```csharp
public MySqlLoadBalance LoadBalance { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.MaximumPoolSize property

# MySqlConnectionStringBuilder.MaximumPoolSize property

The maximum number of connections allowed in the pool.

```csharp
public uint MaximumPoolSize { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.MinimumPoolSize property

# MySqlConnectionStringBuilder.MinimumPoolSize property

The minimum number of connections to leave in the pool if [`ConnectionIdleTimeout`](../ConnectionIdleTimeout/) is reached.

```csharp
public uint MinimumPoolSize { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: MySqlConnectionStringBuilder constructors

# MySqlConnectionStringBuilder constructor (1 of 2)

The default constructor.
Initializes a new [`MySqlConnectionStringBuilder`](../../MySqlConnectionStringBuilderType/).

```csharp
public MySqlConnectionStringBuilder()
Expand All @@ -20,10 +20,16 @@ public MySqlConnectionStringBuilder()

# MySqlConnectionStringBuilder constructor (2 of 2)

Initializes a new [`MySqlConnectionStringBuilder`](../../MySqlConnectionStringBuilderType/) with properties set from the specified connection string.

```csharp
public MySqlConnectionStringBuilder(string connectionString)
```

| parameter | description |
| --- | --- |
| connectionString | The connection string to use to set property values on this object. |

## See Also

* class [MySqlConnectionStringBuilder](../../MySqlConnectionStringBuilderType/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.NoBackslashEscapes property

# MySqlConnectionStringBuilder.NoBackslashEscapes property

Doesn't escape backslashes in string parameters. For use with the `NO_BACKSLASH_ESCAPES` MySQL server mode.

```csharp
public bool NoBackslashEscapes { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.OldGuids property

# MySqlConnectionStringBuilder.OldGuids property

Use the [`GuidFormat`](../GuidFormat/) property instead.

```csharp
public bool OldGuids { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.Password property

# MySqlConnectionStringBuilder.Password property

The password for the MySQL user.

```csharp
public string Password { get; set; }
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.PersistSecurityInfo property

# MySqlConnectionStringBuilder.PersistSecurityInfo property

If true, preserves security-sensitive information in the connection string retrieved from any open [`MySqlConnection`](../../MySqlConnectionType/).

```csharp
public bool PersistSecurityInfo { get; set; }
```
Expand Down
Loading

0 comments on commit 40cfee9

Please sign in to comment.