quackamollie.core.cli.helpers.db_url_config module

quackamollie.core.cli.helpers.db_url_config.anonymize_database_url(db_url: str) → str[source]

Hide the username and password of a given database URL

Parameters:

db_url (str) – The database URL to anonymize, typically postgres://user:password@host/database

Returns:

The anonymized URL, typically postgres://host/database or postgres://us****@host/database or postgres://us****:****@host/database. The number of asterisks is a constant to not divulge data.

Return type:

str

quackamollie.core.cli.helpers.db_url_config.get_db_url_from_config(db_protocol: str, db_host: str, db_name: str, db_username: str | None, db_password: str | None, db_port: int | None) → str[source]

Construct database URL from URL fields

Parameters:

  • db_protocol (str) – Database protocol, must be a protocol supported by SQLAlchemy

  • db_host (str) – Hostname of the database

  • db_name (str) – Name of the database

  • db_username (Optional[str]) – Username for database connection

  • db_password (Optional[str]) – Password for database connection

  • db_port (Optional[str]) – Port of the database

Returns:

The URL of the database in the format {db_protocol}://{db_username}:{db_password}@{}:{db_port}/{db_name}

Return type:

str