Skip to content

Commit 40cfee9

Browse files
committed
Add MySqlConnectionStringBuilder documentation.
Add XML doc-comments for each property, and a [Description] attribute for property grid consumers.
1 parent 4bea884 commit 40cfee9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+537
-115
lines changed

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/AllowLoadLocalInfile.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AllowLoadLocalInfile property
44

55
# MySqlConnectionStringBuilder.AllowLoadLocalInfile property
66

7+
Allows the `LOAD DATA LOCAL` command to request files from the client.
8+
79
```csharp
810
public bool AllowLoadLocalInfile { get; set; }
911
```

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/AllowPublicKeyRetrieval.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AllowPublicKeyRetrieval property
44

55
# MySqlConnectionStringBuilder.AllowPublicKeyRetrieval property
66

7+
Allows the client to automatically request the RSA public key from the server.
8+
79
```csharp
810
public bool AllowPublicKeyRetrieval { get; set; }
911
```

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/AllowUserVariables.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AllowUserVariables property
44

55
# MySqlConnectionStringBuilder.AllowUserVariables property
66

7+
Allows user-defined variables (prefixed with `@`) to be used in SQL statements.
8+
79
```csharp
810
public bool AllowUserVariables { get; set; }
911
```

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/AllowZeroDateTime.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AllowZeroDateTime property
44

55
# MySqlConnectionStringBuilder.AllowZeroDateTime property
66

7+
Returns `DATETIME` fields as [`MySqlDateTime`](../../MySqlDateTimeType/) objects instead of DateTime objects.
8+
79
```csharp
810
public bool AllowZeroDateTime { get; set; }
911
```

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/ApplicationName.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.ApplicationName property
44

55
# MySqlConnectionStringBuilder.ApplicationName property
66

7+
Sets the `program_name` connection attribute passed to MySQL Server.
8+
79
```csharp
810
public string ApplicationName { get; set; }
911
```

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/AutoEnlist.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.AutoEnlist property
44

55
# MySqlConnectionStringBuilder.AutoEnlist property
66

7+
Automatically enlists this connection in any active TransactionScope.
8+
79
```csharp
810
public bool AutoEnlist { get; set; }
911
```

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/CancellationTimeout.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CancellationTimeout property
44

55
# MySqlConnectionStringBuilder.CancellationTimeout property
66

7+
The length of time (in seconds) to wait for a query to be canceled when [`CommandTimeout`](../../MySqlCommand/CommandTimeout/) expires, or zero for no timeout.
8+
79
```csharp
810
public int CancellationTimeout { get; set; }
911
```

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/CertificateFile.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CertificateFile property
44

55
# MySqlConnectionStringBuilder.CertificateFile property
66

7+
The path to a certificate file in PKCS #12 (.pfx) format containing a bundled Certificate and Private Key used for mutual authentication.
8+
79
```csharp
810
public string CertificateFile { get; set; }
911
```

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/CertificatePassword.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CertificatePassword property
44

55
# MySqlConnectionStringBuilder.CertificatePassword property
66

7+
The password for the certificate specified using the [`CertificateFile`](../CertificateFile/) option. Not required if the certificate file is not password protected.
8+
79
```csharp
810
public string CertificatePassword { get; set; }
911
```

docs/content/api/MySqlConnector/MySqlConnectionStringBuilder/CertificateStoreLocation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: MySqlConnectionStringBuilder.CertificateStoreLocation property
44

55
# MySqlConnectionStringBuilder.CertificateStoreLocation property
66

7+
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.
8+
79
```csharp
810
public MySqlCertificateStoreLocation CertificateStoreLocation { get; set; }
911
```

0 commit comments

Comments
 (0)