Fluent builder for constructing database connection strings. More...

#include <connection_string_builder.h>

Collaboration diagram for database::integrated::connection_string_builder:

Public Member Functions
	connection_string_builder ()=default

	~connection_string_builder ()=default

	connection_string_builder (const connection_string_builder &)=default

connection_string_builder &	operator= (const connection_string_builder &)=default

	connection_string_builder (connection_string_builder &&) noexcept=default

connection_string_builder &	operator= (connection_string_builder &&) noexcept=default

connection_string_builder &	host (std::string_view h)
	Set the database host.

connection_string_builder &	port (uint16_t p)
	Set the database port.

connection_string_builder &	database (std::string_view db)
	Set the database name.

connection_string_builder &	user (std::string_view u)
	Set the username for authentication.

connection_string_builder &	password (std::string_view p)
	Set the password for authentication.

connection_string_builder &	ssl_mode (enum ssl_mode mode)
	Set the SSL connection mode.

connection_string_builder &	connect_timeout (uint32_t seconds)
	Set the connection timeout.

connection_string_builder &	application_name (std::string_view name)
	Set the application name (for PostgreSQL)

connection_string_builder &	in_memory ()
	Configure SQLite to use in-memory database.

connection_string_builder &	option (std::string_view key, std::string_view value)
	Add a custom option.

kcenon::common::Result< std::string >	build (backend_type type) const
	Build the connection string for the specified backend.

connection_string_builder &	reset ()
	Reset the builder to initial state.

Private Member Functions
kcenon::common::Result< std::string >	build_postgres () const

kcenon::common::Result< std::string >	build_sqlite () const

kcenon::common::Result< std::string >	build_mongodb () const

kcenon::common::Result< std::string >	build_redis () const

Static Private Member Functions
static std::string	ssl_mode_to_postgres_string (enum ssl_mode mode)

Private Attributes
std::optional< std::string >	host_

std::optional< uint16_t >	port_

std::optional< std::string >	database_

std::optional< std::string >	user_

std::optional< std::string >	password_

std::optional< enum ssl_mode >	ssl_mode_

std::optional< uint32_t >	connect_timeout_

std::optional< std::string >	application_name_

bool	in_memory_ = false

std::vector< std::pair< std::string, std::string > >	custom_options_

Detailed Description

Fluent builder for constructing database connection strings.

This class provides a type-safe way to build connection strings for different database backends. It validates required fields per backend and generates properly formatted connection strings.

Thread Safety: This class is not thread-safe. Each thread should use its own builder instance.

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 76 of file connection_string_builder.h.

Constructor & Destructor Documentation

◆ connection_string_builder() [1/3]

database::integrated::connection_string_builder::connection_string_builder ( )

default

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

◆ ~connection_string_builder()

database::integrated::connection_string_builder::~connection_string_builder ( )

default

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

◆ connection_string_builder() [2/3]

database::integrated::connection_string_builder::connection_string_builder ( const connection_string_builder & )

default

◆ connection_string_builder() [3/3]

database::integrated::connection_string_builder::connection_string_builder ( connection_string_builder && )

defaultnoexcept

Member Function Documentation

◆ application_name()

connection_string_builder & database::integrated::connection_string_builder::application_name ( std::string_view name )

Set the application name (for PostgreSQL)

Parameters

name	Application name

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 46 of file connection_string_builder.cpp.

                                                                                          {
    application_name_ = std::string(name);
    return *this;
}

References application_name_.

Referenced by test_builder_chaining(), and test_postgres_app_name().

Here is the caller graph for this function:

◆ build()

kcenon::common::Result< std::string > database::integrated::connection_string_builder::build ( backend_type type ) const

nodiscard

Build the connection string for the specified backend.

Parameters

type	Database backend type

Returns: Result containing the connection string or validation error

Validates that required fields are set for the backend:

