SQL Insert

Drizzle ORM은 데이터베이스 테이블에 행을 삽입하는 가장 SQL과 유사한 방법을 제공합니다.

Insert one row

Drizzle로 데이터를 삽입하는 것은 매우 간단하고 SQL과 유사합니다. 직접 확인해보세요:

await db.insert(users).values({ name: 'Andrew' });

insert into "users" ("name") values ("Andrew");

특정 테이블의 insert 타입이 필요한 경우 typeof usersTable.$inferInsert 구문을 사용할 수 있습니다.

type NewUser = typeof users.$inferInsert;

const insertUser = async (user: NewUser) => {
  return db.insert(users).values(user);
}

const newUser: NewUser = { name: "Alef" };
await insertUser(newUser);

Insert returning

PostgreSQL

SQLite

MySQL

SingleStore

PostgreSQL과 SQLite에서 다음과 같이 행을 삽입하고 반환받을 수 있습니다:

await db.insert(users).values({ name: "Dan" }).returning();

// partial return
await db.insert(users).values({ name: "Partial Dan" }).returning({ insertedId: users.id });

Insert $returningId

PostgreSQL

SQLite

MySQL

SingleStore

MySQL 자체는 INSERT 사용 후 RETURNING에 대한 네이티브 지원이 없습니다. autoincrement(또는 serial) 타입을 가진 primary keys의 경우 insertId와 affectedRows 필드에 액세스할 수 있는 한 가지 방법만 있습니다. Drizzle로 이러한 경우를 처리하고 삽입된 모든 ID를 별도의 객체로 자동으로 받을 수 있는 자동 방법을 준비했습니다

import { boolean, int, text, mysqlTable } from 'drizzle-orm/mysql-core';

const usersTable = mysqlTable('users', {
  id: int('id').primaryKey(),
  name: text('name').notNull(),
  verified: boolean('verified').notNull().default(false),
});


const result = await db.insert(usersTable).values([{ name: 'John' }, { name: 'John1' }]).$returningId();
//    ^? { id: number }[]

또한 Drizzle을 사용하면 런타임에 사용자 정의 기본 키를 생성하는 $default 함수로 primary key를 지정할 수 있습니다. $returningId() 호출에서 생성된 키도 반환해드립니다

import { varchar, text, mysqlTable } from 'drizzle-orm/mysql-core';
import { createId } from '@paralleldrive/cuid2';

const usersTableDefFn = mysqlTable('users_default_fn', {
  customId: varchar('id', { length: 256 }).primaryKey().$defaultFn(createId),
  name: text('name').notNull(),
});


const result = await db.insert(usersTableDefFn).values([{ name: 'John' }, { name: 'John1' }]).$returningId();
//  ^? { customId: string }[]

기본 키가 없는 경우 -> 이러한 쿼리의 타입은 {}[]이 됩니다

Insert multiple rows

await db.insert(users).values([{ name: 'Andrew' }, { name: 'Dan' }]);

Upserts and conflicts

Drizzle ORM은 upsert와 충돌 처리를 위한 간단한 인터페이스를 제공합니다.

On conflict do nothing

PostgreSQL

SQLite

MySQL

SingleStore

onConflictDoNothing은 충돌이 있을 경우 삽입을 취소합니다:

await db.insert(users)
  .values({ id: 1, name: 'John' })
  .onConflictDoNothing();

// explicitly specify conflict target
await db.insert(users)
  .values({ id: 1, name: 'John' })
  .onConflictDoNothing({ target: users.id });

On conflict do update

PostgreSQL

SQLite

MySQL

onConflictDoUpdate는 충돌이 있을 경우 행을 업데이트합니다:

await db.insert(users)
  .values({ id: 1, name: 'Dan' })
  .onConflictDoUpdate({ target: users.id, set: { name: 'John' } });

`where` 절

on conflict do update는 두 가지 다른 위치에 where 절을 가질 수 있습니다 - 충돌 대상의 일부(예: 부분 인덱스용) 또는 update 절의 일부로:

insert into employees (employee_id, name)
values (123, 'John Doe')
on conflict (employee_id) where name <> 'John Doe'
do update set name = excluded.name

insert into employees (employee_id, name)
values (123, 'John Doe')
on conflict (employee_id) do update set name = excluded.name
where name <> 'John Doe';

Drizzle에서 이러한 조건을 지정하려면 setWhere와 targetWhere 절을 사용할 수 있습니다:

await db.insert(employees)
  .values({ employeeId: 123, name: 'John Doe' })
  .onConflictDoUpdate({
    target: employees.employeeId,
    targetWhere: sql`name <> 'John Doe'`,
    set: { name: sql`excluded.name` }
  });

await db.insert(employees)
  .values({ employeeId: 123, name: 'John Doe' })
  .onConflictDoUpdate({
    target: employees.employeeId,
    set: { name: 'John Doe' },
    setWhere: sql`name <> 'John Doe'`
  });

복합 인덱스 또는 onConflictDoUpdate를 위한 복합 기본 키를 사용한 Upsert:

await db.insert(users)
  .values({ firstName: 'John', lastName: 'Doe' })
  .onConflictDoUpdate({
    target: [users.firstName, users.lastName],
    set: { firstName: 'John1' }
  });

