xia_engine_mysql.engine.MysqlConnectParam
- class xia_engine_mysql.engine.MysqlConnectParam(**kwargs)
Bases:
EmbeddedDocument- __init__(**kwargs)
Methods
__init__(**kwargs)action(action_name[, acl, payload])Doing an action of a document
collection_action(action_name[, acl, payload])Doing a collection level action
from_db(**kwargs)Transform database data to internal data
from_display(**kwargs)Transform Display data to internal data
Get action supported by this document
get_display_data([lazy, catalog, show_hidden])Get Display data (visualized form of data)
get_meta_data()Get Raw data (materialized form of data)
Get Runtime data (calculated from raw data when runtime is activated)
Get a sample document data
to_db(*[, catalog, ignore_unknown])Translate the runtime data into raw data (materialized form of data)
validate()Validate if all of the component of document follows the predefined rules
Attributes
OPERATORSdatabasehostpassworduser- action(action_name: str, acl=None, payload: Optional[dict] = None)
Doing an action of a document
- Parameters
action_name – The action name
acl – Access Control List
payload – Parameters of action
- classmethod collection_action(action_name, acl=None, payload: Optional[dict] = None)
Doing a collection level action
- Parameters
action_name – The action name
acl – Access Control List
payload – Parameters of action
- classmethod from_db(**kwargs)
Transform database data to internal data
- Parameters
**kwargs (object) – python dict got from system
- Returns
python dict object
- classmethod from_display(**kwargs)
Transform Display data to internal data
- Parameters
**kwargs (object) – display object got from front end
- Returns
python dict object
- classmethod get_actions()
Get action supported by this document
- Returns
Base]
- Return type
dictionary[str
- get_display_data(lazy: bool = True, catalog: Optional[dict] = None, show_hidden: bool = False)
Get Display data (visualized form of data)
- Parameters
lazy (bool) – Left the fields as is if they are not explicitly loaded
catalog (dict) – The catalog of display field in the following format: * {field1: None, field2: None, field3: {sub-field1: None, sub-field2: None}} * field1, field2 is the top-level normal field * field3 is an embedded field/reference field/external field while sub-field1, sub-field2 is its fields * None means all fields
show_hidden (bool) – If hidden value should be shown or not
- Returns
python dict object
Notes
We will return the detail form if it is possible
- get_raw_data()
Get Raw data (materialized form of data)
- Returns
python dict object
- get_runtime_data()
Get Runtime data (calculated from raw data when runtime is activated)
- Returns
python dict object
- classmethod get_sample()
Get a sample document data
- to_db(*, catalog: Optional[dict] = None, ignore_unknown: bool = False)
Translate the runtime data into raw data (materialized form of data)
- Parameters
catalog (dict) – Data catalog to be parsed
ignore_unknown (bool) – When a field is not defined in the document, should we send it back to the database
- Returns
python dict object
- validate()
Validate if all of the component of document follows the predefined rules
- Returns
Always None. No exception raised means the validation passed