Skip to content

Commit d165bd3

Browse files
authored
SNOW-1559272: Document differences b/w query result APIs (snowflakedb#2055)
1 parent 12d3fc9 commit d165bd3

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/snowflake/connector/cursor.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -1238,6 +1238,7 @@ def check_can_use_pandas(self) -> None:
12381238
)
12391239

12401240
def query_result(self, qid: str) -> SnowflakeCursor:
1241+
"""Query the result of a previously executed query."""
12411242
url = f"/queries/{qid}/result"
12421243
ret = self._connection.rest.request(url=url, method="get")
12431244
self._sfqid = (
@@ -1631,7 +1632,9 @@ def __exit__(
16311632
self.close()
16321633

16331634
def get_results_from_sfqid(self, sfqid: str) -> None:
1634-
"""Gets the results from previously ran query."""
1635+
"""Gets the results from previously ran query. This methods differs from ``SnowflakeCursor.query_result``
1636+
in that it monitors the ``sfqid`` until it is no longer running, and then retrieves the results.
1637+
"""
16351638

16361639
def wait_until_ready() -> None:
16371640
"""Makes sure query has finished executing and once it has retrieves results."""

0 commit comments

Comments
 (0)