@pdg/drizzle-mssql
v1.0.49
Published
Drizzle ORM MSSQL 보조 라이브러리
Readme
@pdg/drizzle-mssql
Drizzle ORM과 mssql을 사용하는 Node.js용 SQL Server 보조 라이브러리입니다. [email protected]를 기준으로 합니다.
설치
npm install @pdg/drizzle-mssql [email protected] mssql@^11사용
연결과 스키마
테이블 정의에는 Drizzle의 SQL Server 스키마 API를 패키지 루트에서 가져올 수 있습니다. 연결은 url 또는 mssql 드라이버 설정과 스키마를 전달해 만듭니다. url을 사용할 때 server, port, user, password, database는 함께 전달할 수 없습니다.
import {
drizzleMsSql,
datetime2,
int,
mssqlTable,
nvarchar,
} from '@pdg/drizzle-mssql';
const users = mssqlTable('users', {
id: int('id').identity().primaryKey(),
name: nvarchar('name', { length: 100 }).notNull(),
email: nvarchar('email', { length: 255 }),
created_at: datetime2('created_at'),
updated_at: datetime2('updated_at'),
});
const posts = mssqlTable('posts', {
id: int('id').identity().primaryKey(),
user_id: int('user_id').notNull(),
title: nvarchar('title', { length: 200 }).notNull(),
});
const db = drizzleMsSql({
url: process.env.DATABASE_URL!,
schema: { users, posts },
getTimestamp: () => new Date(),
});
const user = db.query(users);연결 문자열 대신 mssql 설정을 직접 전달할 수도 있습니다. options에는 mssql 드라이버 옵션을 지정합니다.
const db = drizzleMsSql({
server: process.env.DB_SERVER!,
port: Number(process.env.DB_PORT!),
user: process.env.DB_USER!,
password: process.env.DB_PASSWORD!,
database: process.env.DB_DATABASE,
options: { encrypt: true },
schema: { users, posts },
});스키마 타입은 schema에 전달한 객체에서 추론됩니다. 테이블명과 컬럼명의 자동완성을 유지하려면 스키마를 넓은 Record<string, MsSqlTable> 타입으로 지정하지 않고 구체적인 타입을 유지하세요.
반환 타입 DrizzleMsSql<typeof schema>와 MsSqlAliases, MsSqlSchemaConditions를 공개합니다. 연결 타입과 테이블별 보조 함수 타입을 분리하며, query(table)은 전달받은 테이블만으로 타입을 추론합니다. 등록된 테이블 외에도 별칭 테이블이나 직접 가져온 테이블을 전달할 수 있습니다.
const u = db.a.users('u');
const fields = db.columns(u, 'id', 'name as displayName');
const query = db.query(u);200개 테이블에 대한 자동완성 후보를 TypeScript Language Service 테스트로 검증합니다. IDE 자체의 자동완성 동작은 사용하는 TypeScript 엔진과 설정에 따라서도 달라질 수 있습니다.
drizzleMsSql에는 schema와 url 또는 직접 연결 설정이 필요하며, getTimestamp는 선택 사항입니다. new MsSqlQuery(table, db.current, getTimestamp?)에서 생성 함수를 지정하면 해당 쿼리에서 우선 사용합니다. db.query(table)은 해당 테이블에 맞춰 타입이 지정된 쿼리 객체를 반환합니다. 연결을 다 사용한 뒤 await db.close()로 커넥션 풀을 닫습니다.
데이터 추가·수정·삭제
user.addValues(...)와 user.editValues(...)는 테이블의 입력 타입을 검사하고 전달한 값을 그대로 반환합니다. 실제 정책 검사와 시각 생성은 add와 edit에서 수행합니다.
IDENTITY 컬럼이 있는 테이블에서 add는 OUTPUT으로 생성된 값을 반환합니다. 여러 행을 넣으면 값의 배열을 반환하고, IDENTITY 컬럼이 없으면 단일 행에는 undefined, 여러 행에는 undefined 배열을 반환합니다. 해당 INSERT 동작에 활성 트리거가 있는 테이블에서는 SQL Server가 결과를 직접 반환하는 OUTPUT을 허용하지 않습니다. 생성 키의 타입은 IDENTITY 컬럼의 타입을 따릅니다.
const id = (await user.add({ name: '홍길동', email: '[email protected]' })) as number;
const ids = await user.add([
{ name: '김민수', email: '[email protected]' },
{ name: '이서연', email: '[email protected]' },
]);
await user.editByPrimaryKey({ name: '김민수' }, id);
await user.removeByPrimaryKey(id);조건으로 수정·삭제할 때는 반드시 SQL 조건을 전달해야 합니다. 실수로 테이블 전체를 갱신하거나 삭제하지 않도록 조건이 없으면 오류가 발생합니다.
await user.edit({ name: '수정된 이름' }, user.eq({ id }));
await user.remove(user.eq({ id }));복합 기본 키 테이블은 기본 키 컬럼명을 모두 포함한 객체를 사용합니다. 단일 기본 키는 값 하나 또는 기본 키 객체를 전달할 수 있습니다. 테이블 수준으로 정의한 복합 기본 키는 Drizzle 타입에 컬럼 목록이 노출되지 않으므로 런타임에 필수 키를 검사합니다.
const found = await user.findByPrimaryKey(id);
const exists = await user.existsByPrimaryKey(id);
const missing = await user.notExistsByPrimaryKey(id);조회와 컬럼 선택
select는 Drizzle 조회 빌더를 반환하므로 where, orderBy, offset, fetch 등 Drizzle의 빌더 메서드를 이어서 사용할 수 있습니다. find는 한 행을 조회하며, 결과가 없으면 undefined를 반환합니다.
const rows = await user
.select(['id', 'name'])
.where(user.gt({ id: 0 }))
.orderBy(user.t.id)
.offset(0)
.fetch(20);
const found = await user.find(['id', 'name'], user.eq({ id }));
const foundWithAlias = await user.find({ id_2: 'id' }, user.eq({ id }));
const foundByPrimaryKeyWithAlias = await user.findByPrimaryKey({ id_2: 'id' }, id);
const count = await user.count(user.isNotNull('email'));
const exists = await user.exists(user.eq({ email: '[email protected]' }));연결 객체의 select(table, fields?)에서도 같은 선택 기능을 사용할 수 있습니다. 첫 인자는 등록된 스키마의 테이블명 또는 alias 테이블이며, 이후 선택 인자와 반환 빌더는 MsSqlQuery.select와 동일합니다.
const rows = await db.select('users', ['id', 'name']).where((q) => q.gt({ id: 0 }));
const u = db.a.users('u');
const aliasedRows = await db.select(u, (q) => q.columns('id', 'name as displayName'));select의 첫 인자로 .as()가 반환한 서브쿼리도 전달할 수 있습니다. 서브쿼리에서 선택한 컬럼만 외부 조회에 사용할 수 있습니다.
const aa = db.select('users', ['id', 'name']).where(q => q.eq({ id: 1 })).as('aa');
const rows = await db.select(aa, q => q.columns('id', 'name'));min과 max는 컬럼 객체 또는 스키마 속성명으로 집계 필드를 만듭니다. select와 find의 선택 객체 또는 선택 콜백에서 사용할 수 있습니다.
const maxIdRows = await user.select({ max_id: user.max(user.t.id) });
const found = await user.find({ min_id: user.min('id') }, user.eq({ id }));문자열 컬럼 매핑 객체로 결과 별칭을 지정할 수도 있습니다. 객체 키가 결과 키가 되고 값에는 스키마 속성명을 지정합니다.
const rows = await user.select({ id_2: 'id', name_2: 'name' });컬럼 선택에는 컬럼명 배열, Drizzle 선택 객체, 또는 columns()를 사용하는 콜백을 사용할 수 있습니다. columns()는 전체 컬럼 또는 지정한 컬럼만 가져오며, as로 결과 키를 지정할 수 있습니다.
const allColumns = user.columns();
const selectedColumns = user.columns('id', 'name as displayName');
const projected = await user.find(
(query) => [query.columns('id', 'name as displayName')],
user.eq({ id })
);테이블의 TypeScript 속성명과 SQL 컬럼명을 다르게 지정하면 기본 전체 조회 결과 키와 추론된 타입이 달라질 수 있습니다. 기본 컬럼 선택을 사용할 경우 스키마 속성명과 SQL 컬럼명을 같게 작성하는 것을 권장합니다. 이름이 다르면 필요한 컬럼을 명시적으로 선택하고 별칭을 지정하세요.
문자열 컬럼 별칭의 as는 AS, As, aS도 지원하며 결과 키의 대소문자는 유지합니다.
조건식
조건 함수는 db 연결 객체나 db.query(table)이 반환한 쿼리 객체에서 사용할 수 있습니다. 쿼리 객체 메서드는 해당 테이블의 컬럼을 기준으로 타입을 검사하고, db 메서드는 테이블 객체 또는 연결 스키마에 등록된 스키마 키를 함께 받습니다.
const byName = user.eq({ name: '홍길동' });
const bySchemaKey = db.eq('users', { name: '홍길동' });
const byTable = db.eq(users, { name: '홍길동' });createConditions(schema)를 직접 호출해도 같은 조건 함수를 만들 수 있습니다. 독립된 조건 빌더가 필요할 때 사용하며, 반환된 함수는 생성할 때 전달한 스키마의 키와 테이블을 기준으로 동작합니다.
import { createConditions } from '@pdg/drizzle-mssql';
const condition = createConditions({ users });
const where = condition.and('users', {
gte: { id: 1 },
isNotNull: 'email',
});
const rows = await user.select().where(where);비교 연산자
eq, ne, gt, gte, lt, lte는 컬럼과 값을 비교합니다. 하나의 값 객체에 여러 컬럼을 넣으면 각 비교가 AND로 묶입니다. undefined 값은 생략되므로 선택적 검색 조건을 만들 때 유용합니다.
const filters = {
name: searchName,
email: searchEmail,
};
const rows = await user.find((query) =>
query.eq({
name: filters.name,
email: filters.email,
})
);
const changedIds = await user
.select(['id'])
.where(user.and({
gte: { id: 10 },
lte: { id: 50 },
}));orEq와 orNe는 객체 안의 컬럼 비교를 OR로 결합합니다. eq·ne와 동일하게 undefined는 생략하고, 빈 객체는 undefined를 반환합니다. null은 각각 IS NULL·IS NOT NULL로 변환합니다.
user.orEq({ id: 1, name: '홍길동' }); // id = 1 OR name = '홍길동'
user.orNe({ id: 1, name: '홍길동' }); // id <> 1 OR name <> '홍길동'
const u = db.a.users('u');
db.orEq(u, { id: 1, name: '홍길동' });
db.orNe('users', { id: 1, name: '홍길동' });모든 비교 조건에는 컬럼 사이를 OR로 결합하는 대응 함수가 있습니다: orGt, orGte, orLt, orLte, orInArray, orNotInArray, orBetween, orNotBetween, orLike, orNotLike, orIlike, orNotIlike, orIsNull, orIsNotNull. 원래 함수와 같은 입력 타입과 검증 규칙을 사용합니다. orIsNull·orIsNotNull은 컬럼명 또는 컬럼명 배열을 받으며, orBetween은 각 컬럼의 범위 내부 AND를 유지합니다. orIlike·orNotIlike도 SQL Server의 ILIKE 실행 제한을 그대로 가집니다.
user.orGt({ id: 10, age: 20 });
db.orInArray(u, { id: [1, 2], name: ['홍길동'] });
user.orIsNull(['email', 'name']);
user.select().where(q => q.orLike({ name: '%홍%', email: '%example.com' }));
user.and({ orEq: { id: 1, name: '홍길동' }, gt: { age: 20 } });and·or 조건 객체 안에서도 위 OR 함수 이름을 키로 사용할 수 있습니다.
eq({ email: null })은 IS NULL, ne({ email: null })은 IS NOT NULL로 변환됩니다. gt 등의 비교 연산자에는 null을 전달할 수 없습니다.
배열과 범위
inArray와 notInArray는 컬럼별 허용·제외 값 배열을 받고, between과 notBetween은 [시작, 끝] 튜플을 받습니다. 한 객체에 여러 컬럼을 지정하면 각각의 조건은 AND로 결합됩니다.
const selected = await user.find((query) =>
query.and({
inArray: { id: [1, 3, 5, 7] },
notInArray: { name: ['차단 사용자', '삭제 사용자'] },
between: { id: [1, 100] },
})
);
const recentIds = await user
.select(['id'])
.where(user.notBetween({ id: [1, 10] }));inArray와 notInArray의 배열 원소에는 일반 값과 컬럼·SQL 표현식을 함께 사용할 수 있습니다. 예: mssql.and(td, { inArray: { id: [0, td.id] } }).
범위 양 끝은 null이나 undefined가 아닌 값이어야 합니다. inArray와 notInArray의 값은 배열이어야 합니다.
문자열 패턴
like, notLike, ilike, notIlike는 문자열 컬럼에 SQL 패턴을 적용합니다. %는 임의 길이 문자열, _는 한 문자에 대응합니다. ilike 계열은 대소문자를 구분하지 않는 ILIKE 연산자를 생성하지만, SQL Server는 ILIKE 문법을 지원하지 않으므로 SQL Server 쿼리에서는 사용하지 마세요. SQL Server의 LIKE 대소문자 구분 여부는 컬럼 collation 설정에 따릅니다.
const matchingUsers = await user.find((query) =>
query.or({
like: { email: '%@example.com' },
eq: { name: 'Kim' },
})
);
const excludedNames = await user
.select()
.where(user.notLike({ name: '테스트_%' }));패턴 연산은 문자열 컬럼에만 사용할 수 있으며, 값은 %홍길동%처럼 SQL 패턴 문자열로 전달합니다. ilike / notIlike는 패키지의 조건 함수 목록에는 있지만 SQL Server에서는 실행할 수 없습니다.
NULL 검사
isNull과 isNotNull은 컬럼명 하나 또는 컬럼명 배열을 받습니다. 배열 안의 컬럼 검사는 AND로 결합됩니다. 검색 조건에 따라 컬럼 검사를 생략하려면 undefined를 전달할 수 있습니다.
const noEmail = await user.find((query) => query.isNull('email'));
const hasNameAndEmail = await user.find((query) =>
query.isNotNull(['name', 'email'])
);
const optionalNullCheck = user.isNull(shouldCheckEmail ? 'email' : undefined);AND·OR 조합
query.and({ ... })와 query.or({ ... })는 여러 연산자 그룹을 객체로 구성합니다. 한 연산자 아래의 컬럼 비교는 기본적으로 AND로, or 접두사 조건은 OR로 묶이고, 바깥 함수가 각 연산자 그룹을 AND 또는 OR로 결합합니다. and / or 객체는 조건 그룹이며, 그 안에 다시 and / or를 중첩하는 형식은 지원하지 않습니다.
const usersMatchingEither = await user.find((query) =>
query.or({
eq: { name: '홍길동' },
like: { email: '%@example.com' },
})
);
const activeCandidates = await user.find((query) =>
query.and({
isNotNull: 'email',
ne: { name: '탈퇴 사용자' },
})
);여러 조건을 임의로 중첩하거나 이미 만든 SQL 조건을 결합할 때는 db.and(...) / db.or(...)의 Drizzle 호환 오버로드를 사용합니다. 이 형식에서는 함수 호출 인자로 SQL 조건을 직접 조합할 수 있습니다.
const nameOrEmail = db.or(
user.eq({ name: '홍길동' }),
user.like({ email: '%@example.com' }),
);
const condition = db.and(
nameOrEmail,
db.isNotNull(users.email),
);
const matchingUsers = await user.select().where(condition);같은 함수는 테이블 객체와 조건 객체를 받아 그룹 조건을 만들 수도 있습니다.
const groupedCondition = db.and(users, {
gte: { id: 1 },
isNotNull: ['name', 'email'],
});
const groupedUsers = await user.select().where(groupedCondition);Drizzle 컬럼 연산자와 함께 사용
db의 조건 함수는 테이블/객체 형식 외에도 Drizzle의 컬럼 기반 연산자 오버로드를 그대로 사용할 수 있습니다. SQL 조건은 래퍼 조회 메서드에 전달하거나 Drizzle 조회 빌더에서 조합할 수 있습니다.
const columnCondition = db.and(
db.eq(users.name, '홍길동'),
db.isNotNull(users.email),
);
const rows = await user.select().where(columnCondition);
const count = await user.count(columnCondition);지원하는 객체 조건 함수는 eq, ne, orEq, orNe, gt, gte, lt, lte, inArray, notInArray, between, notBetween, like, notLike, ilike, notIlike, isNull, isNotNull, and, or입니다. 존재하지 않는 스키마 키나 컬럼, 잘못된 값 형식은 조건을 조용히 생략하지 않고 오류로 처리합니다.
별칭과 조인
db.a는 연결에 전달한 스키마의 테이블별 별칭 생성 함수입니다. 별칭 테이블은 선택 및 조건식에 사용할 수 있습니다. select가 반환하는 Drizzle 빌더에서 조인을 이어서 작성할 수 있습니다.
const u = db.a.users('u');
const rows = await user
.select(u, ['id', 'name'])
.where(db.eq(u, { name: '홍길동' }));
const userPosts = await user
.select()
.leftJoin(posts, db.eq(users.id, posts.user_id));기본 별칭은 스키마 키의 첫 글자와 대문자 위치를 기준으로 만듭니다. 예를 들어 userProfile의 기본 별칭은 up이며, db.a.userProfile('profile')처럼 직접 지정할 수도 있습니다.
페이지네이션
db.paginate(builder, page, limit)은 조회 데이터와 페이지 정보를 함께 반환합니다. 페이지와 페이지 크기는 양의 정수여야 합니다. SQL Server 2012 이상의 OFFSET … FETCH를 사용합니다. orderBy가 없으면 (select 0)을 사용하므로 행 순서가 보장되지 않습니다. 페이지 간 중복이나 누락을 줄이려면 고유한 컬럼을 포함해 orderBy를 지정하세요. 페이지네이션에 전달하는 빌더는 사용할 트랜잭션 안에서 생성해야 합니다.
const page = await db.paginate(
user.select().where(user.isNotNull('email')).orderBy(user.t.id),
1,
20,
);
console.log(page.data);
console.log(page.paging); // current_page, per_page, last_page, total, from, to트랜잭션과 원본 Drizzle API
db.trans 콜백 안의 쿼리 객체는 현재 트랜잭션을 자동으로 사용합니다. 중첩된 db.trans도 별도 연결의 독립 트랜잭션으로 실행됩니다. 안쪽이 커밋된 뒤 바깥이 롤백되어도 안쪽 변경은 유지됩니다. 안쪽 종료 후에는 바깥 트랜잭션 문맥으로 복귀합니다. 안쪽 오류가 바깥으로 전파되면 바깥도 롤백되며, 바깥에서 오류를 처리하면 계속 진행할 수 있습니다. 트랜잭션 안에서 시작한 비동기 작업은 트랜잭션이 끝나기 전에 모두 await해야 합니다.
await db.trans(async () => {
const id = (await user.add({ name: '트랜잭션 사용자' })) as number;
await user.editByPrimaryKey({ name: '이름 변경' }, id);
// 같은 트랜잭션을 사용하는 원본 Drizzle API
await db.current().select().from(users);
await db.trans(async () => {
await user.add({ name: '독립 트랜잭션 사용자' });
});
});콜백 인자의 rollback()으로 해당 트랜잭션을 명시적으로 종료할 수 있습니다. 롤백은 비동기이므로 반드시 await한 뒤 후속 쿼리를 실행합니다. 이미 롤백된 트랜잭션은 다시 커밋하거나 롤백하지 않습니다. 이후 콜백에서 던진 오류는 호출자에게 그대로 전달됩니다. 종료된 트랜잭션 문맥에서 쿼리를 실행하면 오류가 발생합니다.
await db.trans(async (trxOuter) => {
await user.editByPrimaryKey({ name: 'name-outer' }, 2);
await db.trans(async () => {
await trxOuter.rollback(); // 바깥 트랜잭션의 잠금을 해제한다
await user.editByPrimaryKey({ name: 'name-inner' }, 2);
});
throw new Error('outer error'); // 오류는 전파되지만 바깥 롤백을 반복하지 않는다
});
// 안쪽 커밋은 유지되어 name은 'name-inner'가 된다.독립 트랜잭션은 연결 풀에 추가 연결이 필요합니다. 바깥이 잠근 행을 안쪽에서 수정하거나 미커밋 데이터에 의존하면 잠금 대기 또는 타임아웃이 발생할 수 있습니다.
db.current()는 현재 문맥의 Drizzle 데이터베이스 인스턴스를 반환합니다. 래퍼가 제공하지 않는 Drizzle 기능은 이 API로 직접 사용할 수 있습니다.
테이블 수정·삭제 금지
이 패키지의 mssqlTable에 { updateBlocked: true, deleteBlocked: true }를 전달하면 등록과 조회는 유지하면서 테이블 전체의 수정·삭제를 금지합니다. 정책은 세 번째 인자에 전달하거나, 인덱스·제약조건 설정 콜백을 사용하는 경우 네 번째 인자에 전달합니다. 각 옵션을 생략하거나 false로 지정하면 해당 작업은 기존처럼 허용됩니다. 별도로 선언하는 정책 객체에는 as const 또는 satisfies TablePolicy를 사용해 true 리터럴 타입을 유지하면 타입 검사에서도 차단됩니다.
import { mssqlTable, int, varchar, index } from '@pdg/drizzle-mssql';
const logs = mssqlTable(
'logs',
{
id: int().identity().primaryKey(),
message: varchar({ length: 100 }).notNull(),
},
{ updateBlocked: true, deleteBlocked: true },
);
const indexedLogs = mssqlTable(
'indexed_logs',
{
id: int().identity().primaryKey(),
message: varchar({ length: 100 }).notNull(),
},
(t) => [index('indexed_logs_message_idx').on(t.message)],
{ updateBlocked: true, deleteBlocked: true },
);updateBlocked는 MsSqlQuery.edit와 editByPrimaryKey, deleteBlocked는 remove와 removeByPrimaryKey 호출을 TypeScript에서 차단합니다. 타입 정보가 사라지거나 JavaScript에서 호출하더라도 조건 콜백과 DB 접근 전에 명시적인 오류가 발생합니다. 테이블 수정 금지는 컬럼의 updateAllowed()보다 우선합니다. 정책은 db.query(table)과 직접 생성한 MsSqlQuery 모두에 적용되지만, 원본 Drizzle 쿼리나 직접 실행한 SQL에는 적용되지 않습니다. DB 수준의 제한이 필요하면 별도로 UPDATE·DELETE 권한을 제한해야 합니다.
생성·수정 시각
패키지의 mssqlTable로 정의한 컬럼에 createdAt()과 updatedAt()을 지정하면 add에서 누락된 시각을 getTimestamp로 채웁니다. 한 행에서 생성한 값은 누락된 시각 컬럼이 공유하며 직접 지정한 값은 유지합니다. edit에서는 생성 시각의 변경을 금지하고 수정 시각이 없으면 자동으로 갱신합니다.
const users = mssqlTable('users', {
id: int('id').identity().primaryKey(),
name: nvarchar('name', { length: 100 }).notNull(),
created_at: datetime2('created_at').notNull().createdAt(),
updated_at: datetime2('updated_at').notNull().updatedAt(),
});
const db = drizzleMsSql({ url: process.env.DATABASE_URL!, schema: { users }, getTimestamp: () => new Date() });
const user = db.query(users);
const id = await user.add(user.addValues({ name: '사용자' }));
await user.editByPrimaryKey(user.editValues({ name: '수정' }), id);insertBlocked(), insertAllowed(), updateBlocked(), updateAllowed(), updateRequired()로 컬럼 정책을 지정할 수 있습니다. IDENTITY 컬럼은 기본적으로 등록과 수정이 금지되고 기본 키는 수정이 금지됩니다. 이러한 정책은 타입 검사와 런타임 검사에 반영됩니다. 기본 키 수정에는 updateAllowed()가 필요합니다. Drizzle의 SQL Server 입력 타입은 IDENTITY 컬럼을 제외하므로 insertAllowed()로도 IDENTITY 직접 등록을 지원하지 않습니다. 금지된 키는 값이 undefined여도 런타임에서 거부하며, 필수 수정 값이 누락되어도 오류가 발생합니다. updatedAt().updateRequired()는 생략 시 자동 시각으로 채웁니다.
updateAllowed()를 지정한 IDENTITY 컬럼은 MsSqlEditValues, editValues(), edit(), editByPrimaryKey()의 수정 입력에 포함됩니다. 이는 라이브러리의 입력 정책 허용이며, SQL Server 자체의 제약을 해제하지는 않습니다. SQL Server는 IDENTITY 값의 UPDATE를 허용하지 않으므로 실제 DB 실행은 실패합니다. 기본 키 값을 변경해야 한다면 IDENTITY가 아닌 일반 컬럼을 사용하세요.
정책은 이 패키지의 mssqlTable과 MsSqlQuery에 적용됩니다. mssqlTableCreator, mssqlSchema, Drizzle의 원본 테이블 생성 함수와 db.current()의 원본 쿼리에는 적용되지 않습니다. 생성 함수를 직접 전달하지 않은 MsSqlQuery가 자동 시각을 필요로 하면 오류가 발생합니다. 생성 함수의 반환값은 컬럼 타입과 일치해야 합니다.
집계·SQL 표현식
db 인스턴스는 asc, desc, count, countDistinct, avg, avgDistinct, sum, sumDistinct, max, min, not, exists, notExists, arrayContains, arrayContained, arrayOverlaps 등 Drizzle 함수를 제공합니다. arrayContains, arrayContained, arrayOverlaps는 Drizzle 함수로 노출되지만 SQL Server에서 사용할 수 있는 배열 연산을 보장하지 않습니다. db.sqlNumber, db.sqlString, db.sqlBoolean은 SQL 표현식 또는 기본 값을 해당 타입으로 매핑하는 표현식을 만듭니다.
const [summary] = await db.current()
.select({ total: db.count() })
.from(users);
const numericExpression = db.sqlNumber(db.sql`1`);공개 타입과 스키마 API
스키마 정의에 필요한 다음 API를 @pdg/drizzle-mssql에서 직접 가져올 수 있습니다.
| 구분 | 내보내기 |
| --- | --- |
| 테이블·스키마·뷰 | mssqlTable, mssqlTableCreator, mssqlSchema, mssqlView |
| 정수·실수 | tinyint, smallint, int, bigint, float, real, decimal, numeric |
| 문자열 | char, nchar, varchar, nvarchar, text, ntext |
| 날짜·시간 | date, datetime, datetime2, datetimeoffset, time |
| 바이너리 | binary, varbinary |
| 기타 컬럼 | bit, customType |
| 인덱스·제약조건 | index, uniqueIndex, primaryKey, foreignKey, unique, check |
| 타입 (import type) | InferColumnsDataTypes, MsSqlConditions, MsSqlAddValues, MsSqlEditValues, MsSqlAliasTable, MsSqlSelectedColumns, MsSqlSelectedTableColumns, MsSqlColumnSelectionName, MsSqlSelectedNamedColumnUnion, MsSqlSelectedNamedColumns, MsSqlCompareValues, MsSqlColumnName, MsSqlArrayCompareValues, MsSqlRangeCompareValues, MsSqlPatternCompareValues, MsSqlNullConditionInput |
check나 SQL 표현식 기반 기본값에 사용하는 sql은 drizzle-orm에서 가져옵니다. Drizzle의 MsSqlTable 등 직접 필요한 타입도 drizzle-orm/mssql-core에서 가져올 수 있습니다.
라이선스
이 프로젝트는 MIT 라이선스에 따라 배포됩니다.
