Метод модели

Основное взаимодействие!!!tip с базой данных открыто для каждой модели в виде объекта QuerySet, открытого для Model.objects, похожего на django orm.

Прочитать больше о **quering, joining tables, excluding fields etc.visit [queries][queries] Раздел.**

Каждый экземпляр модели имеет набор способов сохранения, обновления или загрузки самого себя.

Доступные методы описаны ниже.

Педантичный метод

Обратите внимание, что каждая модель ormar.Model также является pydantic.BaseModel, поэтому все методы pydantic также могут быть использованы в модели, в частности методы model_dump () и model_dump_json (), которые также могут принимать исключения, включение и другие параметры.

Для получения дополнительной информации ознакомьтесь с документацией pydantic.

Модель_construct ()

model_construct является исходным эквивалентом метода__init__, который используется для построения новых экземпляров.

Разница заключается в том, что модель_construct пропускает проверку, поэтому ее следует использовать, когда вы знаете, что данные верны и достоверны. Преимущество использования конструкции заключается в том, что она ускоряет выполнение, поскольку пропускает проверку.

Примечание!!!Примечание Обратите внимание, что в отличие от метода pydantic.model_construct метод эквивалентности-ormar также будет работать с вложенными связанными моделями.

Предупреждение Помните, что, поскольку проверка пропущена, метод построения не выполняет никаких преобразований, проверок и т. д., поэтому на вас лежит ответственность за предоставление действительных данных для использования в базе данных.

Две вещи, которые имеют отношение к проблеме:

*  Providing a `default` value for not set fields
*  Initialize nested ormar models if you pass a dictionary or a primary key value

Модельный дамб ()

model_dump является методом, унаследованным от pydantic, но ormar добавляет свои собственные аргументы и имеет некоторые нюансы при использовании значений по умолчанию, поэтому для ясности он представлен здесь.

Модель_dump, как следует из названия, экспортирует данные из дерева модели в словарь.

Описание параметра model_dump:

Включить (или изменить)

include: Union[Set, Dict] = None

Набор имен полей или словарь для включения в возвращаемый словарь.

Обратите внимание, что у pydantic есть необычная схема включения/исключения полей из списка через индекс (так же, как и во вложенных моделях). Если вы хотите исключить поля из всех дочерних элементов, вам нужно передать ключ__all__в словарь.

Вы не можете исключить вложенные модели из Sets в pydantic, но можете сделать это в ormar (путем добавления двойного подчеркивания к именам связей, т. е. исключения названий категорий книг, которые вы можете использовать)exclude={"book__category__name"}

Ormar не поддерживает исключение/включение индексов и принимает упрощенные и более удобные для пользователя формы представления.

Чтобы проверить, как включить/исключить поля, включая вложенные поля, просмотрите раздел полей, содержащий пояснения и большое количество примеров.

!!!Обратите внимание, что в ormar вы можете исключить вложенные модели из коллекции, вы можете исключить из всего дерева моделей в response_model_exclude и response_model_include в fastapi!

Исключить (или изменить)

exclude: Union[Set, Dict] = None

Набор или словарь имен полей, которые необходимо исключить из возвращаемого словаря.

Обратите внимание, что у pydantic есть необычная схема включения/исключения полей из списка через индекс (как и во вложенных моделях). Если вы хотите исключить поля из всех дочерних элементов, вам нужно передать ключ__all__в словарь.

Вы не можете исключить вложенные модели из Sets в pydantic, но можете сделать это в ormar (путем добавления двойного подчеркивания к именам связей, т. е. исключения названий категорий книг, которые вы используете)exclude={"book__category__name"})

Ormar не поддерживает исключение/включение индексов и принимает упрощенные и более удобные для пользователя формы представления.

Чтобы проверить, как включить/исключить поля, включая вложенные поля, просмотрите раздел полей, содержащий пояснения и большое количество примеров.

!!!обращает внимание на то, что в ormar вы можете исключить вложенные модели из коллекции, а вы можете исключить из всего дерева моделей в response_model_exclude и response_model_include в fastapi!

Исключить_Отменить настройки

Исключить неустановленные: Логический = False

