-
Notifications
You must be signed in to change notification settings - Fork 142
Open
Labels
status-triage_doneInitial triage done, will be further handled by the driver teamInitial triage done, will be further handled by the driver team
Description
Background
- The docstring of
AsyncJob.status()insrc/snowflake/snowpark/async_job.pyrelied on "etc." to describe possible return values, forcing readers to look up the full list elsewhere. - The Snowflake documentation lists the
QueryStatusvalues that the connector emits (https://docs.snowflake.com/ja/developer-guide/python-connector/python-connector-api#QueryStatus).
Problem
- API consumers cannot determine the full set of status values returned by
AsyncJob.status()from the docstring alone, which slows down implementation and testing.
Proposal
Update the AsyncJob.status() docstring to enumerate the relevant snowflake.connector.cursor.QueryStatus.name values:
"RUNNING","SUCCESS","FAILED_WITH_ERROR","ABORTING","ABORTED","QUEUED",
"DISCONNECTED","RESUMING_WAREHOUSE","QUEUED_REPAIRING_WAREHOUSE",
"RESTARTED","BLOCKED","NO_DATA"
Expected Impact
- Readers can understand the possible return values from the docstring alone, reducing investigation time.
Metadata
Metadata
Assignees
Labels
status-triage_doneInitial triage done, will be further handled by the driver teamInitial triage done, will be further handled by the driver team