feat: add uuidv7 support for pgsql

.github/actions/start-database/action.yml

@@ -3,7 +3,7 @@ description: Starts the required database for tests
 
 inputs:
   database:
-    description: 'Database type: mongodb, mongodb-atlas, cosmosdb, documentdb, firestore, postgres, postgres-custom-schema, postgres-uuid, postgres-read-replica, postgres-read-replicas, vercel-postgres-read-replica, sqlite, sqlite-uuid, supabase, d1'
+    description: 'Database type: mongodb, mongodb-atlas, cosmosdb, documentdb, firestore, postgres, postgres-custom-schema, postgres-uuid, postgres-uuidv7, postgres-read-replica, postgres-read-replicas, vercel-postgres-read-replica, sqlite, sqlite-uuid, sqlite-uuidv7, supabase, d1'
     required: true
 
 outputs:

.github/workflows/int.config.ts

@@ -10,10 +10,12 @@ createIntConfig({
     'postgres',
     'postgres-custom-schema',
     'postgres-uuid',
+    'postgres-uuidv7',
     'postgres-read-replica',
     'supabase',
     'sqlite',
     'sqlite-uuid',
+    'sqlite-uuidv7',
   ],
   shards: 3,
 })

CONTRIBUTING.md

@@ -134,9 +134,11 @@ Set `PAYLOAD_DATABASE` in your `.env` file to choose the database adapter:
 - `postgres` - PostgreSQL with pgvector and PostGIS
 - `postgres-custom-schema` - PostgreSQL with custom schema
 - `postgres-uuid` - PostgreSQL with UUID primary keys
+- `postgres-uuidv7` - PostgreSQL with UUID V7 primary keys
 - `postgres-read-replica` - PostgreSQL with read replica
 - `sqlite` - SQLite
 - `sqlite-uuid` - SQLite with UUID primary keys
+- `sqlite-uuidv7` - SQLite with UUID V7 primary keys
 - `supabase` - Supabase (PostgreSQL)
 - `d1` - D1 (SQLite)
 

packages/db-d1-sqlite/package.json

@@ -77,13 +77,12 @@
     "drizzle-orm": "0.44.7",
     "prompts": "2.4.2",
     "to-snake-case": "1.0.0",
-    "uuid": "9.0.0"
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@payloadcms/eslint-config": "workspace:*",
     "@types/pg": "8.10.2",
     "@types/to-snake-case": "1.0.0",
