forked from herfulnerful/DreamWorld
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMySqlConnector.xml
6105 lines (6099 loc) · 271 KB
/
MySqlConnector.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>MySqlConnector</name>
</assembly>
<members>
<member name="T:MySqlConnector.Authentication.AuthenticationPlugins">
<summary>
A registry of known authentication plugins.
</summary>
</member>
<member name="M:MySqlConnector.Authentication.AuthenticationPlugins.Register(MySqlConnector.Authentication.IAuthenticationPlugin)">
<summary>
Registers the specified authentication plugin. The name of this plugin must be unique.
</summary>
<param name="plugin">The authentication plugin.</param>
</member>
<member name="T:MySqlConnector.Authentication.IAuthenticationPlugin">
<summary>
The primary interface implemented by an authentication plugin.
</summary>
</member>
<member name="P:MySqlConnector.Authentication.IAuthenticationPlugin.Name">
<summary>
Gets the authentication plugin name.
</summary>
</member>
<member name="M:MySqlConnector.Authentication.IAuthenticationPlugin.CreateResponse(System.String,System.ReadOnlySpan{System.Byte})">
<summary>
Creates the authentication response.
</summary>
<param name="password">The client's password.</param>
<param name="authenticationData">The authentication data supplied by the server; this is the <code>auth method data</code>
from the <a href="https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::AuthSwitchRequest">Authentication
Method Switch Request Packet</a>.</param>
<returns>The authentication response.</returns>
</member>
<member name="T:MySqlConnector.Core.CommandListPosition">
<summary>
<see cref="T:MySqlConnector.Core.CommandListPosition"/> encapsulates a list of <see cref="T:MySqlConnector.Core.IMySqlCommand"/> and the current position within that list.
</summary>
</member>
<member name="P:MySqlConnector.Core.CommandListPosition.Commands">
<summary>
The commands in the list.
</summary>
</member>
<member name="F:MySqlConnector.Core.CommandListPosition.CommandIndex">
<summary>
The index of the current command.
</summary>
</member>
<member name="F:MySqlConnector.Core.CommandListPosition.PreparedStatementIndex">
<summary>
If the current command is a prepared statement, the index of the current prepared statement for that command.
</summary>
</member>
<member name="P:MySqlConnector.Core.ConnectionPool.IsEmpty">
<summary>
Returns <c>true</c> if the connection pool is empty, i.e., all connections are in use. Note that in a highly-multithreaded
environment, the value of this property may be stale by the time it's returned.
</summary>
</member>
<member name="M:MySqlConnector.Core.ConnectionPool.GetProcedureCache">
<summary>
Returns the stored procedure cache for this <see cref="T:MySqlConnector.Core.ConnectionPool"/>, lazily creating it on demand.
This method may return a different object after <see cref="M:MySqlConnector.Core.ConnectionPool.ClearAsync(MySqlConnector.Protocol.Serialization.IOBehavior,System.Threading.CancellationToken)"/> has been called. The returned
object is shared between multiple threads and is only safe to use after taking a <c>lock</c> on the
object itself.
</summary>
</member>
<member name="M:MySqlConnector.Core.ConnectionPool.RecoverLeakedSessionsAsync(MySqlConnector.Protocol.Serialization.IOBehavior)">
<summary>
Examines all the <see cref="T:MySqlConnector.Core.ServerSession"/> objects in <see cref="F:MySqlConnector.Core.ConnectionPool.m_leasedSessions"/> to determine if any
have an owning <see cref="T:MySqlConnector.MySqlConnection"/> that has been garbage-collected. If so, assumes that the connection
was not properly disposed and returns the session to the pool.
</summary>
</member>
<member name="P:MySqlConnector.Core.ConnectionSettings.ConnectionStringBuilder">
<summary>
The <see cref="T:MySqlConnector.MySqlConnectionStringBuilder" /> that was used to create this <see cref="T:MySqlConnector.Core.ConnectionSettings" />.!--
This object must not be mutated.
</summary>
</member>
<member name="T:MySqlConnector.Core.ICancellableCommand">
<summary>
<see cref="T:MySqlConnector.Core.IMySqlCommand"/> provides an internal abstraction over operations that can be cancelled: <see cref="T:MySqlConnector.MySqlCommand"/> and <see cref="T:MySqlConnector.MySqlBatch"/>.
</summary>
</member>
<member name="M:MySqlConnector.Core.ICancellableCommandExtensions.GetNextId">
<summary>
Returns a unique ID for all implementations of <see cref="T:MySqlConnector.Core.ICancellableCommand"/>.
</summary>
</member>
<member name="M:MySqlConnector.Core.ICancellableCommandExtensions.GetCommandTimeUntilCanceled(MySqlConnector.Core.ICancellableCommand)">
<summary>
Returns the time (in seconds) until a command should be canceled, clamping it to the maximum time
allowed including CancellationTimeout.
</summary>
</member>
<member name="M:MySqlConnector.Core.ICancellableCommandExtensions.ResetCommandTimeout(MySqlConnector.Core.ICancellableCommand)">
<summary>
Causes the effective command timeout to be reset back to the value specified by <see cref="P:MySqlConnector.Core.ICancellableCommand.CommandTimeout"/>
plus <see cref="P:MySqlConnector.MySqlConnectionStringBuilder.CancellationTimeout"/>. This allows for the command to time out, a cancellation to attempt
to happen, then the "hard" timeout to occur.
</summary>
<remarks>As per the <a href="https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlcommand.commandtimeout.aspx">MSDN documentation</a>,
"This property is the cumulative time-out (for all network packets that are read during the invocation of a method) for all network reads during command
execution or processing of the results. A time-out can still occur after the first row is returned, and does not include user processing time, only network
read time. For example, with a 30 second time out, if Read requires two network packets, then it has 30 seconds to read both network packets. If you call
Read again, it will have another 30 seconds to read any data that it requires."
The <see cref="M:MySqlConnector.Core.ICancellableCommandExtensions.ResetCommandTimeout(MySqlConnector.Core.ICancellableCommand)"/> method is called by public ADO.NET API methods to reset the effective time remaining at the beginning of a new
method call.</remarks>
</member>
<member name="T:MySqlConnector.Core.ICommandPayloadCreator">
<summary>
<see cref="T:MySqlConnector.Core.ICommandPayloadCreator"/> creates the data for an "execute query" command for one or more <see cref="T:MySqlConnector.Core.IMySqlCommand"/> objects in a command list.
</summary>
</member>
<member name="M:MySqlConnector.Core.ICommandPayloadCreator.WriteQueryCommand(MySqlConnector.Core.CommandListPosition@,System.Collections.Generic.IDictionary{System.String,MySqlConnector.Core.CachedProcedure},MySqlConnector.Protocol.Serialization.ByteBufferWriter,System.Boolean)">
<summary>
Writes the payload for an "execute query" command to <paramref name="writer"/>.
</summary>
<param name="commandListPosition">The command list and its current position. This will be updated to the position of the next command to write (or past the end if there are no more commands).</param>
<param name="cachedProcedures">A <see cref="T:MySqlConnector.Core.CachedProcedure"/> for all the stored procedures in the command list, if any.</param>
<param name="writer">The <see cref="T:MySqlConnector.Protocol.Serialization.ByteBufferWriter"/> to write the payload to.</param>
<param name="appendSemicolon">Whether a statement-separating semicolon should be appended if it's missing.</param>
<returns><c>true</c> if a command was written; otherwise, <c>false</c> (if there were no more commands in the list).</returns>
</member>
<member name="M:MySqlConnector.Core.ILoadBalancer.LoadBalance(System.Collections.Generic.IReadOnlyList{System.String})">
<summary>
Returns an <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing <paramref name="hosts"/> in the order they
should be tried to satisfy the load balancing policy.
</summary>
</member>
<member name="T:MySqlConnector.Core.IMySqlCommand">
<summary>
<see cref="T:MySqlConnector.Core.IMySqlCommand"/> provides an internal abstraction over <see cref="T:MySqlConnector.MySqlCommand"/> and <see cref="T:MySqlConnector.MySqlBatchCommand"/>.
</summary>
</member>
<member name="T:MySqlConnector.Core.IValuesEnumerator">
<summary>
<see cref="T:MySqlConnector.Core.IValuesEnumerator"/> provides an abstraction over iterating through a sequence of
rows, where each row can fill an array of field values.
</summary>
</member>
<member name="T:MySqlConnector.Core.ParsedStatement">
<summary>
<see cref="T:MySqlConnector.Core.ParsedStatement"/> represents an individual SQL statement that's been parsed
from a string possibly containing multiple semicolon-delimited SQL statements.
</summary>
</member>
<member name="P:MySqlConnector.Core.ParsedStatement.StatementBytes">
<summary>
The bytes for this statement that will be written on the wire.
</summary>
</member>
<member name="P:MySqlConnector.Core.ParsedStatement.ParameterNames">
<summary>
The names of the parameters (if known) of the parameters in the prepared statement. There
is one entry in this list for each parameter, which will be <c>null</c> if the name is unknown.
</summary>
</member>
<member name="P:MySqlConnector.Core.ParsedStatement.ParameterIndexes">
<summary>
The indexes of the parameters in the prepared statement. There is one entry in this list for
each parameter; it will be <c>-1</c> if the parameter is named.
</summary>
</member>
<member name="T:MySqlConnector.Core.ParsedStatements">
<summary>
<see cref="T:MySqlConnector.Core.ParsedStatements"/> wraps a collection of <see cref="T:MySqlConnector.Core.ParsedStatement"/> objects.
It implements <see cref="T:System.IDisposable"/> to return the memory backing the statements to a shared pool.
</summary>
</member>
<member name="T:MySqlConnector.Core.PreparedStatement">
<summary>
<see cref="T:MySqlConnector.Core.PreparedStatement"/> is a statement that has been prepared on the MySQL Server.
</summary>
</member>
<member name="M:MySqlConnector.Core.ServerSession.SafeDispose``1(``0@)">
<summary>
Disposes and sets <paramref name="disposable"/> to <c>null</c>, ignoring any
<see cref="T:System.IO.IOException"/> or <see cref="T:System.Net.Sockets.SocketException"/> that is thrown.
</summary>
<typeparam name="T">An <see cref="T:System.IDisposable"/> type.</typeparam>
<param name="disposable">The object to dispose.</param>
</member>
<member name="M:MySqlConnector.Core.SingleCommandPayloadCreator.WriteQueryPayload(MySqlConnector.Core.IMySqlCommand,System.Collections.Generic.IDictionary{System.String,MySqlConnector.Core.CachedProcedure},MySqlConnector.Protocol.Serialization.ByteBufferWriter,System.Boolean)">
<summary>
Writes the text of <paramref name="command"/> to <paramref name="writer"/>, encoded in UTF-8.
</summary>
<param name="command">The command.</param>
<param name="cachedProcedures">The cached procedures.</param>
<param name="writer">The output writer.</param>
<param name="appendSemicolon">Whether a statement-separating semicolon should be appended if it's missing.</param>
<returns><c>true</c> if a complete command was written; otherwise, <c>false</c>.</returns>
</member>
<member name="F:MySqlConnector.Core.SqlParser.FinalParseStates.Complete">
<summary>
The statement is complete (apart from potentially needing a semicolon or newline).
</summary>
</member>
<member name="F:MySqlConnector.Core.SqlParser.FinalParseStates.NeedsNewline">
<summary>
The statement needs a newline (e.g., to terminate a final comment).
</summary>
</member>
<member name="F:MySqlConnector.Core.SqlParser.FinalParseStates.NeedsSemicolon">
<summary>
The statement needs a semicolon (if another statement is going to be concatenated to it).
</summary>
</member>
<member name="T:MySqlConnector.Logging.IMySqlConnectorLogger">
<summary>
Implementations of <see cref="T:MySqlConnector.Logging.IMySqlConnectorLogger"/> write logs to a particular target.
</summary>
</member>
<member name="M:MySqlConnector.Logging.IMySqlConnectorLogger.IsEnabled(MySqlConnector.Logging.MySqlConnectorLogLevel)">
<summary>
Returns <c>true</c> if logging for this logger is enabled at the specified level.
</summary>
<param name="level">The log level.</param>
<returns><c>true</c> if logging is enabled; otherwise, <c>false</c>.</returns>
</member>
<member name="M:MySqlConnector.Logging.IMySqlConnectorLogger.Log(MySqlConnector.Logging.MySqlConnectorLogLevel,System.String,System.Object[],System.Exception)">
<summary>
Writes a log message to the target.
</summary>
<param name="level">The log level.</param>
<param name="message">The log message. See documentation for <paramref name="args"/> for notes on interpreting <c>{0}</c> within this string.</param>
<param name="args">If not <c>null</c> or empty, then <paramref name="message"/> includes formatting placeholders (e.g., <c>{0}</c>)
which must be replaced with the arguments in <paramref name="args"/>, using <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> or similar.
If <c>null</c> or an empty array, then <paramref name="message"/> is a literal string; any curly braces within it must be treated as literal characters,
not formatting placeholders.</param>
<param name="exception">If not <c>null</c>, an <see cref="T:System.Exception"/> associated with the log message.</param>
<remarks>This method may be called from multiple threads and must be thread-safe. This method may be called
even if <see cref="M:MySqlConnector.Logging.IMySqlConnectorLogger.IsEnabled(MySqlConnector.Logging.MySqlConnectorLogLevel)"/> would return <c>false</c> for <paramref name="level"/>; the implementation must
check if logging is enabled for that level.</remarks>
</member>
<member name="T:MySqlConnector.Logging.IMySqlConnectorLoggerProvider">
<summary>
Implementations of <see cref="T:MySqlConnector.Logging.IMySqlConnectorLoggerProvider"/> create logger instances.
</summary>
</member>
<member name="M:MySqlConnector.Logging.IMySqlConnectorLoggerProvider.CreateLogger(System.String)">
<summary>
Creates a logger with the specified name. This method may be called from multiple threads and must be thread-safe.
</summary>
</member>
<member name="T:MySqlConnector.Logging.MySqlConnectorLogManager">
<summary>
Controls logging for MySqlConnector.
</summary>
</member>
<member name="P:MySqlConnector.Logging.MySqlConnectorLogManager.Provider">
<summary>
Allows the <see cref="T:MySqlConnector.Logging.IMySqlConnectorLoggerProvider"/> to be set for this library. <see cref="P:MySqlConnector.Logging.MySqlConnectorLogManager.Provider"/> can
be set once, and must be set before any other library methods are used.
</summary>
</member>
<member name="T:MySqlConnector.Logging.NoOpLogger">
<summary>
<see cref="T:MySqlConnector.Logging.NoOpLogger"/> is an implementation of <see cref="T:MySqlConnector.Logging.IMySqlConnectorLogger"/> that does nothing.
</summary>
<remarks>This is the default logging implementation unless <see cref="P:MySqlConnector.Logging.MySqlConnectorLogManager.Provider"/> is set.</remarks>
</member>
<member name="M:MySqlConnector.Logging.NoOpLogger.IsEnabled(MySqlConnector.Logging.MySqlConnectorLogLevel)">
<summary>
Returns <c>false</c>.
</summary>
</member>
<member name="M:MySqlConnector.Logging.NoOpLogger.Log(MySqlConnector.Logging.MySqlConnectorLogLevel,System.String,System.Object[],System.Exception)">
<summary>
Ignores the specified log message.
</summary>
</member>
<member name="P:MySqlConnector.Logging.NoOpLogger.Instance">
<summary>
Returns a singleton instance of <see cref="T:MySqlConnector.Logging.NoOpLogger"/>.
</summary>
</member>
<member name="T:MySqlConnector.Logging.NoOpLoggerProvider">
<summary>
Creates loggers that do nothing.
</summary>
</member>
<member name="M:MySqlConnector.Logging.NoOpLoggerProvider.CreateLogger(System.String)">
<summary>
Returns a <see cref="T:MySqlConnector.Logging.NoOpLogger"/>.
</summary>
</member>
<member name="T:MySqlConnector.MySqlAttribute">
<summary>
<see cref="T:MySqlConnector.MySqlAttribute"/> represents an attribute that can be sent with a MySQL query.
</summary>
<remarks>See <a href="https://dev.mysql.com/doc/refman/8.0/en/query-attributes.html">Query Attributes</a> for information on using query attributes.</remarks>
</member>
<member name="M:MySqlConnector.MySqlAttribute.#ctor">
<summary>
Initializes a new <see cref="T:MySqlConnector.MySqlAttribute"/>.
</summary>
</member>
<member name="M:MySqlConnector.MySqlAttribute.#ctor(System.String,System.Object)">
<summary>
Initializes a new <see cref="T:MySqlConnector.MySqlAttribute"/> with the specified attribute name and value.
</summary>
</member>
<member name="P:MySqlConnector.MySqlAttribute.AttributeName">
<summary>
Gets or sets the attribute name.
</summary>
</member>
<member name="P:MySqlConnector.MySqlAttribute.Value">
<summary>
Gets or sets the attribute value.
</summary>
</member>
<member name="T:MySqlConnector.MySqlAttributeCollection">
<summary>
<see cref="T:MySqlConnector.MySqlAttributeCollection"/> represents a collection of query attributes that can be added to a <see cref="T:MySqlConnector.MySqlCommand"/>.
</summary>
</member>
<member name="P:MySqlConnector.MySqlAttributeCollection.Count">
<summary>
Returns the number of attributes in the collection.
</summary>
</member>
<member name="M:MySqlConnector.MySqlAttributeCollection.Add(MySqlConnector.MySqlAttribute)">
<summary>
Adds a new <see cref="T:MySqlConnector.MySqlAttribute"/> to the collection.
</summary>
<param name="attribute">The attribute to add.</param>
<remarks>The attribute name must not be empty, and must not already exist in the collection.</remarks>
</member>
<member name="M:MySqlConnector.MySqlAttributeCollection.SetAttribute(System.String,System.Object)">
<summary>
Sets the attribute with the specified name to the given value, overwriting it if it already exists.
</summary>
<param name="attributeName">The attribute name.</param>
<param name="value">The attribute value.</param>
</member>
<member name="P:MySqlConnector.MySqlAttributeCollection.Item(System.Int32)">
<summary>
Gets the attribute at the specified index.
</summary>
<param name="index">The index.</param>
<returns>The <see cref="T:MySqlConnector.MySqlAttribute"/> at that index.</returns>
</member>
<member name="M:MySqlConnector.MySqlAttributeCollection.Clear">
<summary>
Clears the collection.
</summary>
</member>
<member name="M:MySqlConnector.MySqlAttributeCollection.GetEnumerator">
<summary>
Returns an enumerator for the collection.
</summary>
</member>
<member name="M:MySqlConnector.MySqlAttributeCollection.Remove(MySqlConnector.MySqlAttribute)">
<summary>
Removes the specified attribute from the collection.
</summary>
<param name="attribute">The attribute to remove.</param>
<returns><c>true</c> if that attribute was removed; otherwise, <c>false</c>.</returns>
</member>
<member name="M:MySqlConnector.MySqlAttributeCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator for the collection.
</summary>
</member>
<member name="T:MySqlConnector.MySqlBatch">
<summary>
<para><see cref="T:MySqlConnector.MySqlBatch"/> implements the new
<a href="https://github.com/dotnet/runtime/issues/28633">ADO.NET batching API</a>.
<strong>It is currently experimental</strong> and may change in the future.</para>
<para>When using MariaDB (10.2 or later), the commands will be sent in a single batch, reducing network
round-trip time. With other MySQL Servers, this may be no more efficient than executing the commands
individually.</para>
<para>Example usage:</para>
<code>
using var connection = new MySqlConnection("...connection string...");
await connection.OpenAsync();
using var batch = new MySqlBatch(connection)
{
BatchCommands =
{
new MySqlBatchCommand("INSERT INTO departments(name) VALUES(@name);")
{
Parameters =
{
new MySqlParameter("@name", "Sales"),
},
},
new MySqlBatchCommand("SET @dept_id = last_insert_id()"),
new MySqlBatchCommand("INSERT INTO employees(name, department_id) VALUES(@name, @dept_id);")
{
Parameters =
{
new MySqlParameter("@name", "Jim Halpert"),
},
},
new MySqlBatchCommand("INSERT INTO employees(name, department_id) VALUES(@name, @dept_id);")
{
Parameters =
{
new MySqlParameter("@name", "Dwight Schrute"),
},
},
},
};
await batch.ExecuteNonQueryAsync();
</code>
</summary>
<remarks>The proposed ADO.NET API that <see cref="T:MySqlConnector.MySqlBatch"/> is based on is not finalized. This API is experimental and may change in the future.</remarks>
</member>
<member name="M:MySqlConnector.MySqlBatch.#ctor">
<summary>
Initializes a new <see cref="T:MySqlConnector.MySqlBatch"/> object. The <see cref="P:MySqlConnector.MySqlBatch.Connection"/> property must be set before this object can be used.
</summary>
</member>
<member name="M:MySqlConnector.MySqlBatch.#ctor(MySqlConnector.MySqlConnection,MySqlConnector.MySqlTransaction)">
<summary>
Initializes a new <see cref="T:MySqlConnector.MySqlBatch"/> object, setting the <see cref="P:MySqlConnector.MySqlBatch.Connection"/> and <see cref="P:MySqlConnector.MySqlBatch.Transaction"/> if specified.
</summary>
<param name="connection">(Optional) The <see cref="T:MySqlConnector.MySqlConnection"/> to use.</param>
<param name="transaction">(Optional) The <see cref="T:MySqlConnector.MySqlTransaction"/> to use.</param>
</member>
<member name="P:MySqlConnector.MySqlBatch.BatchCommands">
<summary>
The collection of commands that will be executed in the batch.
</summary>
</member>
<member name="M:MySqlConnector.MySqlBatch.ExecuteReader(System.Data.CommandBehavior)">
<summary>
Executes all the commands in the batch, returning a <see cref="T:MySqlConnector.MySqlDataReader"/> that can iterate
over the result sets. If multiple resultsets are returned, use <see cref="M:MySqlConnector.MySqlDataReader.NextResult"/>
to access them.
</summary>
</member>
<member name="M:MySqlConnector.MySqlBatch.ExecuteReaderAsync(System.Threading.CancellationToken)">
<summary>
Executes all the commands in the batch, returning a <see cref="T:MySqlConnector.MySqlDataReader"/> that can iterate
over the result sets. If multiple resultsets are returned, use <see cref="M:MySqlConnector.MySqlDataReader.NextResultAsync(System.Threading.CancellationToken)"/>
to access them.
</summary>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> containing the result of the asynchronous operation.</returns>
</member>
<member name="T:MySqlConnector.MySqlBulkCopy">
<summary>
<para><see cref="T:MySqlConnector.MySqlBulkCopy"/> lets you efficiently load a MySQL Server table with data from another source.
It is similar to the <a href="https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlbulkcopy">SqlBulkCopy</a> class
for SQL Server.</para>
<para>Due to <a href="https://mysqlconnector.net/troubleshooting/load-data-local-infile/">security features</a>
in MySQL Server, the connection string <em>must</em> have <c>AllowLoadLocalInfile=true</c> in order
to use this class.</para>
<para>For data that is in CSV or TSV format, use <see cref="T:MySqlConnector.MySqlBulkLoader"/> to bulk load the file.</para>
<para>Example code:</para>
<code>
// NOTE: to copy data between tables in the same database, use INSERT ... SELECT
// https://dev.mysql.com/doc/refman/8.0/en/insert-select.html
var dataTable = GetDataTableFromExternalSource();
// open the connection
using var connection = new MySqlConnection("...;AllowLoadLocalInfile=True");
await connection.OpenAsync();
// bulk copy the data
var bulkCopy = new MySqlBulkCopy(connection);
bulkCopy.DestinationTableName = "some_table_name";
var result = await bulkCopy.WriteToServerAsync(dataTable);
// check for problems
if (result.Warnings.Count != 0) { /* handle potential data loss warnings */ }
</code>
</summary>
<remarks><para><strong>Note:</strong> This API is a unique feature of MySqlConnector; you must
<a href="https://mysqlconnector.net/overview/installing/">switch to MySqlConnector</a> in order to use it.</para>
<para>This API is experimental and may change in the future.</para>
</remarks>
</member>
<member name="M:MySqlConnector.MySqlBulkCopy.#ctor(MySqlConnector.MySqlConnection,MySqlConnector.MySqlTransaction)">
<summary>
Initializes a <see cref="T:MySqlConnector.MySqlBulkCopy"/> object with the specified connection, and optionally the active transaction.
</summary>
<param name="connection">The <see cref="T:MySqlConnector.MySqlConnection"/> to use.</param>
<param name="transaction">(Optional) The <see cref="T:MySqlConnector.MySqlTransaction"/> to use.</param>
</member>
<member name="P:MySqlConnector.MySqlBulkCopy.BulkCopyTimeout">
<summary>
The number of seconds for the operation to complete before it times out, or <c>0</c> for no timeout.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkCopy.DestinationTableName">
<summary>
The name of the table to insert rows into.
</summary>
<remarks>This name needs to be quoted if it contains special characters.</remarks>
</member>
<member name="P:MySqlConnector.MySqlBulkCopy.NotifyAfter">
<summary>
If non-zero, this specifies the number of rows to be processed before generating a notification event.
</summary>
</member>
<member name="E:MySqlConnector.MySqlBulkCopy.MySqlRowsCopied">
<summary>
This event is raised every time that the number of rows specified by the <see cref="P:MySqlConnector.MySqlBulkCopy.NotifyAfter"/> property have been processed.
</summary>
<remarks>
<para>Receipt of a RowsCopied event does not imply that any rows have been sent to the server or committed.</para>
<para>The <see cref="P:MySqlConnector.MySqlRowsCopiedEventArgs.Abort"/> property can be set to <c>true</c> by the event handler to abort the copy.</para>
</remarks>
</member>
<member name="P:MySqlConnector.MySqlBulkCopy.ColumnMappings">
<summary>
A collection of <see cref="T:MySqlConnector.MySqlBulkCopyColumnMapping"/> objects. If the columns being copied from the
data source line up one-to-one with the columns in the destination table then populating this collection is
unnecessary. Otherwise, this should be filled with a collection of <see cref="T:MySqlConnector.MySqlBulkCopyColumnMapping"/> objects
specifying how source columns are to be mapped onto destination columns. If one column mapping is specified,
then all must be specified.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkCopy.RowsCopied">
<summary>
Returns the number of rows that were copied (after <c>WriteToServer(Async)</c> finishes).
</summary>
</member>
<member name="M:MySqlConnector.MySqlBulkCopy.WriteToServer(System.Data.DataTable)">
<summary>
Copies all rows in the supplied <see cref="T:System.Data.DataTable"/> to the destination table specified by the
<see cref="P:MySqlConnector.MySqlBulkCopy.DestinationTableName"/> property of the <see cref="T:MySqlConnector.MySqlBulkCopy"/> object.
</summary>
<param name="dataTable">The <see cref="T:System.Data.DataTable"/> to copy.</param>
<returns>A <see cref="T:MySqlConnector.MySqlBulkCopyResult"/> with the result of the bulk copy operation.</returns>
</member>
<member name="M:MySqlConnector.MySqlBulkCopy.WriteToServerAsync(System.Data.DataTable,System.Threading.CancellationToken)">
<summary>
Asynchronously copies all rows in the supplied <see cref="T:System.Data.DataTable"/> to the destination table specified by the
<see cref="P:MySqlConnector.MySqlBulkCopy.DestinationTableName"/> property of the <see cref="T:MySqlConnector.MySqlBulkCopy"/> object.
</summary>
<param name="dataTable">The <see cref="T:System.Data.DataTable"/> to copy.</param>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>
<returns>A <see cref="T:MySqlConnector.MySqlBulkCopyResult"/> with the result of the bulk copy operation.</returns>
</member>
<member name="M:MySqlConnector.MySqlBulkCopy.WriteToServer(System.Collections.Generic.IEnumerable{System.Data.DataRow},System.Int32)">
<summary>
Copies all rows in the supplied sequence of <see cref="T:System.Data.DataRow"/> objects to the destination table specified by the
<see cref="P:MySqlConnector.MySqlBulkCopy.DestinationTableName"/> property of the <see cref="T:MySqlConnector.MySqlBulkCopy"/> object. The number of columns
to be read from the <see cref="T:System.Data.DataRow"/> objects must be specified in advance.
</summary>
<param name="dataRows">The collection of <see cref="T:System.Data.DataRow"/> objects.</param>
<param name="columnCount">The number of columns to copy (in each row).</param>
<returns>A <see cref="T:MySqlConnector.MySqlBulkCopyResult"/> with the result of the bulk copy operation.</returns>
</member>
<member name="M:MySqlConnector.MySqlBulkCopy.WriteToServerAsync(System.Collections.Generic.IEnumerable{System.Data.DataRow},System.Int32,System.Threading.CancellationToken)">
<summary>
Asynchronously copies all rows in the supplied sequence of <see cref="T:System.Data.DataRow"/> objects to the destination table specified by the
<see cref="P:MySqlConnector.MySqlBulkCopy.DestinationTableName"/> property of the <see cref="T:MySqlConnector.MySqlBulkCopy"/> object. The number of columns
to be read from the <see cref="T:System.Data.DataRow"/> objects must be specified in advance.
</summary>
<param name="dataRows">The collection of <see cref="T:System.Data.DataRow"/> objects.</param>
<param name="columnCount">The number of columns to copy (in each row).</param>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>
<returns>A <see cref="T:MySqlConnector.MySqlBulkCopyResult"/> with the result of the bulk copy operation.</returns>
</member>
<member name="M:MySqlConnector.MySqlBulkCopy.WriteToServer(System.Data.IDataReader)">
<summary>
Copies all rows in the supplied <see cref="T:System.Data.IDataReader"/> to the destination table specified by the
<see cref="P:MySqlConnector.MySqlBulkCopy.DestinationTableName"/> property of the <see cref="T:MySqlConnector.MySqlBulkCopy"/> object.
</summary>
<param name="dataReader">The <see cref="T:System.Data.IDataReader"/> to copy from.</param>
<returns>A <see cref="T:MySqlConnector.MySqlBulkCopyResult"/> with the result of the bulk copy operation.</returns>
</member>
<member name="M:MySqlConnector.MySqlBulkCopy.WriteToServerAsync(System.Data.IDataReader,System.Threading.CancellationToken)">
<summary>
Asynchronously copies all rows in the supplied <see cref="T:System.Data.IDataReader"/> to the destination table specified by the
<see cref="P:MySqlConnector.MySqlBulkCopy.DestinationTableName"/> property of the <see cref="T:MySqlConnector.MySqlBulkCopy"/> object.
</summary>
<param name="dataReader">The <see cref="T:System.Data.IDataReader"/> to copy from.</param>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>
<returns>A <see cref="T:MySqlConnector.MySqlBulkCopyResult"/> with the result of the bulk copy operation.</returns>
</member>
<member name="T:MySqlConnector.MySqlBulkCopyColumnMapping">
<summary>
<para>Use <see cref="T:MySqlConnector.MySqlBulkCopyColumnMapping"/> to specify how to map columns in the source data to
columns in the destination table when using <see cref="T:MySqlConnector.MySqlBulkCopy"/>.</para>
<para>Set <see cref="P:MySqlConnector.MySqlBulkCopyColumnMapping.SourceOrdinal"/> to the index of the source column to map. Set <see cref="P:MySqlConnector.MySqlBulkCopyColumnMapping.DestinationColumn"/> to
either the name of a column in the destination table, or the name of a user-defined variable.
If a user-defined variable, you can use <see cref="P:MySqlConnector.MySqlBulkCopyColumnMapping.Expression"/> to specify a MySQL expression that assigns
its value to destination column.</para>
<para>Source columns that don't have an entry in <see cref="P:MySqlConnector.MySqlBulkCopy.ColumnMappings"/> will be ignored
(unless the <see cref="P:MySqlConnector.MySqlBulkCopy.ColumnMappings"/> collection is empty, in which case all columns will be mapped
one-to-one).</para>
<para>MySqlConnector will transmit all binary data as hex, so any expression that operates on it
must decode it with the <c>UNHEX</c> function first. (This will be performed automatically if no
<see cref="P:MySqlConnector.MySqlBulkCopyColumnMapping.Expression"/> is specified, but will be necessary to specify manually for more complex expressions.)</para>
<para>Example code:</para>
<code>
new MySqlBulkCopyColumnMapping
{
SourceOrdinal = 2,
DestinationColumn = "user_name",
},
new MySqlBulkCopyColumnMapping
{
SourceOrdinal = 0,
DestinationColumn = "@tmp",
Expression = "column_value = @tmp * 2",
},
</code>
</summary>
</member>
<member name="M:MySqlConnector.MySqlBulkCopyColumnMapping.#ctor">
<summary>
Initializes <see cref="T:MySqlConnector.MySqlBulkCopyColumnMapping"/> with the default values.
</summary>
</member>
<member name="M:MySqlConnector.MySqlBulkCopyColumnMapping.#ctor(System.Int32,System.String,System.String)">
<summary>
Initializes <see cref="T:MySqlConnector.MySqlBulkCopyColumnMapping"/> to the specified values.
</summary>
<param name="sourceOrdinal">The ordinal position of the source column.</param>
<param name="destinationColumn">The name of the destination column.</param>
<param name="expression">The optional expression to be used to set the destination column.</param>
</member>
<member name="P:MySqlConnector.MySqlBulkCopyColumnMapping.SourceOrdinal">
<summary>
The ordinal position of the source column to map from.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkCopyColumnMapping.DestinationColumn">
<summary>
The name of the destination column to copy to. To use an expression, this should be the name of a unique user-defined variable.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkCopyColumnMapping.Expression">
<summary>
An optional expression for setting a destination column. To use an expression, the <see cref="P:MySqlConnector.MySqlBulkCopyColumnMapping.DestinationColumn"/> should
be set to the name of a user-defined variable and this expression should set a column using that variable.
</summary>
<remarks>To populate a binary column, you must set <see cref="P:MySqlConnector.MySqlBulkCopyColumnMapping.DestinationColumn"/> to a variable name, and <see cref="P:MySqlConnector.MySqlBulkCopyColumnMapping.Expression"/> to an
expression that uses <code>UNHEX</code> to set the column value, e.g., <code>`destColumn` = UNHEX(@variableName)</code>.</remarks>
</member>
<member name="T:MySqlConnector.MySqlBulkCopyResult">
<summary>
Represents the result of a <see cref="T:MySqlConnector.MySqlBulkCopy"/> operation.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkCopyResult.Warnings">
<summary>
The warnings, if any. Users of <see cref="T:MySqlConnector.MySqlBulkCopy"/> should check that this collection is empty to avoid
potential data loss from failed data type conversions.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkCopyResult.RowsInserted">
<summary>
The number of rows that were inserted during the bulk copy operation.
</summary>
</member>
<member name="T:MySqlConnector.MySqlBulkLoader">
<summary>
<para><see cref="T:MySqlConnector.MySqlBulkLoader"/> lets you efficiently load a MySQL Server Table with data from a CSV or TSV file or <see cref="T:System.IO.Stream"/>.</para>
<para>Example code:</para>
<code>
using var connection = new MySqlConnection("...;AllowLoadLocalInfile=True");
await connection.OpenAsync();
var bulkLoader = new MySqlBulkLoader(connection)
{
FileName = @"C:\Path\To\file.csv",
TableName = "destination",
CharacterSet = "UTF8",
NumberOfLinesToSkip = 1,
FieldTerminator = ",",
FieldQuotationCharacter = '"',
FieldQuotationOptional = true,
Local = true,
}
var rowCount = await bulkLoader.LoadAsync();
</code>
</summary>
<remarks>Due to <a href="https://mysqlconnector.net/troubleshooting/load-data-local-infile/">security features</a>
in MySQL Server, the connection string <strong>must</strong> have <c>AllowLoadLocalInfile=true</c> in order to use a local source.
</remarks>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.CharacterSet">
<summary>
(Optional) The character set of the source data. By default, the database's character set is used.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.Columns">
<summary>
(Optional) A list of the column names in the destination table that should be filled with data from the input file.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.ConflictOption">
<summary>
A <see cref="T:MySqlConnector.MySqlBulkLoaderConflictOption"/> value that specifies how conflicts are resolved (default <see cref="F:MySqlConnector.MySqlBulkLoaderConflictOption.None"/>).
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.Connection">
<summary>
The <see cref="T:MySqlConnector.MySqlConnection"/> to use.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.EscapeCharacter">
<summary>
(Optional) The character used to escape instances of <see cref="P:MySqlConnector.MySqlBulkLoader.FieldQuotationCharacter"/> within field values.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.Expressions">
<summary>
(Optional) A list of expressions used to set field values from the columns in the source data.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.FieldQuotationCharacter">
<summary>
(Optional) The character used to enclose fields in the source data.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.FieldQuotationOptional">
<summary>
Whether quoting fields is optional (default <c>false</c>).
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.FieldTerminator">
<summary>
(Optional) The string fields are terminated with.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.FileName">
<summary>
The name of the local (if <see cref="P:MySqlConnector.MySqlBulkLoader.Local"/> is <c>true</c>) or remote (otherwise) file to load.
Either this or <see cref="P:MySqlConnector.MySqlBulkLoader.SourceStream"/> must be set.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.LinePrefix">
<summary>
(Optional) A prefix in each line that should be skipped when loading.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.LineTerminator">
<summary>
(Optional) The string lines are terminated with.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.Local">
<summary>
Whether a local file is being used (default <c>true</c>).
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.NumberOfLinesToSkip">
<summary>
The number of lines to skip at the beginning of the file (default <c>0</c>).
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.Priority">
<summary>
A <see cref="T:MySqlConnector.MySqlBulkLoaderPriority"/> giving the priority to load with (default <see cref="F:MySqlConnector.MySqlBulkLoaderPriority.None"/>).
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.SourceStream">
<summary>
A <see cref="T:System.IO.Stream"/> containing the data to load. Either this or <see cref="P:MySqlConnector.MySqlBulkLoader.FileName"/> must be set.
The <see cref="P:MySqlConnector.MySqlBulkLoader.Local"/> property must be <c>true</c> if this is set.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.TableName">
<summary>
The name of the table to load into. If this is a reserved word or contains spaces, it must be quoted.
</summary>
</member>
<member name="P:MySqlConnector.MySqlBulkLoader.Timeout">
<summary>
The timeout (in milliseconds) to use.
</summary>
</member>
<member name="M:MySqlConnector.MySqlBulkLoader.#ctor(MySqlConnector.MySqlConnection)">
<summary>
Initializes a new instance of the <see cref="T:MySqlConnector.MySqlBulkLoader"/> class with the specified <see cref="T:MySqlConnector.MySqlConnection"/>.
</summary>
<param name="connection">The <see cref="T:MySqlConnector.MySqlConnection"/> to use.</param>
</member>
<member name="M:MySqlConnector.MySqlBulkLoader.Load">
<summary>
Loads all data in the source file or stream into the destination table.
</summary>
<returns>The number of rows inserted.</returns>
</member>
<member name="M:MySqlConnector.MySqlBulkLoader.LoadAsync">
<summary>
Asynchronously loads all data in the source file or stream into the destination table.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that will be completed with the number of rows inserted.</returns>
</member>
<member name="M:MySqlConnector.MySqlBulkLoader.LoadAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously loads all data in the source file or stream into the destination table.
</summary>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that will be completed with the number of rows inserted.</returns>
</member>
<member name="F:MySqlConnector.MySqlCertificateStoreLocation.None">
<summary>
Do not use certificate store
</summary>
</member>
<member name="F:MySqlConnector.MySqlCertificateStoreLocation.CurrentUser">
<summary>
Use certificate store for the current user
</summary>
</member>
<member name="F:MySqlConnector.MySqlCertificateStoreLocation.LocalMachine">
<summary>
User certificate store for the machine
</summary>
</member>
<member name="T:MySqlConnector.MySqlCommand">
<summary>
<see cref="T:MySqlConnector.MySqlCommand"/> represents a SQL statement or stored procedure name
to execute against a MySQL database.
</summary>
</member>
<member name="M:MySqlConnector.MySqlCommand.#ctor">
<summary>
Initializes a new instance of the <see cref="T:MySqlConnector.MySqlCommand"/> class.
</summary>
</member>
<member name="M:MySqlConnector.MySqlCommand.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:MySqlConnector.MySqlCommand"/> class, setting <see cref="P:MySqlConnector.MySqlCommand.CommandText"/> to <paramref name="commandText"/>.
</summary>
<param name="commandText">The text to assign to <see cref="P:MySqlConnector.MySqlCommand.CommandText"/>.</param>
</member>
<member name="M:MySqlConnector.MySqlCommand.#ctor(MySqlConnector.MySqlConnection,MySqlConnector.MySqlTransaction)">
<summary>
Initializes a new instance of the <see cref="T:MySqlConnector.MySqlCommand"/> class with the specified <see cref="T:MySqlConnector.MySqlConnection"/> and <see cref="T:MySqlConnector.MySqlTransaction"/>.
</summary>
<param name="connection">The <see cref="T:MySqlConnector.MySqlConnection"/> to use.</param>
<param name="transaction">The active <see cref="T:MySqlConnector.MySqlTransaction"/>, if any.</param>
</member>
<member name="M:MySqlConnector.MySqlCommand.#ctor(System.String,MySqlConnector.MySqlConnection)">
<summary>
Initializes a new instance of the <see cref="T:MySqlConnector.MySqlCommand"/> class with the specified command text and <see cref="T:MySqlConnector.MySqlConnection"/>.
</summary>
<param name="commandText">The text to assign to <see cref="P:MySqlConnector.MySqlCommand.CommandText"/>.</param>
<param name="connection">The <see cref="T:MySqlConnector.MySqlConnection"/> to use.</param>
</member>
<member name="M:MySqlConnector.MySqlCommand.#ctor(System.String,MySqlConnector.MySqlConnection,MySqlConnector.MySqlTransaction)">
<summary>
Initializes a new instance of the <see cref="T:MySqlConnector.MySqlCommand"/> class with the specified command text,<see cref="T:MySqlConnector.MySqlConnection"/>, and <see cref="T:MySqlConnector.MySqlTransaction"/>.
</summary>
<param name="commandText">The text to assign to <see cref="P:MySqlConnector.MySqlCommand.CommandText"/>.</param>
<param name="connection">The <see cref="T:MySqlConnector.MySqlConnection"/> to use.</param>
<param name="transaction">The active <see cref="T:MySqlConnector.MySqlTransaction"/>, if any.</param>
</member>
<member name="P:MySqlConnector.MySqlCommand.Parameters">
<summary>
The collection of <see cref="T:MySqlConnector.MySqlParameter"/> objects for this command.
</summary>
</member>
<member name="P:MySqlConnector.MySqlCommand.Attributes">
<summary>
The collection of <see cref="T:MySqlConnector.MySqlAttribute"/> objects for this command.
</summary>
</member>
<member name="M:MySqlConnector.MySqlCommand.Cancel">
<inheritdoc/>
</member>
<member name="M:MySqlConnector.MySqlCommand.ExecuteNonQuery">
<summary>
Executes this command on the associated <see cref="T:MySqlConnector.MySqlConnection"/>.
</summary>
<returns>The number of rows affected.</returns>
<remarks>For UPDATE, INSERT, and DELETE statements, the return value is the number of rows affected by the command.
For stored procedures, the return value is the number of rows affected by the last statement in the stored procedure,
or zero if the last statement is a SELECT. For all other types of statements, the return value is -1.</remarks>
</member>
<member name="M:MySqlConnector.MySqlCommand.ExecuteScalar">
<inheritdoc/>
</member>
<member name="M:MySqlConnector.MySqlCommand.Prepare">
<inheritdoc/>
</member>
<member name="P:MySqlConnector.MySqlCommand.CommandText">
<summary>
Gets or sets the command text to execute.
</summary>
<remarks>If <see cref="P:MySqlConnector.MySqlCommand.CommandType"/> is <see cref="F:System.Data.CommandType.Text"/>, this is one or more SQL statements to execute.
If <see cref="P:MySqlConnector.MySqlCommand.CommandType"/> is <see cref="F:System.Data.CommandType.StoredProcedure"/>, this is the name of the stored procedure; any
special characters in the stored procedure name must be quoted or escaped.</remarks>
</member>
<member name="P:MySqlConnector.MySqlCommand.CommandTimeout">
<inheritdoc/>
</member>
<member name="P:MySqlConnector.MySqlCommand.CommandType">
<inheritdoc/>
</member>
<member name="P:MySqlConnector.MySqlCommand.DesignTimeVisible">
<inheritdoc/>
</member>
<member name="P:MySqlConnector.MySqlCommand.UpdatedRowSource">
<inheritdoc/>
</member>
<member name="P:MySqlConnector.MySqlCommand.LastInsertedId">
<summary>
Holds the first automatically-generated ID for a value inserted in an <c>AUTO_INCREMENT</c> column in the last statement.
</summary>
<remarks>
See <a href="https://dev.mysql.com/doc/refman/8.0/en/information-functions.html#function_last-insert-id"><c>LAST_INSERT_ID()</c></a> for more information.
</remarks>
</member>
<member name="M:MySqlConnector.MySqlCommand.ExecuteNonQueryAsync(System.Threading.CancellationToken)">
<summary>
Executes this command asynchronously on the associated <see cref="T:MySqlConnector.MySqlConnection"/>.
</summary>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>
<returns>A task representing the asynchronous operation.</returns>
<remarks>For UPDATE, INSERT, and DELETE statements, the return value is the number of rows affected by the command.
For stored procedures, the return value is the number of rows affected by the last statement in the stored procedure,
or zero if the last statement is a SELECT. For all other types of statements, the return value is -1.</remarks>
</member>
<member name="M:MySqlConnector.MySqlCommand.MySqlConnector#Core#ICancellableCommand#RegisterCancel(System.Threading.CancellationToken)">
<summary>
Registers <see cref="M:MySqlConnector.MySqlCommand.Cancel"/> as a callback with <paramref name="cancellationToken"/> if cancellation is supported.
</summary>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
<returns>An object that must be disposed to revoke the cancellation registration.</returns>
<remarks>This method is more efficient than calling <code>token.Register(Command.Cancel)</code> because it avoids
unnecessary allocations.</remarks>
</member>
<member name="T:MySqlConnector.MySqlConnection">
<summary>
<see cref="T:MySqlConnector.MySqlConnection"/> represents a connection to a MySQL database.
</summary>
</member>
<member name="M:MySqlConnector.MySqlConnection.BeginTransaction">
<summary>
Begins a database transaction.
</summary>
<returns>A <see cref="T:MySqlConnector.MySqlTransaction"/> representing the new database transaction.</returns>
<remarks>Transactions may not be nested.</remarks>
</member>
<member name="M:MySqlConnector.MySqlConnection.BeginTransaction(System.Data.IsolationLevel)">
<summary>
Begins a database transaction.
</summary>
<param name="isolationLevel">The <see cref="T:System.Data.IsolationLevel"/> for the transaction.</param>
<returns>A <see cref="T:MySqlConnector.MySqlTransaction"/> representing the new database transaction.</returns>
<remarks>Transactions may not be nested.</remarks>
</member>
<member name="M:MySqlConnector.MySqlConnection.BeginTransaction(System.Data.IsolationLevel,System.Boolean)">
<summary>
Begins a database transaction.
</summary>
<param name="isolationLevel">The <see cref="T:System.Data.IsolationLevel"/> for the transaction.</param>
<param name="isReadOnly">If <c>true</c>, changes to tables used in the transaction are prohibited; otherwise, they are permitted.</param>
<returns>A <see cref="T:MySqlConnector.MySqlTransaction"/> representing the new database transaction.</returns>
<remarks>Transactions may not be nested.</remarks>
</member>
<member name="M:MySqlConnector.MySqlConnection.BeginDbTransaction(System.Data.IsolationLevel)">
<summary>
Begins a database transaction.
</summary>
<param name="isolationLevel">The <see cref="T:System.Data.IsolationLevel"/> for the transaction.</param>
<returns>A <see cref="T:MySqlConnector.MySqlTransaction"/> representing the new database transaction.</returns>
</member>
<member name="M:MySqlConnector.MySqlConnection.BeginTransactionAsync(System.Threading.CancellationToken)">
<summary>
Begins a database transaction asynchronously.
</summary>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the new database transaction.</returns>
<remarks>Transactions may not be nested.</remarks>
</member>
<member name="M:MySqlConnector.MySqlConnection.BeginTransactionAsync(System.Data.IsolationLevel,System.Threading.CancellationToken)">
<summary>
Begins a database transaction asynchronously.
</summary>
<param name="isolationLevel">The <see cref="T:System.Data.IsolationLevel"/> for the transaction.</param>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the new database transaction.</returns>
<remarks>Transactions may not be nested.</remarks>
</member>
<member name="M:MySqlConnector.MySqlConnection.BeginTransactionAsync(System.Data.IsolationLevel,System.Boolean,System.Threading.CancellationToken)">
<summary>
Begins a database transaction asynchronously.
</summary>
<param name="isolationLevel">The <see cref="T:System.Data.IsolationLevel"/> for the transaction.</param>
<param name="isReadOnly">If <c>true</c>, changes to tables used in the transaction are prohibited; otherwise, they are permitted.</param>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the new database transaction.</returns>
<remarks>Transactions may not be nested.</remarks>
</member>
<member name="M:MySqlConnector.MySqlConnection.ResetConnectionAsync(System.Threading.CancellationToken)">
<summary>
Resets the session state of the current open connection; this clears temporary tables and user-defined variables.
</summary>
<param name="cancellationToken">A token to cancel the asynchronous operation.</param>