Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Draft: Add query_options documentation #50

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Draft: Add query_options documentation #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion collector/configuration/sources.xml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This file stores the configuration regarding the connection to all the remote da
| `rig_name` | string | |
| `service_company` | string | |
| `protocol_name` | string | |
| The protocol name defines the interpretation of all the other fields. Possible values are `witsml`, `wits`, `opc-da`,`opc-ua`, `csv`, and `raw`. | | |
| The protocol name defines the interpretation of all the other fields. Possible values are `witsml`, `wits`, `opc-da`,`opc-ua`, `modbus`, `csv`, and `raw`. | | |
| `protocol_version` | string | |
| `endpoint` | string | |
| The format of the endpoint varies by protocol. | | |
Expand Down Expand Up @@ -61,6 +61,8 @@ This file stores the configuration regarding the connection to all the remote da
| This field is informative only, and not used on the connection. It can be left blank. | | |
| `index_type` | string | witsml |
| When a wildcard (`*`) is used for the `uid_log`, this fields restrict the collection for a specific log index type. It is also useful to tell the collector, a priori, not to query by date when a log is depth-indexed, and vice-versa. Possible values are `date time`, `measured depth` or `vertical depth`. | | |
| `query_options` | string | witsml, liverig 5.5+ |
| For WITSML, the requests can be made lightweight once metadata information is ommited in responses. That is specially trick for WITSML Log polling. Here you can specify `returnElements=data-only` to make such lightweight requests by default. | | |
| `mnemonics` | string | witsml, opc-da, opc-ua |
| For opc-da and opc-ua, it should be combined with a list provided on the file `store.json`. | | |
| `log_delay` | int | witsml |
Expand Down