forked from ServiceStack/ServiceStack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNpgsql.xml
More file actions
6973 lines (6953 loc) · 356 KB
/
Npgsql.xml
File metadata and controls
6973 lines (6953 loc) · 356 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.IBackendMessage">
<summary>
Base class for all classes which represent a message sent by the PostgreSQL backend.
</summary>
</member>
<member name="T:Npgsql.FrontendMessage">
<summary>
Base class for all classes which represent a message sent to the PostgreSQL backend.
Concrete classes which directly inherit this represent arbitrary-length messages which can chunked.
</summary>
</member>
<member name="M:Npgsql.FrontendMessage.Write(Npgsql.WriteBuffer)">
<param name="buf">the buffer into which to write the message.</param>
<returns>
Whether there was enough space in the buffer to contain the entire message.
If false, the buffer should be flushed and write should be called again.
</returns>
</member>
<member name="T:Npgsql.SimpleFrontendMessage">
<summary>
Represents a simple frontend message which is typically small and fits well within
the write buffer. The message is first queries for the number of bytes it requires,
and then writes itself out.
</summary>
</member>
<member name="P:Npgsql.SimpleFrontendMessage.Length">
<summary>
Returns the number of bytes needed to write this message.
</summary>
</member>
<member name="M:Npgsql.SimpleFrontendMessage.WriteFully(Npgsql.WriteBuffer)">
<summary>
Writes the message contents into the buffer.
</summary>
</member>
<member name="T:Npgsql.StatementType">
<summary>
Specifies the type of SQL statement, e.g. SELECT
</summary>
</member>
<member name="T:Npgsql.ByteOrder">
<summary>
The way how to order bytes.
</summary>
</member>
<member name="F:Npgsql.ByteOrder.MSB">
<summary>
Most significant byte first (XDR)
</summary>
</member>
<member name="F:Npgsql.ByteOrder.LSB">
<summary>
Less significant byte first (NDR)
</summary>
</member>
<member name="T:Npgsql.NpgsqlCommand">
<summary>
Represents a SQL statement or function (stored procedure) to execute
against a PostgreSQL database. This class cannot be inherited.
</summary>
</member>
<member name="F:Npgsql.NpgsqlCommand._connector">
<summary>
Cached version of _connection.Connector, for performance
</summary>
</member>
<member name="P:Npgsql.NpgsqlCommand.Statements">
<summary>
Returns details about each statement that this command has executed.
Is only populated when an Execute* method is called.
</summary>
</member>
<member name="F:Npgsql.NpgsqlCommand.RemainingSendTask">
<summary>
If part of the send happens asynchronously (see <see cref="M:Npgsql.NpgsqlCommand.SendRemaining(Npgsql.NpgsqlCommand.PopulateMethod,System.Threading.CancellationToken)"/>,
the Task for that remaining send is stored here.
</summary>
</member>
<member name="F:Npgsql.NpgsqlCommand._isPrepared">
<summary>
Indicates whether this command has been prepared.
Never access this field directly, use <see cref="P:Npgsql.NpgsqlCommand.IsPrepared"/> instead.
</summary>
</member>
<member name="F:Npgsql.NpgsqlCommand._prepareConnectionOpenId">
<summary>
For prepared commands, captures the connection's <see cref="P:Npgsql.NpgsqlConnection.OpenCounter"/>
at the time the command was prepared. This allows us to know whether the connection was
closed since the command was prepared.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCommand.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCommand.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class with the text of the query.
</summary>
<param name="cmdText">The text of the query.</param>
</member>
<member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnection)">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class with the text of the query and a <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>.
</summary>
<param name="cmdText">The text of the query.</param>
<param name="connection">A <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> that represents the connection to a PostgreSQL server.</param>
</member>
<member name="M:Npgsql.NpgsqlCommand.#ctor(System.String,Npgsql.NpgsqlConnection,Npgsql.NpgsqlTransaction)">
<summary>
Initializes a new instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> class with the text of the query, a <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>, and the <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>.
</summary>
<param name="cmdText">The text of the query.</param>
<param name="connection">A <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see> that represents the connection to a PostgreSQL server.</param>
<param name="transaction">The <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see> in which the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> executes.</param>
</member>
<member name="P:Npgsql.NpgsqlCommand.CommandText">
<summary>
Gets or sets the SQL statement or function (stored procedure) to execute at the data source.
</summary>
<value>The Transact-SQL statement or stored procedure to execute. The default is an empty string.</value>
</member>
<member name="P:Npgsql.NpgsqlCommand.CommandTimeout">
<summary>
Gets or sets the wait time before terminating the attempt to execute a command and generating an error.
</summary>
<value>The time (in seconds) to wait for the command to execute. The default value is 30 seconds.</value>
</member>
<member name="P:Npgsql.NpgsqlCommand.CommandType">
<summary>
Gets or sets a value indicating how the
<see cref="P:Npgsql.NpgsqlCommand.CommandText">CommandText</see> property is to be interpreted.
</summary>
<value>One of the <see cref="T:System.Data.CommandType">CommandType</see> values. The default is <see cref="T:System.Data.CommandType">CommandType.Text</see>.</value>
</member>
<member name="P:Npgsql.NpgsqlCommand.DbConnection">
<summary>
DB connection.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCommand.Connection">
<summary>
Gets or sets the <see cref="T:Npgsql.NpgsqlConnection">NpgsqlConnection</see>
used by this instance of the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>.
</summary>
<value>The connection to a data source. The default value is a null reference.</value>
</member>
<member name="P:Npgsql.NpgsqlCommand.DesignTimeVisible">
<summary>
Design time visible.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCommand.UpdatedRowSource">
<summary>
Gets or sets how command results are applied to the DataRow when used by the
DbDataAdapter.Update(DataSet) method.
</summary>
<value>One of the <see cref="T:System.Data.UpdateRowSource">UpdateRowSource</see> values.</value>
</member>
<member name="P:Npgsql.NpgsqlCommand.IsPrepared">
<summary>
Returns whether this query will execute as a prepared (compiled) query.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCommand.AllResultTypesAreUnknown">
<summary>
Marks all of the query's result columns as either known or unknown.
Unknown results column are requested them from PostgreSQL in text format, and Npgsql makes no
attempt to parse them. They will be accessible as strings only.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCommand.UnknownResultTypeList">
<summary>
Marks the query's result columns as known or unknown, on a column-by-column basis.
Unknown results column are requested them from PostgreSQL in text format, and Npgsql makes no
attempt to parse them. They will be accessible as strings only.
</summary>
<remarks>
If the query includes several queries (e.g. SELECT 1; SELECT 2), this will only apply to the first
one. The rest of the queries will be fetched and parsed as usual.
The array size must correspond exactly to the number of result columns the query returns, or an
error will be raised.
</remarks>
</member>
<member name="P:Npgsql.NpgsqlCommand.ObjectResultTypes">
<summary>
Marks result types to be used when using GetValue on a data reader, on a column-by-column basis.
Used for Entity Framework 5-6 compability.
Only primitive numerical types and DateTimeOffset are supported.
Set the whole array or just a value to null to use default type.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCommand.State">
<summary>
Gets the current state of the connector
</summary>
</member>
<member name="M:Npgsql.NpgsqlCommand.CreateDbParameter">
<summary>
Creates a new instance of an <see cref="T:System.Data.Common.DbParameter">DbParameter</see> object.
</summary>
<returns>An <see cref="T:System.Data.Common.DbParameter">DbParameter</see> object.</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.CreateParameter">
<summary>
Creates a new instance of a <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.
</summary>
<returns>A <see cref="T:Npgsql.NpgsqlParameter">NpgsqlParameter</see> object.</returns>
</member>
<member name="P:Npgsql.NpgsqlCommand.DbParameterCollection">
<summary>
DB parameter collection.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCommand.Parameters">
<summary>
Gets the <see cref="T:Npgsql.NpgsqlParameterCollection">NpgsqlParameterCollection</see>.
</summary>
<value>The parameters of the SQL statement or function (stored procedure). The default is an empty collection.</value>
</member>
<member name="M:Npgsql.NpgsqlCommand.Prepare">
<summary>
Creates a prepared version of the command on a PostgreSQL server.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCommand.SendRemaining(Npgsql.NpgsqlCommand.PopulateMethod,System.Threading.CancellationToken)">
<summary>
This method is used to asynchronously sends all remaining protocol messages for statements
beyond the first one, and *without* waiting for the send to complete. This technique is
used to avoid the deadlock described in #641 by allowing the user to read query results
while at the same time sending messages for later statements.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCommand.PopulateExecuteNonPrepared(Npgsql.DirectBuffer@)">
<summary>
Populates the send buffer with protocol messages for the execution of non-prepared statement(s).
</summary>
<returns>
true whether all messages could be populated in the buffer, false otherwise (method needs to be
called again)
</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.PopulateExecutePrepared(Npgsql.DirectBuffer@)">
<summary>
Populates the send buffer with protocol messages for the execution of prepared statement(s).
</summary>
<returns>
true whether all messages could be populated in the buffer, false otherwise (method needs to be
called again)
</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.PopulatePrepare(Npgsql.DirectBuffer@)">
<summary>
Populates the send buffer with Parse/Describe protocol messages, used for preparing commands
and for execution in SchemaOnly mode.
</summary>
<returns>
true whether all messages could be populated in the buffer, false otherwise (method needs to be
called again)
</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.PopulateExecuteSchemaOnly(Npgsql.DirectBuffer@)">
<summary>
Populates the send buffer with Parse/Describe protocol messages, used for preparing commands
and for execution in SchemaOnly mode.
</summary>
<returns>
true whether all messages could be populated in the buffer, false otherwise (method needs to be
called again)
</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.ExecuteNonQuery">
<summary>
Executes a SQL statement against the connection and returns the number of rows affected.
</summary>
<returns>The number of rows affected if known; -1 otherwise.</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.ExecuteNonQueryAsync(System.Threading.CancellationToken)">
<summary>
Asynchronous version of <see cref="M:Npgsql.NpgsqlCommand.ExecuteNonQuery"/>
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<returns>A task representing the asynchronous operation, with the number of rows affected if known; -1 otherwise.</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.ExecuteScalar">
<summary>
Executes the query, and returns the first column of the first row
in the result set returned by the query. Extra columns or rows are ignored.
</summary>
<returns>The first column of the first row in the result set,
or a null reference if the result set is empty.</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.ExecuteScalarAsync(System.Threading.CancellationToken)">
<summary>
Asynchronous version of <see cref="M:Npgsql.NpgsqlCommand.ExecuteScalar"/>
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<returns>A task representing the asynchronous operation, with the first column of the
first row in the result set, or a null reference if the result set is empty.</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.ExecuteReader">
<summary>
Executes the CommandText against the Connection, and returns an DbDataReader.
</summary>
<remarks>
Unlike the ADO.NET method which it replaces, this method returns a Npgsql-specific
DataReader.
</remarks>
<returns>A DbDataReader object.</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.ExecuteReader(System.Data.CommandBehavior)">
<summary>
Executes the CommandText against the Connection, and returns an DbDataReader using one
of the CommandBehavior values.
</summary>
<remarks>
Unlike the ADO.NET method which it replaces, this method returns a Npgsql-specific
DataReader.
</remarks>
<returns>A DbDataReader object.</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.ExecuteDbDataReaderAsync(System.Data.CommandBehavior,System.Threading.CancellationToken)">
<summary>
Executes the command text against the connection.
</summary>
<param name="behavior">An instance of <see cref="T:System.Data.CommandBehavior"/>.</param>
<param name="cancellationToken">A task representing the operation.</param>
<returns></returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.ExecuteDbDataReader(System.Data.CommandBehavior)">
<summary>
Executes the command text against the connection.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCommand.DbTransaction">
<summary>
DB transaction.
</summary>
</member>
<member name="P:Npgsql.NpgsqlCommand.Transaction">
<summary>
Gets or sets the <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>
within which the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see> executes.
</summary>
<value>The <see cref="T:Npgsql.NpgsqlTransaction">NpgsqlTransaction</see>.
The default value is a null reference.</value>
</member>
<member name="M:Npgsql.NpgsqlCommand.Cancel">
<summary>
Attempts to cancel the execution of a <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>.
</summary>
<remarks>As per the specs, no exception will be thrown by this method in case of failure</remarks>
</member>
<member name="M:Npgsql.NpgsqlCommand.Dispose(System.Boolean)">
<summary>
Releases the resources used by the <see cref="T:Npgsql.NpgsqlCommand">NpgsqlCommand</see>.
</summary>
</member>
<member name="M:Npgsql.NpgsqlCommand.FixupRowDescription(Npgsql.BackendMessages.RowDescriptionMessage,System.Boolean)">
<summary>
Fixes up the text/binary flag on result columns.
Since Prepare() describes a statement rather than a portal, the resulting RowDescription
will have text format on all result columns. Fix that up.
</summary>
<remarks>
Note that UnknownResultTypeList only applies to the first query, while AllResultTypesAreUnknown applies
to all of them.
</remarks>
</member>
<member name="M:Npgsql.NpgsqlCommand.System#ICloneable#Clone">
<summary>
Create a new command based on this one.
</summary>
<returns>A new NpgsqlCommand object.</returns>
</member>
<member name="M:Npgsql.NpgsqlCommand.Clone">
<summary>
Create a new command based on this one.
</summary>
<returns>A new NpgsqlCommand object.</returns>
</member>
<member name="T:Npgsql.NpgsqlConnection">
<summary>
This class represents a connection to a PostgreSQL server.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.Settings">
<summary>
The parsed connection string set by the user
</summary>
</member>
<member name="F:Npgsql.NpgsqlConnection._connectionString">
<summary>
The actual string provided by the user for the connection string
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.Connector">
<summary>
The connector object connected to the backend.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.OpenCounter">
<summary>
A counter that gets incremented every time the connection is (re-)opened.
This allows us to identify an "instance" of connection, which is useful since
some resources are released when a connection is closed (e.g. prepared statements).
</summary>
</member>
<member name="F:Npgsql.NpgsqlConnection.DefaultPort">
<summary>
The default TCP/IP port for PostgreSQL.
</summary>
</member>
<member name="F:Npgsql.NpgsqlConnection.TimeoutLimit">
<summary>
Maximum value for connection timeout.
</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(Npgsql.NpgsqlConnectionStringBuilder)">
<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="builder">The connection used to open the PostgreSQL database.</param>
</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.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.OpenAsync(System.Threading.CancellationToken)">
<summary>
This is the asynchronous version of <see cref="M:Npgsql.NpgsqlConnection.Open"/>.
</summary>
<remarks>
Do not invoke other methods and properties of the <see cref="T:Npgsql.NpgsqlConnection"/> object until the returned Task is complete.
</remarks>
<param name="cancellationToken">The cancellation instruction.</param>
<returns>A task representing the asynchronous operation.</returns>
</member>
<member name="P:Npgsql.NpgsqlConnection.ConnectionString">
<summary>
Gets or sets the string used to connect to a PostgreSQL database. See the manual for details.
</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.UseSslStream">
<summary>
If true, the connection will attempt to use SslStream instead of an internal TlsClientStream.
</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.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.DataSource">
<summary>
Gets the string identifying the database server (host and port)
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.IntegratedSecurity">
<summary>
Whether to use Windows integrated security to log in.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.UserName">
<summary>
User name.
</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, ConnectionState.Closed or ConnectionState.Connecting</value>
</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.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. Transactions created by this method will have Read Committed isolation level.
</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.PromotableLocalTransactionEnded">
<summary>
When a connection is closed within an enclosing TransactionScope and the transaction
hasn't been promoted, we defer the actual closing until the scope ends.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.EnlistTransaction(System.Transactions.Transaction)">
<summary>
Enlist transation.
</summary>
<param name="transaction"></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.CloseOngoingOperations">
<summary>
Closes ongoing operations, i.e. an open reader exists or a COPY operation still in progress, as
part of a connection close.
Does nothing if the thread has been aborted - the connector will be closed immediately.
</summary>
</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="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="P:Npgsql.NpgsqlConnection.IsSecure">
<summary>
Returns whether SSL is being used for the connection.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.ProvideClientCertificatesCallback">
<summary>
Selects the local Secure Sockets Layer (SSL) certificate used for authentication.
</summary>
<remarks>
See <see href="https://msdn.microsoft.com/en-us/library/system.net.security.localcertificateselectioncallback(v=vs.110).aspx"/>
</remarks>
</member>
<member name="P:Npgsql.NpgsqlConnection.UserCertificateValidationCallback">
<summary>
Verifies the remote Secure Sockets Layer (SSL) certificate used for authentication.
Ignored if <see cref="P:Npgsql.NpgsqlConnectionStringBuilder.TrustServerCertificate"/> is set.
</summary>
<remarks>
See <see href="https://msdn.microsoft.com/en-us/library/system.net.security.remotecertificatevalidationcallback(v=vs.110).aspx"/>
</remarks>
</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.ServerVersion">
<summary>
PostgreSQL server version.
</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.UseConformantStrings">
<summary>
Report whether the backend is expecting standard conformant strings.
In version 8.1, Postgres began reporting this value (false), but did not actually support standard conformant strings.
In version 8.2, Postgres began supporting standard conformant strings, but defaulted this flag to false.
As of version 9.1, this flag defaults to true.
</summary>
</member>
<member name="P:Npgsql.NpgsqlConnection.SupportsEStringPrefix">
<summary>
Report whether the backend understands the string literal E prefix (>= 8.1).
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.BeginBinaryImport(System.String)">
<summary>
Begins a binary COPY FROM STDIN operation, a high-performance data import mechanism to a PostgreSQL table.
</summary>
<param name="copyFromCommand">A COPY FROM STDIN SQL command</param>
<returns>A <see cref="T:Npgsql.NpgsqlBinaryImporter"/> which can be used to write rows and columns</returns>
<remarks>
See http://www.postgresql.org/docs/current/static/sql-copy.html.
</remarks>
</member>
<member name="M:Npgsql.NpgsqlConnection.BeginBinaryExport(System.String)">
<summary>
Begins a binary COPY TO STDOUT operation, a high-performance data export mechanism from a PostgreSQL table.
</summary>
<param name="copyToCommand">A COPY TO STDOUT SQL command</param>
<returns>A <see cref="T:Npgsql.NpgsqlBinaryExporter"/> which can be used to read rows and columns</returns>
<remarks>
See http://www.postgresql.org/docs/current/static/sql-copy.html.
</remarks>
</member>
<member name="M:Npgsql.NpgsqlConnection.BeginTextImport(System.String)">
<summary>
Begins a textual COPY FROM STDIN operation, a data import mechanism to a PostgreSQL table.
It is the user's responsibility to send the textual input according to the format specified
in <paramref name="copyFromCommand"/>.
</summary>
<param name="copyFromCommand">A COPY FROM STDIN SQL command</param>
<returns>
A TextWriter that can be used to send textual data.</returns>
<remarks>
See http://www.postgresql.org/docs/current/static/sql-copy.html.
</remarks>
</member>
<member name="M:Npgsql.NpgsqlConnection.BeginTextExport(System.String)">
<summary>
Begins a textual COPY TO STDOUT operation, a data export mechanism from a PostgreSQL table.
It is the user's responsibility to parse the textual input according to the format specified
in <paramref name="copyToCommand"/>.
</summary>
<param name="copyToCommand">A COPY TO STDOUT SQL command</param>
<returns>
A TextReader that can be used to read textual data.</returns>
<remarks>
See http://www.postgresql.org/docs/current/static/sql-copy.html.
</remarks>
</member>
<member name="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopy(System.String)">
<summary>
Begins a raw binary COPY operation (TO STDOUT or FROM STDIN), a high-performance data export/import mechanism to a PostgreSQL table.
Note that unlike the other COPY API methods, <see cref="M:Npgsql.NpgsqlConnection.BeginRawBinaryCopy(System.String)"/> doesn't implement any encoding/decoding
and is unsuitable for structured import/export operation. It is useful mainly for exporting a table as an opaque
blob, for the purpose of importing it back later.
</summary>
<param name="copyCommand">A COPY TO STDOUT or COPY FROM STDIN SQL command</param>
<returns>A <see cref="T:Npgsql.NpgsqlRawCopyStream"/> that can be used to read or write raw binary data.</returns>
<remarks>
See http://www.postgresql.org/docs/current/static/sql-copy.html.
</remarks>
</member>
<member name="M:Npgsql.NpgsqlConnection.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)">
<summary>
Maps a CLR enum to a PostgreSQL enum type for use with this connection.
</summary>
<remarks>
CLR enum labels are mapped by name to PostgreSQL enum labels.
The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
which defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>.
You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your enum fields to manually specify a PostgreSQL enum label.
If there is a discrepancy between the .NET and database labels while an enum is read or written,
an exception will be raised.
Can only be invoked on an open connection; if the connection is closed the mapping is lost.
To avoid mapping the type for each connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapEnumGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
</remarks>
<param name="pgName">
A PostgreSQL type name for the corresponding enum type in the database.
If null, the name translator given in <paramref name="nameTranslator"/>will be used.
</param>
<param name="nameTranslator">
A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
Defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>
</param>
<typeparam name="TEnum">The .NET enum type to be mapped</typeparam>
</member>
<member name="M:Npgsql.NpgsqlConnection.MapEnumGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
<summary>
Maps a CLR enum to a PostgreSQL enum type for use with all connections created from now on. Existing connections aren't affected.
</summary>
<remarks>
CLR enum labels are mapped by name to PostgreSQL enum labels.
The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
which defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>.
You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your enum fields to manually specify a PostgreSQL enum label.
If there is a discrepancy between the .NET and database labels while an enum is read or written,
an exception will be raised.
To map the type for a specific connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
</remarks>
<param name="pgName">
A PostgreSQL type name for the corresponding enum type in the database.
If null, the name translator given in <paramref name="nameTranslator"/>will be used.
</param>
<param name="nameTranslator">
A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
Defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>
</param>
<typeparam name="TEnum">The .NET enum type to be mapped</typeparam>
</member>
<member name="M:Npgsql.NpgsqlConnection.UnmapEnumGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
<summary>
Removes a previous global enum mapping.
</summary>
<param name="pgName">
A PostgreSQL type name for the corresponding enum type in the database.
If null, the name translator given in <paramref name="nameTranslator"/>will be used.
</param>
<param name="nameTranslator">
A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
Defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>
</param>
</member>
<member name="M:Npgsql.NpgsqlConnection.MapComposite``1(System.String,Npgsql.INpgsqlNameTranslator)">
<summary>
Maps a CLR type to a PostgreSQL composite type for use with this connection.
</summary>
<remarks>
CLR fields and properties by string to PostgreSQL enum labels.
The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
which defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>.
You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your members to manually specify a PostgreSQL enum label.
If there is a discrepancy between the .NET and database labels while a composite is read or written,
an exception will be raised.
Can only be invoked on an open connection; if the connection is closed the mapping is lost.
To avoid mapping the type for each connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapCompositeGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
</remarks>
<param name="pgName">
A PostgreSQL type name for the corresponding enum type in the database.
If null, the name translator given in <paramref name="nameTranslator"/>will be used.
</param>
<param name="nameTranslator">
A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
Defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>
</param>
<typeparam name="T">The .NET type to be mapped</typeparam>
</member>
<member name="M:Npgsql.NpgsqlConnection.MapCompositeGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
<summary>
Maps a CLR type to a PostgreSQL composite type for use with all connections created from now on. Existing connections aren't affected.
</summary>
<remarks>
CLR fields and properties by string to PostgreSQL enum labels.
The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
which defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>.
You can also use the <see cref="T:NpgsqlTypes.PgNameAttribute"/> on your members to manually specify a PostgreSQL enum label.
If there is a discrepancy between the .NET and database labels while a composite is read or written,
an exception will be raised.
To map the type for a specific connection, use the <see cref="M:Npgsql.NpgsqlConnection.MapEnum``1(System.String,Npgsql.INpgsqlNameTranslator)"/> method.
</remarks>
<param name="pgName">
A PostgreSQL type name for the corresponding enum type in the database.
If null, the name translator given in <paramref name="nameTranslator"/>will be used.
</param>
<param name="nameTranslator">
A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
Defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>
</param>
<typeparam name="T">The .NET type to be mapped</typeparam>
</member>
<member name="M:Npgsql.NpgsqlConnection.UnmapCompositeGlobally``1(System.String,Npgsql.INpgsqlNameTranslator)">
<summary>
Removes a previous global enum mapping.
</summary>
<param name="pgName">
A PostgreSQL type name for the corresponding enum type in the database.
If null, the name translator given in <paramref name="nameTranslator"/>will be used.
</param>
<param name="nameTranslator">
A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class).
Defaults to <see cref="T:Npgsql.NpgsqlSnakeCaseNameTranslator"/>
</param>
</member>
<member name="M:Npgsql.NpgsqlConnection.Wait(System.Int32)">
<summary>
Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and
exits immediately. The asynchronous message is delivered via the normal events
(<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
</summary>
<param name="timeout">
The time-out value, in milliseconds, passed to <see cref="P:System.Net.Sockets.Socket.ReceiveTimeout"/>.
The default value is 0, which indicates an infinite time-out period.
Specifying -1 also indicates an infinite time-out period.
</param>
<returns>true if an asynchronous message was received, false if timed out.</returns>
</member>
<member name="M:Npgsql.NpgsqlConnection.Wait(System.TimeSpan)">
<summary>
Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and
exits immediately. The asynchronous message is delivered via the normal events
(<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
</summary>
<param name="timeout">
The time-out value is passed to <see cref="P:System.Net.Sockets.Socket.ReceiveTimeout"/>.
</param>
<returns>true if an asynchronous message was received, false if timed out.</returns>
</member>
<member name="M:Npgsql.NpgsqlConnection.Wait">
<summary>
Waits until an asynchronous PostgreSQL messages (e.g. a notification) arrives, and
exits immediately. The asynchronous message is delivered via the normal events
(<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.WaitAsync(System.Threading.CancellationToken)">
<summary>
Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification)
arrives, and exist immediately. The asynchronous message is delivered via the normal events
(<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.WaitAsync">
<summary>
Waits asynchronously until an asynchronous PostgreSQL messages (e.g. a notification)
arrives, and exist immediately. The asynchronous message is delivered via the normal events
(<see cref="E:Npgsql.NpgsqlConnection.Notification"/>, <see cref="E:Npgsql.NpgsqlConnection.Notice"/>).
</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="M:Npgsql.NpgsqlConnection.RemovePasswordFromConnectionString">
<summary>
Remove password from externally-visible ConnectionString, but leave it in
the internally visible one - we need it for the connection pool key, Clone() etc.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.System#ICloneable#Clone">
<summary>
Creates a closed connection with the connection string and authentication details of this message.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.CloneWith(System.String)">
<summary>
Clones this connection, replacing its connection string with the given one.
This allows creating a new connection with the same security information
(password, SSL callbacks) while changing other connection parameters (e.g.
database or pooling)
</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="P:Npgsql.NpgsqlConnection.DbProviderFactory">
<summary>
DB provider factory.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.ClearPool(Npgsql.NpgsqlConnection)">
<summary>
Clear connection pool.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.ClearAllPools">
<summary>
Clear all connection pools.
</summary>
</member>
<member name="M:Npgsql.NpgsqlConnection.ReloadTypes">
<summary>
Flushes the type cache for this connection's connection string and reloads the
types for this connection only.
</summary>
</member>
<member name="T:Npgsql.NpgsqlConnector">
<summary>
Represents a connection to a PostgreSQL backend. Unlike NpgsqlConnection objects, which are
exposed to users, connectors are internal to Npgsql and are recycled by the connection pool.
</summary>
<summary>
Represents a connection to a PostgreSQL backend. Unlike NpgsqlConnection objects, which are
exposed to users, connectors are internal to Npgsql and are recycled by the connection pool.
</summary>
</member>
<member name="F:Npgsql.NpgsqlConnector._socket">
<summary>
The physical connection socket to the backend.
</summary>
</member>
<member name="F:Npgsql.NpgsqlConnector._baseStream">
<summary>
The physical connection stream to the backend, without anything on top.
</summary>
</member>
<member name="F:Npgsql.NpgsqlConnector._stream">