From 1ceea645b6ff380b21b8bfca738e0fc27324e6c8 Mon Sep 17 00:00:00 2001 From: Jacob Fletcher Date: Wed, 17 May 2023 16:34:49 -0400 Subject: [PATCH] chore: replaces instances of the text Mongo with MongoDB --- .gitignore | 2 +- CHANGELOG.md | 2 +- docs/email/overview.mdx | 2 +- docs/fields/relationship.mdx | 2 +- docs/getting-started/installation.mdx | 8 ++++---- docs/getting-started/what-is-payload.mdx | 2 +- src/config/types.ts | 6 +++--- src/express/types.ts | 2 +- src/graphql/schema/buildWhereInputType.ts | 2 +- src/mongoose/connect.ts | 4 ++-- 10 files changed, 16 insertions(+), 16 deletions(-) diff --git a/.gitignore b/.gitignore index e57314eb50..7de28afdba 100644 --- a/.gitignore +++ b/.gitignore @@ -164,7 +164,7 @@ GitHub.sublime-settings # CMake cmake-build-debug/ -# Mongo Explorer plugin: +# MongoDB Explorer plugin: .idea/**/mongoSettings.xml ## File-based project format: diff --git a/CHANGELOG.md b/CHANGELOG.md index a6ff9391c4..8d9b845959 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -589,7 +589,7 @@ If not already defined, add the following to your `compilerOptions`: #### ✋ Versions may need to be migrated -This release includes a substantial simplification / optimization of how Versions work within Payload. They are now significantly more performant and easier to understand behind-the-scenes. We've removed ~600 lines of code and have ensured that Payload can be compatible with all flavors of Mongo - including versions earlier than 4.0, Azure Cosmos MongoDB, AWS' DocumentDB and more. +This release includes a substantial simplification / optimization of how Versions work within Payload. They are now significantly more performant and easier to understand behind-the-scenes. We've removed ~600 lines of code and have ensured that Payload can be compatible with all flavors of MongoDB - including versions earlier than 4.0, Azure Cosmos MongoDB, AWS' DocumentDB and more. But, some of your draft-enabled documents may need to be migrated. diff --git a/docs/email/overview.mdx b/docs/email/overview.mdx index 420323919a..b973ff56c5 100644 --- a/docs/email/overview.mdx +++ b/docs/email/overview.mdx @@ -143,7 +143,7 @@ payload.init({ [06:37:21] INFO (payload): Starting Payload... [06:37:22] INFO (payload): Payload Demo Initialized [06:37:22] INFO (payload): listening on 3000... -[06:37:22] INFO (payload): Connected to Mongo server successfully! +[06:37:22] INFO (payload): Connected to MongoDB server successfully! [06:37:23] INFO (payload): E-mail configured with mock configuration [06:37:23] INFO (payload): Log into mock email provider at https://ethereal.email [06:37:23] INFO (payload): Mock email account username: hhav5jw7doo4euev@ethereal.email diff --git a/docs/fields/relationship.mdx b/docs/fields/relationship.mdx index 702a9abc88..f42f848935 100644 --- a/docs/fields/relationship.mdx +++ b/docs/fields/relationship.mdx @@ -146,7 +146,7 @@ The shape of the data to save for a document with the field configured this way ```json { - // Mongo ObjectID of the related user + // MongoDB ObjectID of the related user "owner": "6031ac9e1289176380734024" } ``` diff --git a/docs/getting-started/installation.mdx b/docs/getting-started/installation.mdx index 5b24ae11c6..697837744e 100644 --- a/docs/getting-started/installation.mdx +++ b/docs/getting-started/installation.mdx @@ -12,7 +12,7 @@ Payload requires the following software: - Yarn or NPM - Node.js version 14+ -- A Mongo Database +- A MongoDB Database Before proceeding any further, please ensure that you have the above @@ -110,15 +110,15 @@ Payload uses this secret key to generate secure user tokens (JWT). Behind the sc ##### `mongoURL` -**Required**. This is a fully qualified MongoDB connection string that points to your Mongo database. If you don't have Mongo installed locally, you can [follow these steps for Mac OSX](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/) and [these steps](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/) for Windows 10. If you want to use a local database and you know you have MongoDB installed locally, a typical connection string will look like this: +**Required**. This is a fully qualified MongoDB connection string that points to your MongoDB database. If you don't have MongoDB installed locally, you can [follow these steps for Mac OSX](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/) and [these steps](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/) for Windows 10. If you want to use a local database and you know you have MongoDB installed locally, a typical connection string will look like this: `mongodb://localhost/payload` -In contrast to running Mongo locally, a popular option is to sign up for a free [MongoDB Atlas account](https://www.mongodb.com/cloud/atlas), which is a fully hosted and cloud-based installation of Mongo that you don't need to ever worry about. +In contrast to running MongoDB locally, a popular option is to sign up for a free [MongoDB Atlas account](https://www.mongodb.com/cloud/atlas), which is a fully hosted and cloud-based installation of MongoDB that you don't need to ever worry about. ##### `mongoOptions` -Customize Mongo connection options. Payload will connect to your MongoDB database using default options which you can override and extend to include all the [options](https://mongoosejs.com/docs/connections.html#options) available to mongoose. +Customize MongoDB connection options. Payload will connect to your MongoDB database using default options which you can override and extend to include all the [options](https://mongoosejs.com/docs/connections.html#options) available to mongoose. ##### `email` diff --git a/docs/getting-started/what-is-payload.mdx b/docs/getting-started/what-is-payload.mdx index 15eb2e986b..a6fe0d787f 100644 --- a/docs/getting-started/what-is-payload.mdx +++ b/docs/getting-started/what-is-payload.mdx @@ -19,7 +19,7 @@ keywords: documentation, getting started, guide, Content Management System, cms, Out of the box, Payload gives you a lot of the things that you often need when developing a new website, web app, or native app: -- A Mongo database to store your data +- A MongoDB database to store your data - A way to store, retrieve, and manipulate data of any shape via full REST and GraphQL APIs - Authentication—complete with commonly required functionality like registration, email verification, login, & password reset - Deep access control to your data, based on document or field-level functions diff --git a/src/config/types.ts b/src/config/types.ts index 9b1a83bb14..0720666988 100644 --- a/src/config/types.ts +++ b/src/config/types.ts @@ -79,9 +79,9 @@ export type GraphQLExtension = ( export type InitOptions = { /** Express app for Payload to use */ express?: Express; - /** Mongo connection URL, starts with `mongo` */ + /** MongoDB connection URL, starts with `mongo` */ mongoURL: string | false; - /** Extra configuration options that will be passed to Mongo */ + /** Extra configuration options that will be passed to MongoDB */ mongoOptions?: ConnectOptions & { /** Set false to disable $facet aggregation in non-supporting databases, Defaults to true */ useFacet?: boolean @@ -124,7 +124,7 @@ export type InitOptions = { * and then sent to the client allowing the dashboard to show accessible data and actions. * * If the result is `true`, the user has access. - * If the result is an object, it is interpreted as a Mongo query. + * If the result is an object, it is interpreted as a MongoDB query. * * @example `{ createdBy: { equals: id } }` * diff --git a/src/express/types.ts b/src/express/types.ts index 0f42f44f1a..41f15177b5 100644 --- a/src/express/types.ts +++ b/src/express/types.ts @@ -22,7 +22,7 @@ export declare type PayloadRequest = Request & { fallbackLocale?: string; /** Information about the collection that is being accessed * - Configuration from payload-config.ts - * - Mongo model for this collection + * - MongoDB model for this collection * - GraphQL type metadata * */ collection?: Collection; diff --git a/src/graphql/schema/buildWhereInputType.ts b/src/graphql/schema/buildWhereInputType.ts index 79f914fc86..5d53dabcb2 100644 --- a/src/graphql/schema/buildWhereInputType.ts +++ b/src/graphql/schema/buildWhereInputType.ts @@ -23,7 +23,7 @@ import fieldToSchemaMap from './fieldToWhereInputSchemaMap'; // 1. Everything needs to be a GraphQLInputObjectType or scalar / enum // 2. Relationships, groups, repeaters and flex content are not // directly searchable. Instead, we need to build a chained pathname -// using dot notation so Mongo can properly search nested paths. +// using dot notation so MongoDB can properly search nested paths. const buildWhereInputType = (name: string, fields: Field[], parentName: string): GraphQLInputObjectType => { // This is the function that builds nested paths for all // field types with nested paths. diff --git a/src/mongoose/connect.ts b/src/mongoose/connect.ts index c345d49759..eab1477cb9 100644 --- a/src/mongoose/connect.ts +++ b/src/mongoose/connect.ts @@ -11,7 +11,7 @@ const connectMongoose = async ( logger: pino.Logger, ): Promise => { let urlToConnect = url; - let successfulConnectionMessage = 'Connected to Mongo server successfully!'; + let successfulConnectionMessage = 'Connected to MongoDB server successfully!'; const connectionOptions: ConnectOptions & { useFacet: undefined } = { autoIndex: true, @@ -35,7 +35,7 @@ const connectMongoose = async ( }); urlToConnect = mongoMemoryServer.getUri(); - successfulConnectionMessage = 'Connected to in-memory Mongo server successfully!'; + successfulConnectionMessage = 'Connected to in-memory MongoDB server successfully!'; } try {