Examples with ValidateQueryRequest org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest used on opensource projects

Example 1 with ValidateQueryRequest

use of org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest in project OpenSearch by opensearch-project.

the class IndicesRequestConverters method validateQuery.

static Request validateQuery(ValidateQueryRequest validateQueryRequest) throws IOException {
    String[] indices = validateQueryRequest.indices() == null ? Strings.EMPTY_ARRAY : validateQueryRequest.indices();
    String endpoint = RequestConverters.endpoint(indices, "_validate/query");
    Request request = new Request(HttpGet.METHOD_NAME, endpoint);
    RequestConverters.Params params = new RequestConverters.Params();
    params.withIndicesOptions(validateQueryRequest.indicesOptions());
    params.putParam("explain", Boolean.toString(validateQueryRequest.explain()));
    params.putParam("all_shards", Boolean.toString(validateQueryRequest.allShards()));
    params.putParam("rewrite", Boolean.toString(validateQueryRequest.rewrite()));
    request.addParameters(params.asMap());
    request.setEntity(RequestConverters.createEntity(validateQueryRequest, RequestConverters.REQUEST_BODY_CONTENT_TYPE));
    return request;
}

Example 2 with ValidateQueryRequest

use of org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest in project OpenSearch by opensearch-project.

the class IndicesClientIT method testInvalidValidateQuery.

public void testInvalidValidateQuery() throws IOException {
    String index = "shakespeare";
    createIndex(index, Settings.EMPTY);
    Request postDoc = new Request(HttpPost.METHOD_NAME, "/" + index + "/_doc");
    postDoc.setJsonEntity("{" + "  \"type\": \"act\"," + "  \"line_id\": 1," + "  \"play_name\": \"Henry IV\"," + "  \"speech_number\": \"\"," + "  \"line_number\": \"\"," + "  \"speaker\": \"\"," + "  \"text_entry\": \"ACT I\"" + "}");
    assertOK(client().performRequest(postDoc));
    QueryBuilder builder = QueryBuilders.queryStringQuery("line_id:foo").lenient(false);
    ValidateQueryRequest request = new ValidateQueryRequest(index).query(builder);
    request.explain(true);
    ValidateQueryResponse response = execute(request, highLevelClient().indices()::validateQuery, highLevelClient().indices()::validateQueryAsync);
    assertFalse(response.isValid());
}

Example 3 with ValidateQueryRequest

use of org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest in project OpenSearch by opensearch-project.

the class IndicesClientIT method testValidateQuery.

public void testValidateQuery() throws IOException {
    String index = "some_index";
    createIndex(index, Settings.EMPTY);
    QueryBuilder builder = QueryBuilders.boolQuery().must(QueryBuilders.queryStringQuery("*:*")).filter(QueryBuilders.termQuery("user", "foobar"));
    ValidateQueryRequest request = new ValidateQueryRequest(index).query(builder);
    request.explain(randomBoolean());
    ValidateQueryResponse response = execute(request, highLevelClient().indices()::validateQuery, highLevelClient().indices()::validateQueryAsync);
    assertTrue(response.isValid());
}

Example 4 with ValidateQueryRequest

use of org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest in project OpenSearch by opensearch-project.

the class IndicesRequestConvertersTests method testValidateQuery.