PostgreSQL: host is recommended (defaults to localhost)
SQLite: database path is required (or in_memory must be set)
MongoDB: host is required
Redis: host is required

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 61 of file connection_string_builder.cpp.

                                                                                      {
    switch (type) {
        case backend_type::postgres:
            return build_postgres();
        case backend_type::sqlite:
            return build_sqlite();
        case backend_type::mongodb:
            return build_mongodb();
        case backend_type::redis:
            return build_redis();
        default:
            return kcenon::common::Result<std::string>::err(
                -1, "Unknown backend type", "connection_string_builder");
    }
}

References build_mongodb(), build_postgres(), build_redis(), build_sqlite(), database::integrated::mongodb, database::integrated::postgres, database::integrated::redis, and database::integrated::sqlite.

Referenced by test_builder_chaining(), test_builder_copy(), test_builder_reset(), test_builder_reuse(), test_mongodb_basic(), test_mongodb_default_host(), test_mongodb_ssl(), test_mongodb_with_auth(), test_postgres_app_name(), test_postgres_basic(), test_postgres_custom_option(), test_postgres_empty(), test_postgres_ssl(), test_postgres_timeout(), test_postgres_verify_ca(), test_redis_basic(), test_redis_with_database(), test_redis_with_password(), test_sqlite_file(), test_sqlite_memory(), test_sqlite_memory_overrides_file(), and test_sqlite_no_database().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build_mongodb()

kcenon::common::Result< std::string > database::integrated::connection_string_builder::build_mongodb ( ) const

nodiscardprivate

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 158 of file connection_string_builder.cpp.

                                                                             {
    // MongoDB uses URI format: mongodb://[user:password@]host[:port]/[database]
    std::ostringstream oss;
    oss << "mongodb://";
 
    if (user_.has_value() && password_.has_value()) {
        oss << *user_ << ':' << *password_ << '@';
    }
 
    if (host_.has_value()) {
        oss << *host_;
    } else {
        oss << "localhost";
    }
 
    if (port_.has_value()) {
        oss << ':' << *port_;
    }
 
    if (database_.has_value()) {
        oss << '/' << *database_;
    }
 
    // Add options as query parameters
    if (!custom_options_.empty() || ssl_mode_.has_value() || connect_timeout_.has_value()) {
        oss << '?';
        bool first = true;
 
        auto append_param = [&oss, &first](const std::string& key, const std::string& value) {
            if (!first) {
                oss << '&';
            }
            oss << key << '=' << value;
            first = false;
        };
 
        if (ssl_mode_.has_value()) {
            bool use_ssl = *ssl_mode_ != ssl_mode::disable;
            append_param("ssl", use_ssl ? "true" : "false");
        }
 
        if (connect_timeout_.has_value()) {
            append_param("connectTimeoutMS", std::to_string(*connect_timeout_ * 1000));
        }
 
        for (const auto& [key, value] : custom_options_) {
            append_param(key, value);
        }
    }
 
    return kcenon::common::Result<std::string>::ok(oss.str());
}

References connect_timeout_, custom_options_, database_, database::integrated::disable, host_, password_, port_, ssl_mode_, and user_.

Referenced by build().

Here is the caller graph for this function:

◆ build_postgres()

kcenon::common::Result< std::string > database::integrated::connection_string_builder::build_postgres ( ) const

nodiscardprivate

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 91 of file connection_string_builder.cpp.

                                                                              {
    std::ostringstream oss;
    bool first = true;
 
    auto append = [&oss, &first](const std::string& key, const std::string& value) {
        if (!first) {
            oss << ' ';
        }
        oss << key << '=' << value;
        first = false;
    };
 
    // PostgreSQL uses space-separated key=value pairs
    if (host_.has_value()) {
        append("host", *host_);
    }
 
    if (port_.has_value()) {
        append("port", std::to_string(*port_));
    }
 
    if (database_.has_value()) {
        append("dbname", *database_);
    }
 
    if (user_.has_value()) {
        append("user", *user_);
    }
 
    if (password_.has_value()) {
        append("password", *password_);
    }
 
    if (ssl_mode_.has_value()) {
        append("sslmode", ssl_mode_to_postgres_string(*ssl_mode_));
    }
 
    if (connect_timeout_.has_value()) {
        append("connect_timeout", std::to_string(*connect_timeout_));
    }
 
    if (application_name_.has_value()) {
        append("application_name", *application_name_);
    }
 
    for (const auto& [key, value] : custom_options_) {
        append(key, value);
    }
 
    return kcenon::common::Result<std::string>::ok(oss.str());
}

