Skip to content

Commit

Permalink
Added support for format parameter to specify the sql response form…
Browse files Browse the repository at this point in the history
…at (#161)

* feat: add test for SQL query endpoint

Signed-off-by: Salih Candir <[email protected]>

* format on Sql

cherry-pick from @archipelweb see: #156

Signed-off-by: archipelweb <[email protected]>

* docs: add 'format' to allowed SQL query params

Signed-off-by: Salih Candir <[email protected]>

* docs: update changelog

Signed-off-by: Salih Candir <[email protected]>

* feat: make failed message of testFormatParamIsAllowedToSet more precise

Signed-off-by: Salih Candir <[email protected]>

* refactor: add an line break at the end of line

Signed-off-by: Salih Candir <[email protected]>

* docs: add example how to use query using sql

Signed-off-by: Salih Candir <[email protected]>

---------

Signed-off-by: Salih Candir <[email protected]>
Signed-off-by: archipelweb <[email protected]>
Co-authored-by: archipelweb <[email protected]>
  • Loading branch information
CSalih and archipelweb authored Jul 12, 2023
1 parent 5c5453c commit 9ebb183
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Added support for Amazon OpenSearch Serverless SigV4 signing ([#119](https://github.com/opensearch-project/opensearch-php/pull/119))
- Added `includePortInHostHeader` option to `ClientBuilder::fromConfig` ([#118](https://github.com/opensearch-project/opensearch-php/pull/118))
- Added the `RefreshSearchAnalyzers` endpoint ([[#152](https://github.com/opensearch-project/opensearch-php/issues/152))
- Added support for `format` parameter to specify the sql response format ([#161](https://github.com/opensearch-project/opensearch-php/pull/161))

### Changed

Expand Down
11 changes: 11 additions & 0 deletions USER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,16 @@ class MyOpenSearchClass
var_dump($docs['hits']['total']['value'] > 0);
}

// Write queries in SQL
public function searchUsingSQL()
{
$docs = $this->client->sql()->query([
'query' => "SELECT * FROM INDEX_NAME WHERE name = 'wrecking'",
'format' => 'json'
]);
var_dump($docs['hits']['total']['value'] > 0);
}

public function getMultipleDocsByIDs()
{
$docs = $this->client->search([
Expand Down Expand Up @@ -338,6 +348,7 @@ try {
$e->getOneByID();
$e->getMultipleDocsByIDs();
$e->search();
$e->searchUsingSQL();
$e->searchByPointInTime();
$e->deleteByQuery('');
$e->deleteByID();
Expand Down
2 changes: 1 addition & 1 deletion src/OpenSearch/Endpoints/Sql/Query.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class Query extends AbstractEndpoint
{
public function getParamWhitelist(): array
{
return [];
return ['format'];
}

public function getURI(): string
Expand Down
1 change: 1 addition & 0 deletions src/OpenSearch/Namespaces/SqlNamespace.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ class SqlNamespace extends AbstractNamespace
{
/**
* $params['query'] = (string) The SQL Query
* $params['format'] = (string) The response format
* $params['cursor'] = (string) The cursor given by the server
* $params['fetch_size'] = (int) The fetch size
*
Expand Down
78 changes: 78 additions & 0 deletions tests/Endpoints/SqlQueryEndpointTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<?php

declare(strict_types=1);

/**
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*
* Elasticsearch PHP client
*
* @link https://github.com/elastic/elasticsearch-php/
* @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* @license https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1
*
* Licensed to Elasticsearch B.V under one or more agreements.
* Elasticsearch B.V licenses this file to you under the Apache 2.0 License or
* the GNU Lesser General Public License, Version 2.1, at your option.
* See the LICENSE file in the project root for more information.
*/

namespace OpenSearch\Tests\Endpoints;

use OpenSearch\Common\Exceptions\UnexpectedValueException;
use OpenSearch\Endpoints\Sql\Query;
use PHPUnit\Framework\TestCase;

/**
* @covers \OpenSearch\Endpoints\Sql\Query
*/
class SqlQueryEndpointTest extends TestCase
{
/**
* @var Query
*/
private $endpoint;

protected function setUp(): void
{
$this->endpoint = new Query();
}

public function testFormatIsInParamWhitelist(): void
{
$this->assertContains('format', $this->endpoint->getParamWhitelist());
}

public function testMethodIsPost(): void
{
$this->assertSame('POST', $this->endpoint->getMethod());
}

public function testUriIsSqlPlugin(): void
{
$this->assertSame('/_plugins/_sql', $this->endpoint->getURI());
}

public function testFormatParamIsAllowedToSet(): void
{
try {
$this->endpoint->setParams([
'format' => 'json',
]);
} catch (UnexpectedValueException $e) {
$this->fail('The format param should be allowed to set but it was not. Format is may not whitelisted.');
}
}

public function testFormatParamIsJson(): void
{
$this->endpoint->setParams([
'format' => 'json',
]);

$params = $this->endpoint->getParams();
$this->assertSame('json', $params['format']);
}
}

0 comments on commit 9ebb183

Please sign in to comment.