Skip to content

SNOW-2395063: Document AsyncJob.status() return values in the docstring #3851

@mkanetsuna

Description

@mkanetsuna

Background

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 team

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions