Skip to content

Commit 0ff911c

Browse files
committed
Fix MySqlInfoMessageEventArgs API.
Remove property that was present just to be backwards compatible with Connector/NET.
1 parent fe7e428 commit 0ff911c

File tree

6 files changed

+32
-6
lines changed

6 files changed

+32
-6
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Errors
3+
---
4+
5+
# MySqlInfoMessageEventArgs.Errors property
6+
7+
```csharp
8+
public IReadOnlyList<MySqlError> Errors { get; }
9+
```
10+
11+
## See Also
12+
13+
* class [MySqlError](../../MySqlErrorType/)
14+
* class [MySqlInfoMessageEventArgs](../../MySqlInfoMessageEventArgsType/)
15+
* namespace [MySqlConnector](../../MySqlInfoMessageEventArgsType/)
16+
* assembly [MySqlConnector](../../../MySqlConnectorAssembly/)
17+
18+
<!-- DO NOT EDIT: generated by xmldocmd for MySqlConnector.dll -->

docs/content/api/MySqlConnector/MySqlInfoMessageEventArgsType.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ public sealed class MySqlInfoMessageEventArgs : EventArgs
1212

1313
| name | description |
1414
| --- | --- |
15-
| [errors](../MySqlInfoMessageEventArgs/errors/) { get; } | |
1615
| [Errors](../MySqlInfoMessageEventArgs/Errors/) { get; } | |
1716

1817
## See Also

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ removes most of the API that is based on those assumptions.
135135
To avoid ambiguity, there are two different factory methods for constructing a `MySqlGeometry`. Use the static factory method `MySqlGeometry.FromMySql` (if you have a byte array containing MySQL's internal format), or `FromWkb` if you have
136136
Well-known Binary bytes.
137137

138+
### MySqlInfoMessageEventArgs
139+
140+
The `MySqlError[] MySqlInfoMessageEventArgs.errors` property has changed to `IReadOnlyList<MySqlError> MySqlInfoMessageEventArgs.Errors`.
141+
138142
### Exceptions
139143

140144
For consistency with other ADO.NET providers, MySqlConnector will throw `InvalidOperationException` (instead of `MySqlException`)

src/MySqlConnector/MySqlConnection.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -759,7 +759,7 @@ internal void FinishQuerying(bool hasWarnings)
759759
errors.Add(new(reader.GetString(0), reader.GetInt32(1), reader.GetString(2)));
760760
}
761761

762-
InfoMessage(this, new MySqlInfoMessageEventArgs(errors.ToArray()));
762+
InfoMessage(this, new MySqlInfoMessageEventArgs(errors));
763763
}
764764
}
765765

src/MySqlConnector/MySqlInfoMessageEventArgs.cs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@ namespace MySqlConnector
55
{
66
public sealed class MySqlInfoMessageEventArgs : EventArgs
77
{
8-
internal MySqlInfoMessageEventArgs(MySqlError[] errors) => this.errors = errors;
8+
internal MySqlInfoMessageEventArgs(IReadOnlyList<MySqlError> errors) => Errors = errors;
99

10-
public MySqlError[] errors { get; }
11-
12-
public IReadOnlyList<MySqlError> Errors => errors;
10+
public IReadOnlyList<MySqlError> Errors { get; }
1311
}
1412

1513
public delegate void MySqlInfoMessageEventHandler(object sender, MySqlInfoMessageEventArgs args);

tests/SideBySide/ConnectionTests.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,13 @@ public void GotInfoMessageForNonExistentTable()
2727
connection.InfoMessage += (s, a) =>
2828
{
2929
gotEvent = true;
30+
#if BASELINE
3031
Assert.Single(a.errors);
3132
Assert.Equal((int) MySqlErrorCode.BadTable, a.errors[0].Code);
33+
#else
34+
Assert.Single(a.Errors);
35+
Assert.Equal((int) MySqlErrorCode.BadTable, a.Errors[0].Code);
36+
#endif
3237
};
3338

3439
connection.Execute(@"drop table if exists table_does_not_exist;");
@@ -46,8 +51,10 @@ public void NoInfoMessageWhenNotLastStatementInBatch()
4651
{
4752
gotEvent = true;
4853

54+
#if BASELINE
4955
// seeming bug in Connector/NET raises an event with no errors
5056
Assert.Empty(a.errors);
57+
#endif
5158
};
5259

5360
connection.Execute(@"drop table if exists table_does_not_exist; select 1;");

0 commit comments

Comments
 (0)