{{ message }}
forked from NpgsqlRest/NpgsqlRest
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNpgsqlRestOptions.cs
More file actions
320 lines (271 loc) · 19.7 KB
/
Copy pathNpgsqlRestOptions.cs
File metadata and controls
320 lines (271 loc) · 19.7 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
using Microsoft.Extensions.Primitives;
using Npgsql;
using NpgsqlRest.Defaults;
namespace NpgsqlRest;
/// <summary>
/// Options for the NpgsqlRest middleware.
/// </summary>
public class NpgsqlRestOptions(
string? connectionString,
NpgsqlDataSource? dataSource,
string? schemaSimilarTo = null,
string? schemaNotSimilarTo = null,
string[]? includeSchemas = null,
string[]? excludeSchemas = null,
string? nameSimilarTo = null,
string? nameNotSimilarTo = null,
string[]? includeNames = null,
string[]? excludeNames = null,
string? urlPathPrefix = "/api",
Func<Routine, NpgsqlRestOptions, string>? urlPathBuilder = null,
ServiceProviderObject serviceProviderMode = ServiceProviderObject.None,
Func<Routine, RoutineEndpoint, RoutineEndpoint?>? endpointCreated = null,
Func<string?, string?>? nameConverter = null,
bool requiresAuthorization = false,
ILogger? logger = null,
string? loggerName = null,
bool logEndpointCreatedInfo = true,
bool logAnnotationSetInfo = true,
bool logConnectionNoticeEvents = true,
bool logCommands = false,
bool logCommandParameters = false,
int? commandTimeout = null,
Method? defaultHttpMethod = null,
RequestParamType? defaultRequestParamType = null,
Action<ParameterValidationValues>? validateParameters = null,
Func<ParameterValidationValues, Task>? validateParametersAsync = null,
CommentsMode commentsMode = CommentsMode.OnlyWithHttpTag,
RequestHeadersMode requestHeadersMode = RequestHeadersMode.Ignore,
string requestHeadersParameterName = "headers",
Action<(Routine routine, RoutineEndpoint endpoint)[]>? endpointsCreated = null,
Func<(Routine routine, NpgsqlCommand command, HttpContext context), Task>? commandCallbackAsync = null,
IEnumerable<IEndpointCreateHandler>? endpointCreateHandlers = null,
Action<List<IRoutineSource>>? sourcesCreated = null,
TextResponseNullHandling textResponseNullHandling = TextResponseNullHandling.EmptyString,
QueryStringNullHandling queryStringNullHandling = QueryStringNullHandling.Ignore,
ulong bufferRows = 25,
NpgsqlRestAuthenticationOptions? authenticationOptions = null,
bool returnNpgsqlExceptionMessage = true,
Dictionary<string, int>? postgreSqlErrorCodeToHttpStatusCodeMapping = null,
Action<NpgsqlConnection, Routine, RoutineEndpoint, HttpContext>? beforeConnectionOpen = null,
Dictionary<string, StringValues>? customRequestHeaders = null,
List<IRoutineSource>? routineSources = null,
bool refreshEndpointEnabled = false,
string refreshMethod = "GET",
string refreshPath = "/api/npgsqlrest/refresh")
{
/// <summary>
/// Options for the NpgsqlRest middleware.
/// </summary>
/// <param name="connectionString">PostgreSQL connection string</param>
public NpgsqlRestOptions(string? connectionString) : this(connectionString, null)
{
}
/// <summary>
/// Options for the NpgsqlRest middleware.
/// Connection string is set to null
/// </summary>
public NpgsqlRestOptions() : this(null)
{
}
/// <summary>
/// The connection string to the database. This is the optional value if the `DataSource` option is set.
/// </summary>
public string? ConnectionString { get; set; } = connectionString;
/// <summary>
/// The data source object that will be used to create a connection to the database.
/// If this option is set, the connection string will be ignored.
/// </summary>
public NpgsqlDataSource? DataSource { get; set; } = dataSource;
/// <summary>
/// Filter schema names [similar to](https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP) this parameter or `null` to ignore this parameter.
/// </summary>
public string? SchemaSimilarTo { get; set; } = schemaSimilarTo;
/// <summary>
/// Filter schema names NOT [similar to](https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP) this parameter or `null` to ignore this parameter.
/// </summary>
public string? SchemaNotSimilarTo { get; set; } = schemaNotSimilarTo;
/// <summary>
/// List of schema names to be included or `null` to ignore this parameter.
/// </summary>
public string[]? IncludeSchemas { get; set; } = includeSchemas;
/// <summary>
/// List of schema names to be excluded or `null` to ignore this parameter.
/// </summary>
public string[]? ExcludeSchemas { get; set; } = excludeSchemas;
/// <summary>
/// Filter names [similar to](https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP) this parameter or `null` to ignore this parameter.
/// </summary>
public string? NameSimilarTo { get; set; } = nameSimilarTo;
/// <summary>
/// Filter names NOT [similar to](https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP) this parameter or `null` to ignore this parameter.
/// </summary>
public string? NameNotSimilarTo { get; set; } = nameNotSimilarTo;
/// <summary>
/// List of names to be included or `null` to ignore this parameter.
/// </summary>
public string[]? IncludeNames { get; set; } = includeNames;
/// <summary>
/// List of names to be excluded or `null` to ignore this parameter.
/// </summary>
public string[]? ExcludeNames { get; set; } = excludeNames;
/// <summary>
/// The URL prefix string for every URL created by the default URL builder or `null` to ignore the URL prefix.
/// </summary>
public string? UrlPathPrefix { get; set; } = urlPathPrefix;
/// <summary>
/// Custom function delegate that receives routine and options parameters and returns constructed URL path string for routine. Default the default URL builder that transforms snake case names to kebab case names.
/// </summary>
public Func<Routine, NpgsqlRestOptions, string> UrlPathBuilder { get; set; } = urlPathBuilder ?? DefaultUrlBuilder.CreateUrl;
/// <summary>
/// Set to NpgsqlDataSource or NpgsqlConnection to use the connection objects from the service provider. Default is None.
/// </summary>
public ServiceProviderObject ServiceProviderMode { get; set; } = serviceProviderMode;
/// <summary>
/// Callback function that is executed just after the new endpoint is created. Receives routine into and new endpoint info as parameters and it is expected to return the same endpoint or `null`. It offers an opportunity to modify the endpoint based on custom logic or disable endpoints by returning `null` based on some custom logic. Default is `null`, which means this callback is not defined.
/// </summary>
public Func<Routine, RoutineEndpoint, RoutineEndpoint?>? EndpointCreated { get; set; } = endpointCreated;
/// <summary>
/// Custom function callback that receives names from PostgreSQL (parameter names, column names, etc), and is expected to return the same or new name. It offers an opportunity to convert names based on certain conventions. The default converter converts snake case names into camel case names.
/// </summary>
public Func<string?, string?> NameConverter { get; set; } = nameConverter ?? DefaultNameConverter.ConvertToCamelCase;
/// <summary>
/// When set to true, it will force all created endpoints to require authorization. Authorization requirements for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// </summary>
public bool RequiresAuthorization { get; set; } = requiresAuthorization;
/// <summary>
/// Set this option to provide a custom logger implementation. The default `null` value will cause middleware to create a default logger named `NpgsqlRest` from the logger factory in the service collection.
/// </summary>
public ILogger? Logger { get; set; } = logger;
/// <summary>
/// Change the logger name with this option.
/// </summary>
public string? LoggerName { get; set; } = loggerName;
/// <summary>
/// Log endpoint created events.
/// </summary>
public bool LogEndpointCreatedInfo { get; set; } = logEndpointCreatedInfo;
/// <summary>
/// When this value is true, all changes in the endpoint properties that are set from the comment annotations will be logged as warnings.
/// </summary>
public bool LogAnnotationSetInfo { get; set; } = logAnnotationSetInfo;
/// <summary>
/// When this value is true, all connection events are logged (depending on the level). This is usually triggered by the PostgreSQL [`RAISE` statements](https://www.postgresql.org/docs/current/plpgsql-errors-and-messages.html). Set to false to disable logging these events.
/// </summary>
public bool LogConnectionNoticeEvents { get; set; } = logConnectionNoticeEvents;
/// <summary>
/// Set this option to true to log information for every executed command and query (including parameters and parameter values).
/// </summary>
public bool LogCommands { get; set; } = logCommands;
/// <summary>
/// Set this option to true to include parameter values when logging commands. This only applies when `LogCommands` is true.
/// </summary>
public bool LogCommandParameters { get; set; } = logCommandParameters;
/// <summary>
/// Sets the wait time (in seconds) on database commands, before terminating the attempt to execute a command and generating an error. This value when it is not null will override the `NpgsqlCommand` which is 30 seconds. Command timeout property for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// </summary>
public int? CommandTimeout { get; set; } = commandTimeout;
/// <summary>
/// When not null, forces a method type for all created endpoints. Method types are `GET`, `PUT`, `POST`, `DELETE`, `HEAD`, `OPTIONS`, `TRACE`, `PATCH` or `CONNECT`. When this value is null (default), the method type is always `GET` when the routine volatility option is not volatile or the routine name starts with, `get_`, contains `_get_` or ends with `_get` (case insensitive). Otherwise, it is `POST`. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// </summary>
public Method? DefaultHttpMethod { get; set; } = defaultHttpMethod;
/// <summary>
/// When not null, sets the request parameter position (request parameter types) for all created endpoints. Values are `QueryString` (parameters are sent using query string) or `BodyJson` (paremeters are sent using JSON request body). When this value is null (default), request parameter type is `QueryString` for all `GET` and `DELETE` endpoints, otherwise, request parameter type is `BodyJson`. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// </summary>
public RequestParamType? DefaultRequestParamType { get; set; } = defaultRequestParamType;
/// <summary>
/// Custom parameter validation method. When this callback option is not null, it will be executed for every database parameter created. The input structure will contain a current HTTP context that offers the opportunity to alter the response and cancel the request: If the current HTTP response reference has started or the status code is different than 200 OK, command execution will be canceled and the response will be returned.
/// </summary>
public Action<ParameterValidationValues>? ValidateParameters { get; set; } = validateParameters;
/// <summary>
/// Custom parameter validation method, asynchrounous version. When this callback option is not null, it will be executed for every database parameter created. The input structure will contain a current HTTP context that offers the opportunity to alter the response and cancel the request: If the current HTTP response reference has started or the status code is different than 200 OK, command execution will be canceled and the response will be returned.
/// </summary>
public Func<ParameterValidationValues, Task>? ValidateParametersAsync { get; set; } = validateParametersAsync;
/// <summary>
/// Configure how the comment annotations will behave. `Ignore` will create all endpoints and ignore comment annotations. `ParseAll` (default) will create all endpoints and parse comment annotations to alter the endpoint. `OnlyWithHttpTag` will only create endpoints that contain the `HTTP` tag in the comments and then parse comment annotations.
/// </summary>
public CommentsMode CommentsMode { get; set; } = commentsMode;
/// <summary>
/// Configure how to send request headers to PostgreSQL routines execution. `Ignore` (default) don't send any request headers to routines. `Context` sets a context variable for the current session `context.headers` containing JSON string with current request headers. This executes `set_config('context.headers', headers, false)` before any routine executions. `Parameter` sends request headers to the routine parameter defined with the `RequestHeadersParameterName` option. Paremeter with this name must exist, must be one of the JSON or text types and must have the default value defined. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// </summary>
public RequestHeadersMode RequestHeadersMode { get; set; } = requestHeadersMode;
/// <summary>
/// Sets a parameter name that will receive a request headers JSON when the `Parameter` value is used in `RequestHeadersMode` options. A parameter with this name must exist, must be one of the JSON or text types and must have the default value defined. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// </summary>
public string RequestHeadersParameterName { get; set; } = requestHeadersParameterName;
/// <summary>
/// Callback, if defined will be executed after all endpoints are created and receive an array of routine info and endpoint info tuples `(Routine routine, RoutineEndpoint endpoint)`. Used mostly for code generation.
/// </summary>
public Action<(Routine routine, RoutineEndpoint endpoint)[]>? EndpointsCreated { get; set; } = endpointsCreated;
/// <summary>
/// Asynchronous callback function that will be called after every database command is created and before it has been executed. It receives a tuple parameter with routine info, created command and current HTTP context. Command instance and HTTP context offer the opportunity to execute the command and return a completely different, custom response format.
/// </summary>
public Func<(Routine routine, NpgsqlCommand command, HttpContext context), Task>? CommandCallbackAsync { get; set; } = commandCallbackAsync;
/// <summary>
/// List of `IEndpointCreateHandler` type handlers executed sequentially after endpoints are created. Used to add the different code generation plugins.
/// </summary>
public IEnumerable<IEndpointCreateHandler> EndpointCreateHandlers { get; set; } = endpointCreateHandlers ?? Array.Empty<IEndpointCreateHandler>();
/// <summary>
/// Action callback executed after routine sources are created and before they are processed into endpoints. Receives a parameter with the list of `IRoutineSource` instances. This list will always contain a single item - functions and procedures source. Use this callback to modify the routine source list and add new sources from plugins.
/// </summary>
public Action<List<IRoutineSource>> SourcesCreated { get; set; } = sourcesCreated ?? (s => { });
/// <summary>
/// Sets the default behavior of plain text responses when the execution returns the `NULL` value from the database. `EmptyString` (default) returns an empty string response with status code 200 OK. `NullLiteral` returns a string literal `NULL` with the status code 200 OK. `NoContent` returns status code 204 NO CONTENT. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// </summary>
public TextResponseNullHandling TextResponseNullHandling { get; set; } = textResponseNullHandling;
/// <summary>
/// Sets the default behavior on how to pass the `NULL` values with query strings. `EmptyString` empty string values are interpreted as `NULL` values. This limits sending empty strings via query strings. `NullLiteral` literal string values `NULL` (case insensitive) are interpreted as `NULL` values. `Ignore` (default) `NULL` values are ignored, query string receives only empty strings. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// </summary>
public QueryStringNullHandling QueryStringNullHandling { get; set; } = queryStringNullHandling;
/// <summary>
/// The number of rows to buffer in the string builder before sending the response. The default is 25.
/// This applies to rows in JSON object array when returning records from the database.
/// Set to 0 to disable buffering and write a response for each row.
/// Set to 1 to buffer the entire array (all rows).
/// Notes:
/// - Disabling buffering can have a slight negative impact on performance since buffering is far less expensive than writing to the response stream.
/// - Setting higher values can have a negative impact on memory usage, especially when returning large datasets.
/// </summary>
public ulong BufferRows { get; set; } = bufferRows;
/// <summary>
/// Default Authentication Options
/// </summary>
public NpgsqlRestAuthenticationOptions AuthenticationOptions { get; set; } = authenticationOptions ?? new();
/// <summary>
/// Set to true to return message from NpgsqlException on response body. Default is true.
/// </summary>
public bool ReturnNpgsqlExceptionMessage { get; set; } = returnNpgsqlExceptionMessage;
/// <summary>
/// Map PostgreSql Error Codes (see https://www.postgresql.org/docs/current/errcodes-appendix.html) to HTTP Status Codes
/// Default is 57014 query_canceled to 205 Reset Content.
/// </summary>
public Dictionary<string, int> PostgreSqlErrorCodeToHttpStatusCodeMapping { get; set; } = postgreSqlErrorCodeToHttpStatusCodeMapping ?? new()
{
{ "57014", 205 }, //query_canceled -> 205 Reset Content
};
/// <summary>
/// Callback executed immediately before connection is opened. Use this callback to adjust connection settings such as application name.
/// </summary>
public Action<NpgsqlConnection, Routine, RoutineEndpoint, HttpContext>? BeforeConnectionOpen { get; set; } = beforeConnectionOpen;
/// <summary>
/// Custom request headers dictionary that will be added to NpgsqlRest requests.
/// Note: these values are added to the request headers dictionary before they are sent as a context or parameter to the PostgreSQL routine and as such not visible to the browser debugger.
/// </summary>
public Dictionary<string, StringValues> CustomRequestHeaders { get; set; } = customRequestHeaders ?? [];
/// <summary>
/// Routine sources default list.
/// </summary>
public List<IRoutineSource> RoutineSources { get; set; } = routineSources ?? [new RoutineSource()];
/// <summary>
/// Enable refresh endpoint for Metadata.
/// </summary>
public bool RefreshEndpointEnabled { get; set; } = refreshEndpointEnabled;
/// <summary>
/// Refresh endpoint method.
/// </summary>
public string RefreshMethod { get; set; } = refreshMethod;
/// <summary>
/// Refresh endpoint path.
/// </summary>
public string RefreshPath { get; set; } = refreshPath;
}
You can’t perform that action at this time.