Objects API

Method	Signature	Description
debug	`debug(*args)`	Debug logging for Connection class.
get_local_db_name	`get_local_db_name(host: str = '', client: str = '') -> str`
transfer_detail	`transfer_detail(DB, recon_db)`	Transfers details from one database object to another by attempting to assign attribute values
get_sql_set	`get_sql_set(config_name = 'primary') -> list`
connect_db	`connect_db(DB = 0, remote: str = '', force_new: int = 0, reconnect: int = 0, config_name = 'primary') -> object`	Establishes and configures a database connection.

Method	Signature	Description
close_db	`close_db(db = 0) -> None`
get_db_connections	`get_db_connections()`
encrypt	`encrypt(message: str, package = '') -> str`
decrypt	`decrypt(message: str, package = '') -> str`
get_deployment	`get_deployment() -> str`
get_host	`get_host() -> str`
get_role	`get_role() -> str`
DBType	`DBType(AltDB = 0) -> str`
safe_int	`safe_int(value, default = 0)`	Safely convert a value to int. Returns default if conversion fails.
get_uuid	`get_uuid(context: str = '') -> str`
is_my_sql	`is_my_sql(data_connector) -> int`
is_ms_sql	`is_ms_sql(data_connector) -> bool`	Return True when data_connector is a Microsoft SQL Server connection.
is_postgres	`is_postgres(data_connector) -> bool`	Return True when data_connector is a PostgreSQL connection.
is_sqlite	`is_sqlite(data_connector) -> bool`	Return True when data_connector is an SQLite connection.
is_mongo	`is_mongo(data_connector) -> int`
is_openobserve	`is_openobserve(data_connector: object) -> int`
is_docker	`is_docker() -> int`	Check if running inside Docker.
is_kubernetes	`is_kubernetes() -> int`	Check if running inside a Kubernetes pod.
patch_all	`patch_all(term: str, key: str, value: str) -> str`
patch_paramBuffer	`patch_paramBuffer(term: str) -> str`
get_acl	`get_acl()`	Resolve the active ACL object when available.
patch_paramRun	`patch_paramRun(term: str, depth: int = 0, local_db: int = 0) -> str`
patch_param	`patch_param(term: str, depth: int = 0) -> str`
process_text	`process_text(text: str = '') -> str`
inject_hidden	`inject_hidden(target: object)`
inject	`inject(target: object) -> None`
inject_dictionary	`inject_dictionary(inject_dict: dict)`
EncodeClassJson	`EncodeClassJson() -> str`
EncodeJson	`EncodeJson() -> str`
decode_class_json	`decode_class_json(d: dict) -> None`
DecodeJson	`DecodeJson(json_str: str) -> None`
sql_escape	`sql_escape(sql: str) -> str`
command_line	`command_line(prompt = 'Please select action', choices = None)`
create_tables_from_yaml	`create_tables_from_yaml(schema_name: str)`	Loads table schemas from a YAML file and creates them in the database if they don't exist.

¶ Objects (API Reference)

¶ class Connection(object)

¶ class Object(_ObjDebug, _ObjPatch, _ObjSystem, _ObjResource, _ObjSerialization, _ObjPlatform)

¶ get_ini_value(section: str, option: str, default: str = '') -> str

¶ get_ini_value(section: str, option: list[str] | list[tuple[str, str]], default: str = '') -> list[str]

¶ get_ini_value(section: str, option: str | list[str] | list[tuple[str, str]], default: str = '') -> str | list[str]

¶ get_ini_int(section: str, option: str, default: int = 0) -> int

¶ get_ini_int(section: str, option: list[str] | list[tuple[str, int]], default: int = 0) -> list[int]

¶ get_ini_int(section: str, option: str | list[str] | list[tuple[str, int]], default: int = 0) -> int | list[int]

¶ get_ini_float(section: str, option: str, default: float = 0.0) -> float

¶ get_ini_float(section: str, option: list[str] | list[tuple[str, float]], default: float = 0.0) -> list[float]

¶ get_ini_float(section: str, option: str | list[str] | list[tuple[str, float]], default: float = 0.0) -> float | list[float]

¶ str_to_bool(value: object, default: bool = False) -> bool

¶ get_ini_bool(section: str, option: str, default: bool = False) -> bool

¶ get_ini_bool(section: str, option: list[str] | list[tuple[str, bool]], default: bool = False) -> list[bool]

¶ get_ini_bool(section: str, option: str | list[str] | list[tuple[str, bool]], default: bool = False) -> bool | list[bool]

¶ get_db_config(name: str = 'primary') -> dict

¶ is_in_multiplexer()

¶ get_multiplexer_info()

¶ connect()

¶ virt()

¶ main(ctx: typer.Context)