docs: databaseOptions missing in Parse Server Options docs

[mtrezza]

The databaseOptions are not documented in the Parse Server docs. Instead it's just an Any type.

The correcting approach is to add a new Type and specify all the databaseOptions in that new type. See for example the Pages option.

This is a crucial part of the documentation for everyone who is using multiple Parse Server instances, e.g. behind a load balancer. The databaseOptions.enableSchemaHooks option is an essential configuration, see #7214.

[dblythy]

https://parseplatform.org/parse-server/api/5.0.0/DatabaseOptions.html

[mtrezza]

Ha! I must have looked at an old API version. Are there other DB options missing?

If any custom options are just passed to the adapter, we don't need to document them. But if supported options are explicitly defined, we should document them all.

[dblythy]

I'm pretty sure databaseOptions can be any valid options that can be passed to Mongo, Postgres, or any other valid database adapter

[mtrezza]

Do we have any other custom options, like enableSchemaHooks which is something we invented and is not passed to the DB adapter.

[dblythy]

I think maxTimeMS, but that is for the mongo adapter only. There might be other options but I think that's all I can find

[mtrezza]

So this issue can actually be closed then? Maybe we should add to the docs somewhere that any other parameter is passed directly to the DB client? In any case, this issue belongs to the parse-server repo, because the API docs are generated from the definition files, right?

[dblythy]

I think it can stay open but transferred, it would help to explain to users that any other database options get passed directly to the db client

[mtrezza]

OK, I'll transfer this to Parse Server and maybe you can do a PR to somehow add that note to the API docs, then we can close this.

[parse-github-assistant]

Thanks for opening this issue!

• ❌ Please edit your post and use the provided template when creating a new issue. This helps everyone to understand your post better and asks for essential information to quicker review the issue.

[parseplatformorg]

🎉 This change has been released in version 5.3.0-alpha.27

[parseplatformorg]

🎉 This change has been released in version 5.4.0-beta.1

[parseplatformorg]

🎉 This change has been released in version 5.4.0-alpha.1

[parseplatformorg]

🎉 This change has been released in version 5.4.0

[parseplatformorg]

🎉 This change has been released in version 5.4.0