Skip to content

Commit 3043b22

Browse files
bgraingerbgrainger
committed
Add docs in Markdown format. Fixes #827 
1 parent 936b7f9 commit 3043b22

File tree

423 files changed

+10485
-0
lines changed

Some content is hidden

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

423 files changed

+10485
-0
lines changed

‎docs/content/api/MySqlConnector.Authentication/AuthenticationPlugins/Register.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Register
3+
---
4+
5+
# AuthenticationPlugins.Register method
6+
7+
Registers the specified authentication plugin. The name of this plugin must be unique.
8+
9+
```csharp
10+
public static void Register(IAuthenticationPlugin plugin)
11+
```
12+
13+
| parameter | description |
14+
| --- | --- |
15+
| plugin | The authentication plugin. |
16+
17+
## See Also
18+
19+
* interface [IAuthenticationPlugin](../../IAuthenticationPluginType/)
20+
* class [AuthenticationPlugins](../../AuthenticationPluginsType/)
21+
* namespace [MySqlConnector.Authentication](../../AuthenticationPluginsType/)
22+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
23+
24+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

‎docs/content/api/MySqlConnector.Authentication/AuthenticationPluginsType.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: AuthenticationPlugins
3+
---
4+
5+
# AuthenticationPlugins class
6+
7+
A registry of known authentication plugins.
8+
9+
```csharp
10+
public static class AuthenticationPlugins
11+
```
12+
13+
## Public Members
14+
15+
| name | description |
16+
| --- | --- |
17+
| static [Register](../AuthenticationPlugins/Register/)(…) | Registers the specified authentication plugin. The name of this plugin must be unique. |
18+
19+
## See Also
20+
21+
* namespace [MySqlConnector.Authentication](../../MySqlConnectorAuthenticationNamespace/)
22+
* assembly [MySqlConnector](../../MySqlConnectorAssembly/)
23+
24+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

‎docs/content/api/MySqlConnector.Authentication/IAuthenticationPlugin/CreateResponse.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: CreateResponse
3+
---
4+
5+
# IAuthenticationPlugin.CreateResponse method
6+
7+
Creates the authentication response.
8+
9+
```csharp
10+
public byte[] CreateResponse(string password, ReadOnlySpan<byte> authenticationData)
11+
```
12+
13+
| parameter | description |
14+
| --- | --- |
15+
| password | The client's password. |
16+
| authenticationData | The authentication data supplied by the server; this is the |
17+
18+
## See Also
19+
20+
* interface [IAuthenticationPlugin](../../IAuthenticationPluginType/)
21+
* namespace [MySqlConnector.Authentication](../../IAuthenticationPluginType/)
22+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
23+
24+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

‎docs/content/api/MySqlConnector.Authentication/IAuthenticationPlugin/Name.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Name
3+
---
4+
5+
# IAuthenticationPlugin.Name property
6+
7+
The authentication plugin name.
8+
9+
```csharp
10+
public string Name { get; }
11+
```
12+
13+
## See Also
14+
15+
* interface [IAuthenticationPlugin](../../IAuthenticationPluginType/)
16+
* namespace [MySqlConnector.Authentication](../../IAuthenticationPluginType/)
17+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
18+
19+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

‎docs/content/api/MySqlConnector.Authentication/IAuthenticationPluginType.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: IAuthenticationPlugin
3+
---
4+
5+
# IAuthenticationPlugin interface
6+
7+
The primary interface implemented by an authentication plugin.
8+
9+
```csharp
10+
public interface IAuthenticationPlugin
11+
```
12+
13+
## Members
14+
15+
| name | description |
16+
| --- | --- |
17+
| [Name](../IAuthenticationPlugin/Name/) { get; } | The authentication plugin name. |
18+
| [CreateResponse](../IAuthenticationPlugin/CreateResponse/)(…) | Creates the authentication response. |
19+
20+
## See Also
21+
22+
* namespace [MySqlConnector.Authentication](../../MySqlConnectorAuthenticationNamespace/)
23+
* assembly [MySqlConnector](../../MySqlConnectorAssembly/)
24+
25+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

‎docs/content/api/MySqlConnector.Logging/ConsoleLoggerProvider/ConsoleLoggerProvider.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: ConsoleLoggerProvider
3+
---
4+
5+
# ConsoleLoggerProvider constructor
6+
7+
```csharp
8+
public ConsoleLoggerProvider(MySqlConnectorLogLevel minimumLevel = MySqlConnectorLogLevel.Info,
9+
bool isColored = true)
10+
```
11+
12+
## See Also
13+
14+
* enum [MySqlConnectorLogLevel](../../MySqlConnectorLogLevelType/)
15+
* class [ConsoleLoggerProvider](../../ConsoleLoggerProviderType/)
16+
* namespace [MySqlConnector.Logging](../../ConsoleLoggerProviderType/)
17+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
18+
19+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

