Snowpark Scala API Reference1.20.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package com
  Definition Classes
    root
-  package snowflake
  Definition Classes
    com
-  package snowpark
  Definition Classes
    snowflake
-  package types

  This package contains all Snowpark logical types.

  This package contains all Snowpark logical types.

  Definition Classes
    snowpark
  Since

    0.1.0

-  package udaf
  Definition Classes
    snowpark
-  package udtf
  Definition Classes
    snowpark
- AggregateFunction
- AsyncJob
- CaseExpr
- Column
- CopyableDataFrame
- CopyableDataFrameAsyncActor
- DataFrame
- DataFrameAsyncActor
- DataFrameNaFunctions
- DataFrameReader
- DataFrameStatFunctions
- DataFrameWriter
- DataFrameWriterAsyncActor
- DeleteResult
- FileOperation
- GetResult
- GroupingSets
- HasCachedResult
- MatchedClauseBuilder
- MergeBuilder
- MergeBuilderAsyncActor
- MergeResult
- MergeTypedAsyncJob
- NotMatchedClauseBuilder
- PublicPreview
- PutResult
- RelationalGroupedDataFrame
- Row
- SProcRegistration
- SaveMode
- Session
- SnowparkClientException
- StoredProcedure
- TableFunction
- TypedAsyncJob
- UDAFRegistration
- UDFRegistration
- UDTFRegistration
- Updatable
- UpdatableAsyncActor
- UpdateResult
- UserDefinedFunction
- Window
- WindowSpec
- WriteFileResult
- functions
- tableFunctions

c

com.snowflake.snowpark

# AsyncJob

###

#### class AsyncJob extends AnyRef

Provides a way to track an asynchronous query in Snowflake.

You can use this object to check the status of an asynchronous query and retrieve the results.

To check the status of an asynchronous query that you submitted earlier, call Session.createAsyncJob, and pass in the query ID. This returns an `AsyncJob` object that you can use to check the status of the query and retrieve the query results.

Example 1: Create an AsyncJob by specifying a valid `<query_id>`, check whether the query is running or not, and get the result rows.

    val asyncJob = session.createAsyncJob(<query_id>)
    println(s"Is query ${asyncJob.getQueryId()} running? ${asyncJob.isRunning()}")
    val rows = asyncJob.getRows()

Example 2: Create an AsyncJob by specifying a valid `<query_id>` and cancel the query if it is still running.

    session.createAsyncJob(<query_id>).cancel()

Since

  0.11.0

Linear Supertypes
AnyRef, Any
Known Subclasses
MergeTypedAsyncJob, TypedAsyncJob

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. AsyncJob
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def cancel(): Unit

   Cancel the underlying query if it is running.

   Cancel the underlying query if it is running.

   Since

     0.11.0

6.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
7.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
8.  def equals(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef → Any
9.  final def getClass(): Class[_ <: AnyRef]
   Definition Classes
     AnyRef → Any
   Annotations
     @HotSpotIntrinsicCandidate() @native()
10.  def getIterator(maxWaitTimeInSeconds: Int = session.requestTimeoutInSeconds): Iterator[Row]

    Returns an iterator of Row objects that you can use to retrieve the results for the underlying query.

    Returns an iterator of Row objects that you can use to retrieve the results for the underlying query.

    Unlike the getRows method, this method does not load all data into memory at once.

    maxWaitTimeInSeconds

      The maximum number of seconds to wait for the query to complete before attempting to retrieve the results. The default value is the value of the `snowpark_request_timeout_in_seconds` configuration property.

    returns

      An Iterator of Row objects

    Since

      0.11.0

11.  def getQueryId(): String

    Get the query ID for the underlying query.

    Get the query ID for the underlying query.

    returns

      a query ID

    Since

      0.11.0

12.  def getRows(maxWaitTimeInSeconds: Int = session.requestTimeoutInSeconds): Array[Row]

    Returns an Array of Row objects that represent the results of the underlying query.

    Returns an Array of Row objects that represent the results of the underlying query.

    maxWaitTimeInSeconds

      The maximum number of seconds to wait for the query to complete before attempting to retrieve the results. The default value is the value of the `snowpark_request_timeout_in_seconds` configuration property.

    returns

      An Array of Row objects

    Since

      0.11.0

13.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @HotSpotIntrinsicCandidate() @native()
14.  def isDone(): Boolean

    Returns true if the underlying query completed.

    Returns true if the underlying query completed.

    Completion may be due to query success, cancellation or failure, in all of these cases, this method will return true.

    returns

      true if this query completed.

    Since

      0.11.0

15.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
16.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
17.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @HotSpotIntrinsicCandidate() @native()
18.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @HotSpotIntrinsicCandidate() @native()
19.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
20.  def toString(): String
    Definition Classes
      AnyRef → Any
21.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
22.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
23.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])

### Deprecated Value Members

1.  def finalize(): Unit
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.Throwable]) @Deprecated
   Deprecated

     (Since version 9)

### Inherited from AnyRef

### Inherited from Any

### Ungrouped