References application_name_, connect_timeout_, custom_options_, database_, host_, password_, port_, ssl_mode_, ssl_mode_to_postgres_string(), and user_.

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ build_redis()

kcenon::common::Result< std::string > database::integrated::connection_string_builder::build_redis ( ) const

nodiscardprivate

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 211 of file connection_string_builder.cpp.

                                                                           {
    // Redis uses URI format: redis://[user:password@]host[:port][/database]
    std::ostringstream oss;
    oss << "redis://";
 
    if (user_.has_value() && password_.has_value()) {
        oss << *user_ << ':' << *password_ << '@';
    } else if (password_.has_value()) {
        // Redis often uses just password without username
        oss << ':' << *password_ << '@';
    }
 
    if (host_.has_value()) {
        oss << *host_;
    } else {
        oss << "localhost";
    }
 
    if (port_.has_value()) {
        oss << ':' << *port_;
    }
 
    if (database_.has_value()) {
        // Redis database is a number (0-15 typically)
        oss << '/' << *database_;
    }
 
    return kcenon::common::Result<std::string>::ok(oss.str());
}

References database_, host_, password_, port_, and user_.

Referenced by build().

Here is the caller graph for this function:

◆ build_sqlite()

kcenon::common::Result< std::string > database::integrated::connection_string_builder::build_sqlite ( ) const

nodiscardprivate

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 143 of file connection_string_builder.cpp.

                                                                            {
    // SQLite uses file path or :memory: for in-memory database
    if (in_memory_) {
        return kcenon::common::Result<std::string>::ok(":memory:");
    }
 
    if (!database_.has_value() || database_->empty()) {
        return kcenon::common::Result<std::string>::err(
            -1, "SQLite requires a database file path or in_memory() to be set",
            "connection_string_builder");
    }
 
    return kcenon::common::Result<std::string>::ok(*database_);
}

References database_, and in_memory_.

Referenced by build().

Here is the caller graph for this function:

◆ connect_timeout()

connection_string_builder & database::integrated::connection_string_builder::connect_timeout ( uint32_t seconds )

Set the connection timeout.

Parameters

seconds Timeout in seconds

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 41 of file connection_string_builder.cpp.

                                                                                      {
    connect_timeout_ = seconds;
    return *this;
}

References connect_timeout_.

Referenced by test_builder_chaining(), and test_postgres_timeout().

Here is the caller graph for this function:

◆ database()

connection_string_builder & database::integrated::connection_string_builder::database ( std::string_view db )

Set the database name.

Parameters

db	Database name or file path (for SQLite)

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 21 of file connection_string_builder.cpp.

                                                                                {
    database_ = std::string(db);
    return *this;
}

References database_.

Referenced by test_builder_chaining(), test_builder_copy(), test_builder_reset(), test_builder_reuse(), test_mongodb_basic(), test_mongodb_default_host(), test_mongodb_with_auth(), test_postgres_basic(), test_postgres_ssl(), test_redis_with_database(), test_sqlite_file(), and test_sqlite_memory_overrides_file().

Here is the caller graph for this function:

◆ host()

connection_string_builder & database::integrated::connection_string_builder::host ( std::string_view h )

Set the database host.

Parameters

h	Hostname or IP address

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 11 of file connection_string_builder.cpp.

                                                                           {
    host_ = std::string(h);
    return *this;
}

References host_.

Referenced by test_builder_chaining(), test_builder_copy(), test_builder_reset(), test_builder_reuse(), test_mongodb_basic(), test_mongodb_ssl(), test_mongodb_with_auth(), test_postgres_app_name(), test_postgres_basic(), test_postgres_custom_option(), test_postgres_ssl(), test_postgres_timeout(), test_postgres_verify_ca(), test_redis_basic(), test_redis_with_database(), and test_redis_with_password().