-    "@types/uuid": "10.0.0",
     "payload": "workspace:*"
   },
   "peerDependencies": {

packages/db-d1-sqlite/src/index.ts

@@ -64,7 +64,7 @@ const filename = fileURLToPath(import.meta.url)
 
 export function sqliteD1Adapter(args: Args): DatabaseAdapterObj<SQLiteD1Adapter> {
   const sqliteIDType = args.idType || 'number'
-  const payloadIDType = sqliteIDType === 'uuid' ? 'text' : 'number'
+  const payloadIDType = sqliteIDType === 'uuid' || sqliteIDType === 'uuidv7' ? 'text' : 'number'
   const allowIDOnCreate = args.allowIDOnCreate ?? false
 
   function adapter({ payload }: { payload: Payload }) {

packages/db-mongodb/package.json

@@ -55,13 +55,12 @@
     "mongoose": "8.15.1",
     "mongoose-paginate-v2": "1.8.5",
     "prompts": "2.4.2",
-    "uuid": "10.0.0"
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@payloadcms/eslint-config": "workspace:*",
     "@types/mongoose-aggregate-paginate-v2": "1.0.12",
     "@types/prompts": "^2.4.5",
-    "@types/uuid": "10.0.0",
     "mongodb": "6.16.0",
     "mongodb-memory-server": "10.1.4",
     "payload": "workspace:*"

packages/db-postgres/package.json

@@ -82,7 +82,7 @@
     "pg": "8.16.3",
     "prompts": "2.4.2",
     "to-snake-case": "1.0.0",
-    "uuid": "10.0.0"
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@hyrious/esbuild-plugin-commonjs": "0.2.6",

packages/db-postgres/src/types.ts

@@ -53,7 +53,7 @@ export type Args = {
   extensions?: string[]
   /** Generated schema from payload generate:db-schema file path */
   generateSchemaOutputFile?: string
-  idType?: 'serial' | 'uuid'
+  idType?: 'serial' | 'uuid' | 'uuidv7'
   localesSuffix?: string
   logger?: DrizzleConfig['logger']
   migrationDir?: string

packages/db-sqlite/package.json

@@ -79,13 +79,12 @@
     "drizzle-orm": "0.44.7",
     "prompts": "2.4.2",
     "to-snake-case": "1.0.0",
-    "uuid": "9.0.0"
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@payloadcms/eslint-config": "workspace:*",
     "@types/pg": "8.10.2",
     "@types/to-snake-case": "1.0.0",
-    "@types/uuid": "10.0.0",
     "payload": "workspace:*"
   },
   "peerDependencies": {

packages/db-sqlite/src/index.ts

@@ -66,7 +66,7 @@ const filename = fileURLToPath(import.meta.url)
 
 export function sqliteAdapter(args: Args): DatabaseAdapterObj<SQLiteAdapter> {
   const sqliteIDType = args.idType || 'number'
-  const payloadIDType = sqliteIDType === 'uuid' ? 'text' : 'number'
+  const payloadIDType = sqliteIDType === 'uuid' || sqliteIDType === 'uuidv7' ? 'text' : 'number'
   const allowIDOnCreate = args.allowIDOnCreate ?? false
 
   function adapter({ payload }: { payload: Payload }) {

packages/db-vercel-postgres/package.json

@@ -82,7 +82,7 @@
     "pg": "8.16.3",
     "prompts": "2.4.2",
     "to-snake-case": "1.0.0",
-    "uuid": "10.0.0"
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@hyrious/esbuild-plugin-commonjs": "0.2.6",

packages/db-vercel-postgres/src/types.ts

@@ -53,7 +53,7 @@ export type Args = {
   forceUseVercelPostgres?: boolean
   /** Generated schema from payload generate:db-schema file path */
   generateSchemaOutputFile?: string
-  idType?: 'serial' | 'uuid'
+  idType?: 'serial' | 'uuid' | 'uuidv7'
   localesSuffix?: string
   logger?: DrizzleConfig['logger']
   migrationDir?: string

packages/drizzle/package.json

@@ -62,7 +62,7 @@
     "drizzle-orm": "0.44.7",
     "prompts": "2.4.2",
     "to-snake-case": "1.0.0",
-    "uuid": "9.0.0"
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@libsql/client": "0.14.0",

packages/drizzle/src/postgres/columnToCodeConverter.ts

@@ -68,6 +68,11 @@ export const columnToCodeConverter: ColumnToCodeConverter = ({
     code = `${code}.defaultRandom()`
   }
 
+  if (column.type === 'uuid' && column.defaultV7) {
+    addImport('uuid', 'v7 as uuidv7')
+    code = `${code}.$defaultFn(() => uuidv7())`
+  }
+
   if (column.notNull) {
     code = `${code}.notNull()`
   }

packages/drizzle/src/postgres/schema/buildDrizzleTable.ts

@@ -18,6 +18,7 @@ import {
   varchar,
   vector,
 } from 'drizzle-orm/pg-core'
+import { v7 as uuidv7 } from 'uuid'
 
 import type { RawColumn, RawTable } from '../../types.js'
 import type { BasePostgresAdapter } from '../types.js'
@@ -109,6 +110,10 @@ export const buildDrizzleTable = ({
           builder = builder.defaultRandom()
         }
 
+        if (column.defaultV7) {
+          builder = builder.$defaultFn(() => uuidv7())
+        }
+
         columns[key] = builder
         break
       }

packages/drizzle/src/postgres/schema/setColumnID.ts

@@ -34,6 +34,17 @@ export const setColumnID: SetColumnID = ({ adapter, columns, fields }) => {
     return 'uuid'
   }
 
+  if (adapter.idType === 'uuidv7') {
+    columns.id = {
+      name: 'id',
+      type: 'uuid',
+      defaultV7: true,
+      primaryKey: true,
+    }
+
+    return 'uuid'
+  }
+
   columns.id = {
     name: 'id',
     type: 'serial',

packages/drizzle/src/postgres/types.ts

@@ -147,7 +147,7 @@ export type BasePostgresAdapter = {
    * Used for returning properly formed errors from unique fields
    */
   fieldConstraints: Record<string, Record<string, string>>
-  idType: 'serial' | 'uuid'
+  idType: 'serial' | 'uuid' | 'uuidv7'
   initializing: Promise<void>
   insert: Insert
   localesSuffix?: string

packages/drizzle/src/queries/getTableColumnFromPath.ts

@@ -19,6 +19,7 @@ import type { DrizzleAdapter, GenericColumn } from '../types.js'
 import type { BuildQueryJoinAliases } from './buildQuery.js'
 
 import { isPolymorphicRelationship } from '../utilities/isPolymorphicRelationship.js'
+import { isUUIDType } from '../utilities/isUUIDType.js'
 import { jsonBuildObject } from '../utilities/json.js'
 import { DistinctSymbol } from '../utilities/rawConstraint.js'
 import { resolveBlockTableName } from '../utilities/validateExistingBlockIsIdentical.js'
@@ -111,7 +112,7 @@ export const getTableColumnFromPath = ({
       constraints,
       field: {
         name: 'id',
-        type: adapter.idType === 'uuid' ? 'text' : 'number',
+        type: isUUIDType(adapter.idType) ? 'text' : 'number',
       } as NumberField | TextField,
       table: adapter.tables[newTableName],
     }
@@ -414,7 +415,7 @@ export const getTableColumnFromPath = ({
               constraints,
               field: {
                 name: 'id',
-                type: adapter.idType === 'uuid' ? 'text' : 'number',
+                type: isUUIDType(adapter.idType) ? 'text' : 'number',
               } as NumberField | TextField,
               table: aliasRelationshipTable,
             }
@@ -531,7 +532,7 @@ export const getTableColumnFromPath = ({
             constraints,
             field: {
               name: 'id',
-              type: adapter.idType === 'uuid' ? 'text' : 'number',
+              type: isUUIDType(adapter.idType) ? 'text' : 'number',
             } as NumberField | TextField,
             table: newAliasTable,
           }
@@ -706,8 +707,9 @@ export const getTableColumnFromPath = ({
 
             const columns: TableColumn['columns'] = field.relationTo
               .map((relationTo) => {
-                let idType: 'number' | 'text' | 'uuid' =
-                  adapter.idType === 'uuid' ? 'uuid' : 'number'
+                let idType: 'number' | 'text' | 'uuid' = isUUIDType(adapter.idType)
+                  ? 'uuid'
+                  : 'number'
 
                 const { customIDType } = adapter.payload.collections[relationTo]
 

packages/drizzle/src/queries/sanitizeQueryValue.ts

@@ -8,6 +8,7 @@ import type { DrizzleAdapter } from '../types.js'
 
 import { getCollectionIdType } from '../utilities/getCollectionIdType.js'
 import { isPolymorphicRelationship } from '../utilities/isPolymorphicRelationship.js'
+import { isUUIDType } from '../utilities/isUUIDType.js'
 import { isRawConstraint } from '../utilities/rawConstraint.js'
 
 type SanitizeQueryValueArgs = {
@@ -59,7 +60,7 @@ export const sanitizeQueryValue = ({
   ) {
     const allPossibleIDTypes: (number | string)[] = []
     formattedValue.forEach((val) => {
-      if (adapter.idType !== 'uuid' && typeof val === 'string') {
+      if (!isUUIDType(adapter.idType) && typeof val === 'string') {
         allPossibleIDTypes.push(val, parseInt(val))
       } else if (typeof val === 'string') {
         allPossibleIDTypes.push(val)

packages/drizzle/src/schema/build.ts

@@ -18,6 +18,7 @@ import type {
 import { createTableName } from '../createTableName.js'
 import { buildForeignKeyName } from '../utilities/buildForeignKeyName.js'
 import { buildIndexName } from '../utilities/buildIndexName.js'
+import { isUUIDType } from '../utilities/isUUIDType.js'
 import { traverseFields } from './traverseFields.js'
 
 type Args = {
@@ -619,8 +620,9 @@ export const buildTable = ({
           config: relationshipConfig,
           throwValidationError: true,
         })
-        let colType: 'integer' | 'numeric' | 'uuid' | 'varchar' =
-          adapter.idType === 'uuid' ? 'uuid' : 'integer'
+        let colType: 'integer' | 'numeric' | 'uuid' | 'varchar' = isUUIDType(adapter.idType)
+          ? 'uuid'
+          : 'integer'
         const relatedCollectionCustomIDType =
           adapter.payload.collections[relationshipConfig.slug]?.customIDType
 

packages/drizzle/src/schema/traverseFields.ts

@@ -24,6 +24,7 @@ import { createTableName } from '../createTableName.js'
 import { buildIndexName } from '../utilities/buildIndexName.js'
 import { getArrayRelationName } from '../utilities/getArrayRelationName.js'
 import { hasLocalesTable } from '../utilities/hasLocalesTable.js'
+import { isUUIDType } from '../utilities/isUUIDType.js'
 import {
   InternalBlockTableNameIndex,
   setInternalBlockIndex,
@@ -945,7 +946,7 @@ export const traverseFields = ({
           const tableName = adapter.tableNameMap.get(toSnakeCase(field.relationTo))
 
           // get the id type of the related collection
-          let colType: IDType = adapter.idType === 'uuid' ? 'uuid' : 'integer'
+          let colType: IDType = isUUIDType(adapter.idType) ? 'uuid' : 'integer'
           const relatedCollectionCustomID = relationshipConfig.fields.find(
             (field) => fieldAffectsData(field) && field.name === 'id',
           )

packages/drizzle/src/sqlite/columnToCodeConverter.ts

@@ -69,6 +69,11 @@ export const columnToCodeConverter: ColumnToCodeConverter = ({
         defaultStatement = `$defaultFn(() => randomUUID())`
       }
 
+      if (column.defaultV7) {
+        addImport('uuid', 'v7 as uuidv7')
+        defaultStatement = `$defaultFn(() => uuidv7())`
+      }
+
       break
     }
 

packages/drizzle/src/sqlite/schema/buildDrizzleTable.ts

@@ -10,7 +10,7 @@ import {
   text,
   uniqueIndex,
 } from 'drizzle-orm/sqlite-core'
-import { v4 as uuidv4 } from 'uuid'
+import { v4 as uuidv4, v7 as uuidv7 } from 'uuid'
 
 import type { BuildDrizzleTable, RawColumn } from '../../types.js'
 
@@ -72,6 +72,10 @@ export const buildDrizzleTable: BuildDrizzleTable = ({ adapter, locales, rawTabl
           builder = builder.$defaultFn(() => uuidv4())
         }
 
+        if (column.defaultV7) {
+          builder = builder.$defaultFn(() => uuidv7())
+        }
+
         columns[key] = builder
         break
       }

packages/drizzle/src/sqlite/schema/setColumnID.ts

@@ -34,6 +34,17 @@ export const setColumnID: SetColumnID = ({ adapter, columns, fields }) => {
     return 'uuid'
   }
 
+  if (adapter.idType === 'uuidv7') {
+    columns.id = {
+      name: 'id',
+      type: 'uuid',
+      defaultV7: true,
+      primaryKey: true,
+    }
+
+    return 'uuid'
+  }
+
   columns.id = {
     name: 'id',
     type: 'integer',

packages/drizzle/src/sqlite/types.ts

@@ -60,7 +60,7 @@ export type BaseSQLiteArgs = {
   blocksAsJSON?: boolean
   /** Generated schema from payload generate:db-schema file path */
   generateSchemaOutputFile?: string
-  idType?: 'number' | 'uuid'
+  idType?: 'number' | 'uuid' | 'uuidv7'
   localesSuffix?: string
   logger?: DrizzleConfig['logger']
   migrationDir?: string

packages/drizzle/src/types.ts

@@ -248,6 +248,8 @@ export type TimestampRawColumn = {
  */
 export type UUIDRawColumn = {
   defaultRandom?: boolean
+  /** App-side UUID v7 default (Postgres & SQLite); mutually exclusive with defaultRandom in practice */
+  defaultV7?: boolean
   type: 'uuid'
 } & BaseRawColumn
 
@@ -404,7 +406,7 @@ export interface DrizzleAdapter extends BaseDatabaseAdapter {
   fieldConstraints: Record<string, Record<string, string>>
 
   foreignKeys: Set<string>
-  idType: 'serial' | 'uuid'
+  idType: 'serial' | 'uuid' | 'uuidv7'
   indexes: Set<string>
   initializing: Promise<void>
   insert: Insert

packages/drizzle/src/utilities/getCollectionIdType.ts

@@ -7,6 +7,7 @@ const typeMap: Record<string, 'number' | 'text'> = {
   serial: 'number',
   text: 'text',
   uuid: 'text',
+  uuidv7: 'text',
 }
 
 export const getCollectionIdType = ({

packages/drizzle/src/utilities/isUUIDType.ts

@@ -0,0 +1 @@
+export const isUUIDType = (idType: string): boolean => idType === 'uuid' || idType === 'uuidv7'