‎docs/content/api/MySqlConnector.Logging/ConsoleLoggerProvider/CreateLogger.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: CreateLogger
3+
---
4+
5+
# ConsoleLoggerProvider.CreateLogger method
6+
7+
```csharp
8+
public IMySqlConnectorLogger CreateLogger(string name)
9+
```
10+
11+
## See Also
12+
13+
* interface [IMySqlConnectorLogger](../../IMySqlConnectorLoggerType/)
14+
* class [ConsoleLoggerProvider](../../ConsoleLoggerProviderType/)
15+
* namespace [MySqlConnector.Logging](../../ConsoleLoggerProviderType/)
16+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
17+
18+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

‎docs/content/api/MySqlConnector.Logging/ConsoleLoggerProviderType.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: ConsoleLoggerProvider
3+
---
4+
5+
# ConsoleLoggerProvider class
6+
7+
```csharp
8+
public class ConsoleLoggerProvider : IMySqlConnectorLoggerProvider
9+
```
10+
11+
## Public Members
12+
13+
| name | description |
14+
| --- | --- |
15+
| [ConsoleLoggerProvider](../ConsoleLoggerProvider/ConsoleLoggerProvider/)(…) | |
16+
| [CreateLogger](../ConsoleLoggerProvider/CreateLogger/)(…) | |
17+
18+
## See Also
19+
20+
* interface [IMySqlConnectorLoggerProvider](../IMySqlConnectorLoggerProviderType/)
21+
* namespace [MySqlConnector.Logging](../../MySqlConnectorLoggingNamespace/)
22+
* assembly [MySqlConnector](../../MySqlConnectorAssembly/)
23+
24+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

‎docs/content/api/MySqlConnector.Logging/IMySqlConnectorLogger/IsEnabled.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: IsEnabled
3+
---
4+
5+
# IMySqlConnectorLogger.IsEnabled method
6+
7+
Returns `true` if logging for this logger is enabled at the specified level.
8+
9+
```csharp
10+
public bool IsEnabled(MySqlConnectorLogLevel level)
11+
```
12+
13+
| parameter | description |
14+
| --- | --- |
15+
| level | The log level. |
16+
17+
## Return Value
18+
19+
`true` if logging is enabled; otherwise, `false`.
20+
21+
## See Also
22+
23+
* enum [MySqlConnectorLogLevel](../../MySqlConnectorLogLevelType/)
24+
* interface [IMySqlConnectorLogger](../../IMySqlConnectorLoggerType/)
25+
* namespace [MySqlConnector.Logging](../../IMySqlConnectorLoggerType/)
26+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
27+
28+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

‎docs/content/api/MySqlConnector.Logging/IMySqlConnectorLogger/Log.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Log
3+
---
4+
5+
# IMySqlConnectorLogger.Log method
6+
7+
Writes a log message to the target.
8+
9+
```csharp
10+
public void Log(MySqlConnectorLogLevel level, string message, object[] args = null,
11+
Exception exception = null)
12+
```
13+
14+
| parameter | description |
15+
| --- | --- |
16+
| level | The log level. |
17+
| message | The log message. See documentation for *args* for notes on interpreting `{0}` within this string. |
18+
| args | If not `null` or empty, then *message* includes formatting placeholders (e.g., `{0}`) which must be replaced with the arguments in *args*, using Object[]) or similar. If `null` or an empty array, then *message* is a literal string; any curly braces within it must be treated as literal characters, not formatting placeholders. |
19+
| exception | If not `null`, an Exception associated with the log message. |
20+
21+
## Remarks
22+
23+
This method may be called from multiple threads and must be thread-safe. This method may be called even if [`IsEnabled`](../IsEnabled/) would return `false` for *level*; the implementation must check if logging is enabled for that level.
24+
25+
## See Also
26+
27+
* enum [MySqlConnectorLogLevel](../../MySqlConnectorLogLevelType/)
28+
* interface [IMySqlConnectorLogger](../../IMySqlConnectorLoggerType/)
29+
* namespace [MySqlConnector.Logging](../../IMySqlConnectorLoggerType/)
30+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
31+
32+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

0 commit comments

Comments
 (0)