public void testValidateQuery() throws Exception {
    String[] indices = OpenSearchTestCase.randomBoolean() ? null : RequestConvertersTests.randomIndicesNames(0, 5);
    ValidateQueryRequest validateQueryRequest;
    if (OpenSearchTestCase.randomBoolean()) {
        validateQueryRequest = new ValidateQueryRequest(indices);
    } else {
        validateQueryRequest = new ValidateQueryRequest();
        validateQueryRequest.indices(indices);
    }
    Map<String, String> expectedParams = new HashMap<>();
    RequestConvertersTests.setRandomIndicesOptions(validateQueryRequest::indicesOptions, validateQueryRequest::indicesOptions, expectedParams);
    validateQueryRequest.explain(OpenSearchTestCase.randomBoolean());
    validateQueryRequest.rewrite(OpenSearchTestCase.randomBoolean());
    validateQueryRequest.allShards(OpenSearchTestCase.randomBoolean());
    expectedParams.put("explain", Boolean.toString(validateQueryRequest.explain()));
    expectedParams.put("rewrite", Boolean.toString(validateQueryRequest.rewrite()));
    expectedParams.put("all_shards", Boolean.toString(validateQueryRequest.allShards()));
    Request request = IndicesRequestConverters.validateQuery(validateQueryRequest);
    StringJoiner endpoint = new StringJoiner("/", "/", "");
    if (indices != null && indices.length > 0) {
        endpoint.add(String.join(",", indices));
    }
    endpoint.add("_validate/query");
    Assert.assertThat(request.getEndpoint(), equalTo(endpoint.toString()));
    Assert.assertThat(request.getParameters(), equalTo(expectedParams));
    RequestConvertersTests.assertToXContentBody(validateQueryRequest, request.getEntity());
    Assert.assertThat(request.getMethod(), equalTo(HttpGet.METHOD_NAME));
}

Example 5 with ValidateQueryRequest

use of org.opensearch.action.admin.indices.validate.query.ValidateQueryRequest in project OpenSearch by opensearch-project.

the class IndicesClientDocumentationIT method testValidateQuery.

@SuppressWarnings("unused")
public void testValidateQuery() throws IOException, InterruptedException {
    RestHighLevelClient client = highLevelClient();
    String index = "some_index";
    createIndex(index, Settings.EMPTY);
    // tag::indices-validate-query-request
    // <1>
    ValidateQueryRequest request = new ValidateQueryRequest(index);
    // end::indices-validate-query-request
    // tag::indices-validate-query-request-query
    QueryBuilder builder = QueryBuilders.boolQuery().must(QueryBuilders.queryStringQuery("*:*")).filter(QueryBuilders.termQuery("user", "foobar"));
    // <2>
    request.query(builder);
    // end::indices-validate-query-request-query
    // tag::indices-validate-query-request-explain
    // <1>
    request.explain(true);
    // end::indices-validate-query-request-explain
    // tag::indices-validate-query-request-allShards
    // <1>
    request.allShards(true);
    // end::indices-validate-query-request-allShards
    // tag::indices-validate-query-request-rewrite
    // <1>
    request.rewrite(true);
    // end::indices-validate-query-request-rewrite
    // tag::indices-validate-query-execute
    // <1>
    ValidateQueryResponse response = client.indices().validateQuery(request, RequestOptions.DEFAULT);
    // end::indices-validate-query-execute
    // tag::indices-validate-query-response
    // <1>
    boolean isValid = response.isValid();
    // <2>
    int totalShards = response.getTotalShards();
    // <3>
    int successfulShards = response.getSuccessfulShards();
    // <4>
    int failedShards = response.getFailedShards();
    if (failedShards > 0) {
        for (DefaultShardOperationFailedException failure : response.getShardFailures()) {
            // <5>
            // <6>
            String failedIndex = failure.index();
            // <7>
            int shardId = failure.shardId();
            // <8>
            String reason = failure.reason();
        }
    }
    for (QueryExplanation explanation : response.getQueryExplanation()) {
        // <9>
        // <10>
        String explanationIndex = explanation.getIndex();
        // <11>
        int shardId = explanation.getShard();
        // <12>
        String explanationString = explanation.getExplanation();
    }
    // end::indices-validate-query-response
    // tag::indices-validate-query-execute-listener
    ActionListener<ValidateQueryResponse> listener = new ActionListener<ValidateQueryResponse>() {

        @Override
        public void onResponse(ValidateQueryResponse validateQueryResponse) {
        // <1>
        }

        @Override
        public void onFailure(Exception e) {
        // <2>
        }
    };
    // end::indices-validate-query-execute-listener
    // Replace the empty listener by a blocking listener in test
    final CountDownLatch latch = new CountDownLatch(1);
    listener = new LatchedActionListener<>(listener, latch);
    // tag::indices-validate-query-execute-async
    // <1>
    client.indices().validateQueryAsync(request, RequestOptions.DEFAULT, listener);
    // end::indices-validate-query-execute-async
    assertTrue(latch.await(30L, TimeUnit.SECONDS));
}