pip_services3_components.connect.ConnectionUtils module
-
class
pip_services3_components.connect.ConnectionUtils.ConnectionUtils Bases:
objectA set of utility functions to process connection parameters
-
static
compose_uri(options: pip_services3_commons.config.ConfigParams.ConfigParams, default_protocol: str, default_port: int) → str Composes URI from config parameters. The result URI will be in the following form: protocol://username@password@host1:port1,host2:port2,…?param1=abc¶m2=xyz&…
- Parameters
options – configuration parameters
default_protocol – a default protocol
default_port – a default port
- Returns
a composed URI
-
static
concat(options1: pip_services3_commons.config.ConfigParams.ConfigParams, options2: pip_services3_commons.config.ConfigParams.ConfigParams, *keys: str) → pip_services3_commons.config.ConfigParams.ConfigParams Concatinates two options by combining duplicated properties into comma-separated list
- Parameters
options1 – first options to merge
options2 – second options to merge
keys – when define it limits only to specific keys
-
static
exclude(options: pip_services3_commons.config.ConfigParams.ConfigParams, *keys: str) → pip_services3_commons.config.ConfigParams.ConfigParams Excludes specified keys from the config parameters.
- Parameters
options – configuration parameters to be processed.
keys – a list of keys to be excluded.
- Returns
a processed config parameters.
-
static
include(options: pip_services3_commons.config.ConfigParams.ConfigParams, *keys: str) → pip_services3_commons.config.ConfigParams.ConfigParams Includes specified keys from the config parameters.
- Parameters
options – configuration parameters to be processed.
keys – a list of keys to be included.
- Returns
a processed config parameters.
-
static
parse_uri(uri: str, default_protocol: str, default_port: str) → pip_services3_commons.config.ConfigParams.ConfigParams Parses URI into config parameters. The URI shall be in the following form: protocol://username@password@host1:port1,host2:port2,…?param1=abc¶m2=xyz&…
- Parameters
uri – the URI to be parsed
default_protocol – a default protocol
default_port – a default port
- Returns
a configuration parameters with URI elements
-
static