datawave/microservices/services/query/README.md

Query Service

The query service is a user-facing DATAWAVE microservice that serves as the main REST interface for DataWave query functionality.

Query Context

https://host:port/query/v1/

User API

Done?	New?	Admin?	Method	Operation	Description	Path Param	Request Body	Response Body
✓			GET	/listQueryLogic	List QueryLogic types that are currently available	N/A	N/A	[QueryLogicResponse]
✓			POST	/{queryLogic}/define	Define a query using the specified query logic and params	[QueryLogicName]	[QueryParameters]	[GenericResponse]
✓			POST	/{queryLogic}/create	Create a query using the specified query logic and params	[QueryLogicName]	[QueryParameters]	[GenericResponse]
✓			POST	/{queryLogic}/plan	Generate a query plan using the specified query logic and params	[QueryLogicName]	[QueryParameters]	[GenericResponse]
✓			POST	/{queryLogic}/predict	Generate a query prediction using the specified query logic and params	[QueryLogicName]	[QueryParameters]	[GenericResponse]
✓			POST	/{queryLogic}/async/create	Create a query using the specified query logic and params	[QueryLogicName]	[QueryParameters]	[GenericResponse]
✓			PUT POST	/{id}/reset	Resets the specified query	[QueryId]	N/A	[VoidResponse] [GenericResponse]
✓			POST	/{queryLogic}/createAndNext	Create a query using the specified query logic and params, and get the first page	[QueryLogicName]	[QueryParameters]	[BaseQueryResponse]
✓			POST	/{queryLogic}/async/createAndNext	Create a query using the specified query logic and params, and get the first page	[QueryLogicName]	[QueryParameters]	[BaseQueryResponse]
			GET	/lookupContentUUID/{uuidType}/{uuid}	Returns content associated with the given UUID	[UUIDType], [UUID]	N/A	[BaseQueryResponse] or [StreamingOutput]
			POST	/lookupContentUUID	Returns content associated with the given batch of UUIDs	N/A	[QueryParameters]	[BaseQueryResponse] or [StreamingOutput]
			GET	/lookupUUID/{uuidType}/{uuid}	Returns event associated with the given batch of UUID	[UUIDType], [UUID]	N/A	[BaseQueryResponse] or [StreamingOutput]
			POST	/lookupUUID	Returns event(s) associated with the given batch of UUIDs	N/A	[QueryParameters]	[BaseQueryResponse] or [StreamingOutput]
✓			GET	/{id}/plan	Returns the plan for the specified query	[QueryId]	N/A	[GenericResponse]
✓			GET	/{id}/predictions	Returns the predictions for the specified query	[QueryId]	N/A	[GenericResponse]
✓			GET	/{id}/async/next	Returns the next page of results for the specified query	[QueryId]	N/A	[BaseQueryResponse]
✓			GET	/{id}/next	Returns the next page of results for the specified query	[QueryId]	N/A	[BaseQueryResponse]
✓			PUT POST	/{id}/close	Closes the specified query	[QueryId]	N/A	[VoidResponse]
✓		✓	PUT POST	/{id}/adminClose	Closes the specified query	[QueryId]	N/A	[VoidResponse]
✓	✓	✓	PUT POST	/adminCloseAll	Closes all running queries	N/A	N/A	[VoidResponse]
✓			PUT POST	/{id}/cancel	Cancels the specified query	[QueryId]	N/A	[VoidResponse]
✓		✓	PUT POST	/{id}/adminCancel	Cancels the specified query	[QueryId]	N/A	[VoidResponse]
✓	✓	✓	PUT POST	/adminCancelAll	Cancels all running queries	N/A	N/A	[VoidResponse]
✓			GET	/listAll	Returns a list of queries associated with the current user	N/A	N/A	[QueryImplListResponse]
✓			GET	/{id}	Returns query info for the specified query	[QueryId]	N/A	[QueryImplListResponse]
✓			GET	/list	Returns a list of queries for this caller, filtering by the (optional) query id, and (optional) query name	N/A	[QueryId], [QueryName]	[QueryImplListResponse]
✓	✓	✓	GET	/adminList	Returns a list of queries, filtered by the (optional) user, (optional) query id, and (optional) query name	N/A	[User], [QueryId], [QueryName]	[QueryImplListResponse]
✓			DELETE	/{id}/remove	Remove (delete) the specified query	[QueryId]	N/A	[VoidResponse]
✓	✓	✓	DELETE	/{id}/adminRemove	Remove (delete) the specified query	[QueryId]	N/A	[VoidResponse]
✓	✓	✓	DELETE	/{id}/adminRemoveAll	Removes all queries which aren't running	N/A	N/A	[VoidResponse]
✓			POST	/{id}/duplicate	Duplicates the specified query	[QueryId]	[QueryParameters]	[GenericResponse]
✓			PUT POST	/{id}/update	Updates the specified query	[QueryId]	[QueryParameters]	[GenericResponse]
✓			GET	/{id}/listAll	Returns a list of queries associated with the specified user	[UserId]	N/A	[QueryImplListResponse]
✓			POST	/purgeQueryCache	Purges the cache of query objects	N/A	N/A	[VoidResponse]
✓			GET	/enableTracing	Enables tracing for queries which match the given criteria	N/A	[QueryRegex], [User]	[VoidResponse]
✓			GET	/disableTracing	Disables tracing for queries which match the given criteria	N/A	[QueryRegex], [User]	[VoidResponse]
✓			GET	/disableAllTracing	Disables tracing for all queries	N/A	N/A	[VoidResponse]
			POST	/{logicName}/execute	Create a query using the specified query logic and params, and stream the results	[QueryLogicName]	[QueryParameters]	[StreamingOutput]
			POST	/{logicName}/async/execute	Create a query using the specified query logic and params, and stream the results	[QueryLogicName]	[QueryParameters]	[StreamingOutput]

---

Getting Started

TBD

For now, refer to the Datawave Docker Compose Readme