### What?
Adds four more arguments to the `mongooseAdapter`:
```typescript
useJoinAggregations?: boolean /* The big one */
useAlternativeDropDatabase?: boolean
useBigIntForNumberIDs?: boolean
usePipelineInSortLookup?: boolean
```
Also export a new `compatabilityOptions` object from
`@payloadcms/db-mongodb` where each key is a mongo-compatible database
and the value is the recommended `mongooseAdapter` settings for
compatability.
### Why?
When using firestore and visiting
`/admin/collections/media/payload-folders`, we get:
```
MongoServerError: invalid field(s) in lookup: [let, pipeline], only lookup(from, localField, foreignField, as) is supported
```
Firestore doesn't support the full MongoDB aggregation API used by
Payload which gets used when building aggregations for populating join
fields.
There are several other compatability issues with Firestore:
- The invalid `pipeline` property is used in the `$lookup` aggregation
in `buildSortParams`
- Firestore only supports number IDs of type `Long`, but Mongoose
converts custom ID fields of type number to `Double`
- Firestore does not support the `dropDatabase` command
- Firestore does not support the `createIndex` command (not addressed in
this PR)
### How?
```typescript
useJoinAggregations?: boolean /* The big one */
```
When this is `false` we skip the `buildJoinAggregation()` pipeline and resolve the join fields through multiple queries. This can potentially be used with AWS DocumentDB and Azure Cosmos DB to support join fields, but I have not tested with either of these databases.
```typescript
useAlternativeDropDatabase?: boolean
```
When `true`, monkey-patch (replace) the `dropDatabase` function so that
it calls `collection.deleteMany({})` on every collection instead of
sending a single `dropDatabase` command to the database
```typescript
useBigIntForNumberIDs?: boolean
```
When `true`, use `mongoose.Schema.Types.BigInt` for custom ID fields of type `number` which converts to a firestore `Long` behind the scenes
```typescript
usePipelineInSortLookup?: boolean
```
When `false`, modify the sortAggregation pipeline in `buildSortParams()` so that we don't use the `pipeline` property in the `$lookup` aggregation. Results in slightly worse performance when sorting by relationship properties.
### Limitations
This PR does not add support for transactions or creating indexes in firestore.
### Fixes
Fixed a bug (and added a test) where you weren't able to sort by multiple properties on a relationship field.
### Future work
1. Firestore supports simple `$lookup` aggregations but other databases might not. Could add a `useSortAggregations` property which can be used to disable aggregations in sorting.
---------
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Sasha <64744993+r1tsuu@users.noreply.github.com>
138 lines
3.8 KiB
TypeScript
138 lines
3.8 KiB
TypeScript
import fs from 'fs'
|
|
import path from 'node:path'
|
|
import { fileURLToPath } from 'node:url'
|
|
|
|
const filename = fileURLToPath(import.meta.url)
|
|
const dirname = path.dirname(filename)
|
|
|
|
export const allDatabaseAdapters = {
|
|
mongodb: `
|
|
import { mongooseAdapter } from '@payloadcms/db-mongodb'
|
|
|
|
export const databaseAdapter = mongooseAdapter({
|
|
ensureIndexes: true,
|
|
// required for connect to detect that we are using a memory server
|
|
mongoMemoryServer: global._mongoMemoryServer,
|
|
url:
|
|
process.env.MONGODB_MEMORY_SERVER_URI ||
|
|
process.env.DATABASE_URI ||
|
|
'mongodb://127.0.0.1/payloadtests',
|
|
collation: {
|
|
strength: 1,
|
|
},
|
|
})`,
|
|
firestore: `
|
|
import { mongooseAdapter, compatabilityOptions } from '@payloadcms/db-mongodb'
|
|
|
|
export const databaseAdapter = mongooseAdapter({
|
|
...compatabilityOptions.firestore,
|
|
url:
|
|
process.env.DATABASE_URI ||
|
|
process.env.MONGODB_MEMORY_SERVER_URI ||
|
|
'mongodb://127.0.0.1/payloadtests',
|
|
collation: {
|
|
strength: 1,
|
|
},
|
|
// The following options prevent some tests from failing.
|
|
// More work needed to get tests succeeding without these options.
|
|
ensureIndexes: true,
|
|
transactionOptions: {},
|
|
disableIndexHints: false,
|
|
useAlternativeDropDatabase: false,
|
|
})`,
|
|
postgres: `
|
|
import { postgresAdapter } from '@payloadcms/db-postgres'
|
|
|
|
export const databaseAdapter = postgresAdapter({
|
|
pool: {
|
|
connectionString: process.env.POSTGRES_URL || 'postgres://127.0.0.1:5432/payloadtests',
|
|
},
|
|
})`,
|
|
'postgres-custom-schema': `
|
|
import { postgresAdapter } from '@payloadcms/db-postgres'
|
|
|
|
export const databaseAdapter = postgresAdapter({
|
|
pool: {
|
|
connectionString: process.env.POSTGRES_URL || 'postgres://127.0.0.1:5432/payloadtests',
|
|
},
|
|
schemaName: 'custom',
|
|
})`,
|
|
'postgres-uuid': `
|
|
import { postgresAdapter } from '@payloadcms/db-postgres'
|
|
|
|
export const databaseAdapter = postgresAdapter({
|
|
idType: 'uuid',
|
|
pool: {
|
|
connectionString: process.env.POSTGRES_URL || 'postgres://127.0.0.1:5432/payloadtests',
|
|
},
|
|
})`,
|
|
'postgres-read-replica': `
|
|
import { postgresAdapter } from '@payloadcms/db-postgres'
|
|
|
|
export const databaseAdapter = postgresAdapter({
|
|
pool: {
|
|
connectionString: process.env.POSTGRES_URL,
|
|
},
|
|
readReplicas: [process.env.POSTGRES_REPLICA_URL],
|
|
})
|
|
`,
|
|
'vercel-postgres-read-replica': `
|
|
import { vercelPostgresAdapter } from '@payloadcms/db-vercel-postgres'
|
|
|
|
export const databaseAdapter = vercelPostgresAdapter({
|
|
pool: {
|
|
connectionString: process.env.POSTGRES_URL,
|
|
},
|
|
readReplicas: [process.env.POSTGRES_REPLICA_URL],
|
|
})
|
|
`,
|
|
sqlite: `
|
|
import { sqliteAdapter } from '@payloadcms/db-sqlite'
|
|
|
|
export const databaseAdapter = sqliteAdapter({
|
|
client: {
|
|
url: process.env.SQLITE_URL || 'file:./payloadtests.db',
|
|
},
|
|
autoIncrement: true
|
|
})`,
|
|
'sqlite-uuid': `
|
|
import { sqliteAdapter } from '@payloadcms/db-sqlite'
|
|
|
|
export const databaseAdapter = sqliteAdapter({
|
|
idType: 'uuid',
|
|
client: {
|
|
url: process.env.SQLITE_URL || 'file:./payloadtests.db',
|
|
},
|
|
})`,
|
|
supabase: `
|
|
import { postgresAdapter } from '@payloadcms/db-postgres'
|
|
|
|
export const databaseAdapter = postgresAdapter({
|
|
pool: {
|
|
connectionString:
|
|
process.env.POSTGRES_URL || 'postgresql://postgres:postgres@127.0.0.1:54322/postgres',
|
|
},
|
|
})`,
|
|
}
|
|
|
|
/**
|
|
* Write to databaseAdapter.ts
|
|
*/
|
|
export function generateDatabaseAdapter(dbAdapter) {
|
|
const databaseAdapter = allDatabaseAdapters[dbAdapter]
|
|
if (!databaseAdapter) {
|
|
throw new Error(`Unknown database adapter: ${dbAdapter}`)
|
|
}
|
|
fs.writeFileSync(
|
|
path.resolve(dirname, 'databaseAdapter.js'),
|
|
`
|
|
// DO NOT MODIFY. This file is automatically generated by the test suite.
|
|
|
|
${databaseAdapter}
|
|
`,
|
|
)
|
|
|
|
console.log('Wrote', dbAdapter, 'db adapter')
|
|
return databaseAdapter
|
|
}
|