On duplicate key update

PostgreSQL

SQLite

MySQL

SingleStore

MySQL은 ON CONFLICT 절 대신 ON DUPLICATE KEY UPDATE를 지원합니다. MySQL은 기본 키와 고유 인덱스를 기반으로 충돌 대상을 자동으로 결정하며, 모든 고유 인덱스 충돌 시 행을 업데이트합니다.

Drizzle은 onDuplicateKeyUpdate 메서드를 통해 이를 지원합니다:

// Note that MySQL automatically determines targets based on the primary key and unique indexes
await db.insert(users)
  .values({ id: 1, name: 'John' })
  .onDuplicateKeyUpdate({ set: { name: 'John' } });

MySQL은 충돌 시 아무 작업도 수행하지 않는 것을 직접 지원하지 않지만, 임의의 컬럼 값을 자신으로 설정하여 no-op을 수행하고 동일한 효과를 얻을 수 있습니다:

import { sql } from 'drizzle-orm';

await db.insert(users)
  .values({ id: 1, name: 'John' })
  .onDuplicateKeyUpdate({ set: { id: sql`id` } });

`with insert` 절

select, update, delete와 함께 WITH 문을 사용하는 방법을 확인하세요

with 절을 사용하면 복잡한 쿼리를 공통 테이블 표현식(CTE)이라고 하는 더 작은 하위 쿼리로 분할하여 단순화할 수 있습니다:

const userCount = db.$with('user_count').as(
	db.select({ value: sql`count(*)`.as('value') }).from(users)
);

const result = await db.with(userCount)
	.insert(users)
	.values([
		{ username: 'user1', admin: sql`((select * from ${userCount}) = 0)` }
	])
	.returning({
		admin: users.admin
	});

with "user_count" as (select count(*) as "value" from "users") 
insert into "users" ("username", "admin") 
values ($1, ((select * from "user_count") = 0)) 
returning "admin"

Insert into … select

SQLite 문서에서 언급하듯이:

INSERT 문의 두 번째 형식은 VALUES 절 대신 SELECT 문을 포함합니다. SELECT 문 실행으로 반환된 각 데이터 행에 대해 새 항목이 테이블에 삽입됩니다. column-list가 지정된 경우, SELECT 결과의 컬럼 수는 column-list의 항목 수와 같아야 합니다. 그렇지 않으면, column-list가 지정되지 않은 경우 SELECT 결과의 컬럼 수는 테이블의 컬럼 수와 같아야 합니다. 복합 SELECT 및 ORDER BY 및/또는 LIMIT 절이 있는 SELECT 문을 포함한 모든 SELECT 문을 이 형식의 INSERT 문에서 사용할 수 있습니다.

IMPORTANT

파싱 모호성을 피하기 위해, upsert 절이 있는 경우 SELECT 문은 항상 WHERE 절을 포함해야 하며, 단순히 “WHERE true”인 경우에도 마찬가지입니다. WHERE 절이 없으면 파서는 토큰 “ON”이 SELECT의 조인 제약 조건의 일부인지 upsert 절의 시작인지 알 수 없습니다.

PostgreSQL 문서에서 언급하듯이:

삽입할 행을 제공하는 쿼리(SELECT 문)

그리고 MySQL 문서에서 언급하듯이:

INSERT … SELECT를 사용하면 하나 또는 여러 테이블에서 선택할 수 있는 SELECT 문의 결과로부터 테이블에 많은 행을 빠르게 삽입할 수 있습니다

Drizzle은 모든 dialect에 대한 현재 구문을 지원하며, 모두 동일한 구문을 공유합니다. 몇 가지 일반적인 시나리오와 API 사용법을 검토해 보겠습니다. insert 문 내에서 select를 사용하는 여러 가지 방법이 있어 선호하는 방식을 선택할 수 있습니다:

select 함수 내부에 쿼리 빌더를 전달할 수 있습니다.
콜백 내부에서 쿼리 빌더를 사용할 수 있습니다.
사용하려는 사용자 정의 select 쿼리와 함께 SQL 템플릿 태그를 전달할 수 있습니다

Query Builder

Callback

SQL template tag

const insertedEmployees = await db
  .insert(employees)
  .select(
    db.select({ name: users.name }).from(users).where(eq(users.role, 'employee'))
  )
  .returning({
    id: employees.id,
    name: employees.name
  });

const qb = new QueryBuilder();
await db.insert(employees).select(
    qb.select({ name: users.name }).from(users).where(eq(users.role, 'employee'))
);

await db.insert(employees).select(
    () => db.select({ name: users.name }).from(users).where(eq(users.role, 'employee'))
);

await db.insert(employees).select(
    (qb) => qb.select({ name: users.name }).from(users).where(eq(users.role, 'employee'))
);

await db.insert(employees).select(
    sql`select "users"."name" as "name" from "users" where "users"."role" = 'employee'`
);

await db.insert(employees).select(
    () => sql`select "users"."name" as "name" from "users" where "users"."role" = 'employee'`
);

SQL Insert

Insert one row

Insert returning

Insert $returningId

Insert multiple rows

Upserts and conflicts

On conflict do nothing

On conflict do update

where 절

On duplicate key update

with insert 절

Insert into … select

`where` 절

`with insert` 절