diff --git a/docs/database/mongodb.mdx b/docs/database/mongodb.mdx index 26a139bae..f258ae92d 100644 --- a/docs/database/mongodb.mdx +++ b/docs/database/mongodb.mdx @@ -60,21 +60,21 @@ You can access Mongoose models as follows: ## Using other MongoDB implementations -You can import the `compatabilityOptions` object to get the recommended settings for other MongoDB implementations. Since these databases aren't officially supported by payload, you may still encounter issues even with these settings (please create an issue or PR if you believe these options should be updated): +You can import the `compatibilityOptions` object to get the recommended settings for other MongoDB implementations. Since these databases aren't officially supported by payload, you may still encounter issues even with these settings (please create an issue or PR if you believe these options should be updated): ```ts -import { mongooseAdapter, compatabilityOptions } from '@payloadcms/db-mongodb' +import { mongooseAdapter, compatibilityOptions } from '@payloadcms/db-mongodb' export default buildConfig({ db: mongooseAdapter({ url: process.env.DATABASE_URI, // For example, if you're using firestore: - ...compatabilityOptions.firestore, + ...compatibilityOptions.firestore, }), }) ``` -We export compatability options for [DocumentDB](https://aws.amazon.com/documentdb/), [Azure Cosmos DB](https://azure.microsoft.com/en-us/products/cosmos-db) and [Firestore](https://cloud.google.com/firestore/mongodb-compatibility/docs/overview). Known limitations: +We export compatibility options for [DocumentDB](https://aws.amazon.com/documentdb/), [Azure Cosmos DB](https://azure.microsoft.com/en-us/products/cosmos-db) and [Firestore](https://cloud.google.com/firestore/mongodb-compatibility/docs/overview). Known limitations: - Azure Cosmos DB does not support transactions that update two or more documents in different collections, which is a common case when using Payload (via hooks). - Azure Cosmos DB the root config property `indexSortableFields` must be set to `true`. diff --git a/packages/db-mongodb/src/index.ts b/packages/db-mongodb/src/index.ts index 08c8e6cb6..eaa30b435 100644 --- a/packages/db-mongodb/src/index.ts +++ b/packages/db-mongodb/src/index.ts @@ -331,7 +331,7 @@ export function mongooseAdapter({ } } -export { compatabilityOptions } from './utilities/compatabilityOptions.js' +export { compatibilityOptions } from './utilities/compatibilityOptions.js' /** * Attempt to find migrations directory. diff --git a/packages/db-mongodb/src/utilities/compatabilityOptions.ts b/packages/db-mongodb/src/utilities/compatibilityOptions.ts similarity index 80% rename from packages/db-mongodb/src/utilities/compatabilityOptions.ts rename to packages/db-mongodb/src/utilities/compatibilityOptions.ts index bf797895b..6391c1421 100644 --- a/packages/db-mongodb/src/utilities/compatabilityOptions.ts +++ b/packages/db-mongodb/src/utilities/compatibilityOptions.ts @@ -2,9 +2,9 @@ import type { Args } from '../index.js' /** * Each key is a mongo-compatible database and the value - * is the recommended `mongooseAdapter` settings for compatability. + * is the recommended `mongooseAdapter` settings for compatibility. */ -export const compatabilityOptions = { +export const compatibilityOptions = { cosmosdb: { transactionOptions: false, useJoinAggregations: false, @@ -12,6 +12,7 @@ export const compatabilityOptions = { }, documentdb: { disableIndexHints: true, + useJoinAggregations: false, }, firestore: { disableIndexHints: true, diff --git a/test/generateDatabaseAdapter.ts b/test/generateDatabaseAdapter.ts index dd079d4f6..f0f6f4906 100644 --- a/test/generateDatabaseAdapter.ts +++ b/test/generateDatabaseAdapter.ts @@ -22,10 +22,10 @@ export const allDatabaseAdapters = { }, })`, firestore: ` - import { mongooseAdapter, compatabilityOptions } from '@payloadcms/db-mongodb' + import { mongooseAdapter, compatibilityOptions } from '@payloadcms/db-mongodb' export const databaseAdapter = mongooseAdapter({ - ...compatabilityOptions.firestore, + ...compatibilityOptions.firestore, url: process.env.DATABASE_URI || process.env.MONGODB_MEMORY_SERVER_URI ||