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
|
<docs>
<ClassSummary>
<summary>
Provides a means of reading a forward-only stream of rows from a MySQL database. This class cannot be inherited.
</summary>
<remarks>
<para>
To create a <B>MySQLDataReader</B>, you must call the <see cref="MySqlCommand.ExecuteReader()"/>
method of the <see cref="MySqlCommand"/> object, rather than directly using a constructor.
</para>
<para>
While the <B>MySqlDataReader</B> is in use, the associated <see cref="MySqlConnection"/>
is busy serving the <B>MySqlDataReader</B>, and no other operations can be performed
on the <B>MySqlConnection</B> other than closing it. This is the case until the
<see cref="MySqlDataReader.Close"/> method of the <B>MySqlDataReader</B> is called.
</para>
<para>
<see cref="MySqlDataReader.IsClosed"/> and <see cref="MySqlDataReader.RecordsAffected"/>
are the only properties that you can call after the <B>MySqlDataReader</B> is
closed. Though the <B>RecordsAffected</B> property may be accessed at any time
while the <B>MySqlDataReader</B> exists, always call <B>Close</B> before returning
the value of <B>RecordsAffected</B> to ensure an accurate return value.
</para>
<para>
For optimal performance, <B>MySqlDataReader</B> avoids creating
unnecessary objects or making unnecessary copies of data. As a result, multiple calls
to methods such as <see cref="MySqlDataReader.GetValue"/> return a reference to the
same object. Use caution if you are modifying the underlying value of the objects
returned by methods such as <B>GetValue</B>.
</para>
</remarks>
<example>
The following example creates a <see cref="MySqlConnection"/>,
a <see cref="MySqlCommand"/>, and a <B>MySqlDataReader</B>. The example reads through
the data, writing it out to the console. Finally, the example closes the <B>MySqlDataReader</B>, then the
<B>MySqlConnection</B>.
<code lang="vbnet">
Public Sub ReadMyData(myConnString As String)
Dim mySelectQuery As String = "SELECT OrderID, CustomerID FROM Orders"
Dim myConnection As New MySqlConnection(myConnString)
Dim myCommand As New MySqlCommand(mySelectQuery, myConnection)
myConnection.Open()
Dim myReader As MySqlDataReader
myReader = myCommand.ExecuteReader()
' Always call Read before accessing data.
While myReader.Read()
Console.WriteLine((myReader.GetInt32(0) & ", " & myReader.GetString(1)))
End While
' always call Close when done reading.
myReader.Close()
' Close the connection when done with it.
myConnection.Close()
End Sub 'ReadMyData
</code>
<code lang="C#">
public void ReadMyData(string myConnString) {
string mySelectQuery = "SELECT OrderID, CustomerID FROM Orders";
MySqlConnection myConnection = new MySqlConnection(myConnString);
MySqlCommand myCommand = new MySqlCommand(mySelectQuery,myConnection);
myConnection.Open();
MySqlDataReader myReader;
myReader = myCommand.ExecuteReader();
// Always call Read before accessing data.
while (myReader.Read()) {
Console.WriteLine(myReader.GetInt32(0) + ", " + myReader.GetString(1));
}
// always call Close when done reading.
myReader.Close();
// Close the connection when done with it.
myConnection.Close();
}
</code>
</example>
</ClassSummary>
<GetBytes>
<remarks>
<para>
<B>GetBytes</B> returns the number of available bytes in the field. In most
cases this is the exact length of the field. However, the number returned may be
less than the true length of the field if <B>GetBytes</B> has already been used
to obtain bytes from the field. This may be the case, for example, if the
<see cref="MySqlDataReader"/> is reading a large data structure into a buffer.
For more information, see the <B>SequentialAccess</B> setting for
<see cref="MySqlCommand.CommandBehavior"/>.
</para>
<para>
If you pass a buffer that is a null reference (<B>Nothing</B> in Visual
Basic), <B>GetBytes</B> returns the length of the field in bytes.
</para>
<para>
No conversions are performed; therefore the data retrieved must already be a
byte array.
</para>
</remarks>
</GetBytes>
<GetTimeSpan>
<overloads/>
<summary>
Gets the value of the specified column as a <see cref="TimeSpan"/> object.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>Time</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The zero-based column ordinal or column name.</param>
<returns>The value of the specified column.</returns>
</GetTimeSpan>
<GetDateTime>
<summary>
Gets the value of the specified column as a <see cref="DateTime"/> object.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>DateTime</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
<note>
<para>
MySql allows date columns to contain the value '0000-00-00' and datetime
columns to contain the value '0000-00-00 00:00:00'. The DateTime structure cannot contain
or represent these values. To read a datetime value from a column that might
contain zero values, use <see cref="GetMySqlDateTime(int)"/>.
</para>
<para>
The behavior of reading a zero datetime column using this method is defined by the
<i>ZeroDateTimeBehavior</i> connection string option. For more information on this option,
please refer to <see cref="MySqlConnection.ConnectionString"/>.
</para>
</note>
</remarks>
<param name="i">The zero-based column ordinal.</param>
<returns>The value of the specified column.</returns>
</GetDateTime>
<GetDateTimeS>
<summary>
Gets the value of the specified column as a <see cref="DateTime"/> object.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>DateTime</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
<note>
<para>
MySql allows date columns to contain the value '0000-00-00' and datetime
columns to contain the value '0000-00-00 00:00:00'. The DateTime structure cannot contain
or represent these values. To read a datetime value from a column that might
contain zero values, use <see cref="GetMySqlDateTime(int)"/>.
</para>
<para>
The behavior of reading a zero datetime column using this method is defined by the
<i>ZeroDateTimeBehavior</i> connection string option. For more information on this option,
please refer to <see cref="MySqlConnection.ConnectionString"/>.
</para>
</note>
</remarks>
<param name="column">The column name.</param>
<returns>The value of the specified column.</returns>
</GetDateTimeS>
<GetMySqlDateTime>
<summary>
Gets the value of the specified column as a <see cref="MySql.Data.Types.MySqlDateTime"/> object.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>DateTime</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The zero-based column ordinal or column name.</param>
<returns>The value of the specified column.</returns>
</GetMySqlDateTime>
<GetString>
<summary>
Gets the value of the specified column as a <see cref="String"/> object.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>String</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="i">The zero-based column ordinal.</param>
<returns>The value of the specified column.</returns>
</GetString>
<GetStringS>
<summary>
Gets the value of the specified column as a <see cref="String"/> object.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>String</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The column name.</param>
<returns>The value of the specified column.</returns>
</GetStringS>
<GetDecimal>
<summary>
Gets the value of the specified column as a <see cref="Decimal"/> object.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>Decimal</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="i">The zero-based column ordinal</param>
<returns>The value of the specified column.</returns>
</GetDecimal>
<GetDecimalS>
<summary>
Gets the value of the specified column as a <see cref="Decimal"/> object.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>Decimal</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The column name</param>
<returns>The value of the specified column.</returns>
</GetDecimalS>
<GetDouble>
<summary>Gets the value of the specified column as a double-precision floating point number.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>Double</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="i">The zero-based column ordinal.</param>
<returns>The value of the specified column.</returns>
</GetDouble>
<GetDoubleS>
<summary>Gets the value of the specified column as a double-precision floating point number.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>Double</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The column name</param>
<returns>The value of the specified column.</returns>
</GetDoubleS>
<GetFloat>
<summary>
Gets the value of the specified column as a single-precision floating point number.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>Float</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="i">The zero-based column ordinal.</param>
<returns>The value of the specified column.</returns>
</GetFloat>
<GetFloatS>
<summary>
Gets the value of the specified column as a single-precision floating point number.
</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>Float</b> object.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The column name</param>
<returns>The value of the specified column.</returns>
</GetFloatS>
<GetGiud>
<summary>Gets the value of the specified column as a globally-unique identifier (GUID).</summary>
<param name="i">The zero-based column ordinal.</param>
<returns>The value of the specified column.</returns>
</GetGiud>
<GetGiudS>
<summary>Gets the value of the specified column as a globally-unique identifier (GUID).</summary>
<param name="column">The column name</param>
<returns>The value of the specified column.</returns>
</GetGiudS>
<GetInt16>
<summary>Gets the value of the specified column as a 16-bit signed integer.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>16 bit integer</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="i">The zero-based column ordinal.</param>
<returns>The value of the specified column.</returns>
</GetInt16>
<GetInt16S>
<summary>Gets the value of the specified column as a 16-bit signed integer.</summary>
<remarks>
<para>
No conversions are performed; threfore, the data retrieved must already be a <b>16 bit integer</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The column name</param>
<returns>The value of the specified column.</returns>
</GetInt16S>
<GetInt32>
<summary>Gets the value of the specified column as a 32-bit signed integer.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>32 bit integer</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="i">The zero-based column ordinal.</param>
<returns>The value of the specified column.</returns>
</GetInt32>
<GetInt32S>
<summary>Gets the value of the specified column as a 32-bit signed integer.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>32 bit integer</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The column name.</param>
<returns>The value of the specified column.</returns>
</GetInt32S>
<GetInt64>
<summary>Gets the value of the specified column as a 64-bit signed integer.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>64 bit integer</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="i">The zero-based column ordinal.</param>
<returns>The value of the specified column.</returns>
</GetInt64>
<GetInt64S>
<summary>Gets the value of the specified column as a 64-bit signed integer.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>64 bit integer</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The column name.</param>
<returns>The value of the specified column.</returns>
</GetInt64S>
<GetUInt16>
<summary>Gets the value of the specified column as a 16-bit unsigned integer.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>16 bit unsigned integer</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The zero-based column ordinal or column name.</param>
<returns>The value of the specified column.</returns>
</GetUInt16>
<GetUInt32>
<summary>Gets the value of the specified column as a 32-bit unsigned integer.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>32 bit unsigned integer</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The zero-based column ordinal or column name.</param>
<returns>The value of the specified column.</returns>
</GetUInt32>
<GetUInt64>
<summary>Gets the value of the specified column as a 64-bit unsigned integer.</summary>
<remarks>
<para>
No conversions are performed; therefore, the data retrieved must already be a <b>64 bit unsigned integer</b> value.
</para>
<para>
Call IsDBNull to check for null values before calling this method.
</para>
</remarks>
<param name="column">The zero-based column ordinal or column name.</param>
<returns>The value of the specified column.</returns>
</GetUInt64>
</docs>
|
