CTRL + K
Apps
Stories
Agents
Bricks
Constellab Space LogoSpace
Login
Back to bricks list
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

Typing

Typing class. This class allows storing information on all the types of the models in the system.

:property type: The type of the related model. :type type: str :property super_type: The super type of the related model. :type super_type: str :property root_type: The root type of the related task. :type root_type: str

Attributes
brick: CharFieldbrick_version: CharFielddata: Dictdeprecated_message: CharFielddeprecated_since: CharFieldhide: BooleanFieldhuman_name: CharFieldmodel_type: CharFieldobject_sub_type: CharFieldobject_type: CharFieldrelated_model_typing_name: CharFieldshort_description: CharFieldstyle: TypingStyleunique_name: CharField
Functions
__INIT__

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

CLONE
COERCE
_coerce : bool - True
DELETE_INSTANCE
recursive : bool - False
delete_nullable : bool - False
DEPENDENCIES
search_nullable : bool - False
GET_ANCESTORS
Return type : List
GET_ID
GET_MODEL_TYPE_DOC

Return the python documentation of the model type

Return type : str
GET_PARENT_TYPING
Return type : Optional
GET_TYPE
Return type : Optional
GET_TYPE_STATUS
Return type : TypingStatus
IS_ALIAS
IS_DIRTY
IS_SAVED

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

Return type : bool
REFRESH
Return type : ModelType
REFRESH_ANCESTORS
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
TO_DTO
Return type : TypingDTO
TO_FULL_DTO
Return type : TypingFullDTO
TO_REF_DTO
Return type : TypingRefDTO
TO_SIMPLE_DTO
Return type : SimpleTypingDTO
UNWRAP
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
COLUMN_EXISTS - @classmethod

Returns True if the column exists in the table

column_name : str
The column name
Return type : bool
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_BRICK_AND_OBJECT_TYPE - @classmethod
Brick name : str
Return type : List
GET_BY_BRICK_AND_UNIQUE_NAME - @classmethod
object_type : Literal
brick : str
unique_name : str
Return type : ModelSelect
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_BY_MODEL_TYPE - @classmethod
model_type : Type
Return type : Typing
GET_BY_OBJECT_SUB_TYPE - @classmethod
sub_type : str
Return type : List
GET_BY_OBJECT_TYPE - @classmethod

Return all the visible typing name of a type.

object_type : Literal
Return type : ModelSelect
GET_BY_OBJECT_TYPE_AND_NAME - @classmethod

Return all the visible typing name of a type searched by name.

object_type : Literal
Name : str
Return type : ModelSelect
GET_BY_TYPE_AND_BRICK - @classmethod

Return all the visible typing name of a type.

object_type : Literal
Brick name : str
Return type : ModelSelect
GET_BY_TYPING_NAME - @classmethod
typing_name : str
Return type : Typing
GET_CHILDREN_TYPINGS - @classmethod

Retunr the list of typings that are a child class of the provided model_type

typing_type : Literal
base_type : Type
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_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
TYPE_IS_REGISTER - @classmethod
model_type : Type
Return type : bool
UPDATE - @classmethod
_Model__data : Any
update : Any
VALIDATE_MODEL - @classmethod
COPY - @staticmethod
method : Any
TYPING_NAME_IS_PROTOCOL - @staticmethod
typing_name : str
Return type : bool