Python-ORM-2024

Important commands

Zip project on Mac/Linux

   zip -r project.zip . -x "*.idea*" -x "*venv*" -x "*__pycache__*"

Zip project on Windows

   tar -czvf project.zip --exclude='.idea' --exclude='.venv' --exclude='__pycache__' .

Creation of Venv

	python3 -m venv ./venv
	source ./venv/bin/activate
	venv\Scripts\activate

dbshell on Docker

	docker exec -t <container_name> /bin/bash
	psql -U your_user_me -d your_db_name

Helpers

Populate Django DB Script

Theory Tests

Django Models Basics

Migrations and Django Admin

Plans

Django Models

ORM - Object Relational Mapping

ORM - Предимства и недостатъци
- Pros:
  - Не ни се налага писането на low level SQL
  - По-лесна поддръжка
  - Добър при CRUD операции
- Cons:
  - Не много оптимизиран за по-сложни заявки
  - Възможно е да влага излишна сложност в някои от заявките
Django models
- Всеки модел е отделна таблица
- Всяка променлова използваща поле от models е колона в тази таблица
Създаване на модели
- Наследяваме models.Model
Migrations
- makemigrations - създава миграции
- migrate - прилага миграциите
Други команди
- dbshell - отваря конзола, в която можем да пишем SQL
- CTRL + ALT + R - отваря manage.py console

Migrations and Admin

Django Migrations Advanced
- Миграциите ни помагат надграждаме промени в нашите модели
- Както и да можем да пазим предишни стейтове на нашата база
- Команди:
  - makemigrations
  - migrate
  - Връщане до определена миграция - migrate main_app 0001
  - Връщане на всички миграции - migrate main_app zero
  - showmigrations - показва всички апове и миграциите, които имат
  - showmigrations app_name - показва миграциите за един app
  - showmigrations --list - showmigrations -l
  - squashmigrations app_name migration_to_which_you_want_to_sqash - събира миграциите до определена миграция в една миграция
  - sqlmigrate app_name migration_name - дава ни SQL-а на текущата миграция - използваме го, за да проверим дали миграцията е валидна
  - makemigrations --empty main_app - прави празна миграция в зададен от нас app
Custom/Data migrations
- Когато например добавим ново поле, искаме да го попълним с данни на база на вече съществуващи полета, използваме data migrations
- RunPython
  - викайки функция през него получаваме достъп до всички апове и техните модели (първи параметър), Scheme Editor (втори параметър)
  - добра практика е да подаваме фунцкия и reverse функция, за да можем да връяа безпроблемно миграции
- Scheme Editor - клас, който превръща нашия пайтън код в SQL, ползваме го когато правим create, alter и delete на таблица
  - използвайки RunPython в 95% от случаите няма да ни се наложи да ползавме Scheme Editor, освен, ако не правим някаква временна таблица индекси или промяна на схемата на таблицата
- Стъпки:
  
  2.1. Създаваме празен файл за миграция: makemigrations --empty main_app - прави празна миграция в зададен от нас app
  
  2.2. Дефиниране на операции - Използваме RunPython за да изпълним data migrations
  
  2.3. Прилагане на промените - migrate

Пример с временна таблица:

Да приемем, че имате модел с име „Person“ във вашето Django приложение и искате да създадете временна таблица, за да съхранявате някои изчислени данни въз основа на съществуващите данни в таблицата „Person“. В този случай можете да използвате мигриране на данни, за да извършите тази операция:

Create the Data Migration:

Run the following command to create a data migration:

python manage.py makemigrations your_app_name --empty

This will create an empty data migration file.

Edit the Data Migration:

Open the generated data migration file and modify it to use RunPython with a custom Python function that utilizes the SchemaEditor to create a temporary table. Here's an example:

from django.db import migrations, models

def create_temporary_table(apps, schema_editor):
    # Get the model class
    Person = apps.get_model('your_app_name', 'Person')

    # Access the SchemaEditor to create a temporary table
    schema_editor.execute(
        "CREATE TEMPORARY TABLE temp_person_data AS SELECT id, first_name, last_name FROM your_app_name_person"
    )

def reverse_create_temporary_table(apps, schema_editor):
    schema_editor.execute("DROP TABLE temp_person_data")

class Migration(migrations.Migration):

    dependencies = [
        ('your_app_name', 'previous_migration'),
    ]

    operations = [
        migrations.RunPython(create_temporary_table, reverse_create_temporary_table),
    ]

Django admin

createsuperuser
Register model, example:

   @admin.register(OurModelName)
   class OurModelNameAdmin(admin.ModelAdmin):
	pass

Admin site customizations

str метод в модела, за да го визуализираме в админ панела по-достъпно

list_display - Показваме различни полета още в админа Пример:

class EmployeeAdmin(admin.ModelAdmin):
	list_display = ['job_title', 'first_name', 'email_address']

List filter - добавя страничен панел с готови филтри Пример:
```
 class EmployeeAdmin(admin.ModelAdmin):
 	list_filter = ['job_level']
```
Searched fields - казваме, в кои полета разрешаваме да се търси, по дефолт са всички Пример:
```
class EmployeeAdmin(admin.ModelAdmin):
    search_fields = ['email_address']
```
Layout changes - избираме, кои полета как и дали да се появяват при добавяне или промяна на запис Пример:
```
class EmployeeAdmin(admin.ModelAdmin):
    fields = [('first_name', 'last_name'), 'email_address']
```
list_per_page

fieldsets - променяме визуално показването на полетата Пример:

  fieldsets = (
       ('Personal info',
        {'fields': (...)}),
       ('Advanced options',
        {'classes': ('collapse',),
       'fields': (...),}),
  )

VladimirMilchev/Python-ORM-2024