Skip to content

Commit 42424ef

Browse files
Wraith2mdaigle
Wraith2
authored and
mdaigle
committed
Strong typed diagnostics (#2226)
1 parent 8401a77 commit 42424ef

File tree

8 files changed

+1795
-195
lines changed

8 files changed

+1795
-195
lines changed

‎doc/snippets/Microsoft.Data.SqlClient/SqlClientDiagnostic.xml

+312
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,312 @@
1+
<?xml version="1.0"?>
2+
<docs>
3+
<members name="SqlClientDiagnostic">
4+
<OperationId>
5+
<summary>A guid value used to correlate before, after and error events.</summary>
6+
</OperationId>
7+
<Operation>
8+
<summary>The name of the operation.</summary>
9+
</Operation>
10+
<Timestamp>
11+
<summary>The timestamp of the event.</summary>
12+
</Timestamp>
13+
<Item1>
14+
<summary>
15+
Gets the element at the specified index in the read-only list.
16+
</summary>
17+
<param name="index">The zero-based index of the element to get.</param>
18+
<returns>The element at the specified index in the read-only list.</returns>
19+
<exception cref="IndexOutOfRangeException"></exception>
20+
</Item1>
21+
<Count>
22+
<summary>Gets the number of elements in the collection.</summary>
23+
<returns>The number of elements in the collection.</returns>
24+
</Count>
25+
<GetEnumerator>
26+
<summary>Returns an enumerator that iterates through the collection.</summary>
27+
<returns>An enumerator that can be used to iterate through the collection.</returns>
28+
</GetEnumerator>
29+
</members>
30+
<members name="SqlClientCommandBefore">
31+
<SqlClientCommandBefore>
32+
<summary>Contains diagnostic information emitted before a command is executed.</summary>
33+
</SqlClientCommandBefore>
34+
<Name>
35+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
36+
</Name>
37+
<ConnectionId>
38+
<summary>A nullable guid uniquely identifying the connection that the xommand is being executed on.</summary>
39+
</ConnectionId>
40+
<TransactionId>
41+
<summary>A nullable long uniquely identifying the transaction that the command enrolled in if it is enrolled in one.</summary>
42+
</TransactionId>
43+
<Command>
44+
<summary>The command object that is executing.</summary>
45+
</Command>
46+
</members>
47+
<members name="SqlClientCommandAfter">
48+
<SqlClientCommandAfter>
49+
<summary>Contains diagnostic information emitted after a command is successfully executed.</summary>
50+
</SqlClientCommandAfter>
51+
<Name>
52+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
53+
</Name>
54+
<ConnectionId>
55+
<summary>A nullable guid uniquely identifying the connection that the command is being executed on.</summary>
56+
</ConnectionId>
57+
<TransactionId>
58+
<summary>A nullable long uniquely identifying the transaction that the command is enrolled in if it is enrolled in one, or null.</summary>
59+
</TransactionId>
60+
<Command>
61+
<summary>The command object that is executing.</summary>
62+
</Command>
63+
<Statistics>
64+
<summary>An IDictionary of statistic information about the event that has completed.</summary>
65+
</Statistics>
66+
</members>
67+
<members name="SqlClientCommandError">
68+
<SqlClientCommandError>
69+
<summary>Contains diagnostic information emitted after a command execution fails with an exception.</summary>
70+
</SqlClientCommandError>
71+
<Name>
72+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
73+
</Name>
74+
<ConnectionId>
75+
<summary>A nullable guid uniquely identifying the connection that the command is being executed on.</summary>
76+
</ConnectionId>
77+
<TransactionId>
78+
<summary>A nullable long uniquely identifying the transaction that the command is enrolled in if it is enrolled in one, or null.</summary>
79+
</TransactionId>
80+
<Command>
81+
<summary>The command object that is executing.</summary>
82+
</Command>
83+
<Exception>
84+
<summary>The exception object that caused the command execution to fail.</summary>
85+
</Exception>
86+
</members>
87+
<members name="SqlClientConnectionOpenBefore">
88+
<SqlClientConnectionOpenBefore>
89+
<summary>Contains diagnostic information emitted before a connection is opened.</summary>
90+
</SqlClientConnectionOpenBefore>
91+
<Name>
92+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
93+
</Name>
94+
<Connection>
95+
<summary>The connection object that is being opened.</summary>
96+
</Connection>
97+
<ClientVersion>
98+
<summary>The version of the SqlClient library.</summary>
99+
</ClientVersion>
100+
</members>
101+
<members name="SqlClientConnectionOpenAfter">
102+
<SqlClientConnectionOpenAfter>
103+
<summary>Contains diagnostic information emitted after a connection has been successfully opened.</summary>
104+
</SqlClientConnectionOpenAfter>
105+
<Name>
106+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
107+
</Name>
108+
<Connection>
109+
<summary>The connection object that has been opened.</summary>
110+
</Connection>
111+
<ClientVersion>
112+
<summary>The version of the SqlClient library.</summary>
113+
</ClientVersion>
114+
<ConnectionId>
115+
<summary>The unique guid assigned to the connection.</summary>
116+
</ConnectionId>
117+
<Statistics>
118+
<summary>An IDictionary of statistic information about the event that has completed.</summary>
119+
</Statistics>
120+
</members>
121+
<members name="SqlClientConnectionOpenError">
122+
<SqlClientConnectionOpenError>
123+
<summary>Contains diagnostic information emitted after a connection open fails with an exception.</summary>
124+
</SqlClientConnectionOpenError>
125+
<Name>
126+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
127+
</Name>
128+
<Connection>
129+
<summary>The connection object that has been opened.</summary>
130+
</Connection>
131+
<ClientVersion>
132+
<summary>The version of the SqlClient library.</summary>
133+
</ClientVersion>
134+
<ConnectionId>
135+
<summary>The unique guid assigned to the connection.</summary>
136+
</ConnectionId>
137+
<Exception>
138+
<summary>The exception object that caused the command execution to fail.</summary>
139+
</Exception>
140+
</members>
141+
<members name="SqlClientConnectionCloseBefore">
142+
<SqlClientConnectionCloseBefore>
143+
<summary>Contains diagnostic information emitted before a connection is closed.</summary>
144+
</SqlClientConnectionCloseBefore>
145+
<Name>
146+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
147+
</Name>
148+
<Connection>
149+
<summary>The connection object that is being closed.</summary>
150+
</Connection>
151+
<ConnectionId>
152+
<summary>The unique guid assigned to the connection.</summary>
153+
</ConnectionId>
154+
<Statistics>
155+
<summary>An IDictionary of statistic information about the connection.</summary>
156+
</Statistics>
157+
</members>
158+
<members name="SqlClientConnectionCloseAfter">
159+
<SqlClientConnectionCloseAfter>
160+
<summary>Contains diagnostic information emitted after a connection has been successfully closed.</summary>
161+
</SqlClientConnectionCloseAfter>
162+
<Name>
163+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
164+
</Name>
165+
<Connection>
166+
<summary>The connection object that has been closed.</summary>
167+
</Connection>
168+
<ConnectionId>
169+
<summary>The unique guid assigned to the connection.</summary>
170+
</ConnectionId>
171+
<Statistics>
172+
<summary>An IDictionary of statistic information about the connection.</summary>
173+
</Statistics>
174+
</members>
175+
<members name="SqlClientConnectionCloseError">
176+
<SqlClientConnectionCloseError>
177+
<summary>Contains diagnostic information emitted after a connection close fails with an exception.</summary>
178+
</SqlClientConnectionCloseError>
179+
<Name>
180+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
181+
</Name>
182+
<Connection>
183+
<summary>The connection object that has been closed.</summary>
184+
</Connection>
185+
<ConnectionId>
186+
<summary>The unique guid assigned to the connection.</summary>
187+
</ConnectionId>
188+
<Statistics>
189+
<summary>An IDictionary of statistic information about the connection.</summary>
190+
</Statistics>
191+
<Exception>
192+
<summary>The exception object that caused the command execution to fail.</summary>
193+
</Exception>
194+
</members>
195+
<members name="SqlClientTransactionCommitBefore">
196+
<SqlClientTransactionCommitBefore>
197+
<summary>Contains diagnostic information emitted before a transaction is opened.</summary>
198+
</SqlClientTransactionCommitBefore>
199+
<Name>
200+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
201+
</Name>
202+
<Connection>
203+
<summary>The connection object that the transaction belongs to.</summary>
204+
</Connection>
205+
<IsolationLevel>
206+
<summary>The IsolationLevel of the transaction.</summary>
207+
</IsolationLevel>
208+
<TransactionId>
209+
<summary>A nullable long uniquely identifying the transaction that the command is enrolled in if it is enrolled in one, or null.</summary>
210+
</TransactionId>
211+
</members>
212+
<members name="SqlClientTransactionCommitAfter">
213+
<SqlClientTransactionCommitAfter>
214+
<summary>Contains diagnostic information emitted after a transaction is successfully committed.</summary>
215+
</SqlClientTransactionCommitAfter>
216+
<Name>
217+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
218+
</Name>
219+
<Connection>
220+
<summary>The connection object that the transaction belongs to.</summary>
221+
</Connection>
222+
<IsolationLevel>
223+
<summary>The IsolationLevel of the transaction.</summary>
224+
</IsolationLevel>
225+
<TransactionId>
226+
<summary>A nullable long uniquely identifying the transaction that the command is enrolled in if it is enrolled in one, or null.</summary>
227+
</TransactionId>
228+
</members>
229+
<members name="SqlClientTransactionCommitError">
230+
<SqlClientTransactionCommitError>
231+
<summary>Contains diagnostic information emitted after a transaction commit fails with an exception.</summary>
232+
</SqlClientTransactionCommitError>
233+
<Name>
234+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
235+
</Name>
236+
<Connection>
237+
<summary>The connection object that the transaction belongs to.</summary>
238+
</Connection>
239+
<IsolationLevel>
240+
<summary>The IsolationLevel of the transaction.</summary>
241+
</IsolationLevel>
242+
<TransactionId>
243+
<summary>A nullable long uniquely identifying the transaction that the command is enrolled in if it is enrolled in one, or null.</summary>
244+
</TransactionId>
245+
<Exception>
246+
<summary>The exception object that caused the command execution to fail.</summary>
247+
</Exception>
248+
</members>
249+
<members name="SqlClientTransactionRollbackBefore">
250+
<SqlClientTransactionRollbackBefore>
251+
<summary>Contains diagnostic information emitted before a transaction rollback is rolled back.</summary>
252+
</SqlClientTransactionRollbackBefore>
253+
<Name>
254+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
255+
</Name>
256+
<Connection>
257+
<summary>The connection object that the transaction belongs to.</summary>
258+
</Connection>
259+
<IsolationLevel>
260+
<summary>The IsolationLevel of the transaction.</summary>
261+
</IsolationLevel>
262+
<TransactionId>
263+
<summary>A nullable long uniquely identifying the transaction that the command is enrolled in if it is enrolled in one, or null.</summary>
264+
</TransactionId>
265+
<TransactionName>
266+
<summary>The name of the transaction which is being rolled back.</summary>
267+
</TransactionName>
268+
</members>
269+
<members name="SqlClientTransactionRollbackAfter">
270+
<SqlClientTransactionRollbackAfter>
271+
<summary>Contains diagnostic information emitted after a transaction is rolled back successfully.</summary>
272+
</SqlClientTransactionRollbackAfter>
273+
<Name>
274+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
275+
</Name>
276+
<Connection>
277+
<summary>The connection object that the transaction belongs to.</summary>
278+
</Connection>
279+
<IsolationLevel>
280+
<summary>The IsolationLevel of the transaction.</summary>
281+
</IsolationLevel>
282+
<TransactionId>
283+
<summary>A nullable long uniquely identifying the transaction, or null.</summary>
284+
</TransactionId>
285+
<TransactionName>
286+
<summary>The name of the transaction which is being rolled back.</summary>
287+
</TransactionName>
288+
</members>
289+
<members name="SqlClientTransactionRollbackError">
290+
<SqlClientTransactionRollbackError>
291+
<summary>Contains diagnostic information emitted after a transaction roll back failes with an exception.</summary>
292+
</SqlClientTransactionRollbackError>
293+
<Name>
294+
<summary>The name of the event that needs to be enabled for the event to be raised.</summary>
295+
</Name>
296+
<Connection>
297+
<summary>The connection object that the transaction belongs to.</summary>
298+
</Connection>
299+
<IsolationLevel>
300+
<summary>The IsolationLevel of the transaction.</summary>
301+
</IsolationLevel>
302+
<TransactionId>
303+
<summary>A nullable long uniquely identifying the transaction , or null.</summary>
304+
</TransactionId>
305+
<TransactionName>
306+
<summary>The name of the transaction which is being rolled back.</summary>
307+
</TransactionName>
308+
<Exception>
309+
<summary>The exception object that caused the command execution to fail.</summary>
310+
</Exception>
311+
</members>
312+
</docs>

‎src/Microsoft.Data.SqlClient.sln

+1
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Microsoft.Data.SqlClient",
102102
..\doc\snippets\Microsoft.Data.SqlClient\SqlBulkCopyColumnOrderHint.xml = ..\doc\snippets\Microsoft.Data.SqlClient\SqlBulkCopyColumnOrderHint.xml
103103
..\doc\snippets\Microsoft.Data.SqlClient\SqlBulkCopyColumnOrderHintCollection.xml = ..\doc\snippets\Microsoft.Data.SqlClient\SqlBulkCopyColumnOrderHintCollection.xml
104104
..\doc\snippets\Microsoft.Data.SqlClient\SqlBulkCopyOptions.xml = ..\doc\snippets\Microsoft.Data.SqlClient\SqlBulkCopyOptions.xml
105+
..\doc\snippets\Microsoft.Data.SqlClient\SqlClientDiagnostic.xml = ..\doc\snippets\Microsoft.Data.SqlClient\SqlClientDiagnostic.xml
105106
..\doc\snippets\Microsoft.Data.SqlClient\SqlClientFactory.xml = ..\doc\snippets\Microsoft.Data.SqlClient\SqlClientFactory.xml
106107
..\doc\snippets\Microsoft.Data.SqlClient\SqlClientLogger.xml = ..\doc\snippets\Microsoft.Data.SqlClient\SqlClientLogger.xml
107108
..\doc\snippets\Microsoft.Data.SqlClient\SqlClientMetaDataCollectionNames.xml = ..\doc\snippets\Microsoft.Data.SqlClient\SqlClientMetaDataCollectionNames.xml

0 commit comments

Comments
 (0)