diff --git a/src/Options/Definitions.js b/src/Options/Definitions.js index c9a316db36..6f9bec050e 100644 --- a/src/Options/Definitions.js +++ b/src/Options/Definitions.js @@ -140,7 +140,8 @@ module.exports.ParseServerOptions = { }, databaseAdapter: { env: 'PARSE_SERVER_DATABASE_ADAPTER', - help: 'Adapter module for the database', + help: + 'Adapter module for the database; any options that are not explicitly described here are passed directly to the database client.', action: parsers.moduleOrObjectParser, }, databaseOptions: { diff --git a/src/Options/docs.js b/src/Options/docs.js index e8601bd4e5..d774aa4668 100644 --- a/src/Options/docs.js +++ b/src/Options/docs.js @@ -28,7 +28,7 @@ * @property {Number|Boolean} cluster Run with cluster, optionally set the number of processes default to os.cpus().length * @property {String} collectionPrefix A collection prefix for the classes * @property {CustomPagesOptions} customPages custom pages for password validation and reset - * @property {Adapter} databaseAdapter Adapter module for the database + * @property {Adapter} databaseAdapter Adapter module for the database; any options that are not explicitly described here are passed directly to the database client. * @property {DatabaseOptions} databaseOptions Options to pass to the database client * @property {String} databaseURI The full URI to your database. Supported databases are mongodb or postgres. * @property {Boolean} directAccess Set to `true` if Parse requests within the same Node.js environment as Parse Server should be routed to Parse Server directly instead of via the HTTP interface. Default is `false`.

If set to `false` then Parse requests within the same Node.js environment as Parse Server are executed as HTTP requests sent to Parse Server via the `serverURL`. For example, a `Parse.Query` in Cloud Code is calling Parse Server via a HTTP request. The server is essentially making a HTTP request to itself, unnecessarily using network resources such as network ports.

⚠️ In environments where multiple Parse Server instances run behind a load balancer and Parse requests within the current Node.js environment should be routed via the load balancer and distributed as HTTP requests among all instances via the `serverURL`, this should be set to `false`.