-
Notifications
You must be signed in to change notification settings - Fork 236
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update mongdb connector readme with lb4 style #576
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice job 👍
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there's an extra |
here that's putting this in a new row
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick (feel free to ignore): can you make the type column slightly wider to fit Boolean
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@slnode test please |
9ba024f
to
a178485
Compare
@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 |
Closes loopbackio/loopback-next#4059
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm test
passes on your machine