forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNpgsqlConnectionStringBuilder.cs
More file actions
1159 lines (1036 loc) · 40.9 KB
/
NpgsqlConnectionStringBuilder.cs
File metadata and controls
1159 lines (1036 loc) · 40.9 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
#region License
// The PostgreSQL License
//
// Copyright (C) 2015 The Npgsql Development Team
//
// Permission to use, copy, modify, and distribute this software and its
// documentation for any purpose, without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph and the following two paragraphs appear in all copies.
//
// IN NO EVENT SHALL THE NPGSQL DEVELOPMENT TEAM BE LIABLE TO ANY PARTY
// FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
// DOCUMENTATION, EVEN IF THE NPGSQL DEVELOPMENT TEAM HAS BEEN ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
// THE NPGSQL DEVELOPMENT TEAM SPECIFICALLY DISCLAIMS ANY WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
// ON AN "AS IS" BASIS, AND THE NPGSQL DEVELOPMENT TEAM HAS NO OBLIGATIONS
// TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#endregion
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data.Common;
using System.Diagnostics.Contracts;
using System.DirectoryServices;
using System.Linq;
using System.Reflection;
using System.Security.Principal;
namespace Npgsql
{
/// <summary>
/// Provides a simple way to create and manage the contents of connection strings used by
/// the <see cref="NpgsqlConnection"/> class.
/// </summary>
public sealed class NpgsqlConnectionStringBuilder : DbConnectionStringBuilder
{
#region Fields
/// <summary>
/// Makes all valid keywords for a property to that property (e.g. User Name -> Username, UserId -> Username...)
/// </summary>
static readonly Dictionary<string, PropertyInfo> PropertiesByKeyword;
/// <summary>
/// Maps CLR property names (e.g. BufferSize) to their canonical keyword name, which is the
/// property's [DisplayName] (e.g. Buffer Size)
/// </summary>
static readonly Dictionary<string, string> PropertyNameToCanonicalKeyword;
/// <summary>
/// Maps each property to its [DefaultValue]
/// </summary>
static readonly Dictionary<PropertyInfo, object> PropertyDefaults;
static readonly string[] Empty = new string[0];
#endregion
#region Constructors
/// <summary>
/// Initializes a new instance of the NpgsqlConnectionStringBuilder class.
/// </summary>
public NpgsqlConnectionStringBuilder() { Init(); }
/// <summary>
/// Initializes a new instance of the NpgsqlConnectionStringBuilder class, optionally using ODBC rules for quoting values.
/// </summary>
/// <param name="useOdbcRules">true to use {} to delimit fields; false to use quotation marks.</param>
public NpgsqlConnectionStringBuilder(bool useOdbcRules) : base(useOdbcRules) { Init(); }
/// <summary>
/// Initializes a new instance of the NpgsqlConnectionStringBuilder class and sets its <see cref="DbConnectionStringBuilder.ConnectionString"/>.
/// </summary>
public NpgsqlConnectionStringBuilder(string connectionString)
{
Init();
ConnectionString = connectionString;
}
void Init()
{
foreach (var kv in PropertyDefaults) {
kv.Key.SetValue(this, kv.Value);
base.Clear();
}
}
#endregion
#region Static initialization
static NpgsqlConnectionStringBuilder()
{
var properties = typeof(NpgsqlConnectionStringBuilder)
.GetProperties()
.Where(p => p.GetCustomAttribute<NpgsqlConnectionStringPropertyAttribute>() != null)
.ToArray();
Contract.Assume(properties.All(p => p.CanRead && p.CanWrite));
Contract.Assume(properties.All(p => p.GetCustomAttribute<DisplayNameAttribute>() != null));
PropertiesByKeyword = (
from p in properties
let displayName = p.GetCustomAttribute<DisplayNameAttribute>().DisplayName.ToUpperInvariant()
let propertyName = p.Name.ToUpperInvariant()
from k in new[] { displayName }
.Concat(propertyName != displayName ? new[] { propertyName } : Empty )
.Concat(p.GetCustomAttribute<NpgsqlConnectionStringPropertyAttribute>().Aliases
.Select(a => a.ToUpperInvariant())
)
.Select(k => new { Property = p, Keyword = k })
select k
).ToDictionary(t => t.Keyword, t => t.Property);
PropertyNameToCanonicalKeyword = properties.ToDictionary(
p => p.Name,
p => p.GetCustomAttribute<DisplayNameAttribute>().DisplayName
);
PropertyDefaults = properties
.Where(p => p.GetCustomAttribute<ObsoleteAttribute>() == null)
.ToDictionary(
p => p,
p => p.GetCustomAttribute<DefaultValueAttribute>() != null
? p.GetCustomAttribute<DefaultValueAttribute>().Value
: (p.PropertyType.IsValueType ? Activator.CreateInstance(p.PropertyType) : null)
);
}
#endregion
#region Non-static property handling
/// <summary>
/// Gets or sets the value associated with the specified key.
/// </summary>
/// <param name="keyword">The key of the item to get or set.</param>
/// <returns>The value associated with the specified key.</returns>
public override object this[string keyword]
{
get
{
object value;
if (!TryGetValue(keyword, out value)) {
throw new ArgumentException("Keyword not supported: " + keyword, "keyword");
}
return value;
}
set
{
if (value == null) {
Remove(keyword);
return;
}
var p = GetProperty(keyword);
try {
object convertedValue;
if (p.PropertyType.IsEnum && value is string) {
convertedValue = Enum.Parse(p.PropertyType, (string)value);
} else {
convertedValue = Convert.ChangeType(value, Type.GetTypeCode(p.PropertyType));
}
p.SetValue(this, convertedValue);
} catch (Exception e) {
throw new ArgumentException("Couldn't set " + keyword, keyword, e);
}
}
}
/// <summary>
/// Removes the entry with the specified key from the DbConnectionStringBuilder instance.
/// </summary>
/// <param name="keyword">The key of the key/value pair to be removed from the connection string in this DbConnectionStringBuilder.</param>
/// <returns><b>true</b> if the key existed within the connection string and was removed; <b>false</b> if the key did not exist.</returns>
public override bool Remove(string keyword)
{
var p = GetProperty(keyword);
var removed = base.ContainsKey(p.Name);
// Note that string property setters call SetValue, which itself calls base.Remove().
p.SetValue(this, PropertyDefaults[p]);
base.Remove(p.Name);
return removed;
}
/// <summary>
/// Clears the contents of the <see cref="NpgsqlConnectionStringBuilder"/> instance.
/// </summary>
public override void Clear()
{
Contract.Assert(Keys != null);
foreach (var k in Keys.Cast<string>().ToArray()) {
Remove(k);
}
}
/// <summary>
/// Determines whether the <see cref="NpgsqlConnectionStringBuilder"/> contains a specific key.
/// </summary>
/// <param name="keyword">The key to locate in the <see cref="NpgsqlConnectionStringBuilder"/>.</param>
/// <returns><b>true</b> if the <see cref="NpgsqlConnectionStringBuilder"/> contains an entry with the specified key; otherwise <b>false</b>.</returns>
public override bool ContainsKey(string keyword)
{
if (keyword == null)
throw new ArgumentNullException("keyword");
Contract.EndContractBlock();
return PropertiesByKeyword.ContainsKey(keyword.ToUpperInvariant());
}
PropertyInfo GetProperty(string keyword)
{
PropertyInfo p;
if (!PropertiesByKeyword.TryGetValue(keyword.ToUpperInvariant(), out p)) {
throw new ArgumentException("Keyword not supported: " + keyword, "keyword");
}
return p;
}
/// <summary>
/// Retrieves a value corresponding to the supplied key from this <see cref="NpgsqlConnectionStringBuilder"/>.
/// </summary>
/// <param name="keyword">The key of the item to retrieve.</param>
/// <param name="value">The value corresponding to the key.</param>
/// <returns><b>true</b> if keyword was found within the connection string, <b>false</b> otherwise.</returns>
public override bool TryGetValue(string keyword, out object value)
{
if (keyword == null)
throw new ArgumentNullException("keyword");
Contract.EndContractBlock();
PropertyInfo p;
if (!PropertiesByKeyword.TryGetValue(keyword.ToUpperInvariant(), out p))
{
value = null;
return false;
}
value = GetProperty(keyword).GetValue(this) ?? "";
return true;
}
void SetValue(string propertyName, object value)
{
var canonicalKeyword = PropertyNameToCanonicalKeyword[propertyName];
if (value == null) {
base.Remove(canonicalKeyword);
} else {
base[canonicalKeyword] = value;
}
}
#endregion
#region Properties - Connection
/// <summary>
/// The hostname or IP address of the PostgreSQL server to connect to.
/// </summary>
#if !DNXCORE50
[Category("Connection")]
[DisplayName("Host")]
[Description("The hostname or IP address of the PostgreSQL server to connect to.")]
#endif
[NpgsqlConnectionStringProperty("Server")]
public string Host
{
get { return _host; }
set
{
_host = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("Host", value);
}
}
string _host;
/// <summary>
/// The TCP/IP port of the PostgreSQL server.
/// </summary>
#if !DNXCORE50
[Category("Connection")]
[DisplayName("Port")]
[Description("The TCP port of the PostgreSQL server.")]
[DefaultValue(NpgsqlConnection.DefaultPort)]
#endif
[NpgsqlConnectionStringProperty]
public int Port
{
get { return _port; }
set
{
if (value <= 0)
throw new ArgumentOutOfRangeException("value", value, "Invalid port: " + value);
Contract.EndContractBlock();
_port = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("Port", value);
}
}
int _port;
///<summary>
/// The PostgreSQL database to connect to.
/// </summary>
#if !DNXCORE50
[Category("Connection")]
[DisplayName("Database")]
[Description("The PostgreSQL database to connect to.")]
#endif
[NpgsqlConnectionStringProperty("DB")]
public string Database
{
get { return _database; }
set
{
_database = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("Database", value);
}
}
string _database;
/// <summary>
/// The username to connect with. Not required if using IntegratedSecurity.
/// </summary>
#if !DNXCORE50
[Category("Connection")]
[DisplayName("Username")]
[Description("The username to connect with. Not required if using IntegratedSecurity.")]
#endif
[NpgsqlConnectionStringProperty("User Name", "UserId", "User Id", "UID")]
public string Username
{
get
{
#if !DNXCORE50
if ((_integratedSecurity) && (String.IsNullOrEmpty(_username))) {
_username = GetIntegratedUserName();
}
#endif
return _username;
}
set
{
_username = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("Username", value);
}
}
string _username;
/// <summary>
/// The password to connect with. Not required if using IntegratedSecurity.
/// </summary>
#if !DNXCORE50
[Category("Connection")]
[DisplayName("Password")]
[Description("The password to connect with. Not required if using IntegratedSecurity.")]
[PasswordPropertyText(true)]
#endif
[NpgsqlConnectionStringProperty("PSW", "PWD")]
public string Password
{
get { return _password; }
set
{
_password = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("Password", value);
}
}
string _password;
/// <summary>
/// The optional application name parameter to be sent to the backend during connection initiation.
/// </summary>
#if !DNXCORE50
[Category("Connection")]
[DisplayName("Application Name")]
[Description("The optional application name parameter to be sent to the backend during connection initiation")]
#endif
[NpgsqlConnectionStringProperty]
public string ApplicationName
{
get { return _applicationName; }
set
{
_applicationName = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("ApplicationName", value);
}
}
string _applicationName;
/// <summary>
/// Whether to enlist in an ambient TransactionScope.
/// </summary>
#if !DNXCORE50
[Category("Connection")]
[DisplayName("Enlist")]
[Description("Whether to enlist in an ambient TransactionScope.")]
#endif
[NpgsqlConnectionStringProperty]
public bool Enlist
{
get { return _enlist; }
set
{
_enlist = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("Enlist", value);
}
}
bool _enlist;
/// <summary>
/// Gets or sets the schema search path.
/// </summary>
#if !DNXCORE50
[Category("Connection")]
[DisplayName("Search Path")]
[Description("Gets or sets the schema search path.")]
#endif
[NpgsqlConnectionStringProperty]
public string SearchPath
{
get { return _searchpath; }
set
{
_searchpath = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("SearchPath", value);
}
}
string _searchpath;
#endregion
#region Properties - Security
/// <summary>
/// Controls whether SSL is required, disabled or preferred, depending on server support.
/// </summary>
#if !DNXCORE50
[Category("Security")]
[DisplayName("SSL Mode")]
[Description("Controls whether SSL is required, disabled or preferred, depending on server support.")]
#endif
[NpgsqlConnectionStringProperty]
public SslMode SslMode
{
get { return _sslmode; }
set
{
_sslmode = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("SslMode", value);
}
}
SslMode _sslmode;
/// <summary>
/// Whether to trust the server certificate without validating it.
/// </summary>
#if !DNXCORE50
[Category("Security")]
[DisplayName("Trust Server Certificate")]
[Description("Whether to trust the server certificate without validating it.")]
#endif
[NpgsqlConnectionStringProperty]
public bool TrustServerCertificate
{
get { return _trustServerCertificate; }
set
{
_trustServerCertificate = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("TrustServerCertificate", value);
}
}
bool _trustServerCertificate;
/// <summary>
/// Npgsql uses its own internal implementation of TLS/SSL. Turn this on to use .NET SslStream instead.
/// </summary>
#if !DNXCORE50
[Category("Security")]
[DisplayName("Use SSL Stream")]
[Description("Npgsql uses its own internal implementation of TLS/SSL. Turn this on to use .NET SslStream instead.")]
#endif
[NpgsqlConnectionStringProperty]
public bool UseSslStream
{
get { return _useSslStream; }
set
{
_useSslStream = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("UseSslStream", value);
}
}
bool _useSslStream;
/// <summary>
/// Whether to use Windows integrated security to log in.
/// </summary>
#if !DNXCORE50
[Category("Security")]
[DisplayName("Integrated Security")]
[Description("Whether to use Windows integrated security to log in.")]
#endif
[NpgsqlConnectionStringProperty]
public bool IntegratedSecurity
{
get { return _integratedSecurity; }
set
{
#if !NET40
if (value)
CheckIntegratedSecuritySupport();
#endif
_integratedSecurity = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("IntegratedSecurity", value);
}
}
bool _integratedSecurity;
/// <summary>
/// The Kerberos service name to be used for authentication.
/// </summary>
#if !DNXCORE50
[Category("Security")]
[DisplayName("Kerberos Service Name")]
[Description("The Kerberos service name to be used for authentication.")]
#endif
[NpgsqlConnectionStringProperty("Krbsrvname")]
public string KerberosServiceName
{
get { return _kerberosServiceName; }
set
{
_kerberosServiceName = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("KerberosServiceName", value);
}
}
string _kerberosServiceName;
/// <summary>
/// The Kerberos realm to be used for authentication.
/// </summary>
#if !DNXCORE50
[Category("Security")]
[DisplayName("Include Realm")]
[Description("The Kerberos realm to be used for authentication.")]
#endif
[NpgsqlConnectionStringProperty]
public bool IncludeRealm
{
get { return _includeRealm; }
set
{
_includeRealm = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("IncludeRealm", value);
}
}
bool _includeRealm;
#endregion
#region Properties - Pooling
/// <summary>
/// Whether connection pooling should be used.
/// </summary>
#if !DNXCORE50
[Category("Pooling")]
[DisplayName("Pooling")]
[Description("Whether connection pooling should be used.")]
[DefaultValue(true)]
#endif
[NpgsqlConnectionStringProperty]
public bool Pooling
{
get { return _pooling; }
set
{
_pooling = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("Pooling", value);
}
}
bool _pooling;
/// <summary>
/// The minimum connection pool size.
/// </summary>
#if !DNXCORE50
[Category("Pooling")]
[DisplayName("Minimum Pool Size")]
[Description("The minimum connection pool size.")]
[DefaultValue(1)]
#endif
[NpgsqlConnectionStringProperty]
public int MinPoolSize
{
get { return _minPoolSize; }
set
{
if (value < 0 || value > NpgsqlConnectorPool.PoolSizeLimit)
throw new ArgumentOutOfRangeException("value", value, "MinPoolSize must be between 0 and " + NpgsqlConnectorPool.PoolSizeLimit);
Contract.EndContractBlock();
_minPoolSize = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("MinPoolSize", value);
}
}
int _minPoolSize;
/// <summary>
/// The maximum connection pool size.
/// </summary>
#if !DNXCORE50
[Category("Pooling")]
[DisplayName("Maximum Pool Size")]
[Description("The maximum connection pool size.")]
[DefaultValue(20)]
#endif
[NpgsqlConnectionStringProperty]
public int MaxPoolSize
{
get { return _maxPoolSize; }
set
{
if (value < 0 || value > NpgsqlConnectorPool.PoolSizeLimit)
throw new ArgumentOutOfRangeException("value", value, "MaxPoolSize must be between 0 and " + NpgsqlConnectorPool.PoolSizeLimit);
Contract.EndContractBlock();
_maxPoolSize = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("MaxPoolSize", value);
}
}
int _maxPoolSize;
/// <summary>
/// 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>
#if !DNXCORE50
[Category("Pooling")]
[DisplayName("Connection Lifetime")]
[Description("The time to wait before closing unused connections in the pool if the count of all connections exeeds MinPoolSize.")]
[DefaultValue(15)]
#endif
[NpgsqlConnectionStringProperty]
public int ConnectionLifeTime
{
get { return _connectionLifeTime; }
set
{
_connectionLifeTime = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("ConnectionLifeTime", value);
}
}
int _connectionLifeTime;
#endregion
#region Properties - Timeouts
/// <summary>
/// The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error.
/// Defaults to 15 seconds.
/// </summary>
#if !DNXCORE50
[Category("Timeouts")]
[DisplayName("Timeout")]
[Description("The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error.")]
[DefaultValue(15)]
#endif
[NpgsqlConnectionStringProperty]
public int Timeout
{
get { return _timeout; }
set
{
if (value < 0 || value > NpgsqlConnection.TimeoutLimit)
throw new ArgumentOutOfRangeException("value", value, "Timeout must be between 0 and " + NpgsqlConnection.TimeoutLimit);
Contract.EndContractBlock();
_timeout = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("Timeout", value);
}
}
int _timeout;
/// <summary>
/// The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error.
/// Defaults to 30 seconds.
/// </summary>
#if !DNXCORE50
[Category("Timeouts")]
[DisplayName("Command Timeout")]
[Description("The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity.")]
[DefaultValue(NpgsqlCommand.DefaultTimeout)]
#endif
[NpgsqlConnectionStringProperty]
public int CommandTimeout
{
get { return _commandTimeout; }
set
{
if (value < 0)
throw new ArgumentOutOfRangeException("value", value, "CommandTimeout can't be negative");
Contract.EndContractBlock();
_commandTimeout = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("CommandTimeout", value);
}
}
int _commandTimeout;
/// <summary>
/// The time to wait (in seconds) while trying to execute a an internal command before terminating the attempt and generating an error.
/// </summary>
#if !DNXCORE50
[Category("Timeouts")]
[DisplayName("Internal Command Timeout")]
[Description("The time to wait (in seconds) while trying to execute a an internal command before terminating the attempt and generating an error. -1 uses CommandTimeout, 0 means no timeout.")]
[DefaultValue(-1)]
#endif
[NpgsqlConnectionStringProperty]
public int InternalCommandTimeout
{
get { return _internalCommandTimeout; }
set
{
if (value != 0 && value != -1 && value < NpgsqlConnector.MinimumInternalCommandTimeout)
throw new ArgumentOutOfRangeException("value", value, string.Format("InternalCommandTimeout must be >= {0}, 0 (infinite) or -1 (use CommandTimeout)", NpgsqlConnector.MinimumInternalCommandTimeout));
Contract.EndContractBlock();
_internalCommandTimeout = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("InternalCommandTimeout", value);
}
}
int _internalCommandTimeout;
/// <summary>
/// Whether to have the backend enforce <see cref="CommandTimeout"/> and <see cref="InternalCommandTimeout"/>
/// via the statement_timeout variable. Defaults to true.
/// </summary>
#if !DNXCORE50
[Category("Timeouts")]
[DisplayName("Backend Timeouts")]
[Description("Whether to have the backend enforce CommandTimeout and InternalCommandTimeout via the statement_timeout variable.")]
[DefaultValue(true)]
#endif
[NpgsqlConnectionStringProperty]
public bool BackendTimeouts
{
get { return _backendTimeouts; }
set
{
_backendTimeouts = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("BackendTimeouts", value);
}
}
bool _backendTimeouts;
#endregion
#region Properties - Entity Framework
/// <summary>
/// The database template to specify when creating a database in Entity Framework. If not specified,
/// PostgreSQL defaults to "template1".
/// </summary>
/// <remarks>
/// http://www.postgresql.org/docs/current/static/manage-ag-templatedbs.html
/// </remarks>
#if !DNXCORE50
[Category("Entity Framework")]
[DisplayName("EF Template Database")]
[Description("The database template to specify when creating a database in Entity Framework. If not specified, PostgreSQL defaults to \"template1\".")]
#endif
[NpgsqlConnectionStringProperty]
public string EntityTemplateDatabase
{
get { return _entityTemplateDatabase; }
set
{
_entityTemplateDatabase = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("EntityTemplateDatabase", value);
}
}
string _entityTemplateDatabase;
#endregion
#region Properties - Advanced
/// <summary>
/// Whether to process messages that arrive between command activity.
/// </summary>
#if !DNXCORE50
[Category("Advanced")]
[DisplayName("Continuous Processing")]
[Description("Whether to process messages that arrive between command activity.")]
#endif
[NpgsqlConnectionStringProperty("SyncNotification")]
public bool ContinuousProcessing
{
get { return _continuousProcessing; }
set
{
_continuousProcessing = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("ContinuousProcessing", value);
}
}
bool _continuousProcessing;
/// <summary>
/// The number of seconds of connection inactivity before Npgsql sends a keepalive query.
/// Set to 0 (the default) to disable.
/// </summary>
#if !DNXCORE50
[Category("Advanced")]
[DisplayName("Keepalive")]
[Description("The number of seconds of connection inactivity before Npgsql sends a keepalive query.")]
#endif
[NpgsqlConnectionStringProperty]
public int KeepAlive
{
get { return _keepAlive; }
set
{
if (value < 0)
throw new ArgumentOutOfRangeException("value", value, "KeepAlive can't be negative");
Contract.EndContractBlock();
_keepAlive = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("KeepAlive", value);
}
}
int _keepAlive;
/// <summary>
/// Gets or sets the buffer size.
/// </summary>
#if !DNXCORE50
[Category("Advanced")]
[DisplayName("Buffer Size")]
[Description("Determines the size of the internal buffer Npgsql uses when reading or writing. Increasing may improve performance if transferring large values from the database.")]
[DefaultValue(NpgsqlBuffer.DefaultBufferSize)]
#endif
[NpgsqlConnectionStringProperty]
public int BufferSize
{
get { return _bufferSize; }
set
{
_bufferSize = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("BufferSize", value);
}
}
int _bufferSize;
#endregion
#region Properties - Compatibility
/// <summary>
/// A compatibility mode for special PostgreSQL server types.
/// </summary>
#if !DNXCORE50
[Category("Compatibility")]
[DisplayName("Server Compatibility Mode")]
[Description("A compatibility mode for special PostgreSQL server types.")]
#endif
[NpgsqlConnectionStringProperty]
public ServerCompatibilityMode ServerCompatibilityMode
{
get { return _serverCompatibilityMode; }
set
{
_serverCompatibilityMode = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("ServerCompatibilityMode", value);
}
}
ServerCompatibilityMode _serverCompatibilityMode;
/// <summary>
/// Makes MaxValue and MinValue timestamps and dates readable as infinity and negative infinity.
/// </summary>
#if !DNXCORE50
[Category("Compatibility")]
[DisplayName("Convert Infinity DateTime")]
[Description("Makes MaxValue and MinValue timestamps and dates readable as infinity and negative infinity.")]
#endif
[NpgsqlConnectionStringProperty]
public bool ConvertInfinityDateTime
{
get { return _convertInfinityDateTime; }
set
{
_convertInfinityDateTime = value;
// TODO: Replace literal name with nameof operator in C# 6.0
SetValue("ConvertInfinityDateTime", value);
}
}
bool _convertInfinityDateTime;
#endregion
#region Properties - Obsolete
/// <summary>
/// Obsolete, see https://github.com/npgsql/Npgsql/wiki/PreloadReader-Removal
/// </summary>
#if !DNXCORE50
[Category("Obsolete")]
[DisplayName("Preload Reader")]
[Description("Obsolete, see https://github.com/npgsql/Npgsql/wiki/PreloadReader-Removal")]
#endif
[NpgsqlConnectionStringProperty]
[Obsolete]
public bool PreloadReader
{
get { return false; }
set { throw new NotSupportedException("The PreloadReader parameter is no longer supported. Please see https://github.com/npgsql/Npgsql/wiki/PreloadReader-Removal"); }
}
/// <summary>
/// Obsolete, see https://github.com/npgsql/Npgsql/wiki/UseExtendedTypes-Removal
/// </summary>
#if !DNXCORE50
[Category("Obsolete")]
[DisplayName("Use Extended Types")]
[Description("Obsolete, see https://github.com/npgsql/Npgsql/wiki/UseExtendedTypes-Removal")]
#endif
[NpgsqlConnectionStringProperty]
[Obsolete]
public bool UseExtendedTypes
{
get { return false; }
set { throw new NotSupportedException("The UseExtendedTypes parameter is no longer supported. Please see https://github.com/npgsql/Npgsql/wiki/UseExtendedTypes-Removal"); }
}
#endregion
#region Integrated security support
/// <summary>
/// No integrated security if we're on mono and .NET 4.5 because of ClaimsIdentity,
/// see https://github.com/npgsql/Npgsql/issues/133
/// </summary>
static void CheckIntegratedSecuritySupport()
{
if (Type.GetType("Mono.Runtime") != null)
throw new NotSupportedException("IntegratedSecurity is currently unsupported on mono and .NET 4.5 (see https://github.com/npgsql/Npgsql/issues/133)");
}
#if !DNXCORE50
class CachedUpn
{
public string Upn;
public DateTime ExpiryTimeUtc;