Updates the db reference with sqlite and postgres#556
Open
BoDonkey wants to merge 1 commit into
Open
Conversation
boutell
requested changes
Jul 10, 2026
| |`port` | Integer | A port to use in the database URI if the `uri` option is not used. This falls back to `27017`. | | ||
| |`name` | String | The project's database name. This falls back to the project [shortname](/reference/glossary.md#shortname). | | ||
| |`client` | String |An existing MongoDB connection (MongoClient) object. If present, it is used and `uri`, `host`, `connect`, etc. are ignored. | | ||
| |`uri` | String | The database connection URI. May use the `mongodb://`, `sqlite://`, or `postgres://` protocol. See the [MongoDB URI documentation](https://docs.mongodb.com/manual/reference/connection-string/) for the MongoDB format. | |
Member
There was a problem hiding this comment.
or multipostgres
Link to our documentation too
| <!-- Some are used within the module and would just create noise here. --> | ||
|
|
||
| Because this module has an alias, you can call these from another module from the alias path. For example, `self.apos.db.connectToMongo()`. | ||
| Because this module has an alias, you can call these from another module from the alias path. For example, `self.apos.db.connectToDb()`. |
Member
There was a problem hiding this comment.
I know this isn't new, but: this is not the case. The db module has no alias, which was called out earlier in the same document. self.apos.db is the database object.
All in all I think removing this section would be best at this point. If someone really wants to make a connection completely independent of self.apos.db they should consider using @apostrophecms/db-connect directly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please indicate which branch this PR should merge into:
Check one
Summary
Summarize the changes briefly, including which issue/ticket this resolves. If it closes an existing Github issue, include "Closes #[issue number]"
This PR updates the @apostrophe/db reference document with the new database options. Closes PRO-9680
What are the specific steps to test this change?
For example:
What kind of change does this PR introduce?
(Check at least one)
Make sure the PR fulfills these requirements:
If adding a new feature without an already open issue, it's best to open a feature request issue first and wait for approval before working on it.
Other information: