-
Notifications
You must be signed in to change notification settings - Fork 43
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-3095] - local mongo collection #3673
[DOCS-3095] - local mongo collection #3673
Conversation
docs/services/data/_index.md
Outdated
| `mongo_capture_config.uri` | string | Optional | The [MongoDB URI](https://www.mongodb.com/docs/v6.2/reference/connection-string/) data capture will attempt to write tabular data to after it is enqueued to be written to disk. When non empty, data capture will capture tabular data to the configured MongoDB database & collection at that URI.<br>See `mongo_capture_config.database` and `mongo_capture_config.collection` below for database & collection defaults. | <p class="center-text"><i class="fas fa-times" title="no"></i></p> | | ||
| `mongo_capture_config.database` | string | Optional | When `mongo_capture_config.uri` is non empty, changes the database data capture will write tabular data to. <br> Default: `"sensorData"` | <p class="center-text"><i class="fas fa-times" title="no"></i></p> | | ||
| `mongo_capture_config.collection` | string | Optional | When `mongo_capture_config.uri` is non empty, changes the collection data capture will write tabular data to.<br> Default: `"readings"` | <p class="center-text"><i class="fas fa-times" title="no"></i></p> | |
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.
Question for the docs team: Is this the proper way to document a config attribute which is an object with multiple fields? I wasn't sure how best to document each field of the mongo_capture_config
object.
79202c8
to
2e21eab
Compare
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.
Technical explanations LGTM! Thanks for doing this.
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.
LGTM! I only had a few style fixes / trying to align terminology with the rest of the page. Thank you!!
d0ad9ed
to
fcd6669
Compare
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.
thanks nick!
docs/services/data/_index.md
Outdated
This feature is intended to support use cases like offline dashboards which don't require strong data | ||
delivery or consistency guarantees. | ||
|
||
Here is a sample configuration that will capture fake sensor readings both to the configured MongoDB URI |
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.
Here is a sample configuration that will capture fake sensor readings both to the configured MongoDB URI | |
Here is a sample configuration that will capture fake sensor readings both to the configured MongoDB URI as well as to the `~/.viam/capture` directory on disk: |
docs/services/data/_index.md
Outdated
delivery or consistency guarantees. | ||
|
||
Here is a sample configuration that will capture fake sensor readings both to the configured MongoDB URI | ||
as well as to the Viam capture directory on disk: |
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.
as well as to the Viam capture directory on disk: |
Co-authored-by: Sierra Guequierre <[email protected]>
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3673 |
Ticket
Capture Directly to MongoDB
feature.