docs(config): add method docs

This commit is contained in:
Denis Gukov 2024-11-23 15:27:25 +05:00
parent 80be12d0d5
commit b18fb8dced

View File

@ -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()