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
brick: CharField
brick_version: CharField
data: Dict
deprecated_message: CharField
deprecated_since: CharField
hide: BooleanField
human_name: CharField
model_type: CharField
object_sub_type: CharField
object_type: CharField
related_model_typing_name: CharField
short_description: CharField
style: TypingStyle
unique_name: CharField
Initialize self. See help(type(self)) for accurate signature.
bool
- True
bool
- False
bool
- False
bool
- False
List
Return the python documentation of the model type
str
Optional
Optional
TypingStatus
Returns True if the model is saved in db, False otherwise
bool
ModelType
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
ModelType
TypingDTO
TypingFullDTO
TypingRefDTO
SimpleTypingDTO
Any
Method call after all the table are inited
Useful when use DeferredForeignKey to create the foreign key manually latter
Method call after the table is created
Usefull to create the full text indexes
Any
Any
bool
- True
bool
- True
Any
Any
bool
- True
bool
- True
Any
Any
Any
Any
Any
Returns the name of the class
bool
- False
bool
- False
bool
- False
str
Returns True if the column exists in the table
str
bool
Any
Create a foreign key for a Foreign key field only if the foreign key does not exists
ForeignKeyField
Method to create a full text index
List
str
Create model table
Any
Drop model table
Execute a raw SQL query. Can use the [TABLE_NAME] to replace by the table name
str
Any
Any
str
bool
Returns the full name of the class
bool
- False
bool
- False
str
Any
Any
str
List
Literal
str
str
ModelSelect
str
Optional
Get by ID and throw 404 error if object not found
str
ModelType
List
List
Type
Typing
str
List
Return all the visible typing name of a type.
Literal
ModelSelect
Return all the visible typing name of a type searched by name.
Literal
str
ModelSelect
Return all the visible typing name of a type.
Literal
str
ModelSelect
str
Typing
Retunr the list of typings that are a child class of the provided model_type
Literal
Type
List
DatabaseProxy
Returns the (current) DbManager of this model
Type
Any
Any
Returns the table name of this class
str
Any
Returns True if the index exists in the table
str
bool
Get all the classes that inherit this class
List
Any
Any
Any
Any
Any
Any
Any
Any
Any
Any
Any
Any
Performs full-text search on the field. Must be overrided by child class to work
str
str
ModelSelect
Any
Any
Any
Any
Type
bool
Any
Any
Any
str
bool