forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathNpgsqlDataSourceBuilder.cs
More file actions
377 lines (336 loc) · 18.9 KB
/
NpgsqlDataSourceBuilder.cs
File metadata and controls
377 lines (336 loc) · 18.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
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Net.Security;
using System.Security.Cryptography.X509Certificates;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using Npgsql.Internal;
using Npgsql.Internal.Resolvers;
using Npgsql.TypeMapping;
namespace Npgsql;
/// <summary>
/// Provides a simple API for configuring and creating an <see cref="NpgsqlDataSource" />, from which database connections can be obtained.
/// </summary>
public sealed class NpgsqlDataSourceBuilder : INpgsqlTypeMapper
{
static UnsupportedTypeInfoResolver<NpgsqlDataSourceBuilder> UnsupportedTypeInfoResolver { get; } = new();
readonly NpgsqlSlimDataSourceBuilder _internalBuilder;
/// <summary>
/// A diagnostics name used by Npgsql when generating tracing, logging and metrics.
/// </summary>
public string? Name
{
get => _internalBuilder.Name;
set => _internalBuilder.Name = value;
}
/// <inheritdoc />
public INpgsqlNameTranslator DefaultNameTranslator
{
get => _internalBuilder.DefaultNameTranslator;
set => _internalBuilder.DefaultNameTranslator = value;
}
/// <summary>
/// A connection string builder that can be used to configured the connection string on the builder.
/// </summary>
public NpgsqlConnectionStringBuilder ConnectionStringBuilder => _internalBuilder.ConnectionStringBuilder;
/// <summary>
/// Returns the connection string, as currently configured on the builder.
/// </summary>
public string ConnectionString => _internalBuilder.ConnectionString;
internal static void ResetGlobalMappings(bool overwrite)
=> GlobalTypeMapper.Instance.AddGlobalTypeMappingResolvers(new IPgTypeInfoResolver[]
{
overwrite ? new AdoTypeInfoResolver() : AdoTypeInfoResolver.Instance,
new ExtraConversionsResolver(),
new JsonTypeInfoResolver(),
new RangeTypeInfoResolver(),
new RecordTypeInfoResolver(),
new FullTextSearchTypeInfoResolver(),
new NetworkTypeInfoResolver(),
new GeometricTypeInfoResolver(),
new LTreeTypeInfoResolver(),
// Arrays
new AdoArrayTypeInfoResolver(),
new ExtraConversionsArrayTypeInfoResolver(),
new JsonArrayTypeInfoResolver(),
new RangeArrayTypeInfoResolver(),
new RecordArrayTypeInfoResolver(),
new FullTextSearchArrayTypeInfoResolver(),
new NetworkArrayTypeInfoResolver(),
new GeometricArrayTypeInfoResolver(),
new LTreeArrayTypeInfoResolver()
}, overwrite);
static NpgsqlDataSourceBuilder()
=> ResetGlobalMappings(overwrite: false);
/// <summary>
/// Constructs a new <see cref="NpgsqlDataSourceBuilder" />, optionally starting out from the given <paramref name="connectionString"/>.
/// </summary>
public NpgsqlDataSourceBuilder(string? connectionString = null)
{
_internalBuilder = new(new NpgsqlConnectionStringBuilder(connectionString));
AddDefaultFeatures();
void AddDefaultFeatures()
{
_internalBuilder.EnableTransportSecurity();
_internalBuilder.EnableIntegratedSecurity();
AddTypeInfoResolver(UnsupportedTypeInfoResolver);
// Reverse order arrays.
AddTypeInfoResolver(new LTreeArrayTypeInfoResolver());
AddTypeInfoResolver(new GeometricArrayTypeInfoResolver());
AddTypeInfoResolver(new NetworkArrayTypeInfoResolver());
AddTypeInfoResolver(new FullTextSearchArrayTypeInfoResolver());
AddTypeInfoResolver(new RecordArrayTypeInfoResolver());
AddTypeInfoResolver(new RangeArrayTypeInfoResolver());
AddTypeInfoResolver(new JsonArrayTypeInfoResolver());
AddTypeInfoResolver(new ExtraConversionsArrayTypeInfoResolver());
AddTypeInfoResolver(new AdoArrayTypeInfoResolver());
// Reverse order.
AddTypeInfoResolver(new LTreeTypeInfoResolver());
AddTypeInfoResolver(new GeometricTypeInfoResolver());
AddTypeInfoResolver(new NetworkTypeInfoResolver());
AddTypeInfoResolver(new FullTextSearchTypeInfoResolver());
AddTypeInfoResolver(new RecordTypeInfoResolver());
AddTypeInfoResolver(new RangeTypeInfoResolver());
AddTypeInfoResolver(new JsonTypeInfoResolver());
AddTypeInfoResolver(new ExtraConversionsResolver());
AddTypeInfoResolver(AdoTypeInfoResolver.Instance);
var plugins = new List<IPgTypeInfoResolver>(GlobalTypeMapper.Instance.GetPluginResolvers());
plugins.Reverse();
foreach (var plugin in plugins)
AddTypeInfoResolver(plugin);
}
}
/// <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 NpgsqlDataSourceBuilder UseLoggerFactory(ILoggerFactory? loggerFactory)
{
_internalBuilder.UseLoggerFactory(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 NpgsqlDataSourceBuilder EnableParameterLogging(bool parameterLoggingEnabled = true)
{
_internalBuilder.EnableParameterLogging(parameterLoggingEnabled);
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>
public NpgsqlDataSourceBuilder UseUserCertificateValidationCallback(RemoteCertificateValidationCallback userCertificateValidationCallback)
{
_internalBuilder.UseUserCertificateValidationCallback(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>
public NpgsqlDataSourceBuilder UseClientCertificate(X509Certificate? clientCertificate)
{
_internalBuilder.UseClientCertificate(clientCertificate);
return this;
}
/// <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>
public NpgsqlDataSourceBuilder UseClientCertificates(X509CertificateCollection? clientCertificates)
{
_internalBuilder.UseClientCertificates(clientCertificates);
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>
public NpgsqlDataSourceBuilder UseClientCertificatesCallback(Action<X509CertificateCollection>? clientCertificatesCallback)
{
_internalBuilder.UseClientCertificatesCallback(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 NpgsqlDataSourceBuilder UseRootCertificate(X509Certificate2? rootCertificate)
{
_internalBuilder.UseRootCertificate(rootCertificate);
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 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>
public NpgsqlDataSourceBuilder UseRootCertificateCallback(Func<X509Certificate2>? rootCertificateCallback)
{
_internalBuilder.UseRootCertificateCallback(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>
public NpgsqlDataSourceBuilder UsePeriodicPasswordProvider(
Func<NpgsqlConnectionStringBuilder, CancellationToken, ValueTask<string>>? passwordProvider,
TimeSpan successRefreshInterval,
TimeSpan failureRefreshInterval)
{
_internalBuilder.UsePeriodicPasswordProvider(passwordProvider, successRefreshInterval, failureRefreshInterval);
return this;
}
#endregion Authentication
#region Type mapping
/// <inheritdoc />
public void AddTypeInfoResolver(IPgTypeInfoResolver resolver)
=> _internalBuilder.AddTypeInfoResolver(resolver);
/// <inheritdoc />
void INpgsqlTypeMapper.Reset()
=> _internalBuilder.ResetTypeMappings();
/// <inheritdoc />
public INpgsqlTypeMapper MapEnum<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields)] TEnum>(string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
where TEnum : struct, Enum
{
_internalBuilder.MapEnum<TEnum>(pgName, nameTranslator);
return this;
}
/// <inheritdoc />
public bool UnmapEnum<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields)] TEnum>(string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
where TEnum : struct, Enum
=> _internalBuilder.UnmapEnum<TEnum>(pgName, nameTranslator);
/// <inheritdoc />
[RequiresDynamicCode("Calling MapEnum with a Type can require creating new generic types or methods. This may not work when AOT compiling.")]
public INpgsqlTypeMapper MapEnum([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)]
Type clrType, string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
=> _internalBuilder.MapEnum(clrType, pgName, nameTranslator);
/// <inheritdoc />
public bool UnmapEnum([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicFields | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)]
Type clrType, string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
=> _internalBuilder.UnmapEnum(clrType, pgName, nameTranslator);
/// <inheritdoc />
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types, requiring require creating new generic types or methods. This is currently unsupported with NativeAOT, vote on issue #5303 if this is important to you.")]
public INpgsqlTypeMapper MapComposite<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)] T>(
string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
{
_internalBuilder.MapComposite<T>(pgName, nameTranslator);
return this;
}
/// <inheritdoc />
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types, requiring require creating new generic types or methods. This is currently unsupported with NativeAOT, vote on issue #5303 if this is important to you.")]
public INpgsqlTypeMapper MapComposite([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicFields)]
Type clrType, string? pgName = null, INpgsqlNameTranslator? nameTranslator = null)
{
_internalBuilder.MapComposite(clrType, pgName, nameTranslator);
return this;
}
/// <inheritdoc />
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types, requiring 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)
=> _internalBuilder.UnmapComposite<T>(pgName, nameTranslator);
/// <inheritdoc />
[RequiresDynamicCode("Mapping composite types involves serializing arbitrary types, requiring 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)
=> _internalBuilder.UnmapComposite(clrType, pgName, nameTranslator);
#endregion Type mapping
/// <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 NpgsqlDataSourceBuilder UsePhysicalConnectionInitializer(
Action<NpgsqlConnection>? connectionInitializer,
Func<NpgsqlConnection, Task>? connectionInitializerAsync)
{
_internalBuilder.UsePhysicalConnectionInitializer(connectionInitializer, connectionInitializerAsync);
return this;
}
/// <summary>
/// Builds and returns an <see cref="NpgsqlDataSource" /> which is ready for use.
/// </summary>
public NpgsqlDataSource Build()
=> _internalBuilder.Build();
/// <summary>
/// Builds and returns a <see cref="NpgsqlMultiHostDataSource" /> which is ready for use for load-balancing and failover scenarios.
/// </summary>
public NpgsqlMultiHostDataSource BuildMultiHost()
=> _internalBuilder.BuildMultiHost();
}