com.redhat.lightblue.crud

Interface ExplainQuerySupport

public interface ExplainQuerySupport

If the controller supports explain query, implement this interface

Method Summary

Modifier and Type	Method and Description
void	explain(CRUDOperationContext ctx, QueryExpression query, Projection projection, Sort sort, Long from, Long to, JsonDoc destDoc) Explains a query

Method Detail

explain

void explain(CRUDOperationContext ctx,
             QueryExpression query,
             Projection projection,
             Sort sort,
             Long from,
             Long to,
             JsonDoc destDoc)

Explains a query

Parameters:

ctx - Operation context

entity - The entity to search for

query - The query. Cannot be null

projection - What fields to return. Cannot be null

sort - Sort keys. Can be null

from - starting index in the result set. Can be null. Meaninguful only if a sort is given. Starts from 0.

to - end index in the result set. Starts from 0, and inclusive. Can be null.

destDoc - This document is populated with the explained query