class TypedAsyncJob [ T ] extends AsyncJob
Provides a way to track an asynchronously executed action in a DataFrame.
To get the result of the action (e.g. the number of results from a
count()
action
or an Array of
Row
objects from the
collect()
action), call the
getResult
method.
To perform an action on a DataFrame asynchronously, call an action method on the DataFrameAsyncActor object returned by DataFrame.async . For example:
val asyncJob1 = df.async.collect() val asyncJob2 = df.async.toLocalIterator() val asyncJob3 = df.async.count()
Each of these methods returns a TypedAsyncJob object that you can use to get the results of the action.
- Since
-
0.11.0
- Alphabetic
- By Inheritance
- TypedAsyncJob
- AsyncJob
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=
(
arg0:
Any
)
:
Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##
()
:
Int
- Definition Classes
- AnyRef → Any
-
final
def
==
(
arg0:
Any
)
:
Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf
[
T0
]
:
T0
- Definition Classes
- Any
-
def
cancel
()
:
Unit
Cancel the underlying query if it is running.
Cancel the underlying query if it is running.
- Definition Classes
- AsyncJob
- Since
-
0.11.0
-
def
clone
()
:
AnyRef
- Attributes
- protected[ lang ]
- Definition Classes
- AnyRef
- Annotations
- @throws ( ... ) @native () @HotSpotIntrinsicCandidate ()
-
final
def
eq
(
arg0:
AnyRef
)
:
Boolean
- Definition Classes
- AnyRef
-
def
equals
(
arg0:
Any
)
:
Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass
()
:
Class
[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native () @HotSpotIntrinsicCandidate ()
-
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_secondsconfiguration property. - returns
-
An Iterator of Row objects
- Definition Classes
- AsyncJob
- Since
-
0.11.0
-
def
getQueryId
()
:
String
Get the query ID for the underlying query.
Get the query ID for the underlying query.
- returns
-
a query ID
- Definition Classes
- AsyncJob
- Since
-
0.11.0
-
def
getResult
(
maxWaitTimeInSeconds:
Int
=
session.requestTimeoutInSeconds
)
:
T
Returns the result for the specific DataFrame action.
Returns the result for the specific DataFrame action.
Example 1: Create a TypedAsyncJob by asynchronously executing a DataFrame action
collect(), check whether the job is running or not, and get the action result with getResult . NOTE: The returned type for getResult in this example isArray[Row].val df = session.table("t1") val asyncJob = df.async.collect() println(s"Is query ${asyncJob.getQueryId()} running? ${asyncJob.isRunning()}") val rowResult = asyncJob.getResult()
Example 2: Create a TypedAsyncJob by asynchronously executing a DataFrame action count() and get the action result with getResult . NOTE: The returned type for getResult in this example is
Long.val asyncJob = df.async.count() val longResult = asyncJob.getResult()
- 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_secondsconfiguration property. - returns
-
The result for the specific action
- Since
-
0.11.0
-
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_secondsconfiguration property. - returns
-
An Array of Row objects
- Definition Classes
- AsyncJob
- Since
-
0.11.0
-
def
hashCode
()
:
Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native () @HotSpotIntrinsicCandidate ()
-
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.
- Definition Classes
- AsyncJob
- Since
-
0.11.0
-
final
def
isInstanceOf
[
T0
]
:
Boolean
- Definition Classes
- Any
-
final
def
ne
(
arg0:
AnyRef
)
:
Boolean
- Definition Classes
- AnyRef
-
final
def
notify
()
:
Unit
- Definition Classes
- AnyRef
- Annotations
- @native () @HotSpotIntrinsicCandidate ()
-
final
def
notifyAll
()
:
Unit
- Definition Classes
- AnyRef
- Annotations
- @native () @HotSpotIntrinsicCandidate ()
-
final
def
synchronized
[
T0
]
(
arg0: ⇒
T0
)
:
T0
- Definition Classes
- AnyRef
-
def
toString
()
:
String
- Definition Classes
- AnyRef → Any
-
final
def
wait
(
arg0:
Long
,
arg1:
Int
)
:
Unit
- Definition Classes
- AnyRef
- Annotations
- @throws ( ... )
-
final
def
wait
(
arg0:
Long
)
:
Unit
- Definition Classes
- AnyRef
- Annotations
- @throws ( ... ) @native ()
-
final
def
wait
()
:
Unit
- Definition Classes
- AnyRef
- Annotations
- @throws ( ... )
Deprecated Value Members
-
def
finalize
()
:
Unit
- Attributes
- protected[ lang ]
- Definition Classes
- AnyRef
- Annotations
- @throws ( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated