Англійський словник для розробників Drizzle ORM

Drizzle ORM набув значної популярності як легкий, безпечний для типів набір інструментів бази даних для TypeScript. Його SQL-подібний конструктор запитів і підхід схеми-як-код вимагають певного словника, щоб обговорити його чітко. Незалежно від того, чи ви залучаєте колегу, переглядаєте запит на звантаження або пишете документацію щодо бази даних, у цій статті ви знайдете необхідні вам інструменти англійської мови.

Ключовий словник

** Визначення схеми ** У Drizzle схема бази даних визначається в коді TypeScript за допомогою функцій визначення схеми Drizzle. Цей підхід схеми як коду означає, що структура вашої бази даних контролюється версіями разом з кодом вашої програми. Приклад: “Ми визначили всі наші таблиці у файлі schema.ts і використовуємо Drizzle Kit для створення і застосування міграцій.”

** Конструктор запитів ** Конструктор запитів Drizzle є плавним, безпечним для типів API для побудови SQL-запитів у TypeScript. На відміну від традиційного ORM, він близько відображає структуру SQL, що робить генеровані запити передбачуваними.

• Приклад: « Конструктор запитів надає вам змогу писати складні з’ єднання і підзапити у TypeScript, зберігаючи повний захист типів ». *

Миграція Міграція — це зміна версії у схемі бази даних, наприклад, створення таблиці, додавання стовпчика або створення індексу. Drizzle Kit створює файли перенесення автоматично, порівнюючи визначення поточної схеми з попереднім станом.

• Приклад: « Запустити drizzle-kit generate, щоб створити файл міграції для змін, які ви внесли до схеми. » *

** Виведення типу ** Одним з ключових пунктів продажу Drizzle є автоматичне виведення типів — типи TypeScript для результатів запиту виводяться з визначення схеми, тому ви отримуєте повну безпеку типів без написання окремих визначення типів.

• Приклад: « Оскільки Drizzle виводить типи з схеми, результат цього запиту буде введено автоматично — ви отримаєте помилку компіляції, якщо спробуєте отримати доступ до поля, якого не існує. » *

** Подготовленное заявление ** Підготований запит — це попередньо зібраний запит SQL, який база даних може виконувати неодноразово з різними параметрами. Drizzle підтримує підготовлені команди для поліпшення швидкодії і безпеки.

• Приклад: « Ми використовуємо підготовлений запит для пошуку продукту, оскільки його викликають тисячі разів за хвилину. » *

Поширені сценарії, де використовується ця мова

В обзоре кода: “Я бачу, що ви використовуєте сирий запит SQL. Чи можемо ми скористатися конструктором запитів Drizzle? Це дасть нам безпеку типів і зробить запит легшим для перефакторизації, якщо схема зміниться»

** Під час запуску нового розробника: ** «Наша схема бази даних визначена в src/db/schema.ts. Ми використовуємо Drizzle Kit для створення міграцій, коли ми змінюємо схему. Ніколи не змінюйте базу даних безпосередньо — всі зміни проходять через міграції»

** В обговоренні технічного рішення: ** “Ми оцінюємо Drizzle проти Prisma для цього проекту. Перевага Drizzle в тому, що він ближчий до SQL і має нижчий рівень витрат, але Prisma має більшу екосистему і більш зрілі інструменти міграції. Для проекту, де нам потрібен чіткий контроль запитів і продуктивність, я б схилявся до Drizzle»

Корисні фрази для обговорень ORM Drizzle

• Схема визначена в TypeScript, тому будь-які зміни відстежуються в системі контролю версій
• «Drizzle генерує міграцію автоматично на основі відмінності між поточною і попередньою схемою.»
• «Ми використовуємо конструктор запитів для складних запитів і сирого SQL тільки як останню інстанцію.»
• «Виведення типів означає, що нам не потрібно підтримувати окремі інтерфейси TypeScript для наших моделей баз даних»
• “Підготовлений запит кешується і повторно використовується в запитах, що значно покращує продуктивність.”
• «Щоб застосувати міграцію, запустіть drizzle-kit push в середовищі розробки або генерований SQL в виробництві»
• «Я додав індекс до цієї колонки, щоб прискорити пошуковий запит — ви можете побачити це в визначенні схеми»
• «Реляційний API Drizzle робить легшим визначати і запитувати відносини без написання явних з’єднань кожен раз»
• «Це з’єднання написано в конструкторі запитів Drizzle, який генерує оптимізований SQL під капотом.»
• «Ми маємо тест, який перевіряє, чи схема відповідає стану бази даних на кожному CI-запуску»

Порівняння Drizzle з іншими інструментами бази даних

Поширена розмова в проектах TypeScript порівнює Drizzle з його альтернативами. Ось як можна чітко сформулювати ці порівняння англійською мовою:

«Drizzle є SQL-першим — конструктор запитів читає як SQL, що означає, що знання SQL передаються безпосередньо. Prisma є більш абстракцією, що може бути легше вивчити, але важче оптимізувати для складних запитів»

«У порівнянні з сирим SQL з бібліотекою, як postgres.js, Drizzle додає безпеку типів і управління схемами, зберігаючи синтаксис запиту знайомим»

«Drizzle є хорошим вибором, коли продуктивність і безпека типів є двома пріоритетами, а ваша команда добре володіє SQL. Якщо вам потрібен більш критичний ORM з більшою екосистемою плагінів, Prisma може бути кращим вибором»

Запис документації бази даних за допомогою програми Drizzle

Під час документування шару бази даних, заснованої на Drizzle, поясніть структуру схеми простою англійською мовою разом з кодом. Для кожної таблиці описайте її призначення і зв’ язки, у яких вона бере участь. Для неочевидних назв стовпчиків або обмежень додайте коментар, у якому буде пояснено логіку роботи.

Задокументуйте процес перенесення для вашої команди: як вносити зміни у схему, як створювати і переглядати перенесення, і як безпечно застосовувати їх у виробництві.

Практичні рекомендації

Погляньте на файл schema.ts з проекту Drizzle — або ваш власний, або приклад з відкритим кодом на GitHub. Напишіть опис схеми англійською мовою обсягом 200 слів: які таблиці існують, що представляє кожна таблиця, і як ці таблиці пов’ язані між собою. Сфокусуйтеся на поясненні бізнес-домену, а не технічного впровадження. Це документація, яка допомагає новим членам команди швидко зрозуміти структуру бази даних.

Навігація та зв’язок

Для не-рідних мовців, розуміння нюансів зворотнього зв’язку в команді розробників може бути особливо складним. Це не просто про те, чи ваш код працює; це про те, як ця робота сприймається і передається. Розглянемо деякі поширені сценарії, що включають конструктивну критику і спільне формулювання, які часто вимагають точного словника, крім простого «доброго» або «поганого»

Часта ситуація виникає під час перегляду коду. Замість того, щоб сказати щось на зразок: «Це не компілюється», що може здатися тупим, рецензент може запропонувати: «Я бачу проблему з виведенням типів тут. Чи могли б ви дослідити використання більш чітких анотацій типів, щоб надати компілятору вказівки?» Ця фраза виявляє технічну проблему, але трактує її як запит на дослідження і поліпшення — пропонує * розв’ язання *, а не просто вказує на помилку. Аналогічно, якщо хтось каже: «Цей запит можна було б оптимізувати», вони не обов’язково критикують ваш підхід; вони пропонують альтернативу, яка може призвести до кращої продуктивності. Це ефективність і потенційна масштабованість, концепції, які часто найкраще виражаються обережними формулюваннями. Інша поширена проблема виникає при обговоренні змін в самому описі PR. Сказати “Виявлено ваду” - це занадто неочевидно. Ефективнішим описом буде « Впроваджено захист від потенційних помилок нульових посилань за допомогою додавання тверджень про типи під час отримання даних ». Це показує не лише те, що було змінено, але і * чому * це було змінено — важливо для контексту і майбутнього супроводження. Врешті-решт, ключовим є навчання інтерпретувати ці фрази як запрошення до вдосконалення вашої роботи, а не як пряму критику.

Крім того, пам’ятайте, що «країнні випадки» часто обговорюються в певний спосіб. Замість того, щоб просто стверджувати, що існує « крайній випадок », розробники часто описують його з великою точністю: « Ми виявили крайній випадок, коли перевірка схеми зазнає невдачі, коли стовпчик бази даних містить неочікувані символи пробілу. » Такий рівень деталізації демонструє ретельність і допомагає іншим зрозуміти потенційний обсяг проблеми. Вміння чітко сформулювати ці складні сценарії є життєво важливим для ефективного співробітництва, особливо при обговоренні потенційного впливу на стабільність системи або цілісність даних.

І, нарешті, не бійтеся прохання про пояснення. Якщо частина зворотного зв’язку здається неясною, ввічливо запитайте пояснення - “Чи можете ви розібратися, що ви маєте на увазі під “покращенням читабельності” в цьому контексті?” - показує залученість і бажання навчатися. Більшість досвідчених розробників з радістю надають вам додаткові поради, особливо якщо вони бачать вашу готовність зрозуміти їхні погляди.

Ось приклад того, як можна використовувати функцію Drizzle у описі PR:

drizzle way migrate --prerelease

Ця команда показує використання drizzle way, що є звичайним скороченням для виконання міграцій за допомогою Drizzle, і --prerelease, що вказує на те, що міграцію було перевірено у середовищі перевірки перед її розгортанням. Такий спосіб використання командного рядка часто обговорюється під час перегляду змін до схеми бази даних або моделей даних.