Flag указывает, следует ли исключить поля, которые не были заданы явно при создании модели, из возвращаемого словаря.

!!!Обратите внимание, что после сохранения данных в базе данных каждое поле имеет свое собственное значение->, которое может быть предоставлено вами, значение по умолчанию или нет.

That means that what you load the data from database,**all**fields are set, and this flag basically stop working!


Категория (Ormar.Model):
    ormar_config = base_ormar_config.copy (tablename="categories")

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100, default="Test")
    visibility: bool = ormar.Boolean(default=True)


class Item(ormar.Model):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100)
    price: float = ormar.Float(default=9.99)
    Категория: Список [Category] = ormar.ManyToMany(Категория)

Категория = Категория (name="тест 2")
assert category. model_dump () =={'id': None, 'items':[], 'name':'Test 2',
                           «Visibility»: True
category. model_dump (exclude_unset =True) == {'items': [], 'name': 'Test 2'}

category.save (
Категория 2 = await Category.objects.get ()
assert category2.model_dump() =={'id': 1, 'items':[], 'name':'Test 2',
                            «visibility»: True
# NOTE How after loading from db all fields are set explicitly
Это то, что произошло, когда вы по-прежнему используете модель из DB
assert category2.model_dump(exclude_unset =True) =={'id': 1, 'items':[],
                                              'name':'Test 2','visibility': True}

Исключить значения по умолчанию

exclude_defaults: bool = False

Значения флагов, равные значению по умолчанию (независимо от того, установлены они или нет), должны быть исключены из возвращаемого словаря

Категория (Ormar.Model):
    ormar_config = base_ormar_config.copy (tablename="categories")

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100, default="Test")
    visibility: bool = ormar.Boolean(default=True)

class Item(ormar.Model):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100)
    price: float = ormar.Float(default=9.99)
    Категория: Список [Category] = ormar.ManyToMany(Категория)

Категория = Категория ()
# note that Integer is by default autoincrement so optional
assert category. model_dump () == {'id': None, 'items': [], 'name': 'Test', 'visibility': True}
category. model_dump (exclude_defaults =True) == {'items': []}

# Save and Reload the data
category.save (
Категория 2 = await Category.objects.get ()

assert category2.model_dump() = {'id': 1, 'items': [], 'name': 'Test', 'visibility': True}
assert category2.model_dump(exclude_defaults =True) == {'id': 1, 'items': []}

Исключить_Нет

Исключить_Нет: Логический = False

Flag указывает, следует ли исключить поле, равное None, из возвращаемого словаря.

Категория (Ormar.Model):
    ormar_config = base_ormar_config.copy (tablename="categories")

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100, default="Test", nullable=True)
    visibility: bool = ormar.Boolean(default=True)


class Item(ormar.Model):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100)
    price: float = ormar.Float(default= 9,99)
    Категория: Список [Category] = ormar.ManyToMany(Категория)


