Files
payload/packages/db-sqlite/src/schema/buildDrizzleTable.ts
Sasha 03ff77544e feat(db-sqlite): add idType: 'uuid' support (#10016)
Adds `idType: 'uuid'` to the SQLite adapter support:
```ts
sqliteAdapter({
  idType: 'uuid',
})
```

Achieved through Drizzle's `$defaultFn()`
https://orm.drizzle.team/docs/latest-releases/drizzle-orm-v0283#-added-defaultfn--default-methods-to-column-builders
as SQLite doesn't have native UUID support. Added `sqlite-uuid` to CI.
2024-12-18 22:44:04 -05:00

158 lines
4.0 KiB
TypeScript

import type { BuildDrizzleTable, RawColumn } from '@payloadcms/drizzle/types'
import type { ForeignKeyBuilder, IndexBuilder } from 'drizzle-orm/sqlite-core'
import { sql } from 'drizzle-orm'
import {
foreignKey,
index,
integer,
numeric,
sqliteTable,
text,
uniqueIndex,
} from 'drizzle-orm/sqlite-core'
import { v4 as uuidv4 } from 'uuid'
const rawColumnBuilderMap: Partial<Record<RawColumn['type'], any>> = {
integer,
numeric,
text,
}
export const buildDrizzleTable: BuildDrizzleTable = ({ adapter, locales, rawTable }) => {
const columns: Record<string, any> = {}
for (const [key, column] of Object.entries(rawTable.columns)) {
switch (column.type) {
case 'boolean': {
columns[key] = integer(column.name, { mode: 'boolean' })
break
}
case 'enum':
if ('locale' in column) {
columns[key] = text(column.name, { enum: locales as [string, ...string[]] })
} else {
columns[key] = text(column.name, { enum: column.options as [string, ...string[]] })
}
break
case 'geometry':
case 'jsonb': {
columns[key] = text(column.name, { mode: 'json' })
break
}
case 'serial': {
columns[key] = integer(column.name)
break
}
case 'timestamp': {
let builder = text(column.name)
if (column.defaultNow) {
builder = builder.default(sql`(strftime('%Y-%m-%dT%H:%M:%fZ', 'now'))`)
}
columns[key] = builder
break
}
case 'uuid': {
let builder = text(column.name, { length: 36 })
if (column.defaultRandom) {
builder = builder.$defaultFn(() => uuidv4())
}
columns[key] = builder
break
}
case 'varchar': {
columns[key] = text(column.name)
break
}
default:
columns[key] = rawColumnBuilderMap[column.type](column.name)
break
}
if (column.reference) {
columns[key].references(() => adapter.tables[column.reference.table][column.reference.name], {
onDelete: column.reference.onDelete,
})
}
if (column.primaryKey) {
columns[key].primaryKey()
}
if (column.notNull) {
columns[key].notNull()
}
if (typeof column.default !== 'undefined') {
let sanitizedDefault = column.default
if (column.type === 'geometry' && Array.isArray(column.default)) {
sanitizedDefault = JSON.stringify({
type: 'Point',
coordinates: [column.default[0], column.default[1]],
})
}
columns[key].default(sanitizedDefault)
}
}
const extraConfig = (cols: any) => {
const config: Record<string, ForeignKeyBuilder | IndexBuilder> = {}
if (rawTable.indexes) {
for (const [key, rawIndex] of Object.entries(rawTable.indexes)) {
let fn: any = index
if (rawIndex.unique) {
fn = uniqueIndex
}
if (Array.isArray(rawIndex.on)) {
if (rawIndex.on.length) {
config[key] = fn(rawIndex.name).on(...rawIndex.on.map((colName) => cols[colName]))
}
} else {
config[key] = fn(rawIndex.name).on(cols[rawIndex.on])
}
}
}
if (rawTable.foreignKeys) {
for (const [key, rawForeignKey] of Object.entries(rawTable.foreignKeys)) {
let builder = foreignKey({
name: rawForeignKey.name,
columns: rawForeignKey.columns.map((colName) => cols[colName]) as any,
foreignColumns: rawForeignKey.foreignColumns.map(
(column) => adapter.tables[column.table][column.name],
),
})
if (rawForeignKey.onDelete) {
builder = builder.onDelete(rawForeignKey.onDelete)
}
if (rawForeignKey.onUpdate) {
builder = builder.onDelete(rawForeignKey.onUpdate)
}
config[key] = builder
}
}
return config
}
adapter.tables[rawTable.name] = sqliteTable(rawTable.name, columns as any, extraConfig as any)
}