CTRL + K
Stories
Apps
Agents
Bricks
Constellab Space LogoSpace
Login

gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

Scenario

Model class with created_by and last_modified_by columns automatically provided

:param Model: [description] :type Model: [type] :return: [description] :rtype: [type]

Attributes
creation_type: ScenarioCreationTypedata: Dict[str, Any]description: RichTextDTOfolder: SpaceFolderid: stris_validated: boollab_config: LabConfigModelstatus: ScenarioStatusvalidated_at: datetime
Functions
__init__

Initialize self. See help(type(self)) for accurate signature.

archive
check_is_runnable

Throw an error if the scenario is not runnable

check_is_stopable

Throw an error if the scenario is not stopable

check_is_updatable

Throw an error if the scenario is not updatable

clone
coerce
_coerce : bool - True
delete_instance
dependencies
search_nullable : bool - False
entity_is_validated
Return type : bool
export_protocol
Return type : ScenarioProtocolDTO
get_current_progress
Return type : ScenarioProgressDTO
get_entity_name
Return type : str
get_entity_type
Return type : EntityType
get_error_info
Return type : Optional[ProcessErrorInfo]
get_id
get_process_status
Return type : ScenarioProcessStatus
get_running_tasks
Return type : List[TaskModel]
get_short_name

Method to get a readable to quickly distinguish the scenario, (used in error message)

Return type : str
is_alias
is_dirty
is_manual
Return type : bool
is_saved

Returns True if the model is saved in db, False otherwise

Return type : bool
mark_as_draft
mark_as_error
error_info : ProcessErrorInfo
mark_as_in_queue
mark_as_partially_run
mark_as_started
pid : int
mark_as_success
mark_as_waiting_for_cli_process

Mark that a process is created for the scenario, but it is not started yet

pid : int
pid of the linux process
refresh
Return type : ModelType
reset
save

Sets the data set force_insert to True to force creation of the object set skip_hook to True to skip the before insert or update hook

Return type : ModelType
set_error_info
error_info : ProcessErrorInfo
to_dto
Return type : ScenarioDTO
to_simple_dto
Return type : ScenarioSimpleDTO
unwrap
validate
add_index @classmethod
fields : Any
after_all_tables_init @classmethod

Method call after all the table are inited

Useful when use DeferredForeignKey to create the foreign key manually latter

after_table_creation @classmethod

Method call after the table is created

Usefull to create the full text indexes

alias @classmethod
alias : Any
bind @classmethod
database : Any
bind_refs : bool - True
bind_backrefs : bool - True
_exclude : Any
bind_ctx @classmethod
database : Any
bind_refs : bool - True
bind_backrefs : bool - True
bulk_create @classmethod
model_list : Any
batch_size : Any
bulk_update @classmethod
model_list : Any
fields : Any
batch_size : Any
classname @classmethod

Returns the name of the class

slugify : bool - False
True to slugify the class name if True
snakefy : bool - False
True to snakefy the class name if True
replace_uppercase : bool - False
Replace upper cases by "-" if True
Return type : str
clear_folder @classmethod

Clear folders from all the entities that have the folder

folders : List
column_exists @classmethod

Returns True if the column exists in the table

column_name : str
The column name
Return type : bool
count_queued_scenarios @classmethod
Return type : int
count_running_or_queued_scenarios @classmethod
Return type : int
count_running_scenarios @classmethod
Return type : int
create @classmethod
query : Any
create_foreign_key_if_not_exist @classmethod

Create a foreign key for a Foreign key field only if the foreign key does not exists

field : ForeignKeyField
[description]
create_full_text_index @classmethod

Method to create a full text index

columns : List
[description]
index_name : str
create_table @classmethod

Create model table

delete @classmethod
delete_by_id @classmethod
pk : Any
drop_table @classmethod

Drop model table

execute_sql @classmethod

Execute a raw SQL query. Can use the [TABLE_NAME] to replace by the table name

query : str
The query to execute
filter @classmethod
dq_nodes : Any
filters : Any
foreign_key_exists @classmethod
column_name : str
Return type : bool
full_classname @classmethod

Returns the full name of the class

slugify : bool - False
Slugify the returned class name if True
snakefy : bool - False
Snakefy the returned class name if True
Return type : str
get @classmethod
query : Any
filters : Any
get_by_id @classmethod
id : str
Return type : Optional
get_by_id_and_check @classmethod

Get by ID and throw 404 error if object not found

id : str
[description]
Return type : ModelType
get_by_ids @classmethod
ids : List
Return type : List
get_db @classmethod
Return type : DatabaseProxy
get_db_manager @classmethod

Returns the (current) DbManager of this model

Return type : Type
get_or_create @classmethod
get_or_none @classmethod
query : Any
filters : Any
get_running_scenarios @classmethod
Return type : ModelSelect
get_table_name @classmethod

Returns the table name of this class

Return type : str
index @classmethod
fields : Any
index_exists @classmethod

Returns True if the index exists in the table

index_name : str
The index name
Return type : bool
inheritors @classmethod

Get all the classes that inherit this class

Return type : List
insert @classmethod
_Model__data : Any
insert : Any
insert_from @classmethod
query : Any
fields : Any
insert_many @classmethod
rows : Any
fields : Any
is_mysql_engine @classmethod
noop @classmethod
raw @classmethod
sql : Any
params : Any
replace @classmethod
_Model__data : Any
insert : Any
replace_many @classmethod
rows : Any
fields : Any
save_all @classmethod
select @classmethod
fields : Any
set_by_id @classmethod
key : Any
value : Any
table_exists @classmethod
truncate_table @classmethod
options : Any
update @classmethod
_Model__data : Any
update : Any
validate_model @classmethod
copy @staticmethod
method : Any