Package com.veeva.vault.sdk.api.query

Interface QueryService

All Superinterfaces:
Service
public interface QueryService extends Service
Service to execute VQL queries.

  • Method Details

    • query

      @Deprecated QueryResponse query(String vqlQuery)
      Deprecated.
      as of 21R3.4, replaced by query(QueryExecutionRequest)
      Executes the given vqlQuery.
      Parameters:
      vqlQuery - VQL query to execute
      Returns:
      query execution response

    • query

      QueryOperation<QueryExecutionResponse> query(QueryExecutionRequest queryExecutionRequest)
      Creates an operation to execute the given queryExecutionRequest. You can specify how success and error responses are handled on the returned QueryOperation, then call QueryOperation.execute() to execute the query request. For example: 
       queryService.query(queryExecutionRequest)
  .onSuccess(queryExecutionResponse -> {
      queryExecutionResponse.streamResults().forEach( ... )
  })
  .execute()

      The stream returned by QueryExecutionResponse.streamResults() includes all results qualified by the query. Therefore, this method does not support the VQL pagination clauses PAGESIZE and PAGEOFFSET.

      Parameters:
      queryExecutionRequest - query request to execute
      Returns:
      operation used to execute the query execution request
      Since:
      21R3.4

    • query

      QueryOperation<QueryExecutionResponse> query(QueryPageRequest pageRequest)
      Executes a request to retrieve a specific page of query results.
      Parameters:
      pageRequest - a request for a page of results
      Returns:
      operation used to execute the query page request

    • query

      <U extends UserDefinedModel> QueryOperation<QueryUserDefinedModelResponse<U>> query(QueryExecutionRequest queryExecutionRequest, Class<U> udmClass)
      Creates an operation to execute the given queryExecutionRequest and map each result row to the specified UserDefinedModel (UDM) type. You can specify how success and error responses are handled on the returned QueryOperation, then call QueryOperation.execute() to execute the query request. For example: 
       queryService.query(queryExecutionRequest, MyUdm.class)
  .onSuccess(response -> {
      response.streamResults().forEach(udm -> ... )
 })
 .execute()

      The stream returned by QueryUserDefinedModelResponse.streamResults() includes all UDMs mapped from results qualified by the query.

      Type Parameters:
      U - the UDM type
      Parameters:
      queryExecutionRequest - query request to execute
      udmClass - the UDM type to materialize from each row; must extend UserDefinedModel
      Returns:
      operation used to execute the query and obtain a typed QueryUserDefinedModelResponse

    • count

      QueryOperation<QueryCountResponse> count(QueryCountRequest queryCountRequest)
      Creates an operation to count the records qualified by the given queryCountRequest. You can specify how success and error responses are handled on the returned QueryOperation, then call QueryOperation.execute() to execute the query request. For example: 
       queryService.count(queryCountRequest)
  .onSuccess(queryCountResponse -> {
      queryCountResponse.getCount()
      ...
  })
  .execute()
      Parameters:
      queryCountRequest - query count request to execute
      Returns:
      operation used to count the records qualified by the query count request

    • validate

      QueryOperation<QueryValidationResponse> validate(QueryValidationRequest queryValidationRequest)
      Creates an operation to validate the given queryValidationRequest. You can specify how success and error responses are handled on the returned QueryOperation, then call QueryOperation.execute() to execute the query request. For example: 
       queryService.validate(queryValidationRequest)
  .onSuccess(queryValidationResponse -> {
      queryValidationResponse.getQuery()
      ...
  })
  .execute()
      Parameters:
      queryValidationRequest - query validation request to execute
      Returns:
      operation used to validate the query validation request

    • newQueryExecutionRequestBuilder

      QueryExecutionRequest.Builder newQueryExecutionRequestBuilder()
      Retrieves a QueryExecutionRequest.Builder.
      Returns:
      a QueryRequest builder

    • newQueryPageRequestBuilder

      QueryPageRequest.Builder newQueryPageRequestBuilder()
      Creates a new QueryPageRequest.Builder for constructing a query page request.
      Returns:
      a new QueryPageRequest builder

    • newQueryCountRequestBuilder

      QueryCountRequest.Builder newQueryCountRequestBuilder()
      Retrieves a QueryCountRequest.Builder.
      Returns:
      a QueryCountRequest builder

    • newQueryValidationRequestBuilder

      QueryValidationRequest.Builder newQueryValidationRequestBuilder()
      Retrieves a QueryValidationRequest.Builder.
      Returns:
      a QueryValidationRequest builder

    • newQueryFacetRequestBuilder

      QueryFacetRequest.Builder newQueryFacetRequestBuilder()
      Retrieves a QueryFacetRequest.Builder.
      Returns:
      a QueryFacetRequest builder

    • newQueryBuilder

      Query.Builder newQueryBuilder()
      Retrieves a Query.Builder.
      Returns:
      a Query builder

    • newQueryBuilderFromQuery

      Query.Builder newQueryBuilderFromQuery(Query query)
      Creates a Query.Builder based on a Query.
      Parameters:
      query - Query with which to populate the returned builder
      Returns:
      a Query builder based on the given query

    • newQueryShowTargetsRequestBuilder

      QueryShowTargetsRequest.Builder newQueryShowTargetsRequestBuilder()
      Retrieves a QueryShowTargetsRequest.Builder.
      Returns:
      a QueryShowTargetsRequest builder

    • newQueryShowFieldsRequestBuilder

      QueryShowFieldsRequest.Builder newQueryShowFieldsRequestBuilder()
      Retrieves a QueryShowFieldsRequest.Builder.
      Returns:
      a QueryShowFieldsRequest builder

    • newQueryShowRelationshipsRequestBuilder

      QueryShowRelationshipsRequest.Builder newQueryShowRelationshipsRequestBuilder()
      Retrieves a QueryShowRelationshipsRequest.Builder.
      Returns:
      a QueryShowRelationshipsRequest builder

    • escape

      @Deprecated String escape(String value)
      Deprecated.
      This method only escapes single quotes and backslashes and does not provide a way to escape other special characters. As of 21R3.4, the preferred escape utility is escapeValue(String, QueryEscapeOverride...) which escapes all VQL special characters by default and supports overriding the default escape strategy.
      Escapes special characters in a string for use in a VQL statement.

      Escaped characters include single quotes and backslashes. This method does not escape reserved keywords, such as SELECT or WHERE.

      All user-provided values should be escaped to ensure your queries execute as expected. For example, in the following VQL statement: 

       SELECT id FROM user__sys WHERE name__v='O'Brien'
      The name value is a user-entered value which, if not escaped, could cause the VQL parser to fail because of the special character.

      Note that improperly escaped VQL will not bypass configured security.

      Parameters:
      value - the value to escape
      Returns:
      the escaped value

    • escapeValue

      String escapeValue(String value, QueryEscapeOverride... escapeOverrides)
      Escapes all VQL special characters in a string for use in a VQL statement.

      VQL special characters are: 

      \ " ' ( ) * %

      Optionally, any number of QueryEscapeOverride can be used to exempt certain special characters from being escaped.

      Parameters:
      value - the value to escape
      escapeOverrides - overrides(s) indicating which characters not to escape
      Returns:
      the escaped value