OSDU Data Helper Utility - SPIKE: develop LOE and plan for a small helper
Some operators are unaware of all available data within OSDU. How can we make it easier for operators to understand all available data?
One idea is a helper utility / script which generates a log file that evaluates a given OSDU instance for all available kinds/versions and total record counts of each kind. This may help operators understand how to better configure GCZ.
Some companies choose to persist data among both older and newer versions, and some companies prefer this distinction between versions. It is difficult for GCZ administrators to know which versions hold the right data, so this utility could assist with the distinction - and not require GCZ administrators to individually query each OSDU kind themselves.
OSDU Utility: Storage_Host/query/kinds
- This utility shows all available kinds
-
Use above service to locate all available kinds.
-
Then query each kind for total count:
Lucene syntax:
Query endpoint: https://{{SEARCH_HOST}}/query_with_cursor
JSON Payload
{
"kind": "osdu:wks:work-product-component--LocalBoundaryFeature:*",
"limit": 1,
"returnedFields": [""]
}
Example output:
kinds in database:
kind [x] with # records
kind [y] with # records
kind [z] with # records
...