Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add timeout option to SQL CLI tool. #1076

Merged
merged 4 commits into from
Nov 23, 2022
Merged

Add timeout option to SQL CLI tool. #1076

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2bf7a56
Add timeout option to SQL CLI tool.
Yury-Fridlyand Nov 2, 2022
edfbc3c
Fix test.
Yury-Fridlyand Nov 2, 2022
ca8ae7b
Merge pull request #153 from Bit-Quill/dev-timeout-cli
Yury-Fridlyand Nov 15, 2022
dad0f8f
Extend help message.
Yury-Fridlyand Nov 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions sql-cli/src/opensearch_sql_cli/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@
default="sql",
help="SQL OR PPL",
)
@click.option(
"-t",
"--timeout",
"response_timeout",
type=click.INT,
default=10,
help="Timeout to await a response from the server"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should the help message indicate it's in seconds? and is the default 10 seconds too short? I think frontend request times out 30 seconds by default

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10 sec is default timeout in PY client.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Help message updated in dad0f8f.

)
def cli(
endpoint,
query,
Expand All @@ -83,6 +91,7 @@ def cli(
always_use_pager,
use_aws_authentication,
query_language,
response_timeout
):
"""
Provide endpoint for OpenSearch client.
Expand Down Expand Up @@ -114,12 +123,9 @@ def cli(
sys.exit(0)

# use console to interact with user
opensearchsql_cli = OpenSearchSqlCli(
clirc_file=clirc,
always_use_pager=always_use_pager,
use_aws_authentication=use_aws_authentication,
query_language=query_language,
)
opensearchsql_cli = OpenSearchSqlCli(clirc_file=clirc, always_use_pager=always_use_pager,
use_aws_authentication=use_aws_authentication, query_language=query_language,
response_timeout=response_timeout)
opensearchsql_cli.connect(endpoint, http_auth)
opensearchsql_cli.run_cli()

Expand Down
6 changes: 4 additions & 2 deletions sql-cli/src/opensearch_sql_cli/opensearch_connection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ def __init__(
http_auth=None,
use_aws_authentication=False,
query_language="sql",
response_timeout=10
):
"""Initialize an OpenSearchConnection instance.

Expand All @@ -45,6 +46,7 @@ def __init__(
self.http_auth = http_auth
self.use_aws_authentication = use_aws_authentication
self.query_language = query_language
self.response_timeout = response_timeout

def get_indices(self):
if self.client:
Expand Down Expand Up @@ -167,14 +169,14 @@ def execute_query(self, query, output_format="jdbc", explain=False, use_console=
data = self.client.transport.perform_request(
url="/_plugins/_sql/_explain" if explain else "/_plugins/_sql/",
method="POST",
params=None if explain else {"format": output_format},
params=None if explain else {"format": output_format, "request_timeout": self.response_timeout},
body={"query": final_query},
)
else:
data = self.client.transport.perform_request(
url="/_plugins/_ppl/_explain" if explain else "/_plugins/_ppl/",
method="POST",
params=None if explain else {"format": output_format},
params=None if explain else {"format": output_format, "request_timeout": self.response_timeout},
body={"query": final_query},
)
return data
Expand Down
6 changes: 4 additions & 2 deletions sql-cli/src/opensearch_sql_cli/opensearchsql_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
class OpenSearchSqlCli:
"""OpenSearchSqlCli instance is used to build and run the OpenSearch SQL CLI."""

def __init__(self, clirc_file=None, always_use_pager=False, use_aws_authentication=False, query_language="sql"):
def __init__(self, clirc_file=None, always_use_pager=False, use_aws_authentication=False, query_language="sql",
response_timeout=10):
# Load conf file
config = self.config = get_config(clirc_file)
literal = self.literal = self._get_literals()
Expand All @@ -49,6 +50,7 @@ def __init__(self, clirc_file=None, always_use_pager=False, use_aws_authenticati
self.query_language = query_language
self.always_use_pager = always_use_pager
self.use_aws_authentication = use_aws_authentication
self.response_timeout = response_timeout
self.keywords_list = literal["keywords"]
self.functions_list = literal["functions"]
self.syntax_style = config["main"]["syntax_style"]
Expand Down Expand Up @@ -160,7 +162,7 @@ def echo_via_pager(self, text, color=None):

def connect(self, endpoint, http_auth=None):
self.opensearch_executor = OpenSearchConnection(
endpoint, http_auth, self.use_aws_authentication, self.query_language
endpoint, http_auth, self.use_aws_authentication, self.query_language, self.response_timeout
)
self.opensearch_executor.set_connection()

Expand Down
4 changes: 3 additions & 1 deletion sql-cli/tests/test_opensearchsql_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
QUERY_WITH_CTRL_D = "select * from %s;\r\x04\r" % TEST_INDEX_NAME
USE_AWS_CREDENTIALS = False
QUERY_LANGUAGE = "sql"
RESPONSE_TIMEOUT = 10


@pytest.fixture()
Expand All @@ -34,7 +35,8 @@ def test_connect(self, cli):
) as mock_set_connectiuon:
cli.connect(endpoint=ENDPOINT)

mock_OpenSearchConnection.assert_called_with(ENDPOINT, AUTH, USE_AWS_CREDENTIALS, QUERY_LANGUAGE)
mock_OpenSearchConnection.assert_called_with(ENDPOINT, AUTH, USE_AWS_CREDENTIALS, QUERY_LANGUAGE,
RESPONSE_TIMEOUT)
mock_set_connectiuon.assert_called()

@estest
Expand Down