docs: update mongdb connector readme with lb4 style #576
Conversation
This file contains 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
agnes512
requested review from
dhmlau,
emonddr,
hacksparrow and
jannyHou
as code owners
7 tasks
nabdelgadir
reviewed
Jun 2, 2020
README.md
Outdated
| | enableGeoIndexing | Boolean | `false` | Set to `true` to enable 2d sphere indexing for model properties of type `GeoPoint`. This allows for indexed `near` queries. | | ||
| | lazyConnect | Boolean | `false` | If set to `true`, the database instance will not be attached to the datasource and the connection is deferred. It will try to establish the connection automatically once users hit the endpoint. If the MongoDB server is offline, the app will start, however, the endpoints will not work. | | ||
| | disableDefaultSort | Boolean | `false` | Set to `true` to disable the default sorting | | ||
| | behavior on `id` column, this will help performance using indexed columns available in MongoDB. | |
There was a problem hiding this comment.
I think there's an extra | here that's putting this in a new row
There was a problem hiding this comment.
I think those weird format is causing by the formatting extension 馃槀
README.md
Outdated
| - **disableDefaultSort**: Set to `true` to disable the default sorting | ||
| behavior on `id` column, this will help performance using indexed columns available in mongodb. | ||
| - **collation**: Specify language-specific rules for string comparison, such as rules for lettercase and accent marks. See [`MongdoDB documentation`](https://docs.mongodb.com/manual/reference/collation/) for details. It can also be used to create [`case insensitive indexes`](https://docs.mongodb.com/manual/core/index-case-insensitive/). | ||
| | Property | Type | Default | Description | |
There was a problem hiding this comment.
nitpick (feel free to ignore): can you make the type column slightly wider to fit Boolean?
|
@slnode test please |
nabdelgadir
approved these changes
Jun 3, 2020
agnes512
force-pushed
the
update-readme
branch
2 times, most recently
from
9ba024f
to
a178485
Compare
dhmlau
reviewed
Jun 3, 2020
|
@slnode test please |
|
@slnode test please |
1 similar comment
|
@slnode test please |
|
@slnode test please |
1 similar comment
|
@slnode test please |
|
Test passes except for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes loopbackio/loopback-next#4059
Checklist
馃憠 Read and sign the CLA (Contributor License Agreement) 馃憟
npm testpasses on your machine