From b18fb8dced25f5ffc5c7103f9eb943e806d905cc Mon Sep 17 00:00:00 2001
From: Denis Gukov <denguk@gmail.com>
Date: Sat, 23 Nov 2024 15:27:25 +0500
Subject: [PATCH] docs(config): add method docs

---
 util/config.go | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/util/config.go b/util/config.go
index f57c1c39..b21e1437 100644
--- a/util/config.go
+++ b/util/config.go
@@ -677,6 +677,16 @@ func (d *DbConfig) GetHostname() string {
 	return d.Hostname
 }
 
+// GetConnectionString constructs the database connection string based on the current configuration.
+// It supports MySQL, BoltDB, and PostgreSQL dialects.
+// If the dialect is unsupported, it returns an error.
+//
+// Parameters:
+// - includeDbName: a boolean indicating whether to include the database name in the connection string.
+//
+// Returns:
+// - connectionString: the constructed database connection string.
+// - err: an error if the dialect is unsupported.
 func (d *DbConfig) GetConnectionString(includeDbName bool) (connectionString string, err error) {
 	dbName := d.GetDbName()
 	dbUser := d.GetUsername()