/*

2.36.2

*/

{

//

// The application name used to set the application name property in connection string by "NpgsqlRest.SetApplicationNameInConnection" or the "NpgsqlRest.UseJsonApplicationName" settings.

// It is the name of the top-level directory if set to null.

//

"ApplicationName": null,

//

// Production or Development

//

"EnvironmentName": "Production",

//

// Specify the urls the web host will listen on. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.hosting.hostingabstractionswebhostbuilderextensions.useurls?view=aspnetcore-8.0

//

"Urls": "http://localhost:8080",

//

// Logs at startup, format placeholders:

// {time} - startup time

// {urls} - listening on urls

// {version} - current version

// {environment} - EnvironmentName

// {application} - ApplicationName

//

// Note: This message is logged at Information level. To disable this message, set to empty string.

//

"StartupMessage": "Started in {time}, listening on {urls}, version {version}",

//

// Configuration settings

//

"Config": {

//

// Expose current configuration to the endpoint for debugging and inspection. Note, the password in the connection string is not exposed.

// "ExposeAsEndpoint": "/config" or set to null to disable.

//

"ExposeAsEndpoint": null,

//

// Add the environment variables to configuration.

// When enabled, environment variables will override the settings in this configuration file but can be overridden by command line arguments.

// Complex hierarchical keys can be defined using double underscore as a separator.

// For example, "ConnectionStrings__Default" environment variable will override the "ConnectionStrings.Default" setting in this configuration file.

//

"AddEnvironmentVariables": false,

//

// When set, configuration values will be parsed for environment variables in the format {ENV_VAR_NAME}

// and replaced with the value of the environment variable when available.

//

"ParseEnvironmentVariables": true

},

//

// List of named connection strings to PostgreSQL databases.

// The "Default" connection string is used when no connection name is specified.

// For connection string definition see https://www.npgsql.org/doc/connection-string-parameters.html

//

"ConnectionStrings": {

"Default": "Host={PGHOST};Port=5432;Database={PGDATABASE};Username={PGUSER};Password={PGPASSWORD}"

},

"ConnectionSettings": {

//

// Sets the ApplicationName connection property in the connection string to the value of the ApplicationName configuration.

// Note: This option is ignored if the UseJsonApplicationName option is enabled.

//

"SetApplicationNameInConnection": true,

//

// Sets the ApplicationName connection property dynamically on every request in the following format:

// {"app": [Application Name], "uid": [UserId for authenticated users or NULL], "id": [Value of X-Execution-Id request header or NULL]}

// Note: The ApplicationName connection property is limited to 64 characters.

//

"UseJsonApplicationName": false,

//

// Test any connection string before initializing the application and using it. The connection string is tested by opening and closing the connection.

//

"TestConnectionStrings": true,

//

// Connection open retry options.

//

"RetryOptions": {

"Enabled": true,

//

// Retry sequence in seconds. Accepts decimal numbers (0.25 is quarter of a second). The length of the array determines the maximum number of retries.

//

"RetrySequenceSeconds": [1, 3, 6, 12],

//

// Error codes that will trigger a retry when opening a connection. See https://www.postgresql.org/docs/current/errcodes-appendix.html

//

"ErrorCodes": [

"08000", "08003", "08006", "08001", "08004", // Connection failure codes

"55P03", // Lock not available

"55006", // Object in use

"53300", // Too many connections

"57P03", // Cannot connect now

"40001" // Serialization failure (can be retried)

]

}

},

//

// Enable to invoke UseKestrelHttpsConfiguration. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.hosting.webhostbuilderkestrelextensions.usekestrelhttpsconfiguration?view=aspnetcore-8.0

//

"Ssl": {

"Enabled": false,

//

// Adds middleware for redirecting HTTP Requests to HTTPS. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.httpspolicybuilderextensions.usehttpsredirection?view=aspnetcore-8.0

//

"HttpsRedirection": true,

//

// Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.hstsbuilderextensions.usehsts?view=aspnetcore-2.1

//

"UseHsts": true

},

//

// Data protection settings. Encryption/decryption settings for Auth Cookies, Antiforgery tokens and custom data protection needs.

//

"DataProtection": {

"Enabled": true,

//

// Set to null to use the current "ApplicationName" value.

// This value determines encryption type or class. Meaning, different application names will not be able to decrypt each other's data.

//

"CustomApplicationName": null,

//

// Sets the default lifetime in days of keys created by the data protection system.

// Represents a number of days how long before keys are rotated.

//

"DefaultKeyLifetimeDays": 90,

//

// Data protection location: "Default", "FileSystem" or "Database"

//

// Note: When running on Linux, using Default location means keys will not be persisted.

// When keys are lost on restart, encrypted tokens (auth) will also not work on restart.

// Linux users should use FileSystem or Database storage.

//

"Storage": "Default",

//

// FileSystem storage path. Set to a valid path when using FileSystem.

// Note: When running in Docker environment, the path must be a Docker volume path to persist the keys.

//

"FileSystemPath": "./data-protection-keys",

//

// GetAllElements database command. Expected to return rows with a single column of type text.

//

"GetAllElementsCommand": "select get_data_protection_keys()",

//

// StoreElement database command. Receives two parameters: name and data of type text. Doesn't return anything.

//

"StoreElementCommand": "call store_data_protection_keys($1,$2)",

//

// Configure encryption algorithms for data protection keys or null to use the default algorithm.

// Values: AES_128_CBC, AES_192_CBC, AES_256_CBC, AES_128_GCM, AES_192_GCM, AES_256_GCM

//

"EncryptionAlgorithm": null,

//

// Configure validation algorithms for data protection keys or null to use the default algorithm.

// Values: HMACSHA256, HMACSHA512

//

"ValidationAlgorithm": null

},

//

// Uncomment to configure Kestrel web server and to add certificates

// See https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel/endpoints?view=aspnetcore-9.0

//

"Kestrel": {

// "Endpoints": {

// "Http": {

// "Url": "http://localhost:5000"

// },

// "HttpsInlineCertFile": {

// "Url": "https://localhost:5001",

// "Certificate": {

// "Path": "<path to .pfx file>",

// "Password": "$CREDENTIAL_PLACEHOLDER$"

// }

// },

// "HttpsInlineCertAndKeyFile": {

// "Url": "https://localhost:5002",

// "Certificate": {

// "Path": "<path to .pem/.crt file>",

// "KeyPath": "<path to .key file>",

// "Password": "$CREDENTIAL_PLACEHOLDER$"

// }

// },

// "HttpsInlineCertStore": {

// "Url": "https://localhost:5003",

// "Certificate": {

// "Subject": "<subject; required>",

// "Store": "<certificate store; required>",

// "Location": "<location; defaults to CurrentUser>",

// "AllowInvalid": "<true or false; defaults to false>"

// }

// },

// "HttpsDefaultCert": {

// "Url": "https://localhost:5004"

// }

// },

// "Certificates": {

// "Default": {

// "Path": "<path to .pfx file>",

// "Password": "$CREDENTIAL_PLACEHOLDER$"

// }

// },

// "Limits": {

// "MaxConcurrentConnections": 100,

// "MaxConcurrentUpgradedConnections": 100,

// "MaxRequestBodySize": 30000000,

// "MaxRequestBufferSize": 1048576,

// "MaxRequestHeaderCount": 100,

// "MaxRequestHeadersTotalSize": 32768,

// "MaxRequestLineSize": 8192,

// "MaxResponseBufferSize": 65536,

// "KeepAliveTimeout": "00:02:00",

// "RequestHeadersTimeout": "00:00:30",

// "Http2": {

// "MaxStreamsPerConnection": 100,

// "HeaderTableSize": 4096,

// "MaxFrameSize": 16384,

// "MaxRequestHeaderFieldSize": 8192,

// "InitialConnectionWindowSize": 65535,

// "InitialStreamWindowSize": 65535,

// "MaxReadFrameSize": 16384,

// "KeepAlivePingDelay": "00:00:30",

// "KeepAlivePingTimeout": "00:01:00",

// "KeepAlivePingPolicy": "WithActiveRequests"

// },

// "Http3": {

// "MaxRequestHeaderFieldSize": 8192

// }

// },

// "DisableStringReuse": false,

// "AllowAlternateSchemes": false,

// "AllowSynchronousIO": false,

// "AllowResponseHeaderCompression": true,

// "AddServerHeader": true,

// "AllowHostHeaderOverride": false

},

//

// Thread pool configuration settings for optimizing application performance

//

"ThreadPool": {

//

// Minimum number of worker threads in the thread pool. Set to null to use system defaults.

//

"MinWorkerThreads": null,

//

// Minimum number of completion port threads. Set to null to use system defaults.

//

"MinCompletionPortThreads": null,

//

// Maximum number of worker threads in the thread pool. Set to null to use system defaults.

//

"MaxWorkerThreads": null,

//

// Maximum number of completion port threads. Set to null to use system defaults.

//

"MaxCompletionPortThreads": null

},

//

// Authentication and Authorization settings

//

"Auth": {

//

// Enable Cookie Auth

//

"CookieAuth": false,

//

// Authentication scheme name for cookie authentication. Set to null to use default.

//

"CookieAuthScheme": null,

//

// Number of days the cookie remains valid.

//

"CookieValidDays": 14,

//

// Custom name for the authentication cookie. Set to null to use default.

//

"CookieName": null,

//

// Path scope for the authentication cookie. Set to null to use default.

//

"CookiePath": null,

//

// Domain scope for the authentication cookie. Set to null to use default.

//

"CookieDomain": null,

//

// Allow multiple concurrent sessions for the same user.

//

"CookieMultiSessions": true,

//

// Make cookie accessible only via HTTP (not JavaScript).

//

"CookieHttpOnly": true,

//

// Enable Microsoft Bearer Token Auth

//

"BearerTokenAuth": false,

//

// Authentication scheme name for bearer token authentication. Set to null to use default.

//

"BearerTokenAuthScheme": null,

//

// Number of hours before bearer token expires.

//

"BearerTokenExpireHours": 1,

// POST { "refresh": "{{refreshToken}}" }

"BearerTokenRefreshPath": "/api/token/refresh",

//

// Enable external auth providers

//

"External": {

"Enabled": false,

//

// sessionStorage key to store the status of the external auth process returned by the signin page.

// The value is HTTP status code (200 for success, 401 for unauthorized, 403 for forbidden, etc.)

//

"BrowserSessionStatusKey": "__external_status",

//

// sessionStorage key to store the message of the external auth process returned by the signin page.

//

"BrowserSessionMessageKey": "__external_message",

//

// Path to the signin page to handle the external auth process. Redirect to this page to start the external auth process.

// Format placeholder {0} is the provider name in lowercase (google, linkedin, github, etc.)

//

"SigninUrl": "/signin-{0}",

//

// Sign in page template. Format placeholders {0} is the provider name, {1} is the script to redirect to the external auth provider.

//

"SignInHtmlTemplate": "<!DOCTYPE html><html><head><meta charset=\"utf-8\" /><title>Talking To {0}</title></head><body>Loading...{1}</body></html>",

//

// URL to redirect after the external auth process is completed. Usually this is resolved from the request automatically. Except when it's not.

//

"RedirectUrl": null,

//

// Path to redirect after the external auth process is completed.

//

"ReturnToPath": "/",

//

// Query string key to store the path to redirect after the external auth process is completed.

// Use this to set dynamic return path. If this query string key is not found, the ReturnToPath value is used.

//

"ReturnToPathQueryStringKey": "return_to",

//

// Login command to execute after the external auth process is completed. There are five positional and optional parameters:

// $1 - external login provider (if parameter exists, type text).

// $2 - external login email (if parameter exists, type text).

// $3 - external login name (if parameter exists, type text).

// $4 - external login json data received (if parameter exists, type text, json or jsonb).

// $5 - client browser analytics json data (if parameter exists, type text, json or jsonb).

//

// The command uses the same rules as the login enabled routine.

// See: "NpgsqlRest.“LoginPath"

//

"LoginCommand": "select * from external_login($1,$2,$3,$4,$5)",

//

// Browser client analytics data that will be sent as JSON to external auth command as the 5th parameter if supplied.

//

"ClientAnalyticsData": "{timestamp:new Date().toISOString(),timezone:Intl.DateTimeFormat().resolvedOptions().timeZone,screen:{width:window.screen.width,height:window.screen.height,colorDepth:window.screen.colorDepth,pixelRatio:window.devicePixelRatio,orientation:screen.orientation.type},browser:{userAgent:navigator.userAgent,language:navigator.language,languages:navigator.languages,cookiesEnabled:navigator.cookieEnabled,doNotTrack:navigator.doNotTrack,onLine:navigator.onLine,platform:navigator.platform,vendor:navigator.vendor},memory:{deviceMemory:navigator.deviceMemory,hardwareConcurrency:navigator.hardwareConcurrency},window:{innerWidth:window.innerWidth,innerHeight:window.innerHeight,outerWidth:window.outerWidth,outerHeight:window.outerHeight},location:{href:window.location.href,hostname:window.location.hostname,pathname:window.location.pathname,protocol:window.location.protocol,referrer:document.referrer},performance:{navigation:{type:performance.navigation?.type,redirectCount:performance.navigation?.redirectCount},timing:performance.timing?{loadEventEnd:performance.timing.loadEventEnd,loadEventStart:performance.timing.loadEventStart,domComplete:performance.timing.domComplete,domInteractive:performance.timing.domInteractive,domContentLoadedEventEnd:performance.timing.domContentLoadedEventEnd}:null}}",

//

// Client IP address that will be added to the client analytics data under this JSON key.

//

"ClientAnalyticsIpKey": "ip",

//

// External providers

//

"Google": {

//

// visit https://console.cloud.google.com/apis/ to configure your Google app and get your client id and client secret

//

"Enabled": false,

"ClientId": "",

"ClientSecret": "",

"AuthUrl": "https://accounts.google.com/o/oauth2/v2/auth?response_type=code&client_id={0}&redirect_uri={1}&scope=openid profile email&state={2}",

"TokenUrl": "https://oauth2.googleapis.com/token",

"InfoUrl": "https://www.googleapis.com/oauth2/v3/userinfo",

"EmailUrl": null

},

"LinkedIn": {

//

// visit https://www.linkedin.com/developers/apps/ to configure your LinkedIn app and get your client id and client secret

//

"Enabled": false,

"ClientId": "",

"ClientSecret": "",

"AuthUrl": "https://www.linkedin.com/oauth/v2/authorization?response_type=code&client_id={0}&redirect_uri={1}&state={2}&scope=r_liteprofile%20r_emailaddress",

"TokenUrl": "https://www.linkedin.com/oauth/v2/accessToken",

"InfoUrl": "https://api.linkedin.com/v2/me",

"EmailUrl": "https://api.linkedin.com/v2/emailAddress?q=members&projection=(elements//(handle~))"

},

"GitHub": {

//

// visit https://github.com/settings/developers/ to configure your GitHub app and get your client id and client secret

//

"Enabled": false,

"ClientId": "",

"ClientSecret": "",

"AuthUrl": "https://github.com/login/oauth/authorize?client_id={0}&redirect_uri={1}&state={2}&allow_signup=false",

"TokenUrl": "https://github.com/login/oauth/access_token",

"InfoUrl": "https://api.github.com/user",

"EmailUrl": null

},

"Microsoft": {

//

// visit https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade to configure your Microsoft app and get your client id and client secret

// Documentation: https://learn.microsoft.com/en-us/entra/identity-platform/

//

"Enabled": false,

"ClientId": "",

"ClientSecret": "",

"AuthUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?response_type=code&client_id={0}&redirect_uri={1}&scope=openid%20profile%20email&state={2}",

"TokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token",

"InfoUrl": "https://graph.microsoft.com/oidc/userinfo",

"EmailUrl": null

},

"Facebook": {

//

// visit https://developers.facebook.com/apps/ to configure your Facebook app and get your client id and client secret

// Documentation: https://developers.facebook.com/docs/facebook-login/

//

"Enabled": false,

"ClientId": "",

"ClientSecret": "",

"AuthUrl": "https://www.facebook.com/v20.0/dialog/oauth?response_type=code&client_id={0}&redirect_uri={1}&scope=public_profile%20email&state={2}",

"TokenUrl": "https://graph.facebook.com/v20.0/oauth/access_token",

"InfoUrl": "https://graph.facebook.com/me?fields=id,name,email",

"EmailUrl": null

}

}

},

//

// Serilog settings

//

"Log": {

//

// See https://github.com/serilog/serilog/wiki/Configuration-Basics#minimum-level

// Verbose, Debug, Information, Warning, Error, Fatal.

// Note: NpgsqlRest logger applies to main application logger, which will, by default have the name defined in the ApplicationName setting.

//

"MinimalLevels": {

"NpgsqlRest": "Information",

"System": "Warning",

"Microsoft": "Warning"

},

//

// Enable logging to console output.

//

"ToConsole": true,

//

// Minimum log level for console output: Verbose, Debug, Information, Warning, Error, Fatal.

//

"ConsoleMinimumLevel": "Verbose",

//

// Enable logging to file system.

//

"ToFile": false,

//

// File path for log files.

//

"FilePath": "logs/log.txt",

//

// Maximum size limit for log files in bytes before rolling to a new file.

//

"FileSizeLimitBytes": 30000000,

//

// Minimum log level for file output: Verbose, Debug, Information, Warning, Error, Fatal.

//

"FileMinimumLevel": "Verbose",

//

// Maximum number of log files to retain.

//

"RetainedFileCountLimit": 30,

//

// Create a new log file when size limit is reached.

//

"RollOnFileSizeLimit": true,

//

// Enable logging to PostgreSQL database.

//

"ToPostgres": false,

// $1 - log level text, $2 - message text, $3 - timestamp with tz in utc, $4 - exception text or null, $5 - source context

//

// PostgreSQL command to execute for database logging. Parameters: $1=level, $2=message, $3=timestamp, $4=exception, $5=source.

//

"PostgresCommand": "call log($1,$2,$3,$4,$5)",

//

// Minimum log level for PostgreSQL output: Verbose, Debug, Information, Warning, Error, Fatal.

//

"PostgresMinimumLevel": "Verbose",

//

// Enable OpenTelemetry protocol (OTLP) logging output. Requires an OTLP collector endpoint.

//

"ToOpenTelemetry": false,

"OTLPEndpoint": "http://localhost:4317",

"OTLPProtocol": "Grpc", // "Grpc" or "HttpProtobuf"

"OTLResourceAttributes": {

"service.name": "{application}", // application name from the ApplicationName setting

"service.version": "1.0", // application version, set to a static value or use a build process to update it

"service.environment": "{environment}" // environment name from the EnvironmentName setting

},

"OTLPHeaders": {},

"OTLPMinimumLevel": "Verbose",

//

// See https://github.com/serilog/serilog/wiki/Formatting-Output

//

"OutputTemplate": "[{Timestamp:HH:mm:ss.fff} {Level:u3}] {Message:lj} [{SourceContext}]{NewLine}{Exception}"

},

//

// Response compression settings

//

"ResponseCompression": {

//

// Enable response compression for HTTP responses.

//

"Enabled": false,

//

// Enable response compression for HTTPS responses.

//

"EnableForHttps": false,

//

// Use Brotli compression algorithm when supported by client.

//

"UseBrotli": true,

//

// Use Gzip compression as fallback when Brotli is not supported.

//

"UseGzipFallback": true,

//

// Compression level: Optimal, Fastest, NoCompression, SmallestSize.

//

"CompressionLevel": "Optimal",

//

// MIME types to include for compression.

//

"IncludeMimeTypes": [

"text/plain",

"text/css",

"application/javascript",

"text/html",

"application/xml",

"text/xml",

"application/json",

"text/json",

"image/svg+xml",

"font/woff",

"font/woff2",

"application/font-woff",

"application/font-woff2"

],

//

// MIME types to exclude from compression.

//

"ExcludeMimeTypes": []

},

//

// Antiforgery Token Configuration: Protects against Cross-Site Request Forgery (CSRF) attacks by validating unique tokens for state-changing requests (POST, PUT, DELETE, etc.)

//

"Antiforgery": {

"Enabled": false,

// Use null to use the default cookie name (unique for every request and starts with ".AspNetCore.Antiforgery.")

"CookieName": null,

// Name of the hidden form field containing the antiforgery token

"FormFieldName": "__RequestVerificationToken",

// HTTP header name where the token can be sent (useful for AJAX requests)

"HeaderName": "RequestVerificationToken",

// When true, skips reading tokens from form body (forces header-only validation)

"SuppressReadingTokenFromFormBody": false,

// When true, disables automatic X-Frame-Options header generation

// The X-Frame-Options header helps prevent clickjacking attacks

// Only set to true if you're handling frame protection elsewhere

"SuppressXFrameOptionsHeader": false

},

//

// Static files settings

//

"StaticFiles": {

"Enabled": false,

"RootPath": "wwwroot",

//

// List of static file patterns that will require authorization.

// File paths are relative to the RootPath property and pattern matching is case-insensitive.

// Pattern can include wildcards or question marks. For example: *.html, /user/*, etc

//

"AuthorizePaths": [],

"UnauthorizedRedirectPath": "/",

"UnauthorizedReturnToQueryParameter": "return_to",

"ParseContentOptions": {

//

// Enable or disable the parsing of the static files.

// When enabled, the static files will be parsed and the tags will be replaced with the values from the claims collection.

// The tags are in the format: {claimType} where claimType is the name of the claim that will be replaced with the value from the claims collection.

//

"Enabled": false,

//

// List of claims types used. These will be parsed to NULL if not found in the claims collection or user is not authenticated.

//

"AvailableClaims": [],

//

// Set to true to cache the parsed files in memory. This will improve the performance of the static files. It only applies to parsed content.

// Note: caching will occur before parsing, it applies only to templates, not parsed content.

//

"CacheParsedFile": true,

//

// Headers to be added to the response for static files. Set to null or empty array to ignore.

//

"Headers": [ "Cache-Control: no-store, no-cache, must-revalidate", "Pragma: no-cache", "Expires: 0" ],

//

// List of static file patterns that will parse the content and replace the tags with the values from the claims collection.

// File paths are relative to the RootPath property and pattern matching is case-insensitive.

// Pattern can include wildcards or question marks. For example: *.html, *.htm, *.txt, *.json, *.xml, *.css, *.js

//

"FilePaths": [ "*.html" ],

//

// Name of the configured Antiforgery form field name to be used in the static files (see Antiforgery FormFieldName setting).

//

"AntiforgeryFieldName": "antiForgeryFieldName",

//

// Value of the Antiforgery token if Antiforgery is enabled.

//

"AntiforgeryToken": "antiForgeryToken"

}

},

//

// Cross-origin resource sharing

//

"Cors": {

//

// Enable Cross-Origin Resource Sharing (CORS) support.

//

"Enabled": false,

//

// List of allowed origins for CORS requests. Empty array allows no origins.

//

"AllowedOrigins": [],

//

// List of allowed HTTP methods for CORS requests.

//

"AllowedMethods": [

"*"

],

//

// List of allowed headers for CORS requests.

//

"AllowedHeaders": [

"*"

],

//

// Allow credentials (cookies, authorization headers) in CORS requests.

//

"AllowCredentials": true,

//

// Maximum age in seconds for preflight request caching (10 minutes).

//

"PreflightMaxAgeSeconds": 600

},

//

// Command retry strategies and options for client and middleware commands.

//

"CommandRetryOptions": {

"Enabled": true,

"DefaultStrategy": "default",

"Strategies": {

"default": {

//

// Retry sequence in seconds. Accepts decimal numbers (0.25 is quarter of a second). The length of the array determines the maximum number of retries.

//

"RetrySequenceSeconds": [0, 1, 2, 5, 10],

//

// Error codes that will trigger a retry when executing a command. See https://www.postgresql.org/docs/current/errcodes-appendix.html

//

"ErrorCodes": [

// Serialization failures (MUST retry for correctness)

"40001", // serialization_failure

"40P01", // deadlock_detected

// Connection issues (Class 08)

"08000", // connection_exception

"08003", // connection_does_not_exist

"08006", // connection_failure

"08001", // sqlclient_unable_to_establish_sqlconnection

"08004", // sqlserver_rejected_establishment_of_sqlconnection

"08007", // transaction_resolution_unknown

"08P01", // protocol_violation

// Resource constraints (Class 53)

"53000", // insufficient_resources

"53100", // disk_full

"53200", // out_of_memory

"53300", // too_many_connections

"53400", // configuration_limit_exceeded

// System errors (Class 58)

"57P01", // admin_shutdown

"57P02", // crash_shutdown

"57P03", // cannot_connect_now

"58000", // system_error

"58030", // io_error

// Lock acquisition issues (Class 55)

"55P03", // lock_not_available

"55006", // object_in_use

"55000" // object_not_in_prerequisite_state

]

}

}

},

//

// Caching options for routines that support caching. Currently, routines that return a single result set can be cached. Returning table or "setof" cannot be cached.

// To enable caching for a routine, add the following comment annotation to the routine:

// cached [ param1, param2, param3 [, ...] ] - parameters are optional, if no parameters are specified, all parameters are used for cache key.

// cache_expires [ value ] or cache_expires_in [ value ] - accepts PostgreSQL interval format (for example: '5 minutes' or '5min', '1 second' or '1s', etc.). Default is forever (no expiration).

//

"CacheOptions": {

"Enabled": false,

"Type": "Memory", // Memory or Redis

//

// When memory cache is used, this value determines how often the cache will be pruned for expired items (in seconds).

//

"MemoryCachePruneIntervalSeconds": 60,

//

// Redis configuration string. Only used when CacheType is set to Redis.

// See: https://stackexchange.github.io/StackExchange.Redis/Configuration.html

//

"RedisConfiguration": "localhost:6379,abortConnect=false,ssl=false,connectTimeout=10000,syncTimeout=5000,connectRetry=3"

},

//

// NpgsqlRest HTTP Middleware General Configuration

//

"NpgsqlRest": {

//

// Connection name to be used from the ConnectionStrings section or NULL to use the first available connection string.

//

"ConnectionName": null,

//

// Allow using multiple connections from the ConnectionStrings section. When set to true, the connection name can be set for individual Routines.

// Some routines might use the primary database connection string, while others might want to use a read-only connection string from the replica servers.

//

"UseMultipleConnections": false,

//

// Filter schema names similar to this parameter or `null` to ignore this parameter.

//

"SchemaSimilarTo": null,

//

// Filter schema names NOT similar to this parameter or `null` to ignore this parameter.

//

"SchemaNotSimilarTo": null,

//

// List of schema names to be included or `null` to ignore this parameter.

//

"IncludeSchemas": null,

//

// List of schema names to be excluded or `null` to ignore this parameter.

//

"ExcludeSchemas": null,

//

// Filter names similar to this parameter or `null` to ignore this parameter.

//

"NameSimilarTo": null,

//

// Filter names NOT similar to this parameter or `null` to ignore this parameter.

//

"NameNotSimilarTo": null,

//

// List of names to be included or `null` to ignore this parameter.

//

"IncludeNames": null,

//

// List of names to be excluded or `null` to ignore this parameter.

//

"ExcludeNames": null,

//

// Configure how the comment annotations will behave. `Ignore` will create all endpoints and ignore comment annotations. `ParseAll` will create all endpoints and parse comment annotations to alter the endpoint. `OnlyWithHttpTag` (default) will only create endpoints that contain the `HTTP` tag in the comments and then parse comment annotations.

//

"CommentsMode": "OnlyWithHttpTag",

//

// The URL prefix string for every URL created by the default URL builder or `null` to ignore the URL prefix.

//

"UrlPathPrefix": "/api",

//

// Convert all URL paths to kebab-case from the original PostgreSQL names.

//

"KebabCaseUrls": true,

//

// Convert all parameter names to camel case from the original PostgreSQL paramater names.

//

"CamelCaseNames": true,

//

// 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.

//

"RequiresAuthorization": true,

//

// Log endpoint created events in debug level.

//

"LogEndpointCreatedInfo": true,

//

// When this value is true, all changes in the endpoint properties that are set from the comment annotations will be logged in debug level.

//

"LogAnnotationSetInfo": true,

//

// When this value is true, all connection events are logged (depending on the level). This is usually triggered by the PostgreSQL RAISE statements.

// Set to false to turn off logging these events.

//

"LogConnectionNoticeEvents": true,

//

// MessageOnly - Log only connection messages. FirstStackFrameAndMessage - Log first stack frame and the message. FullStackAndMessage - Log full stack trace and message.

//

"LogConnectionNoticeEventsMode": "FirstStackFrameAndMessage",

//

// Set this option to true to log information for every executed command and query (including parameters and parameter values) in debug level.

//

"LogCommands": false,

//

// Set this option to true to include parameter values when logging commands. This only applies when `LogCommands` is true.

//

"LogCommandParameters": false,

//

// 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.

//

"CommandTimeout": null,

//

// 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.

//

"DefaultHttpMethod": null,

//

// 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` (parameters 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.

//

"DefaultRequestParamType": null,

//

// 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. 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.

//

"RequestHeadersMode": "Parameter",

//

// Name of the context variable that will receive the request headers when RequestHeadersMode is set to Context.

//

"RequestHeadersContextKey": "request.headers",

//

// 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.

//

"RequestHeadersParameterName": "_headers",

//

// Set to true to return message from NpgsqlException on response body. Default is true.

//

"ReturnNpgsqlExceptionMessage": true,

//

// 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.

//

"PostgreSqlErrorCodeToHttpStatusCodeMapping": {

"57014": 205,

"P0001": 400, // PL/pgSQL raise exception

"P0004": 400 // PL/pgSQL assert failure

},

//

// Add the unique NpgsqlRest instance id request header with this name to the response or set to null to ignore.

//

"InstanceIdRequestHeaderName": null,

//

// 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.

//

"CustomRequestHeaders": {

},

//

// Name of the request ID header that will be used to track requests. This is used to correlate requests with server event streaming connection ids.

//

"ExecutionIdHeaderName": "X-NpgsqlRest-ID",

//

// Collection of custom server-sent events response headers that will be added to the response when connected to the endpoint that is configured to return server-sent events.

//

"CustomServerSentEventsResponseHeaders": {

},

//

// Options for handling PostgreSQL routines (functions and procedures)

//

"RoutineOptions": {

//

// Name separator for parameter names when using custom type parameters.

// Parameter names will be in the format: {ParameterName}{CustomTypeParameterSeparator}{CustomTypeFieldName}. When NULL, default underscore is used.

// This is used when using custom types for parameters. For example: with "create type custom_type1 as (value text);" and parameter "_p custom_type1", this name will be merged into "_p_value"

//

"CustomTypeParameterSeparator": null,

//

// List of PostgreSQL routine language names to include. If NULL, all languages are included. Names are case-insensitive.

//

"IncludeLanguages": null,

//

// List of PostgreSQL routine language names to exclude. If NULL, "C" and "INTERNAL" are excluded by default. Names are case-insensitive.

//

"ExcludeLanguages": null

},

//

// Options for different upload handlers and general upload settings

//

"UploadOptions": {

"Enabled": false,

"LogUploadEvent": true,

"LogUploadParameters": false,

//

// Handler that will be used when upload handler or handlers are not specified.

//

"DefaultUploadHandler": "large_object",

//

// Gets or sets a value indicating whether the default upload metadata parameter should be used.

//

"UseDefaultUploadMetadataParameter": false,

//

// Name of the default upload metadata parameter. This parameter is used to pass metadata to the upload handler. The metadata is passed as a JSON object.

//

"DefaultUploadMetadataParameterName": "_upload_metadata",

//

// Gets or sets a value indicating whether the default upload metadata context key should be used.

//

"UseDefaultUploadMetadataContextKey": false,

//

// Name of the default upload metadata context key. This key is used to pass the metadata to the upload handler. The metadata is passed as a JSON object.

//

"DefaultUploadMetadataContextKey": "request.upload_metadata",

//

// Upload handlers specific settings.

//

"UploadHandlers": {

//

// General settings for all upload handlers

//

"StopAfterFirstSuccess": false,

// csv string containing mime type patters, set to null to ignore

"IncludedMimeTypePatterns": null,

// csv string containing mime type patters, set to null to ignore

"ExcludedMimeTypePatterns": null,

"BufferSize": 8192, // Buffer size for the upload handlers file_system and large_object, in bytes. Default is 8192 bytes (8 KB).

"TextTestBufferSize": 4096, // Buffer sample size for testing textual content, in bytes. Default is 4096 bytes (4 KB).

"TextNonPrintableThreshold": 5, // Threshold for non-printable characters in the text buffer. Default is 5 non-printable characters.

"AllowedImageTypes": "jpeg, png, gif, bmp, tiff, webp", // Comma-separated list of allowed image types when checking images.

//

// Enables upload handlers for the NpgsqlRest endpoints that uses PostgreSQL Large Objects API

//

"LargeObjectEnabled": true,

"LargeObjectKey": "large_object",

"LargeObjectCheckText": false,

"LargeObjectCheckImage": false,

//

// Enables upload handlers for the NpgsqlRest endpoints that uses file system

//

"FileSystemEnabled": true,

"FileSystemKey": "file_system",

"FileSystemPath": "/tmp/uploads",

"FileSystemUseUniqueFileName": true,

"FileSystemCreatePathIfNotExists": true,

"FileSystemCheckText": false,

"FileSystemCheckImage": false,

//

// Enables upload handlers for the NpgsqlRest endpoints that uploads CSV files to a row command

//

"CsvUploadEnabled": true,

"CsvUploadCheckFileStatus": true,

"CsvUploadDelimiterChars": ",",

"CsvUploadHasFieldsEnclosedInQuotes": true,

"CsvUploadSetWhiteSpaceToNull": true,

//

// $1 - row index (1-based), $2 - parsed value text array, $3 - result of previous row command, $4 - json metadata for upload

//

"CsvUploadRowCommand": "call process_csv_row($1,$2,$3,$4)",

//

// Enables upload handlers for the NpgsqlRest endpoints that uploads Excel files to a row command

//

"ExcelUploadEnabled": true,

"ExcelKey": "excel",

"ExcelSheetName": null, // null to use the first available

"ExcelAllSheets": false,

"ExcelTimeFormat": "HH:mm:ss",

"ExcelDateFormat": "yyyy-MM-dd",

"ExcelDateTimeFormat": "yyyy-MM-dd HH:mm:ss",

"ExcelRowDataAsJson": false,

//

// $1 - row index (1-based), $2 - parsed value text array, $3 - result of previous row command, $4 - json metadata for upload

//

"ExcelUploadRowCommand": "call process_excel_row($1,$2,$3,$4)"

}

},

//

// Options for refresh metadata endpoint

//

"RefreshOptions": {