Research documentation

Developer guide

Release

CLI

Technical Documentation

Model

Model class

:property id: The id of the model (in database) :type id: int :property id: The unique resource identifier of the model :type id: str :property type: The type of the python Object (the full class name) :type type: str :property created_at: The creation datetime of the model :type created_at: datetime :property save_datetime: The last save datetime in database :type last_modified_at: datetime

Functions

__INIT__

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

CLONE

COERCE

Parameters:

Name	Type	Default value	Description
_coerce	`bool`	True

DELETE_INSTANCE

Parameters:

Name	Type	Default value	Description
recursive	`bool`	False
delete_nullable	`bool`	False

DEPENDENCIES

Parameters:

Name	Type	Default value	Description
search_nullable	`bool`	False

GET_ID

IS_ALIAS

IS_DIRTY

IS_SAVED

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

Return type:

bool

REFRESH

Return type:

ModelType

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

:raises Exception: If the input data is not a dict

Return type:

ModelType

TO_DTO

Return type:

BaseModelDTO

UNWRAP

ADD_INDEX - @classmethod

Parameters:

Name	Type	Default value	Description
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

Parameters:

Name	Type	Default value	Description
alias	`Any`

BIND - @classmethod

Parameters:

Name	Type	Default value
database	`Any`
bind_refs	`bool`	True
bind_backrefs	`bool`	True
_exclude	`Any`

BIND_CTX - @classmethod

Parameters:

Name	Type	Default value
database	`Any`
bind_refs	`bool`	True
bind_backrefs	`bool`	True

BULK_CREATE - @classmethod

Parameters:

Name	Type	Default value	Description
model_list	`Any`
batch_size	`Any`

BULK_UPDATE - @classmethod

Parameters:

Name	Type	Default value	Description
model_list	`Any`
fields	`Any`
batch_size	`Any`

CLASSNAME - @classmethod

Returns the name of the class

Parameters:

Name	Type	Default value	Description
slugify	`bool`	False	True to slugify the class name if true, defaults to false , optional
snakefy	`bool`	False	True to snakefy the class name if true, defaults to false , optional
replace_uppercase	`bool`	False	Replace upper cases by "-" if true, defaults to false , optional

Return type:

str

COLUMN_EXISTS - @classmethod

Returns True if the column exists in the table

Parameters:

Name	Type	Default value	Description
column_name	`str`		The column name ``

Return type:

bool

CREATE - @classmethod

Parameters:

Name	Type	Default value	Description
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

Parameters:

Name	Type	Default value	Description
field	`ForeignKeyField`		[description]

CREATE_FULL_TEXT_INDEX - @classmethod

Method to create a full text index

Parameters:

Name	Type	Default value	Description
columns	`List`		[description] [str]
index_name	`str`

CREATE_TABLE - @classmethod

Create model table

DECORATED_METHOD_NAMES - @classmethod

Parameters:

Name	Type	Default value	Description
decorator_name	`Any`

DELETE - @classmethod

DELETE_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
pk	`Any`

DROP_TABLE - @classmethod

Drop model table

FILTER - @classmethod

Parameters:

Name	Type	Default value	Description
dq_nodes	`Any`
filters	`Any`

FOREIGN_KEY_EXISTS - @classmethod

Parameters:

Name	Type	Default value	Description
column_name	`str`

Return type:

bool

FULL_CLASSNAME - @classmethod

Returns the full name of the class

Parameters:

Name	Type	Default value	Description
slugify	`bool`	False	Slugify the returned class name if true, defaults to false , optional
snakefy	`bool`	False	Snakefy the returned class name if true, defaults to false ``

Return type:

str

GET - @classmethod

Parameters:

Name	Type	Default value	Description
query	`Any`
filters	`Any`

GET_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
id	`str`

Return type:

Optional

GET_BY_ID_AND_CHECK - @classmethod

Get by ID and throw 404 error if object not found

Parameters:

Name	Type	Default value	Description
id	`str`		[description]

Return type:

ModelType

GET_BY_IDS - @classmethod

Parameters:

Name	Type	Default value	Description
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

Parameters:

Name	Type	Default value	Description
query	`Any`
filters	`Any`

GET_TABLE_NAME - @classmethod

Returns the table name of this class

Return type:

str

INDEX - @classmethod

Parameters:

Name	Type	Default value	Description
fields	`Any`

INDEX_EXISTS - @classmethod

Returns True if the index exists in the table

Parameters:

Name	Type	Default value	Description
index_name	`str`		The index name ``

Return type:

bool

INHERITORS - @classmethod

Get all the classes that inherit this class

Return type:

List

INSERT - @classmethod

Parameters:

Name	Type	Default value	Description
_Model__data	`Any`
insert	`Any`

INSERT_FROM - @classmethod

Parameters:

Name	Type	Default value	Description
query	`Any`
fields	`Any`

INSERT_MANY - @classmethod

Parameters:

Name	Type	Default value	Description
rows	`Any`
fields	`Any`

IS_MYSQL_ENGINE - @classmethod

METHOD_NAMES - @classmethod

Returns the list of the methods

Return type:

List

MODULE_NAME - @classmethod

Returns the module name of the class

Return type:

str

NOOP - @classmethod

PROPERTY_METHOD_NAMES - @classmethod

PROPERTY_NAMES - @classmethod

Retrieves the property names

Parameters:

Name	Type	Default value	Description
instance	`type`		The s of the properties to retrieve. set `none` to retrieve all. `type` or `union[type]`
exclude	`type`

Return type:

List

RAW - @classmethod

Parameters:

Name	Type	Default value	Description
sql	`Any`
params	`Any`

REPLACE - @classmethod

Parameters:

Name	Type	Default value	Description
_Model__data	`Any`
insert	`Any`

REPLACE_MANY - @classmethod

Parameters:

Name	Type	Default value	Description
rows	`Any`
fields	`Any`

SAVE_ALL - @classmethod

SEARCH - @classmethod

Performs full-text search on the field. Must be overrided by child class to work

Parameters:

Name	Type	Default value	Description
phrase	`str`		The phrase to search ``
modifier	`str`

Return type:

ModelSelect

SELECT - @classmethod

Parameters:

Name	Type	Default value	Description
fields	`Any`

SET_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
key	`Any`
value	`Any`

TABLE_EXISTS - @classmethod

TRUNCATE_TABLE - @classmethod

Parameters:

Name	Type	Default value	Description
options	`Any`

UPDATE - @classmethod

Parameters:

Name	Type	Default value	Description
_Model__data	`Any`
update	`Any`

VALIDATE_MODEL - @classmethod

COPY - @staticmethod

Parameters:

Name	Type	Default value	Description
method	`Any`

Stories

Live tasks

Bricks

Documentation

Model

Functions