Here is the caller graph for this function:

◆ in_memory()

connection_string_builder & database::integrated::connection_string_builder::in_memory ( )

Configure SQLite to use in-memory database.

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 51 of file connection_string_builder.cpp.

                                                                {
    in_memory_ = true;
    return *this;
}

References in_memory_.

Referenced by test_sqlite_memory(), and test_sqlite_memory_overrides_file().

Here is the caller graph for this function:

◆ operator=() [1/2]

connection_string_builder & database::integrated::connection_string_builder::operator= ( connection_string_builder && )

defaultnoexcept

◆ operator=() [2/2]

connection_string_builder & database::integrated::connection_string_builder::operator= ( const connection_string_builder & )

default

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

◆ option()

connection_string_builder & database::integrated::connection_string_builder::option	(	std::string_view	key,
		std::string_view	value )

Add a custom option.

Parameters

key	Option key
value	Option value

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 56 of file connection_string_builder.cpp.

                                                                                                     {
    custom_options_.emplace_back(std::string(key), std::string(value));
    return *this;
}

References custom_options_.

Referenced by test_builder_chaining(), and test_postgres_custom_option().

Here is the caller graph for this function:

◆ password()

connection_string_builder & database::integrated::connection_string_builder::password ( std::string_view p )

Set the password for authentication.

Parameters

p Password

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 31 of file connection_string_builder.cpp.

                                                                               {
    password_ = std::string(p);
    return *this;
}

References password_.

Referenced by test_builder_chaining(), test_builder_reuse(), test_mongodb_with_auth(), test_postgres_basic(), and test_redis_with_password().

Here is the caller graph for this function:

◆ port()

connection_string_builder & database::integrated::connection_string_builder::port ( uint16_t p )

Set the database port.

Parameters

p	Port number (1-65535)

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 16 of file connection_string_builder.cpp.

                                                                     {
    port_ = p;
    return *this;
}

References port_.

Referenced by test_builder_chaining(), test_builder_copy(), test_builder_reset(), test_builder_reuse(), test_mongodb_basic(), test_postgres_basic(), and test_redis_basic().

Here is the caller graph for this function:

◆ reset()

connection_string_builder & database::integrated::connection_string_builder::reset ( )

Reset the builder to initial state.

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 77 of file connection_string_builder.cpp.

                                                            {
    host_.reset();
    port_.reset();
    database_.reset();
    user_.reset();
    password_.reset();
    ssl_mode_.reset();
    connect_timeout_.reset();
    application_name_.reset();
    in_memory_ = false;
    custom_options_.clear();
    return *this;
}

References application_name_, connect_timeout_, custom_options_, database_, host_, in_memory_, password_, port_, reset(), ssl_mode_, and user_.

Referenced by reset(), test_builder_reset(), and test_builder_reuse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ssl_mode()

connection_string_builder & database::integrated::connection_string_builder::ssl_mode ( enum ssl_mode mode )

Set the SSL connection mode.

Parameters

mode SSL mode

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 36 of file connection_string_builder.cpp.

                                                                                 {
    ssl_mode_ = mode;
    return *this;
}

References ssl_mode_.

Referenced by test_builder_chaining(), test_mongodb_ssl(), test_postgres_ssl(), and test_postgres_verify_ca().

Here is the caller graph for this function:

◆ ssl_mode_to_postgres_string()

std::string database::integrated::connection_string_builder::ssl_mode_to_postgres_string ( enum ssl_mode mode )

staticnodiscardprivate

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 241 of file connection_string_builder.cpp.

                                                                                   {
    switch (mode) {
        case ssl_mode::disable:
            return "disable";
        case ssl_mode::allow:
            return "allow";
        case ssl_mode::prefer:
            return "prefer";
        case ssl_mode::require:
            return "require";
        case ssl_mode::verify_ca:
            return "verify-ca";
        case ssl_mode::verify_full:
            return "verify-full";
        default:
            return "prefer";
    }
}

