Skip to content

Commit 04857e4

Browse files
committed
added info to option docs
1 parent 0855fe2 commit 04857e4

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

src/Options/Definitions.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -778,7 +778,7 @@ module.exports.DatabaseOptions = {
778778
enableSchemaHooks: {
779779
env: 'PARSE_SERVER_DATABASE_ENABLE_SCHEMA_HOOKS',
780780
help:
781-
'Enables database hooks to update single schema cache. Set to true if using multiple Parse Servers instances connected to the same database.',
781+
'Enables database real-time hooks to update single schema cache. Set to `true` if using multiple Parse Servers instances connected to the same database. Failing to do so will cause a schema change to not propagate to all instances and re-syncing will only happen when the instances restart. To use this feature with MongoDB, a replica set cluster with [change stream](https://docs.mongodb.com/manual/changeStreams/#availability) support is required.',
782782
action: parsers.booleanParser,
783783
default: false,
784784
},

src/Options/docs.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -191,5 +191,5 @@
191191

192192
/**
193193
* @interface DatabaseOptions
194-
* @property {Boolean} enableSchemaHooks Enables database hooks to update single schema cache. Set to true if using multiple Parse Servers instances connected to the same database.
194+
* @property {Boolean} enableSchemaHooks Enables database real-time hooks to update single schema cache. Set to `true` if using multiple Parse Servers instances connected to the same database. Failing to do so will cause a schema change to not propagate to all instances and re-syncing will only happen when the instances restart. To use this feature with MongoDB, a replica set cluster with [change stream](https://docs.mongodb.com/manual/changeStreams/#availability) support is required.
195195
*/

src/Options/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ export interface FileUploadOptions {
413413
}
414414

415415
export interface DatabaseOptions {
416-
/* Enables database hooks to update single schema cache. Set to true if using multiple Parse Servers instances connected to the same database.
416+
/* Enables database real-time hooks to update single schema cache. Set to `true` if using multiple Parse Servers instances connected to the same database. Failing to do so will cause a schema change to not propagate to all instances and re-syncing will only happen when the instances restart. To use this feature with MongoDB, a replica set cluster with [change stream](https://docs.mongodb.com/manual/changeStreams/#availability) support is required.
417417
:DEFAULT: false */
418418
enableSchemaHooks: ?boolean;
419419
}

0 commit comments

Comments
 (0)