[DOCS-3095] - local mongo collection #3673
Merged
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
viambot
added
the
safe to build
nicksanford
commented
Nov 13, 2024
nicksanford
commented
Nov 13, 2024
docs/services/data/_index.md
Outdated
Comment on lines
232
to
277
| | `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.
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.
Closed
nicksanford
force-pushed
the
DOCS-3095-local-mongo-collection
branch
from
79202c8
to
2e21eab
Compare
dmhilly
approved these changes
Nov 13, 2024
n0nick
approved these changes
Nov 13, 2024
nicksanford
force-pushed
the
DOCS-3095-local-mongo-collection
branch
from
d0ad9ed
to
fcd6669
Compare
sguequierre
approved these changes
Nov 14, 2024
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.
Suggested change
| 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.
Suggested change
| 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 |
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.
Ticket
Capture Directly to MongoDBfeature.