-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathNpgsql.xml
More file actions
4066 lines (4047 loc) · 213 KB
/
Npgsql.xml
File metadata and controls
4066 lines (4047 loc) · 213 KB
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>Npgsql</name>
</assembly>
<members>
<member name="T:Npgsql.NpgsqlParameter">
<summary>
This class represents a parameter to a command that will be sent to server
</summary>
</member>
<member name="M:Npgsql.NpgsqlParameter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> class.
</summary>
</member>
<member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>
class with the parameter m_Name and a value of the new <b>NpgsqlParameter</b>.
</summary>
<param m_Name="parameterName">The m_Name of the parameter to map.</param>
<param m_Name="value">An <see cref="T:System.Object">Object</see> that is the value of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param>
<remarks>
<p>When you specify an <see cref="T:System.Object">Object</see>
in the value parameter, the <see cref="T:System.Data.DbType">DbType</see> is
inferred from the .NET Framework type of the <b>Object</b>.</p>
<p>When using this constructor, you must be aware of a possible misuse of the constructor which takes a DbType parameter.
This happens when calling this constructor passing an int 0 and the compiler thinks you are passing a value of DbType.
Use <code> Convert.ToInt32(value) </code> for example to have compiler calling the correct constructor.</p>
</remarks>
</member>
<member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType)">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>
class with the parameter m_Name and the data type.
</summary>
<param m_Name="parameterName">The m_Name of the parameter to map.</param>
<param m_Name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param>
</member>
<member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>
class with the parameter m_Name, the <see cref="T:System.Data.DbType">DbType</see>, and the size.
</summary>
<param m_Name="parameterName">The m_Name of the parameter to map.</param>
<param m_Name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param>
<param m_Name="size">The length of the parameter.</param>
</member>
<member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>
class with the parameter m_Name, the <see cref="T:System.Data.DbType">DbType</see>, the size,
and the source column m_Name.
</summary>
<param m_Name="parameterName">The m_Name of the parameter to map.</param>
<param m_Name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param>
<param m_Name="size">The length of the parameter.</param>
<param m_Name="sourceColumn">The m_Name of the source column.</param>
</member>
<member name="M:Npgsql.NpgsqlParameter.#ctor(System.String,NpgsqlTypes.NpgsqlDbType,System.Int32,System.String,System.Data.ParameterDirection,System.Boolean,System.Byte,System.Byte,System.Data.DataRowVersion,System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>
class with the parameter m_Name, the <see cref="T:System.Data.DbType">DbType</see>, the size,
the source column m_Name, a <see cref="T:System.Data.ParameterDirection">ParameterDirection</see>,
the precision of the parameter, the scale of the parameter, a
<see cref="T:System.Data.DataRowVersion">DataRowVersion</see> to use, and the
value of the parameter.
</summary>
<param m_Name="parameterName">The m_Name of the parameter to map.</param>
<param m_Name="parameterType">One of the <see cref="T:System.Data.DbType">DbType</see> values.</param>
<param m_Name="size">The length of the parameter.</param>
<param m_Name="sourceColumn">The m_Name of the source column.</param>
<param m_Name="direction">One of the <see cref="T:System.Data.ParameterDirection">ParameterDirection</see> values.</param>
<param m_Name="isNullable"><b>true</b> if the value of the field can be null, otherwise <b>false</b>.</param>
<param m_Name="precision">The total number of digits to the left and right of the decimal point to which
<see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.</param>
<param m_Name="scale">The total number of decimal places to which
<see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.</param>
<param m_Name="sourceVersion">One of the <see cref="T:System.Data.DataRowVersion">DataRowVersion</see> values.</param>
<param m_Name="value">An <see cref="T:System.Object">Object</see> that is the value
of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.</param>
</member>
<member name="M:Npgsql.NpgsqlParameter.Clone">
<summary>
Creates a new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> that
is a copy of the current instance.
</summary>
<returns>A new <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> that is a copy of this instance.</returns>
</member>
<member name="P:Npgsql.NpgsqlParameter.Precision">
<summary>
Gets or sets the maximum number of digits used to represent the
<see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> property.
</summary>
<value>The maximum number of digits used to represent the
<see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> property.
The default value is 0, which indicates that the data provider
sets the precision for <b>Value</b>.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.Scale">
<summary>
Gets or sets the number of decimal places to which
<see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved.
</summary>
<value>The number of decimal places to which
<see cref="P:Npgsql.NpgsqlParameter.Value">Value</see> is resolved. The default is 0.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.Size">
<summary>
Gets or sets the maximum size, in bytes, of the data within the column.
</summary>
<value>The maximum size, in bytes, of the data within the column.
The default value is inferred from the parameter value.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.DbType">
<summary>
Gets or sets the <see cref="T:System.Data.DbType">DbType</see> of the parameter.
</summary>
<value>One of the <see cref="T:System.Data.DbType">DbType</see> values. The default is <b>String</b>.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.NpgsqlDbType">
<summary>
Gets or sets the <see cref="T:System.Data.DbType">DbType</see> of the parameter.
</summary>
<value>One of the <see cref="T:System.Data.DbType">DbType</see> values. The default is <b>String</b>.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.Direction">
<summary>
Gets or sets a value indicating whether the parameter is input-only,
output-only, bidirectional, or a stored procedure return value parameter.
</summary>
<value>One of the <see cref="T:System.Data.ParameterDirection">ParameterDirection</see>
values. The default is <b>Input</b>.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.IsNullable">
<summary>
Gets or sets a value indicating whether the parameter accepts null values.
</summary>
<value><b>true</b> if null values are accepted; otherwise, <b>false</b>. The default is <b>false</b>.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.ParameterName">
<summary>
Gets or sets the m_Name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
</summary>
<value>The m_Name of the <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see>.
The default is an empty string.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.CleanName">
<summary>
The m_Name scrubbed of any optional marker
</summary>
</member>
<member name="P:Npgsql.NpgsqlParameter.SourceColumn">
<summary>
Gets or sets the m_Name of the source column that is mapped to the
<see cref="T:System.Data.DataSet">DataSet</see> and used for loading or
returning the <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see>.
</summary>
<value>The m_Name of the source column that is mapped to the
<see cref="T:System.Data.DataSet">DataSet</see>. The default is an empty string.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.SourceVersion">
<summary>
Gets or sets the <see cref="T:System.Data.DataRowVersion">DataRowVersion</see>
to use when loading <see cref="P:Npgsql.NpgsqlParameter.Value">Value</see>.
</summary>
<value>One of the <see cref="T:System.Data.DataRowVersion">DataRowVersion</see> values.
The default is <b>Current</b>.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.Value">
<summary>
Gets or sets the value of the parameter.
</summary>
<value>An <see cref="T:System.Object">Object</see> that is the value of the parameter.
The default value is null.</value>
</member>
<member name="P:Npgsql.NpgsqlParameter.NpgsqlValue">
<summary>
Gets or sets the value of the parameter.
</summary>
<value>An <see cref="T:System.Object">Object</see> that is the value of the parameter.
The default value is null.</value>
</member>
<member name="T:Npgsql.NpgsqlFlush">
<summary>
This class represents the Parse message sent to PostgreSQL
server.
</summary>
</member>
<member name="T:Npgsql.ClientMessage">
<summary>
For classes representing messages sent from the client to the server.
</summary>
</member>
<member name="T:Npgsql.NpgsqlCopySerializer">
<summary>
Writes given objects into a stream for PostgreSQL COPY in default copy format (not CSV or BINARY).
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnectionStringBuilder.Clone">
<summary>
Return an exact copy of this NpgsqlConnectionString.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnectionStringBuilder.SetValue(System.String,System.Object)">
<summary>
This function will set value for known key, both private member and base[key].
</summary>
<param name="keyword"></param>
<param name="value"></param>
</member>
<member name="M:Npgsql.NpgsqlConnectionStringBuilder.SetValue(Npgsql.Keywords,System.Object)">
<summary>
The function will modify private member only, not base[key].
</summary>
<param name="keyword"></param>
<param name="value"></param>
</member>
<member name="M:Npgsql.NpgsqlConnectionStringBuilder.Clear">
<summary>
Clear the member and assign them to the default value.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnectionStringBuilder.Compatible">
<summary>
Compatibilty version. When possible, behaviour caused by breaking changes will be preserved
if this version is less than that where the breaking change was introduced.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnectionStringBuilder.Item(System.String)">
<summary>
Case insensative accessor for indivual connection string values.
</summary>
</member>
<member name="T:Npgsql.MD5">
<summary>
Common base class for all derived MD5 implementations.
</summary>
</member>
<member name="M:Npgsql.HashAlgorithm.#ctor">
<summary>
Called from constructor of derived class.
</summary>
</member>
<member name="M:Npgsql.HashAlgorithm.Finalize">
<summary>
Finalizer for HashAlgorithm
</summary>
</member>
<member name="M:Npgsql.HashAlgorithm.ComputeHash(System.Byte[])">
<summary>
Computes the entire hash of all the bytes in the byte array.
</summary>
</member>
<member name="M:Npgsql.HashAlgorithm.HashCore(System.Byte[],System.Int32,System.Int32)">
<summary>
When overridden in a derived class, drives the hashing function.
</summary>
<param name="rgb"></param>
<param name="start"></param>
<param name="size"></param>
</member>
<member name="M:Npgsql.HashAlgorithm.HashFinal">
<summary>
When overridden in a derived class, this pads and hashes whatever data might be left in the buffers and then returns the hash created.
</summary>
</member>
<member name="M:Npgsql.HashAlgorithm.Initialize">
<summary>
When overridden in a derived class, initializes the object to prepare for hashing.
</summary>
</member>
<member name="M:Npgsql.HashAlgorithm.TransformBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
<summary>
Used for stream chaining. Computes hash as data passes through it.
</summary>
<param name="inputBuffer">The buffer from which to grab the data to be copied.</param>
<param name="inputOffset">The offset into the input buffer to start reading at.</param>
<param name="inputCount">The number of bytes to be copied.</param>
<param name="outputBuffer">The buffer to write the copied data to.</param>
<param name="outputOffset">At what point in the outputBuffer to write the data at.</param>
</member>
<member name="M:Npgsql.HashAlgorithm.TransformFinalBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Used for stream chaining. Computes hash as data passes through it. Finishes off the hash.
</summary>
<param name="inputBuffer">The buffer from which to grab the data to be copied.</param>
<param name="inputOffset">The offset into the input buffer to start reading at.</param>
<param name="inputCount">The number of bytes to be copied.</param>
</member>
<member name="P:Npgsql.HashAlgorithm.CanTransformMultipleBlocks">
<summary>
Get whether or not the hash can transform multiple blocks at a time.
Note: MUST be overriden if descendant can transform multiple block
on a single call!
</summary>
</member>
<member name="P:Npgsql.HashAlgorithm.Hash">
<summary>
Gets the previously computed hash.
</summary>
</member>
<member name="P:Npgsql.HashAlgorithm.HashSize">
<summary>
Returns the size in bits of the hash.
</summary>
</member>
<member name="P:Npgsql.HashAlgorithm.InputBlockSize">
<summary>
Must be overriden if not 1
</summary>
</member>
<member name="P:Npgsql.HashAlgorithm.OutputBlockSize">
<summary>
Must be overriden if not 1
</summary>
</member>
<member name="M:Npgsql.MD5.#ctor">
<summary>
Called from constructor of derived class.
</summary>
</member>
<member name="M:Npgsql.MD5.Create">
<summary>
Creates the default derived class.
</summary>
</member>
<member name="T:Npgsql.PGUtil">
<summary>
This class provides many util methods to handle
reading and writing of PostgreSQL protocol messages.
</summary>
</member>
<member name="M:Npgsql.PGUtil.ConvertProtocolVersion(Npgsql.ProtocolVersion)">
<summary>
This method takes a ProtocolVersion and returns an integer
version number that the Postgres backend will recognize in a
startup packet.
</summary>
</member>
<member name="M:Npgsql.PGUtil.ExtractServerVersion(System.String)">
<summary>
This method takes a version string as returned by SELECT VERSION() and returns
a valid version string ("7.2.2" for example).
This is only needed when running protocol version 2.
This does not do any validity checks.
</summary>
</member>
<member name="M:Npgsql.PGUtil.ReadString(System.IO.Stream)">
<summary>
This method gets a C NULL terminated string from the network stream.
It keeps reading a byte in each time until a NULL byte is returned.
It returns the resultant string of bytes read.
This string is sent from backend.
</summary>
</member>
<member name="M:Npgsql.PGUtil.ReadBytes(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
<summary>
Reads requested number of bytes from stream with retries until Stream.Read returns 0 or count is reached.
</summary>
<param name="stream">Stream to read</param>
<param name="buffer">byte buffer to fill</param>
<param name="offset">starting position to fill the buffer</param>
<param name="count">number of bytes to read</param>
<returns>The number of bytes read. May be less than count if no more bytes are available.</returns>
</member>
<member name="M:Npgsql.PGUtil.WriteString(System.String,System.IO.Stream)">
<summary>
This method writes a C NULL terminated string to the network stream.
It appends a NULL terminator to the end of the String.
</summary>
<summary>
This method writes a C NULL terminated string to the network stream.
It appends a NULL terminator to the end of the String.
</summary>
</member>
<member name="M:Npgsql.PGUtil.WriteBytes(System.Byte[],System.IO.Stream)">
<summary>
This method writes a set of bytes to the stream. It also enables logging of them.
</summary>
</member>
<member name="M:Npgsql.PGUtil.WriteLimString(System.String,System.Int32,System.IO.Stream)">
<summary>
This method writes a C NULL terminated string limited in length to the
backend server.
It pads the string with null bytes to the size specified.
</summary>
</member>
<member name="M:Npgsql.PGUtil.WriteInt32(System.IO.Stream,System.Int32)">
<summary>
Write a 32-bit integer to the given stream in the correct byte order.
</summary>
</member>
<member name="M:Npgsql.PGUtil.ReadInt32(System.IO.Stream)">
<summary>
Read a 32-bit integer from the given stream in the correct byte order.
</summary>
</member>
<member name="M:Npgsql.PGUtil.WriteInt16(System.IO.Stream,System.Int16)">
<summary>
Write a 16-bit integer to the given stream in the correct byte order.
</summary>
</member>
<member name="M:Npgsql.PGUtil.ReadInt16(System.IO.Stream)">
<summary>
Read a 16-bit integer from the given stream in the correct byte order.
</summary>
</member>
<member name="T:Npgsql.ProtocolVersion">
<summary>
Represent the frontend/backend protocol version.
</summary>
</member>
<member name="T:Npgsql.ServerVersion">
<summary>
Represent the backend server version.
As this class offers no functionality beyond that offered by <see cref="T:System.Version"/> it has been
deprecated in favour of that class.
</summary>
</member>
<member name="M:Npgsql.ServerVersion.ToString">
<summary>
Returns the string representation of this version in three place dot notation (Major.Minor.Patch).
</summary>
</member>
<member name="P:Npgsql.ServerVersion.Major">
<summary>
Server version major number.
</summary>
</member>
<member name="P:Npgsql.ServerVersion.Minor">
<summary>
Server version minor number.
</summary>
</member>
<member name="P:Npgsql.ServerVersion.Patch">
<summary>
Server version patch level number.
</summary>
</member>
<member name="T:Npgsql.NpgsqlCopyOut">
<summary>
Represents a PostgreSQL COPY TO STDOUT operation with a corresponding SQL statement
to execute against a PostgreSQL database
and an associated stream used to write results to (if provided by user)
or for reading the results (when generated by driver).
Eg. new NpgsqlCopyOut("COPY (SELECT * FROM mytable) TO STDOUT", connection, streamToWrite).Start();
</summary>
</member>
<member name="M:Npgsql.NpgsqlCopyOut.#ctor(System.String,Npgsql.NpgsqlConnection)">
<summary>
Creates NpgsqlCommand to run given query upon Start(), after which CopyStream provides data from database as requested in the query.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCopyOut.#ctor(Npgsql.NpgsqlCommand,Npgsql.NpgsqlConnection)">
<summary>
Given command is run upon Start(), after which CopyStream provides data from database as requested in the query.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCopyOut.#ctor(Npgsql.NpgsqlCommand,Npgsql.NpgsqlConnection,System.IO.Stream)">
<summary>
Given command is executed upon Start() and all requested copy data is written to toStream immediately.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCopyOut.FieldIsBinary(System.Int32)">
<summary>
Returns true if this operation is currently active and field at given location is in binary format.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCopyOut.Start">
<summary>
Command specified upon creation is executed as a non-query.
If CopyStream is set upon creation, all copy data from server will be written to it, and operation will be finished immediately.
Otherwise the CopyStream member can be used for reading copy data from server until no more data is available.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCopyOut.End">
<summary>
Flush generated CopyStream at once. Effectively reads and discard all the rest of copy data from server.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCopyOut.IsActive">
<summary>
Returns true if the connection is currently reserved for this operation.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCopyOut.CopyStream">
<summary>
The stream provided by user or generated upon Start()
</summary>
</member>
<member name="P:Npgsql.NpgsqlCopyOut.NpgsqlCommand">
<summary>
The Command used to execute this copy operation.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCopyOut.IsBinary">
<summary>
Returns true if this operation is currently active and in binary format.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCopyOut.FieldCount">
<summary>
Returns number of fields if this operation is currently active, otherwise -1
</summary>
</member>
<member name="P:Npgsql.NpgsqlCopyOut.Read">
<summary>
Faster alternative to using the generated CopyStream.
</summary>
</member>
<member name="T:Npgsql.NpgsqlConnectorPool">
<summary>
This class manages all connector objects, pooled AND non-pooled.
</summary>
</member>
<member name="F:Npgsql.NpgsqlConnectorPool.ConnectorPoolMgr">
<value>Unique static instance of the connector pool
mamager.</value>
</member>
<member name="F:Npgsql.NpgsqlConnectorPool.PooledConnectors">
<value>Map of index to unused pooled connectors, avaliable to the
next RequestConnector() call.</value>
<remarks>This hashmap will be indexed by connection string.
This key will hold a list of queues of pooled connectors available to be used.</remarks>
</member>
<member name="F:Npgsql.NpgsqlConnectorPool.Timer">
<value>Timer for tracking unused connections in pools.</value>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.RequestConnector(Npgsql.NpgsqlConnection)">
<summary>
Searches the shared and pooled connector lists for a
matching connector object or creates a new one.
</summary>
<param name="Connection">The NpgsqlConnection that is requesting
the connector. Its ConnectionString will be used to search the
pool for available connectors.</param>
<returns>A connector object.</returns>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.RequestPooledConnector(Npgsql.NpgsqlConnection)">
<summary>
Find a pooled connector. Handle locking and timeout here.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.RequestPooledConnectorInternal(Npgsql.NpgsqlConnection)">
<summary>
Find a pooled connector. Handle shared/non-shared here.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.ReleaseConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)">
<summary>
Releases a connector, possibly back to the pool for future use.
</summary>
<remarks>
Pooled connectors will be put back into the pool if there is room.
Shared connectors should just have their use count decremented
since they always stay in the shared pool.
</remarks>
<param name="Connector">The connector to release.</param>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.ReleasePooledConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)">
<summary>
Release a pooled connector. Handle locking here.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.ReleasePooledConnectorInternal(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)">
<summary>
Release a pooled connector. Handle shared/non-shared here.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.GetNonPooledConnector(Npgsql.NpgsqlConnection)">
<summary>
Create a connector without any pooling functionality.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.GetPooledConnector(Npgsql.NpgsqlConnection)">
<summary>
Find an available pooled connector in the non-shared pool, or create
a new one if none found.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.FixPoolCountBecauseOfConnectionDisposeFalse(Npgsql.NpgsqlConnection)">
<summary>
This method is only called when NpgsqlConnection.Dispose(false) is called which means a
finalization. This also means, an NpgsqlConnection was leak. We clear pool count so that
client doesn't end running out of connections from pool. When the connection is finalized, its underlying
socket is closed.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.UngetNonPooledConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)">
<summary>
Close the connector.
</summary>
<param name="Connection"></param>
<param name="Connector">Connector to release</param>
</member>
<member name="M:Npgsql.NpgsqlConnectorPool.UngetPooledConnector(Npgsql.NpgsqlConnection,Npgsql.NpgsqlConnector)">
<summary>
Put a pooled connector into the pool queue.
</summary>
<param name="Connector">Connector to pool</param>
</member>
<member name="T:Npgsql.NpgsqlConnectorPool.ConnectorQueue">
<summary>
A queue with an extra Int32 for keeping track of busy connections.
</summary>
</member>
<member name="F:Npgsql.NpgsqlConnectorPool.ConnectorQueue.Available">
<summary>
Connections available to the end user
</summary>
</member>
<member name="F:Npgsql.NpgsqlConnectorPool.ConnectorQueue.Busy">
<summary>
Connections currently in use
</summary>
</member>
<member name="T:Npgsql.NpgsqlBackEndKeyData">
<summary>
This class represents a BackEndKeyData message received
from PostgreSQL
</summary>
</member>
<member name="M:Npgsql.NpgsqlPromotableSinglePhaseNotification.Prepare">
<summary>
Used when a connection is closed
</summary>
</member>
<member name="T:Npgsql.NpgsqlQuery">
<summary>
Summary description for NpgsqlQuery
</summary>
</member>
<member name="T:Npgsql.NoticeEventHandler">
<summary>
Represents the method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notification">Notice</see> events.
</summary>
<param name="e">A <see cref="T:Npgsql.NpgsqlNoticeEventArgs">NpgsqlNoticeEventArgs</see> that contains the event data.</param>
</member>
<member name="T:Npgsql.NotificationEventHandler">
<summary>
Represents the method that handles the <see cref="E:Npgsql.NpgsqlConnection.Notification">Notification</see> events.
</summary>
<param name="sender">The source of the event.</param>
<param name="e">A <see cref="T:Npgsql.NpgsqlNotificationEventArgs">NpgsqlNotificationEventArgs</see> that contains the event data.</param>
</member>
<member name="T:Npgsql.NpgsqlConnection">
<summary>
This class represents a connection to a
PostgreSQL server.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.#ctor">
<summary>
Initializes a new instance of the
<see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> class.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.#ctor(System.String)">
<summary>
Initializes a new instance of the
<see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> class
and sets the <see cref="P:Npgsql.NpgsqlConnection.ConnectionString">ConnectionString</see>.
</summary>
<param name="ConnectionString">The connection used to open the PostgreSQL database.</param>
</member>
<member name="M:Npgsql.NpgsqlConnection.BeginDbTransaction(System.Data.IsolationLevel)">
<summary>
Begins a database transaction with the specified isolation level.
</summary>
<param name="isolationLevel">The <see cref="T:System.Data.IsolationLevel">isolation level</see> under which the transaction should run.</param>
<returns>An <see cref="T:System.Data.Common.DbTransaction">DbTransaction</see>
object representing the new transaction.</returns>
<remarks>
Currently the IsolationLevel ReadCommitted and Serializable are supported by the PostgreSQL backend.
There's no support for nested transactions.
</remarks>
</member>
<member name="M:Npgsql.NpgsqlConnection.BeginTransaction">
<summary>
Begins a database transaction.
</summary>
<returns>A <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>
object representing the new transaction.</returns>
<remarks>
Currently there's no support for nested transactions.
</remarks>
</member>
<member name="M:Npgsql.NpgsqlConnection.BeginTransaction(System.Data.IsolationLevel)">
<summary>
Begins a database transaction with the specified isolation level.
</summary>
<param name="level">The <see cref="T:System.Data.IsolationLevel">isolation level</see> under which the transaction should run.</param>
<returns>A <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>
object representing the new transaction.</returns>
<remarks>
Currently the IsolationLevel ReadCommitted and Serializable are supported by the PostgreSQL backend.
There's no support for nested transactions.
</remarks>
</member>
<member name="M:Npgsql.NpgsqlConnection.Open">
<summary>
Opens a database connection with the property settings specified by the
<see cref="P:Npgsql.NpgsqlConnection.ConnectionString">ConnectionString</see>.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.ChangeDatabase(System.String)">
<summary>
This method changes the current database by disconnecting from the actual
database and connecting to the specified.
</summary>
<param name="dbName">The name of the database to use in place of the current database.</param>
</member>
<member name="M:Npgsql.NpgsqlConnection.Close">
<summary>
Releases the connection to the database. If the connection is pooled, it will be
made available for re-use. If it is non-pooled, the actual connection will be shutdown.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.CreateDbCommand">
<summary>
Creates and returns a <see cref="T:System.Data.Common.DbCommand">DbCommand</see>
object associated with the <see cref="T:System.Data.Common.DbConnection">IDbConnection</see>.
</summary>
<returns>A <see cref="T:System.Data.Common.DbCommand">DbCommand</see> object.</returns>
</member>
<member name="M:Npgsql.NpgsqlConnection.CreateCommand">
<summary>
Creates and returns a <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>
object associated with the <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>.
</summary>
<returns>A <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> object.</returns>
</member>
<member name="M:Npgsql.NpgsqlConnection.Dispose(System.Boolean)">
<summary>
Releases all resources used by the
<see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>.
</summary>
<param name="disposing"><b>true</b> when called from Dispose();
<b>false</b> when being called from the finalizer.</param>
</member>
<member name="M:Npgsql.NpgsqlConnection.System#ICloneable#Clone">
<summary>
Create a new connection based on this one.
</summary>
<returns>A new NpgsqlConnection object.</returns>
</member>
<member name="M:Npgsql.NpgsqlConnection.Clone">
<summary>
Create a new connection based on this one.
</summary>
<returns>A new NpgsqlConnection object.</returns>
</member>
<member name="M:Npgsql.NpgsqlConnection.DefaultCertificateSelectionCallback(System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Cryptography.X509Certificates.X509Certificate,System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection)">
<summary>
Default SSL CertificateSelectionCallback implementation.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.DefaultCertificateValidationCallback(System.Security.Cryptography.X509Certificates.X509Certificate,System.Int32[])">
<summary>
Default SSL CertificateValidationCallback implementation.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.DefaultPrivateKeySelectionCallback(System.Security.Cryptography.X509Certificates.X509Certificate,System.String)">
<summary>
Default SSL PrivateKeySelectionCallback implementation.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.DefaultProvideClientCertificatesCallback(System.Security.Cryptography.X509Certificates.X509CertificateCollection)">
<summary>
Default SSL ProvideClientCertificatesCallback implementation.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.LogConnectionString">
<summary>
Write each key/value pair in the connection string to the log.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.GetSchema">
<summary>
Returns the supported collections
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.GetSchema(System.String)">
<summary>
Returns the schema collection specified by the collection name.
</summary>
<param name="collectionName">The collection name.</param>
<returns>The collection specified.</returns>
</member>
<member name="M:Npgsql.NpgsqlConnection.GetSchema(System.String,System.String[])">
<summary>
Returns the schema collection specified by the collection name filtered by the restrictions.
</summary>
<param name="collectionName">The collection name.</param>
<param name="restrictions">
The restriction values to filter the results. A description of the restrictions is contained
in the Restrictions collection.
</param>
<returns>The collection specified.</returns>
</member>
<member name="E:Npgsql.NpgsqlConnection.Notice">
<summary>
Occurs on NoticeResponses from the PostgreSQL backend.
</summary>
</member>
<member name="E:Npgsql.NpgsqlConnection.Notification">
<summary>
Occurs on NotificationResponses from the PostgreSQL backend.
</summary>
</member>
<member name="E:Npgsql.NpgsqlConnection.ProvideClientCertificatesCallback">
<summary>
Called to provide client certificates for SSL handshake.
</summary>
</member>
<member name="E:Npgsql.NpgsqlConnection.CertificateSelectionCallback">
<summary>
Mono.Security.Protocol.Tls.CertificateSelectionCallback delegate.
</summary>
</member>
<member name="E:Npgsql.NpgsqlConnection.CertificateValidationCallback">
<summary>
Mono.Security.Protocol.Tls.CertificateValidationCallback delegate.
</summary>
</member>
<member name="E:Npgsql.NpgsqlConnection.PrivateKeySelectionCallback">
<summary>
Mono.Security.Protocol.Tls.PrivateKeySelectionCallback delegate.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.ConnectionString">
<summary>
Gets or sets the string used to connect to a PostgreSQL database.
Valid values are:
<ul>
<li>
Server: Address/Name of Postgresql Server;
</li>
<li>
Port: Port to connect to;
</li>
<li>
Protocol: Protocol version to use, instead of automatic; Integer 2 or 3;
</li>
<li>
Database: Database name. Defaults to user name if not specified;
</li>
<li>
User Id: User name;
</li>
<li>
Password: Password for clear text authentication;
</li>
<li>
SSL: True or False. Controls whether to attempt a secure connection. Default = False;
</li>
<li>
Pooling: True or False. Controls whether connection pooling is used. Default = True;
</li>
<li>
MinPoolSize: Min size of connection pool;
</li>
<li>
MaxPoolSize: Max size of connection pool;
</li>
<li>
Timeout: Time to wait for connection open in seconds. Default is 15.
</li>
<li>
CommandTimeout: Time to wait for command to finish execution before throw an exception. In seconds. Default is 20.
</li>
<li>
Sslmode: Mode for ssl connection control. Can be Prefer, Require, Allow or Disable. Default is Disable. Check user manual for explanation of values.
</li>
<li>
ConnectionLifeTime: Time to wait before closing unused connections in the pool in seconds. Default is 15.
</li>
<li>
SyncNotification: Specifies if Npgsql should use synchronous notifications.
</li>
<li>
SearchPath: Changes search path to specified and public schemas.
</li>
</ul>
</summary>
<value>The connection string that includes the server name,
the database name, and other parameters needed to establish
the initial connection. The default value is an empty string.
</value>
</member>
<member name="P:Npgsql.NpgsqlConnection.Host">
<summary>
Backend server host name.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.Port">
<summary>
Backend server port.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.SSL">
<summary>
If true, the connection will attempt to use SSL.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.ConnectionTimeout">
<summary>
Gets the time to wait while trying to establish a connection
before terminating the attempt and generating an error.
</summary>
<value>The time (in seconds) to wait for a connection to open. The default value is 15 seconds.</value>
</member>
<member name="P:Npgsql.NpgsqlConnection.CommandTimeout">
<summary>
Gets the time to wait while trying to execute a command
before terminating the attempt and generating an error.
</summary>
<value>The time (in seconds) to wait for a command to complete. The default value is 20 seconds.</value>
</member>
<member name="P:Npgsql.NpgsqlConnection.ConnectionLifeTime">
<summary>
Gets the time to wait before closing unused connections in the pool if the count
of all connections exeeds MinPoolSize.
</summary>
<remarks>
If connection pool contains unused connections for ConnectionLifeTime seconds,
the half of them will be closed. If there will be unused connections in a second
later then again the half of them will be closed and so on.
This strategy provide smooth change of connection count in the pool.
</remarks>
<value>The time (in seconds) to wait. The default value is 15 seconds.</value>
</member>
<member name="P:Npgsql.NpgsqlConnection.Database">
<summary>
Gets the name of the current database or the database to be used after a connection is opened.
</summary>
<value>The name of the current database or the name of the database to be
used after a connection is opened. The default value is the empty string.</value>
</member>
<member name="P:Npgsql.NpgsqlConnection.PreloadReader">
<summary>
Whether datareaders are loaded in their entirety (for compatibility with earlier code).
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.DataSource">
<summary>
Gets the database server name.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.SyncNotification">
<summary>
Gets flag indicating if we are using Synchronous notification or not.
The default value is false.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.FullState">
<summary>
Gets the current state of the connection.
</summary>
<value>A bitwise combination of the <see cref="T:System.Data.ConnectionState">ConnectionState</see> values. The default is <b>Closed</b>.</value>
</member>
<member name="P:Npgsql.NpgsqlConnection.State">
<summary>
Gets whether the current state of the connection is Open or Closed
</summary>
<value>ConnectionState.Open or ConnectionState.Closed</value>
</member>
<member name="P:Npgsql.NpgsqlConnection.PostgreSqlVersion">
<summary>
Version of the PostgreSQL backend.
This can only be called when there is an active connection.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.BackendProtocolVersion">
<summary>
Protocol version in use.
This can only be called when there is an active connection.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.ProcessID">
<summary>
Process id of backend server.
This can only be called when there is an active connection.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.Connector">
<summary>
The connector object connected to the backend.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.ConnectionStringValues">
<summary>
Gets the NpgsqlConnectionStringBuilder containing the parsed connection string values.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.UserName">