Категория = Категория (Name=None)
assert category. model_dump () =={'id': None, 'items':[], 'name': None,
                           «Visibility»: True
Название: The id is not set yet so None and excluded
category. model_dump (exclude_none =True) == {'items': [], 'visibility': True}

category.save (
Категория 2 = await Category.objects.get ()
assert category2.model_dump() =={'id': 1, 'items':[], 'name': None,
                            «visibility»: True
assert category2.model_dump(exclude_none =True) =={'id': 1, 'items':[],
                                             «visibility»: True

except_primary_keys (только ormar)

exclude_primary_keys: bool = False

Если флаг имеет значение True, в дереве будут исключены все ключевые столбцы, включая вложенные модели.

class Item(ormar.Model):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100)

item1 = Item(id=1, name="Test Item")
assert item1.model_dump() == {"id": 1, "name": "Test Item"}
assert item1.model_dump(exclude_primary_keys =True) == {"name": "Test Item"}

except_through_models (только для ormar)

exclude_through_models: bool = False

Автоматическое добавление сквозных моделей для каждой связи "Мноя-несколько" и сохранение дополнительных параметров в связанной модели/таблице.

При установке except_through_models =True будут исключены все сквозные модели, включая подмодели.

Категория (Ormar.Model):
    ormar_config = base_ormar_config.copy (tablename="categories")

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100)


class Item(ormar.Model):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100)
    Категория: Список [Category] = ormar.ManyToMany(Категория)

# tree Defining the models
item_dict = {
            "name": "test",
            "категории": [{"name": "test cat"},{"name": "test cat2"}],
        }
# Save Whole Tree
await Item(** item_dict). save_related (ollow =True, save_all =True)

Get the Saved Values
item = await Item.objects.select ("categories").get(

Вы можете видеть через модули (itemcategory)
assert item. model_dump () ={'id': 1, 'name':'test',
                       Категория:[
                           {'id': 1, 'name':'test cat',
                            'itemcategory':{'id': 1, 'category': None, 'item': None}},
                           {'id': 2, 'name':'test cat2',
                            'itemcategory':{'id': 2, 'category': None, 'item': None}}
                       ]}

You Can Exclude Those Fields/ Models
assert item. model_dump (exclude_thrope_models =True) ={
                       'id': 1, 'name':'test',
                       Категория:[
                           {'id': 1, 'name': 'test cat'}, 
                           {'id': 2, 'name': 'test cat2'}
                       ]}

Модель_dump_json ()

Модель_dump_json () имеет точно те же параметры, что и модель_dump (), поэтому проверьте приведенное выше.

Конечным результатом, конечно, является строка, представленная json, а не словарь.

Получить_pydantic ()

get_pydantic(include: Union[Set, Dict] = None, exclude: Union[Set, Dict] = None)

Этот метод позволяет генерировать pydantic модель из ормара без необходимости повторного ввода всех полей.

Обратите внимание, что если у вас есть вложенная модель, она создаст для вас все дерево моделей pydantic! Но таким образом, чтобы предотвратить проблемы с циклическими ссылками.

Кроме того, можно передать исключения и/или включить параметры для сохранения только тех полей, которые необходимы, в том числе во вложенных моделях.

Это означает, что вы можете легко создать Pydantic модель для запросов и ответов в fastapi.

!!! Обратите внимание, что для получения дополнительной информации о возможных исключениях/включении и о том, как создать словарь исключений или настройки, посетите раздел Поля документа

Ниже приведен пример модели ormar:

«Органа»((
    metadata= sqalchemy (),
    Database=databases.Database(DATABAS_URL, force_rollback =True),
)


Категория (Ormar.Model):
    ormar_config = base_ormar_config.copy (tablename="categories")

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100)


class Item(ormar.Model):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100, default="test")
    Категория: Optional[Категория] = ormar.ForeignKey(Категория, nullable=True)

Вы можете создать Pydantic модель с помощью простого вызова.

1	`Pydantic Category = Category. get_pydantic (include={"id", "name"})`

В результате создается модель, эквивалентная следующему:

Категория (BaseModel):
    Optional[int]
    name: Optional[str] = "test"

!!! Внимание, что иметь несколько классов с тем же именем в одном модуле не является хорошей привычкой, и это может повредить файлу fastapi. Вот почему ormar добавляет случайные три заглавные буквы к классу. В приведенном выше примере это означает, что класс будет называться Category_XIP (BaseModel).

Чтобы исключить или включить вложенные поля, можно использовать словарь или двойное подчеркивание.

# Both calls are equivalent
Pydantic Category = Category. get_pydantic (include={"id", "items__id"})
PydanticCategory = Category. get_pydantic (include={"id": ..., "items":{"id"}})

Полученная структура выглядит следующим образом.

Класс (BaseModel):
    Optional[int]

Категория (BaseModel):
    Optional[int]
    items: Optional[Список [Item]]

Конечно, вы также можете использовать глубокие вложенные структуры, и ormar создаст для вас его pydantic эквиваленты (таким образом, чтобы исключить циклы).

Обратите внимание на то, что в модели Item выше нет ссылки на категорию, хотя отношения в ormar являются двунаправленными (и ormar.Item имеет поле категории).

Обратите внимание, что полученная модель pydantic наследует все валидаторы полей от исходной модели ormar, включая аутентификатор выбора ormar и валидатор, определенный с помощью декоритора pydantic.validator.

But, at the same time all root validators present on `ormar` models will**NOT**be copied to the generated pydantic model. Since root validator can operate on all fields and a user can exclude of some fields during generation of pydantic model it's not safe to copy those validators.
If required, you need to redefine/ manually copy them to generated pydantic model.

Загрузка ()

По умолчанию при запросе таблицы без предварительной извлечения связанной модели ormar будет строить связанные модели, но заполнять их только значением pk. Загрузить связанные модели можно, вызовав метод load().

load() также можно использовать для обновления модели из базы данных, если она была изменена другим процессом.

track = await Track.objects.get (name ='The Bird')
track.album.pk # will return malibu album pk (1)
track.album.name # will return None

You need to actually load the first
Album.load ()
track.album.name # will return 'Malibu'

Загрузить все.

load_all(follow: bool = False, exclude: Union[List, str, Set, Dict] = None) -> Model

Метод работает так же, как и метод load(), но он также обходит все отношения модели, которая вызвала метод, и перезагружает их из базы данных.

По умолчанию метод load_all загружает только те модели, которые непосредственно связаны с моделью, к которой он применяется (в одном шаге).

Однако можно задать параметр "follow=True" для прохождения вложенных моделей и загрузки всех их в дерево связей.

Предупреждение Во избежание циклического обновления с использованием параметра "flow =True" load_all сохраняет набор моделей, к которым были применены модели, и не выполняет вложенную загрузку для моделей, к которым они были подключены.

Если у вас есть какие-то новостные или круглые переходы типа you need to perform the loads in a manual way.

```python
# in example like this the second Street (coming from City) won't be load_all, so ZipCode won't be reloaded
Street -> District -> City -> Street -> ZipCode
```

Метод также принимает дополнительные параметры исключения, которые работают точно так же, как и метод исключения полей в QuerySet. Это позволяет удалять поля из обновляемой связанной модели или пропускать всю связанную модель.

Метод выполняет один запрос базы данных и, таким образом, более эффективен, чем вложенные вызовы load() и all() в связанной модели.

!!!tip Для получения дополнительной информации об исключениях см. except_fields

!!!Предупреждение о том, что все связи удалены для load_all (), поэтому при исключении некоторых вложенных моделей они будут пустыми после вызова.

Экономия ()

Save() -> себя

Для создания новой модели можно использовать метод QuerySet.create() или инициализировать модель в виде обычной модели pydantic и вызвать метод save().

save() также можно использовать для сохранения изменений модели, если первичный ключ не задан или модель не существует в базе данных.

Метод save() не проверяет, существует ли модель в базе данных, поэтому при попытке сохранить модель с помощью существующего первичного ключа из выбранного серверного сервера базы данных будет получена ошибка целостности.

track = Track(name ='The Bird')
track.save () # will persist the model in database

track = await Track.objects.get (name ='The Bird')
track.save () # will raise integrity error as pk is populated

Обновить ()

update(_columns: List[str] = None, **kwargs) -> self

Для обновления модели можно использовать метод QuerySet.update () или обновить свойства модели (поля) и вызвать метод update().

При попытке обновить модель без установки первичного ключа будет генерировано исключение ModelPersistenceError.

Для постоянного сохранения вновь созданной модели используйте команду save() или upsert(**Метод KwARG).

track = await Track.objects.get (name ='The Bird')
update(name ='The Bird Strikes Again')

Чтобы обновить в базе данных только выбранные столбцы модели, укажите список столбцов, которые следует обновить до параметра_columns.

В примере:

Class Movie(Ormar):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100, nullable=False, name="title")
    year: int = ormar.Integer()
    «Float = ormar. Float»(

terminator = await Movie(name ='Terminator', year=1984, profit= 0078).save()

terminator.name = "Terminator 2"
Terminator. Год = 1991
terminator.profit = 0520

# update only name
await terminator.update(_columns =["name"])

Примечание That Terminator instance was not reloaded so
Терминатор. год == 1991

But once you load the data from db you see it was not updated
ait terminator.load ()
Терминатор. год == 1984

!!!предупреждает, что update() не обновляет экземпляр модели, поэтому если вы измените больше столбцов, чем в входящем списке_columns, экземпляр модели будет иметь значение, отличное от значения базы данных!

Обновить вставку ()

uppsert (**kwargs) -> Я

Это прокси метода save() или update(**kwargs), описанного выше.

Если ключ установлен на->, вызывается метод обновления.

Если pk не задан, вызывается метод save().

track = Track(name ='The Bird')
wait track.upsert() will save as the pk is empty

track = await Track.objects.get (name ='The Bird')
await track.upsert (name ='The Bird Strikes Again')# will call update as pk is already populated

Удалить ()

Для удаления модели можно использовать метод QuerySet.delete () или использовать модель и вызвать метод delete().

track = await Track.objects.get (name ='The Bird')
Удалить () # will delete the model from database

!!!tip Обратите внимание, что объект трассировки остается неизменным и удаляются только записи из базы данных.

Сохранить связанные ()

save_related(follow: bool = False, save_all: bool = False, exclude=Optional[Union[Set, Dict]]) -> None

Метод проходит через все связи модели, к которой он был применен, и вызывает метод upsert() для каждой из несохраненных моделей.

Чтобы узнать, когда модель была сохранена, см. раздел о состоянии сохранения выше.

По умолчанию метод save_lated сохраняет только те модели, которые непосредственно связаны (в один шаг) с моделью, к которой он применяется.

Однако можно задать параметр "follow=True" для прохождения вложенных моделей и сохранения всех их в дереве связей.

По умолчанию save_lated сохраняются только модели в несохраненном состоянии, что означает, что они были изменены в текущем диапазоне.

Если требуется принудительно сохранить все связанные методы, используйте флаг save_all =True, который обновляет все связанные модели, независимо от их статуса сохранения.

Если необходимо пропустить сохранение некоторых связей, можно передать параметры исключения.

Exclude может быть набором собственных моделей отношений или словарем, который может содержать вложенные элементы.

!!!note Обратите внимание, что параметр исключения в save_lated принимает только имена связанных полей, поэтому при передаче каких-либо дополнительных полей они будут сохранены в любом случае.

!!!note Для получения дополнительной информации о структуре возможных значений, передаваемых исключенным, проверьте документацию по методу Queryset.fields.

Предупреждение: Во избежание циклического обновления с использованием параметра follow=True, save_lated сохраняет набор моделей в каждой ветви дерева связей и не выполняет вложенные save_lated для тех моделей, к которым обращаются.

Если у вас есть циркулярные типы, которые вы нуждаетесь в обработке, то есть в мануальной дороге.

Обратите внимание на то, что с помощью save_all =True и Follow=True можно одновременно сохранить все дерево связей с помощью save_lated ().

Примеры:

Класс Департамента (Ormar.Model):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    department_name: str = ormar.String(max_length =100)


Класс Course(Ormar.Model):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    course_name: str = ormar.String(max_length =100)
    bool = ormar.Boolean()
    Departments: Optional[Department] = ormar.ForeignKey(Department)


Класссный студент (Ormar):
    ormar_config = base_ormar_config ()

    id: int = ormar.Integer(primary_key =True)
    name: str = ormar.String(max_length =100)
    Courses = ormar.ManyToMany(Course)

to_save = {
            "departament_name": "Ormar",
            "Курсы": [
                {"course_name": "basic1",
                 "completed": True,
                 «Студия»: [
                     {"name": "Jack"},
                     {"name": "Abi"}
                 ]},
                {"course_name": "basic2",
                 "completed": True,
                 «Студия»: [
                     {"name": "Kate"},
                     {"name": "Miranda"}
                 ]
                 },
            ],
        }
# initialize whole tree
Departments = Department(** to_save)

Save All At Once (One After Another)
department.save (ollow =True, save_all =True)

department_check = await Department.objects.select (flow =True).get()

to_exclude = {
    "id": ...,
    «courses»: {
        "id": ...,
        «Студия»: {"id", "studentcourse"}
    }
}
# after excluding ids and through models you get exact same payload used to
# construct whole tree
assert departament_check. model_dump (exclude= to_exclude) == to_save

Предупреждает, что save_lated () повторяет все связи и все модели и обновляет их по одному, поэтому он сохраняет все модели, но может оказаться не лучшим с точки зрения количества запросов базы.