storages::postgres::ConnectionSettings Struct Reference

Table of Contents

• Public Types
• Public Member Functions
• Public Attributes
• Detailed Description
• Member Typedef Documentation
• SettingsVersion
• Member Enumeration Documentation
• CheckQueryParamsOptions
• PreparedStatementOptions
• UserTypesOptions
• Member Function Documentation
• operator!=()
• operator==()
• RequiresConnectionReset()
• Member Data Documentation
• ignore_unused_query_params
• max_prepared_cache_size
• pipeline_mode
• prepared_statements
• recent_errors_threshold
• user_types
• version

#include <userver/storages/postgres/options.hpp>

Public Types
enum	PreparedStatementOptions {   kCachePreparedStatements ,   kNoPreparedStatements }
enum	UserTypesOptions {   kUserTypesEnabled ,   kPredefinedTypesOnly }
enum	CheckQueryParamsOptions {   kIgnoreUnused ,   kCheckUnused }
using	SettingsVersion = size_t

Public Member Functions
bool	operator== (const ConnectionSettings &rhs) const
bool	operator!= (const ConnectionSettings &rhs) const
bool	RequiresConnectionReset (const ConnectionSettings &rhs) const

Public Attributes
PreparedStatementOptions	prepared_statements = kCachePreparedStatements
	Cache prepared statements or not.
UserTypesOptions	user_types = kUserTypesEnabled
	Enables the usage of user-defined types.
CheckQueryParamsOptions	ignore_unused_query_params = kCheckUnused
	Checks for not-NULL query params that are not used in query.
size_t	max_prepared_cache_size = kDefaultMaxPreparedCacheSize
	Limits the size or prepared statements cache.
PipelineMode	pipeline_mode = PipelineMode::kDisabled
	Turns on connection pipeline mode.
size_t	recent_errors_threshold = 2
	This many connection errors in 15 seconds block new connections opening.
SettingsVersion	version {0U}
	Helps keep track of the changes in settings.

Detailed Description

PostgreSQL connection options

Dynamic option POSTGRES_CONNECTION_SETTINGS

Definition at line 205 of file options.hpp.

Member Typedef Documentation

SettingsVersion

using storages::postgres::ConnectionSettings::SettingsVersion = size_t

Definition at line 218 of file options.hpp.

Member Enumeration Documentation

CheckQueryParamsOptions

enum storages::postgres::ConnectionSettings::CheckQueryParamsOptions

Definition at line 214 of file options.hpp.

PreparedStatementOptions

enum storages::postgres::ConnectionSettings::PreparedStatementOptions

Definition at line 206 of file options.hpp.

UserTypesOptions

enum storages::postgres::ConnectionSettings::UserTypesOptions

Definition at line 210 of file options.hpp.

Member Function Documentation

operator!=()

bool storages::postgres::ConnectionSettings::operator!= ( const ConnectionSettings &  rhs ) const

inline

Definition at line 250 of file options.hpp.

operator==()

bool storages::postgres::ConnectionSettings::operator== ( const ConnectionSettings &  rhs ) const

inline

Definition at line 241 of file options.hpp.

RequiresConnectionReset()

bool storages::postgres::ConnectionSettings::RequiresConnectionReset ( const ConnectionSettings &  rhs ) const

inline

Definition at line 254 of file options.hpp.

Member Data Documentation

ignore_unused_query_params

CheckQueryParamsOptions storages::postgres::ConnectionSettings::ignore_unused_query_params = kCheckUnused

Checks for not-NULL query params that are not used in query.

Definition at line 227 of file options.hpp.

max_prepared_cache_size

size_t storages::postgres::ConnectionSettings::max_prepared_cache_size = kDefaultMaxPreparedCacheSize

Limits the size or prepared statements cache.

Definition at line 230 of file options.hpp.

pipeline_mode

PipelineMode storages::postgres::ConnectionSettings::pipeline_mode = PipelineMode::kDisabled

Turns on connection pipeline mode.

Definition at line 233 of file options.hpp.

prepared_statements

PreparedStatementOptions storages::postgres::ConnectionSettings::prepared_statements = kCachePreparedStatements

Cache prepared statements or not.

Definition at line 221 of file options.hpp.

recent_errors_threshold

size_t storages::postgres::ConnectionSettings::recent_errors_threshold = 2

This many connection errors in 15 seconds block new connections opening.

Definition at line 236 of file options.hpp.

user_types

UserTypesOptions storages::postgres::ConnectionSettings::user_types = kUserTypesEnabled

Enables the usage of user-defined types.

Definition at line 224 of file options.hpp.

version

SettingsVersion storages::postgres::ConnectionSettings::version {0U}

Helps keep track of the changes in settings.

Definition at line 239 of file options.hpp.

---

The documentation for this struct was generated from the following file:

• userver/storages/postgres/options.hpp