-
Notifications
You must be signed in to change notification settings - Fork 874
Expand file tree
/
Copy pathNpgsqlSlimDataSourceBuilder.cs
More file actions
968 lines (856 loc) · 48.3 KB
/
NpgsqlSlimDataSourceBuilder.cs
File metadata and controls
968 lines (856 loc) · 48.3 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
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Net.Security;
using System.Security.Cryptography.X509Certificates;
using System.Text.Json;
using System.Text.Json.Nodes;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using Npgsql.Internal;
using Npgsql.Internal.ResolverFactories;
using Npgsql.NameTranslation;
using Npgsql.Properties;
using Npgsql.TypeMapping;
using NpgsqlTypes;
namespace Npgsql;
/// <summary>
/// Provides a simple API for configuring and creating an <see cref="NpgsqlDataSource" />, from which database connections can be obtained.
/// </summary>
/// <remarks>
/// On this builder, various features are disabled by default; unless you're looking to save on code size (e.g. when publishing with
/// NativeAOT), use <see cref="NpgsqlDataSourceBuilder" /> instead.
/// </remarks>
public sealed class NpgsqlSlimDataSourceBuilder : INpgsqlTypeMapper
{
static UnsupportedTypeInfoResolver<NpgsqlSlimDataSourceBuilder> UnsupportedTypeInfoResolver { get; } = new();
ILoggerFactory? _loggerFactory;
bool _sensitiveDataLoggingEnabled;
List<Action<NpgsqlTracingOptionsBuilder>>? _tracingOptionsBuilderCallbacks;
List<Action<NpgsqlTypeLoadingOptionsBuilder>>? _typeLoadingOptionsBuilderCallbacks;
TransportSecurityHandler _transportSecurityHandler = new();
RemoteCertificateValidationCallback? _userCertificateValidationCallback;
Action<X509CertificateCollection>? _clientCertificatesCallback;
Action<SslClientAuthenticationOptions>? _sslClientAuthenticationOptionsCallback;
Action<NegotiateAuthenticationClientOptions>? _negotiateOptionsCallback;
IntegratedSecurityHandler _integratedSecurityHandler = new();
Func<NpgsqlConnectionStringBuilder, string>? _passwordProvider;
Func<NpgsqlConnectionStringBuilder, CancellationToken, ValueTask<string>>? _passwordProviderAsync;
Func<NpgsqlConnectionStringBuilder, CancellationToken, ValueTask<string>>? _periodicPasswordProvider;
TimeSpan _periodicPasswordSuccessRefreshInterval, _periodicPasswordFailureRefreshInterval;
List<DbTypeResolverFactory>? _dbTypeResolverFactories;
PgTypeInfoResolverChainBuilder _resolverChainBuilder = new(); // mutable struct, don't make readonly.
readonly UserTypeMapper _userTypeMapper;
Action<NpgsqlConnection>? _connectionInitializer;
Func<NpgsqlConnection, Task>? _connectionInitializerAsync;
internal JsonSerializerOptions? JsonSerializerOptions { get; private set; }
internal Action<NpgsqlSlimDataSourceBuilder> ConfigureDefaultFactories { get; set; }
/// <summary>
/// A connection string builder that can be used to configure the connection string on the builder.
/// </summary>
public NpgsqlConnectionStringBuilder ConnectionStringBuilder { get; }
/// <summary>
/// Returns the connection string, as currently configured on the builder.
/// </summary>
public string ConnectionString => ConnectionStringBuilder.ToString();
static NpgsqlSlimDataSourceBuilder()
=> GlobalTypeMapper.Instance.AddGlobalTypeMappingResolvers([new AdoTypeInfoResolverFactory()]);
/// <summary>
/// A diagnostics name used by Npgsql when generating tracing, logging and metrics.
/// </summary>
public string? Name { get; set; }
/// <summary>
/// Constructs a new <see cref="NpgsqlSlimDataSourceBuilder" />, optionally starting out from the given
/// <paramref name="connectionString"/>.
/// </summary>
public NpgsqlSlimDataSourceBuilder(string? connectionString = null)
: this(new NpgsqlConnectionStringBuilder(connectionString))
{}
internal NpgsqlSlimDataSourceBuilder(NpgsqlConnectionStringBuilder connectionStringBuilder)
{
ConnectionStringBuilder = connectionStringBuilder;
_userTypeMapper = new() { DefaultNameTranslator = GlobalTypeMapper.Instance.DefaultNameTranslator };
ConfigureDefaultFactories = static instance => instance.AppendDefaultFactories();
ConfigureResolverChain = static chain => chain.Add(UnsupportedTypeInfoResolver);
}
/// <summary>
/// Sets the <see cref="ILoggerFactory" /> that will be used for logging.
/// </summary>
/// <param name="loggerFactory">The logger factory to be used.</param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder UseLoggerFactory(ILoggerFactory? loggerFactory)
{
_loggerFactory = loggerFactory;
return this;
}
/// <summary>
/// Enables parameters to be included in logging. This includes potentially sensitive information from data sent to PostgreSQL.
/// You should only enable this flag in development, or if you have the appropriate security measures in place based on the
/// sensitivity of this data.
/// </summary>
/// <param name="parameterLoggingEnabled">If <see langword="true" />, then sensitive data is logged.</param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableParameterLogging(bool parameterLoggingEnabled = true)
{
_sensitiveDataLoggingEnabled = parameterLoggingEnabled;
return this;
}
/// <summary>
/// Configure type loading options for the DataSource. Calling this again will replace
/// the prior action.
/// </summary>
public NpgsqlSlimDataSourceBuilder ConfigureTypeLoading(Action<NpgsqlTypeLoadingOptionsBuilder> configureAction)
{
ArgumentNullException.ThrowIfNull(configureAction);
_typeLoadingOptionsBuilderCallbacks ??= new();
_typeLoadingOptionsBuilderCallbacks.Add(configureAction);
return this;
}
/// <summary>
/// Configures OpenTelemetry tracing options.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder ConfigureTracing(Action<NpgsqlTracingOptionsBuilder> configureAction)
{
ArgumentNullException.ThrowIfNull(configureAction);
_tracingOptionsBuilderCallbacks ??= new();
_tracingOptionsBuilderCallbacks.Add(configureAction);
return this;
}
/// <summary>
/// Configures the JSON serializer options used when reading and writing all System.Text.Json data.
/// </summary>
/// <param name="serializerOptions">Options to customize JSON serialization and deserialization.</param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder ConfigureJsonOptions(JsonSerializerOptions serializerOptions)
{
ArgumentNullException.ThrowIfNull(serializerOptions);
JsonSerializerOptions = serializerOptions;
return this;
}
#region Authentication
/// <summary>
/// When using SSL/TLS, this is a callback that allows customizing how the PostgreSQL-provided certificate is verified. This is an
/// advanced API, consider using <see cref="SslMode.VerifyFull" /> or <see cref="SslMode.VerifyCA" /> instead.
/// </summary>
/// <param name="userCertificateValidationCallback">The callback containing custom callback verification logic.</param>
/// <remarks>
/// <para>
/// Cannot be used in conjunction with <see cref="SslMode.Disable" />, <see cref="SslMode.VerifyCA" /> or
/// <see cref="SslMode.VerifyFull" />.
/// </para>
/// <para>
/// See <see href="https://msdn.microsoft.com/en-us/library/system.net.security.remotecertificatevalidationcallback(v=vs.110).aspx"/>.
/// </para>
/// </remarks>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
[Obsolete("Use UseSslClientAuthenticationOptionsCallback")]
public NpgsqlSlimDataSourceBuilder UseUserCertificateValidationCallback(
RemoteCertificateValidationCallback userCertificateValidationCallback)
{
_userCertificateValidationCallback = userCertificateValidationCallback;
return this;
}
/// <summary>
/// Specifies an SSL/TLS certificate which Npgsql will send to PostgreSQL for certificate-based authentication.
/// </summary>
/// <param name="clientCertificate">The client certificate to be sent to PostgreSQL when opening a connection.</param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
[Obsolete("Use UseSslClientAuthenticationOptionsCallback")]
public NpgsqlSlimDataSourceBuilder UseClientCertificate(X509Certificate? clientCertificate)
{
if (clientCertificate is null)
return UseClientCertificatesCallback(null);
var clientCertificates = new X509CertificateCollection { clientCertificate };
return UseClientCertificates(clientCertificates);
}
/// <summary>
/// Specifies a collection of SSL/TLS certificates which Npgsql will send to PostgreSQL for certificate-based authentication.
/// </summary>
/// <param name="clientCertificates">The client certificate collection to be sent to PostgreSQL when opening a connection.</param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
[Obsolete("Use UseSslClientAuthenticationOptionsCallback")]
public NpgsqlSlimDataSourceBuilder UseClientCertificates(X509CertificateCollection? clientCertificates)
=> UseClientCertificatesCallback(clientCertificates is null ? null : certs => certs.AddRange(clientCertificates));
/// <summary>
/// When using SSL/TLS, this is a callback that allows customizing SslStream's authentication options.
/// </summary>
/// <param name="sslClientAuthenticationOptionsCallback">The callback to customize SslStream's authentication options.</param>
/// <remarks>
/// <para>
/// See <see href="https://learn.microsoft.com/en-us/dotnet/api/system.net.security.sslclientauthenticationoptions?view=net-8.0"/>.
/// </para>
/// </remarks>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder UseSslClientAuthenticationOptionsCallback(Action<SslClientAuthenticationOptions>? sslClientAuthenticationOptionsCallback)
{
_sslClientAuthenticationOptionsCallback = sslClientAuthenticationOptionsCallback;
return this;
}
/// <summary>
/// Specifies a callback to modify the collection of SSL/TLS client certificates which Npgsql will send to PostgreSQL for
/// certificate-based authentication. This is an advanced API, consider using <see cref="UseClientCertificate" /> or
/// <see cref="UseClientCertificates" /> instead.
/// </summary>
/// <param name="clientCertificatesCallback">The callback to modify the client certificate collection.</param>
/// <remarks>
/// <para>
/// The callback is invoked every time a physical connection is opened, and is therefore suitable for rotating short-lived client
/// certificates. Simply make sure the certificate collection argument has the up-to-date certificate(s).
/// </para>
/// <para>
/// The callback's collection argument already includes any client certificates specified via the connection string or environment
/// variables.
/// </para>
/// </remarks>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
[Obsolete("Use UseSslClientAuthenticationOptionsCallback")]
public NpgsqlSlimDataSourceBuilder UseClientCertificatesCallback(Action<X509CertificateCollection>? clientCertificatesCallback)
{
_clientCertificatesCallback = clientCertificatesCallback;
return this;
}
/// <summary>
/// Sets the <see cref="X509Certificate2" /> that will be used validate SSL certificate, received from the server.
/// </summary>
/// <param name="rootCertificate">The CA certificate.</param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder UseRootCertificate(X509Certificate2? rootCertificate)
=> rootCertificate is null
? UseRootCertificatesCallback((Func<X509Certificate2Collection>?)null)
: UseRootCertificateCallback(() => rootCertificate);
/// <summary>
/// Sets the <see cref="X509Certificate2Collection" /> that will be used validate SSL certificate, received from the server.
/// </summary>
/// <param name="rootCertificates">The CA certificates.</param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder UseRootCertificates(X509Certificate2Collection? rootCertificates)
=> rootCertificates is null
? UseRootCertificatesCallback((Func<X509Certificate2Collection>?)null)
: UseRootCertificatesCallback(() => rootCertificates);
/// <summary>
/// Specifies a callback that will be used to validate SSL certificate, received from the server.
/// </summary>
/// <param name="rootCertificateCallback">The callback to get CA certificate.</param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
/// <remarks>
/// This overload, which accepts a callback, is suitable for scenarios where the certificate rotates
/// and might change during the lifetime of the application.
/// When that's not the case, use the overload which directly accepts the certificate.
/// </remarks>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder UseRootCertificateCallback(Func<X509Certificate2>? rootCertificateCallback)
{
_transportSecurityHandler.RootCertificatesCallback = () => rootCertificateCallback is not null
? new X509Certificate2Collection(rootCertificateCallback())
: null;
return this;
}
/// <summary>
/// Specifies a callback that will be used to validate SSL certificate, received from the server.
/// </summary>
/// <param name="rootCertificateCallback">The callback to get CA certificates.</param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
/// <remarks>
/// This overload, which accepts a callback, is suitable for scenarios where the certificate rotates
/// and might change during the lifetime of the application.
/// When that's not the case, use the overload which directly accepts the certificate.
/// </remarks>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder UseRootCertificatesCallback(Func<X509Certificate2Collection>? rootCertificateCallback)
{
_transportSecurityHandler.RootCertificatesCallback = rootCertificateCallback;
return this;
}
/// <summary>
/// Configures a periodic password provider, which is automatically called by the data source at some regular interval. This is the
/// recommended way to fetch a rotating access token.
/// </summary>
/// <param name="passwordProvider">A callback which returns the password to be sent to PostgreSQL.</param>
/// <param name="successRefreshInterval">How long to cache the password before re-invoking the callback.</param>
/// <param name="failureRefreshInterval">
/// If a password refresh attempt fails, it will be re-attempted with this interval.
/// This should typically be much lower than <paramref name="successRefreshInterval" />.
/// </param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
/// <remarks>
/// <para>
/// The provided callback is invoked in a timer, and not when opening connections. It therefore doesn't affect opening time.
/// </para>
/// <para>
/// The provided cancellation token is only triggered when the entire data source is disposed. If you'd like to apply a timeout to the
/// token fetching, do so within the provided callback.
/// </para>
/// </remarks>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder UsePeriodicPasswordProvider(
Func<NpgsqlConnectionStringBuilder, CancellationToken, ValueTask<string>>? passwordProvider,
TimeSpan successRefreshInterval,
TimeSpan failureRefreshInterval)
{
if (successRefreshInterval < TimeSpan.Zero)
throw new ArgumentException(
string.Format(NpgsqlStrings.ArgumentMustBePositive, nameof(successRefreshInterval)), nameof(successRefreshInterval));
if (failureRefreshInterval < TimeSpan.Zero)
throw new ArgumentException(
string.Format(NpgsqlStrings.ArgumentMustBePositive, nameof(failureRefreshInterval)), nameof(failureRefreshInterval));
_periodicPasswordProvider = passwordProvider;
_periodicPasswordSuccessRefreshInterval = successRefreshInterval;
_periodicPasswordFailureRefreshInterval = failureRefreshInterval;
return this;
}
/// <summary>
/// Configures a password provider, which is called by the data source when opening connections.
/// </summary>
/// <param name="passwordProvider">
/// A callback that may be invoked during <see cref="NpgsqlConnection.Open()" /> which returns the password to be sent to PostgreSQL.
/// </param>
/// <param name="passwordProviderAsync">
/// A callback that may be invoked during <see cref="NpgsqlConnection.OpenAsync(CancellationToken)" /> which returns the password to be sent to PostgreSQL.
/// </param>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
/// <remarks>
/// <para>
/// The provided callback is invoked when opening connections. Therefore its important the callback internally depends on cached
/// data or returns quickly otherwise. Any unnecessary delay will affect connection opening time.
/// </para>
/// </remarks>
public NpgsqlSlimDataSourceBuilder UsePasswordProvider(
Func<NpgsqlConnectionStringBuilder, string>? passwordProvider,
Func<NpgsqlConnectionStringBuilder, CancellationToken, ValueTask<string>>? passwordProviderAsync)
{
if (passwordProvider is null != passwordProviderAsync is null)
throw new ArgumentException(NpgsqlStrings.SyncAndAsyncPasswordProvidersRequired);
_passwordProvider = passwordProvider;
_passwordProviderAsync = passwordProviderAsync;
return this;
}
/// <summary>
/// When using Kerberos, this is a callback that allows customizing default settings for Kerberos authentication.
/// </summary>
/// <param name="negotiateOptionsCallback">The callback containing logic to customize Kerberos authentication settings.</param>
/// <remarks>
/// <para>
/// See <see href="https://learn.microsoft.com/en-us/dotnet/api/system.net.security.negotiateauthenticationclientoptions?view=net-7.0"/>.
/// </para>
/// </remarks>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder UseNegotiateOptionsCallback(Action<NegotiateAuthenticationClientOptions>? negotiateOptionsCallback)
{
_negotiateOptionsCallback = negotiateOptionsCallback;
return this;
}
#endregion Authentication
#region Type mapping
/// <inheritdoc />
public INpgsqlNameTranslator DefaultNameTranslator
{
get => _userTypeMapper.DefaultNameTranslator;
set => _userTypeMapper.DefaultNameTranslator = value;
}
/// <summary>
/// Maps a CLR enum to a PostgreSQL enum type.
/// </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="NpgsqlSnakeCaseNameTranslator"/>.
/// You can also use the <see cref="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.
/// </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="DefaultNameTranslator" />.
/// </param>
/// <typeparam name="TEnum">The .NET enum type to be mapped</typeparam>
public NpgsqlSlimDataSourceBuilder MapEnum<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields)] TEnum>(string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
where TEnum : struct, Enum
{
_userTypeMapper.MapEnum<TEnum>(pgName, nameTranslator);
return this;
}
/// <inheritdoc />
public bool UnmapEnum<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields)] TEnum>(string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
where TEnum : struct, Enum
=> _userTypeMapper.UnmapEnum<TEnum>(pgName, nameTranslator);
/// <summary>
/// Maps a CLR enum to a PostgreSQL enum type.
/// </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="NpgsqlSnakeCaseNameTranslator"/>.
/// You can also use the <see cref="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.
/// </remarks>
/// <param name="clrType">The .NET enum type to be mapped</param>
/// <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="DefaultNameTranslator" />.
/// </param>
[RequiresDynamicCode("Calling MapEnum with a Type can require creating new generic types or methods. This may not work when AOT compiling.")]
public NpgsqlSlimDataSourceBuilder MapEnum([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)]
Type clrType, string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
{
_userTypeMapper.MapEnum(clrType, pgName, nameTranslator);
return this;
}
/// <inheritdoc />
public bool UnmapEnum([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)]
Type clrType, string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
=> _userTypeMapper.UnmapEnum(clrType, pgName, nameTranslator);
/// <summary>
/// Maps a CLR type to a PostgreSQL composite type.
/// </summary>
/// <remarks>
/// CLR fields and properties by string to PostgreSQL names.
/// The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
/// which defaults to <see cref="NpgsqlSnakeCaseNameTranslator"/>.
/// You can also use the <see cref="PgNameAttribute"/> on your members to manually specify a PostgreSQL name.
/// If there is a discrepancy between the .NET type and database type while a composite is read or written,
/// an exception will be raised.
/// </remarks>
/// <param name="pgName">
/// A PostgreSQL type name for the corresponding composite 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="DefaultNameTranslator" />.
/// </param>
/// <typeparam name="T">The .NET type to be mapped</typeparam>
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types which can require creating new generic types or methods. This is currently unsupported with NativeAOT, vote on issue #5303 if this is important to you.")]
public NpgsqlSlimDataSourceBuilder MapComposite<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)] T>(
string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
{
_userTypeMapper.MapComposite(typeof(T), pgName, nameTranslator);
return this;
}
/// <inheritdoc />
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types which can require creating new generic types or methods. This is currently unsupported with NativeAOT, vote on issue #5303 if this is important to you.")]
public bool UnmapComposite<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)] T>(
string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
=> _userTypeMapper.UnmapComposite(typeof(T), pgName, nameTranslator);
/// <summary>
/// Maps a CLR type to a composite type.
/// </summary>
/// <remarks>
/// Maps CLR fields and properties by string to PostgreSQL names.
/// The translation strategy can be controlled by the <paramref name="nameTranslator"/> parameter,
/// which defaults to <see cref="DefaultNameTranslator" />.
/// If there is a discrepancy between the .NET type and database type while a composite is read or written,
/// an exception will be raised.
/// </remarks>
/// <param name="clrType">The .NET type to be mapped.</param>
/// <param name="pgName">
/// A PostgreSQL type name for the corresponding composite 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="DefaultNameTranslator" />.
/// </param>
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types which can require creating new generic types or methods. This is currently unsupported with NativeAOT, vote on issue #5303 if this is important to you.")]
public NpgsqlSlimDataSourceBuilder MapComposite([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)]
Type clrType, string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
{
_userTypeMapper.MapComposite(clrType, pgName, nameTranslator);
return this;
}
/// <inheritdoc />
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types which can require creating new generic types or methods. This is currently unsupported with NativeAOT, vote on issue #5303 if this is important to you.")]
public bool UnmapComposite([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)]
Type clrType, string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
=> _userTypeMapper.UnmapComposite(clrType, pgName, nameTranslator);
/// <inheritdoc />
void INpgsqlTypeMapper.AddDbTypeResolverFactory(DbTypeResolverFactory factory)
=> (_dbTypeResolverFactories ??= new()).Add(factory);
/// <inheritdoc />
[Experimental(NpgsqlDiagnostics.ConvertersExperimental)]
public void AddTypeInfoResolverFactory(PgTypeInfoResolverFactory factory)
=> _resolverChainBuilder.PrependResolverFactory(factory);
/// <inheritdoc />
void INpgsqlTypeMapper.Reset() => _resolverChainBuilder.Clear();
internal Action<List<IPgTypeInfoResolver>> ConfigureResolverChain { get; set; }
internal void AppendResolverFactory(PgTypeInfoResolverFactory factory)
=> _resolverChainBuilder.AppendResolverFactory(factory);
internal void AppendResolverFactory<T>(Func<T> factory) where T : PgTypeInfoResolverFactory
=> _resolverChainBuilder.AppendResolverFactory(factory);
internal void AppendDefaultFactories()
{
// When used publicly we start off with our slim defaults.
_resolverChainBuilder.AppendResolverFactory(_userTypeMapper);
if (GlobalTypeMapper.Instance.GetUserMappingsResolverFactory() is { } userMappingsResolverFactory)
_resolverChainBuilder.AppendResolverFactory(userMappingsResolverFactory);
foreach (var factory in GlobalTypeMapper.Instance.GetPluginResolverFactories())
_resolverChainBuilder.AppendResolverFactory(factory);
_resolverChainBuilder.AppendResolverFactory(new AdoTypeInfoResolverFactory());
}
#endregion Type mapping
#region Optional opt-ins
/// <summary>
/// Sets up mappings for the PostgreSQL <c>array</c> types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableArrays()
{
_resolverChainBuilder.EnableArrays();
return this;
}
/// <summary>
/// Sets up mappings for the PostgreSQL <c>range</c> types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableRanges()
{
_resolverChainBuilder.EnableRanges();
return this;
}
/// <summary>
/// Sets up mappings for the PostgreSQL <c>multirange</c> types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableMultiranges()
{
_resolverChainBuilder.EnableMultiranges();
return this;
}
/// <summary>
/// Sets up mappings for the PostgreSQL <c>record</c> type as a .NET <c>object[]</c>.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableRecords()
{
AddTypeInfoResolverFactory(new RecordTypeInfoResolverFactory());
return this;
}
/// <summary>
/// Sets up mappings for the PostgreSQL <c>tsquery</c> and <c>tsvector</c> types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableFullTextSearch()
{
AddTypeInfoResolverFactory(new FullTextSearchTypeInfoResolverFactory());
return this;
}
/// <summary>
/// Sets up mappings for the PostgreSQL <c>ltree</c> extension types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableLTree()
{
AddTypeInfoResolverFactory(new LTreeTypeInfoResolverFactory());
return this;
}
/// <summary>
/// Sets up mappings for the PostgreSQL <c>cube</c> extension type.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableCube()
{
AddTypeInfoResolverFactory(new CubeTypeInfoResolverFactory());
return this;
}
/// <summary>
/// Sets up mappings for extra conversions from PostgreSQL to .NET types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableExtraConversions()
{
AddTypeInfoResolverFactory(new ExtraConversionResolverFactory());
return this;
}
/// <summary>
/// Enables the possibility to use TLS/SSl encryption for connections to PostgreSQL. This does not guarantee that encryption will
/// actually be used; see <see href="https://www.npgsql.org/doc/security.html"/> for more details.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableTransportSecurity()
{
_transportSecurityHandler = new RealTransportSecurityHandler();
return this;
}
/// <summary>
/// Enables the possibility to use GSS/SSPI authentication and encryption for connections to PostgreSQL. This does not guarantee that it will
/// actually be used; see <see href="https://www.npgsql.org/doc/security.html"/> for more details.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableIntegratedSecurity()
{
_integratedSecurityHandler = new RealIntegratedSecurityHandler();
return this;
}
/// <summary>
/// Sets up network mappings. This allows mapping PhysicalAddress, IPAddress, NpgsqlInet and NpgsqlCidr types
/// to PostgreSQL <c>macaddr</c>, <c>macaddr8</c>, <c>inet</c> and <c>cidr</c> types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableNetworkTypes()
{
_resolverChainBuilder.AppendResolverFactory(new NetworkTypeInfoResolverFactory());
return this;
}
/// <summary>
/// Sets up network mappings. This allows mapping types like NpgsqlPoint and NpgsqlPath
/// to PostgreSQL <c>point</c>, <c>path</c> and so on types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableGeometricTypes()
{
_resolverChainBuilder.AppendResolverFactory(new GeometricTypeInfoResolverFactory());
return this;
}
/// <summary>
/// Sets up System.Text.Json mappings. This allows mapping JsonDocument and JsonElement types to PostgreSQL <c>json</c> and <c>jsonb</c>
/// types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder EnableJsonTypes()
{
_resolverChainBuilder.AppendResolverFactory(() => new JsonTypeInfoResolverFactory(JsonSerializerOptions));
return this;
}
/// <summary>
/// Sets up dynamic System.Text.Json mappings. This allows mapping arbitrary .NET types to PostgreSQL <c>json</c> and <c>jsonb</c>
/// types, as well as <see cref="JsonNode" /> and its derived types.
/// </summary>
/// <param name="jsonbClrTypes">
/// A list of CLR types to map to PostgreSQL <c>jsonb</c> (no need to specify <see cref="NpgsqlDbType.Jsonb" />).
/// </param>
/// <param name="jsonClrTypes">
/// A list of CLR types to map to PostgreSQL <c>json</c> (no need to specify <see cref="NpgsqlDbType.Json" />).
/// </param>
/// <remarks>
/// Due to the dynamic nature of these mappings, they are not compatible with NativeAOT or trimming.
/// </remarks>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
[RequiresUnreferencedCode("Json serializer may perform reflection on trimmed types.")]
[RequiresDynamicCode("Serializing arbitrary types to json can require creating new generic types or methods, which requires creating code at runtime. This may not work when AOT compiling.")]
public NpgsqlSlimDataSourceBuilder EnableDynamicJson(
Type[]? jsonbClrTypes = null,
Type[]? jsonClrTypes = null)
{
_resolverChainBuilder.AppendResolverFactory(() => new JsonDynamicTypeInfoResolverFactory(jsonbClrTypes, jsonClrTypes, JsonSerializerOptions));
return this;
}
/// <summary>
/// Sets up mappings for the PostgreSQL <c>record</c> type as a .NET <see cref="ValueTuple" /> or <see cref="Tuple" />.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
[RequiresUnreferencedCode("The mapping of PostgreSQL records as .NET tuples requires reflection usage which is incompatible with trimming.")]
[RequiresDynamicCode("The mapping of PostgreSQL records as .NET tuples requires dynamic code usage which is incompatible with NativeAOT.")]
public NpgsqlSlimDataSourceBuilder EnableRecordsAsTuples()
{
AddTypeInfoResolverFactory(new TupledRecordTypeInfoResolverFactory());
return this;
}
/// <summary>
/// Sets up mappings allowing the use of unmapped enum, range and multirange types.
/// </summary>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
[RequiresUnreferencedCode("The use of unmapped enums, ranges or multiranges requires reflection usage which is incompatible with trimming.")]
[RequiresDynamicCode("The use of unmapped enums, ranges or multiranges requires dynamic code usage which is incompatible with NativeAOT.")]
public NpgsqlSlimDataSourceBuilder EnableUnmappedTypes()
{
AddTypeInfoResolverFactory(new UnmappedTypeInfoResolverFactory());
return this;
}
#endregion Optional opt-ins
/// <summary>
/// Register a connection initializer, which allows executing arbitrary commands when a physical database connection is first opened.
/// </summary>
/// <param name="connectionInitializer">
/// A synchronous connection initialization lambda, which will be called from <see cref="NpgsqlConnection.Open()" /> when a new physical
/// connection is opened.
/// </param>
/// <param name="connectionInitializerAsync">
/// An asynchronous connection initialization lambda, which will be called from
/// <see cref="NpgsqlConnection.OpenAsync(CancellationToken)" /> when a new physical connection is opened.
/// </param>
/// <remarks>
/// If an initializer is registered, both sync and async versions must be provided. If you do not use sync APIs in your code, simply
/// throw <see cref="NotSupportedException" />, which would also catch accidental cases of sync opening.
/// </remarks>
/// <remarks>
/// Take care that the setting you apply in the initializer does not get reverted when the connection is returned to the pool, since
/// Npgsql sends <c>DISCARD ALL</c> by default. The <see cref="NpgsqlConnectionStringBuilder.NoResetOnClose" /> option can be used to
/// turn this off.
/// </remarks>
/// <returns>The same builder instance so that multiple calls can be chained.</returns>
public NpgsqlSlimDataSourceBuilder UsePhysicalConnectionInitializer(
Action<NpgsqlConnection>? connectionInitializer,
Func<NpgsqlConnection, Task>? connectionInitializerAsync)
{
if (connectionInitializer is null != connectionInitializerAsync is null)
throw new ArgumentException(NpgsqlStrings.SyncAndAsyncConnectionInitializersRequired);
_connectionInitializer = connectionInitializer;
_connectionInitializerAsync = connectionInitializerAsync;
return this;
}
/// <summary>
/// Builds and returns an <see cref="NpgsqlDataSource" /> which is ready for use.
/// </summary>
public NpgsqlDataSource Build()
{
var (connectionStringBuilder, config) = PrepareConfiguration();
if (ConnectionStringBuilder.Host!.Contains(','))
{
ValidateMultiHost();
return new NpgsqlMultiHostDataSource(connectionStringBuilder, config);
}
return ConnectionStringBuilder.Multiplexing
? new MultiplexingDataSource(connectionStringBuilder, config)
: ConnectionStringBuilder.Pooling
? new PoolingDataSource(connectionStringBuilder, config)
: new UnpooledDataSource(connectionStringBuilder, config);
}
/// <summary>
/// Builds and returns a <see cref="NpgsqlMultiHostDataSource" /> which is ready for use for load-balancing and failover scenarios.
/// </summary>
public NpgsqlMultiHostDataSource BuildMultiHost()
{
var (connectionStringBuilder, config) = PrepareConfiguration();
ValidateMultiHost();
return new(connectionStringBuilder, config);
}
(NpgsqlConnectionStringBuilder, NpgsqlDataSourceConfiguration) PrepareConfiguration()
{
ConnectionStringBuilder.PostProcessAndValidate();
var connectionStringBuilder = ConnectionStringBuilder.Clone();
var sslClientAuthenticationOptionsCallback = _sslClientAuthenticationOptionsCallback;
var hasCertificateCallbacks = _userCertificateValidationCallback is not null || _clientCertificatesCallback is not null;
if (sslClientAuthenticationOptionsCallback is not null && hasCertificateCallbacks)
{
throw new NotSupportedException(NpgsqlStrings.SslClientAuthenticationOptionsCallbackWithOtherCallbacksNotSupported);
}
if (sslClientAuthenticationOptionsCallback is null && hasCertificateCallbacks)
{
sslClientAuthenticationOptionsCallback = options =>
{
if (_clientCertificatesCallback is not null)
{
options.ClientCertificates ??= new X509Certificate2Collection();
_clientCertificatesCallback.Invoke(options.ClientCertificates);
}
if (_userCertificateValidationCallback is not null)
{
options.RemoteCertificateValidationCallback = _userCertificateValidationCallback;
}
};
}
if (!_transportSecurityHandler.SupportEncryption && sslClientAuthenticationOptionsCallback is not null)
{
throw new InvalidOperationException(NpgsqlStrings.TransportSecurityDisabled);
}
if (_passwordProvider is not null && _periodicPasswordProvider is not null)
{
throw new NotSupportedException(NpgsqlStrings.CannotSetMultiplePasswordProviderKinds);
}
if ((_passwordProvider is not null || _periodicPasswordProvider is not null) &&
(ConnectionStringBuilder.Password is not null || ConnectionStringBuilder.Passfile is not null))
{
throw new NotSupportedException(NpgsqlStrings.CannotSetBothPasswordProviderAndPassword);
}
ConfigureDefaultFactories(this);
var typeLoadingOptionsBuilder = new NpgsqlTypeLoadingOptionsBuilder();
#pragma warning disable CS0618 // Type or member is obsolete
typeLoadingOptionsBuilder.EnableTableCompositesLoading(connectionStringBuilder.LoadTableComposites);
typeLoadingOptionsBuilder.EnableTypeLoading(connectionStringBuilder.ServerCompatibilityMode is not ServerCompatibilityMode.NoTypeLoading);
#pragma warning restore CS0618 // Type or member is obsolete
foreach (var callback in _typeLoadingOptionsBuilderCallbacks ?? (IEnumerable<Action<NpgsqlTypeLoadingOptionsBuilder>>)[])
callback.Invoke(typeLoadingOptionsBuilder);
var typeLoadingOptions = typeLoadingOptionsBuilder.Build();
var tracingOptionsBuilder = new NpgsqlTracingOptionsBuilder();
foreach (var callback in _tracingOptionsBuilderCallbacks ?? (IEnumerable<Action<NpgsqlTracingOptionsBuilder>>)[])
callback.Invoke(tracingOptionsBuilder);
var tracingOptions = tracingOptionsBuilder.Build();
return (connectionStringBuilder, new(
Name,
_loggerFactory is null
? NpgsqlLoggingConfiguration.NullConfiguration
: new NpgsqlLoggingConfiguration(_loggerFactory, _sensitiveDataLoggingEnabled),
tracingOptions,
typeLoadingOptions,
_transportSecurityHandler,
_integratedSecurityHandler,
sslClientAuthenticationOptionsCallback,
_passwordProvider,
_passwordProviderAsync,
_periodicPasswordProvider,
_periodicPasswordSuccessRefreshInterval,
_periodicPasswordFailureRefreshInterval,
_resolverChainBuilder.Build(ConfigureResolverChain),
_dbTypeResolverFactories ?? [],
DefaultNameTranslator,
_connectionInitializer,
_connectionInitializerAsync,
_negotiateOptionsCallback));
}
void ValidateMultiHost()
{
if (ConnectionStringBuilder.Multiplexing)
throw new NotSupportedException("Multiplexing is not supported with multiple hosts");
if (ConnectionStringBuilder.ReplicationMode != ReplicationMode.Off)
throw new NotSupportedException("Replication is not supported with multiple hosts");
}
INpgsqlTypeMapper INpgsqlTypeMapper.ConfigureJsonOptions(JsonSerializerOptions serializerOptions)
=> ConfigureJsonOptions(serializerOptions);
[RequiresUnreferencedCode("Json serializer may perform reflection on trimmed types.")]
[RequiresDynamicCode(
"Serializing arbitrary types to json can require creating new generic types or methods, which requires creating code at runtime. This may not work when AOT compiling.")]
INpgsqlTypeMapper INpgsqlTypeMapper.EnableDynamicJson(Type[]? jsonbClrTypes, Type[]? jsonClrTypes)
=> EnableDynamicJson(jsonbClrTypes, jsonClrTypes);
[RequiresUnreferencedCode(
"The mapping of PostgreSQL records as .NET tuples requires reflection usage which is incompatible with trimming.")]
[RequiresDynamicCode(
"The mapping of PostgreSQL records as .NET tuples requires dynamic code usage which is incompatible with NativeAOT.")]
INpgsqlTypeMapper INpgsqlTypeMapper.EnableRecordsAsTuples()
=> EnableRecordsAsTuples();
[RequiresUnreferencedCode(
"The use of unmapped enums, ranges or multiranges requires reflection usage which is incompatible with trimming.")]
[RequiresDynamicCode(
"The use of unmapped enums, ranges or multiranges requires dynamic code usage which is incompatible with NativeAOT.")]
INpgsqlTypeMapper INpgsqlTypeMapper.EnableUnmappedTypes()
=> EnableUnmappedTypes();
/// <inheritdoc />
INpgsqlTypeMapper INpgsqlTypeMapper.MapEnum<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields)] TEnum>(string? pgName, INpgsqlNameTranslator? nameTranslator)
{
_userTypeMapper.MapEnum<TEnum>(pgName, nameTranslator);
return this;
}
/// <inheritdoc />
[RequiresDynamicCode("Calling MapEnum with a Type can require creating new generic types or methods. This may not work when AOT compiling.")]
INpgsqlTypeMapper INpgsqlTypeMapper.MapEnum([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)]
Type clrType, string? pgName, INpgsqlNameTranslator? nameTranslator)
{
_userTypeMapper.MapEnum(clrType, pgName, nameTranslator);
return this;
}
/// <inheritdoc />
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types which can require creating new generic types or methods. This is currently unsupported with NativeAOT, vote on issue #5303 if this is important to you.")]
INpgsqlTypeMapper INpgsqlTypeMapper.MapComposite<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)] T>(
string? pgName, INpgsqlNameTranslator? nameTranslator)
{
_userTypeMapper.MapComposite(typeof(T), pgName, nameTranslator);
return this;
}
/// <inheritdoc />
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types which can require creating new generic types or methods. This is currently unsupported with NativeAOT, vote on issue #5303 if this is important to you.")]
INpgsqlTypeMapper INpgsqlTypeMapper.MapComposite([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)]
Type clrType, string? pgName, INpgsqlNameTranslator? nameTranslator)
{
_userTypeMapper.MapComposite(clrType, pgName, nameTranslator);
return this;
}
}