References database::integrated::allow, database::integrated::disable, database::integrated::prefer, database::integrated::require, database::integrated::verify_ca, and database::integrated::verify_full.

Referenced by build_postgres().

Here is the caller graph for this function:

◆ user()

connection_string_builder & database::integrated::connection_string_builder::user ( std::string_view u )

Set the username for authentication.

Parameters

u Username

Returns: Reference to this builder for chaining

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 26 of file connection_string_builder.cpp.

                                                                           {
    user_ = std::string(u);
    return *this;
}

References user_.

Referenced by test_builder_chaining(), test_builder_reuse(), test_mongodb_with_auth(), and test_postgres_basic().

Here is the caller graph for this function:

Member Data Documentation

◆ application_name_

std::optional<std::string> database::integrated::connection_string_builder::application_name_

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 184 of file connection_string_builder.h.

Referenced by application_name(), build_postgres(), and reset().

◆ connect_timeout_

std::optional<uint32_t> database::integrated::connection_string_builder::connect_timeout_

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 183 of file connection_string_builder.h.

Referenced by build_mongodb(), build_postgres(), connect_timeout(), and reset().

◆ custom_options_

std::vector<std::pair<std::string, std::string> > database::integrated::connection_string_builder::custom_options_

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 186 of file connection_string_builder.h.

Referenced by build_mongodb(), build_postgres(), option(), and reset().

◆ database_

std::optional<std::string> database::integrated::connection_string_builder::database_

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 179 of file connection_string_builder.h.

Referenced by build_mongodb(), build_postgres(), build_redis(), build_sqlite(), database(), and reset().

◆ host_

std::optional<std::string> database::integrated::connection_string_builder::host_

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 177 of file connection_string_builder.h.

Referenced by build_mongodb(), build_postgres(), build_redis(), host(), and reset().

◆ in_memory_

bool database::integrated::connection_string_builder::in_memory_ = false

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 185 of file connection_string_builder.h.

Referenced by build_sqlite(), in_memory(), and reset().

◆ password_

std::optional<std::string> database::integrated::connection_string_builder::password_

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 181 of file connection_string_builder.h.

Referenced by build_mongodb(), build_postgres(), build_redis(), password(), and reset().

◆ port_

std::optional<uint16_t> database::integrated::connection_string_builder::port_

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 178 of file connection_string_builder.h.

Referenced by build_mongodb(), build_postgres(), build_redis(), port(), and reset().

◆ ssl_mode_

std::optional<enum ssl_mode> database::integrated::connection_string_builder::ssl_mode_

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 182 of file connection_string_builder.h.

Referenced by build_mongodb(), build_postgres(), reset(), and ssl_mode().

◆ user_

std::optional<std::string> database::integrated::connection_string_builder::user_

private

Examples: /home/runner/work/database_system/database_system/database/integrated/connection_string_builder.h.

Definition at line 180 of file connection_string_builder.h.

Referenced by build_mongodb(), build_postgres(), build_redis(), reset(), and user().

The documentation for this class was generated from the following files:

database/integrated/connection_string_builder.h
database/integrated/connection_string_builder.cpp

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ connection_string_builder() [1/3]

◆ ~connection_string_builder()

◆ connection_string_builder() [2/3]

◆ connection_string_builder() [3/3]

Member Function Documentation

◆ application_name()

◆ build()

◆ build_mongodb()

◆ build_postgres()

◆ build_redis()

◆ build_sqlite()

◆ connect_timeout()

◆ database()

◆ host()

◆ in_memory()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ option()

◆ password()

◆ port()

◆ reset()

◆ ssl_mode()

◆ ssl_mode_to_postgres_string()

◆ user()

Member Data Documentation

◆ application_name_

◆ connect_timeout_

◆ custom_options_

◆ database_

◆ host_

◆ in_memory_

◆ password_

◆ port_

◆ ssl_mode_

◆ user_