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

# CopyableDataFrameAsyncActor

###

#### class CopyableDataFrameAsyncActor extends DataFrameAsyncActor

Provides APIs to execute CopyableDataFrame actions asynchronously.

Since

  0.11.0

Linear Supertypes
DataFrameAsyncActor, AnyRef, Any

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. CopyableDataFrameAsyncActor
2. DataFrameAsyncActor
3. AnyRef
4. 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.  def action[T](funcName: String)(func: => T): T
   Attributes
     protected
   Definition Classes
     CopyableDataFrameAsyncActor → DataFrameAsyncActor
   Annotations
     @inline()
5.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
6.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
7.  def collect(): TypedAsyncJob[Array[Row]]

   Executes DataFrame.collect asynchronously.

   Executes DataFrame.collect asynchronously.

   returns

     A TypedAsyncJob object that you can use to check the status of the action and get the results.

   Definition Classes
     DataFrameAsyncActor
   Since

     0.11.0

8.  def copyInto(tableName: String, targetColumnNames: Seq[String], transformations: Seq[Column], options: Map[String, Any]): TypedAsyncJob[Unit]

   Executes `CopyableDataFrame.copyInto` asynchronously.

   Executes `CopyableDataFrame.copyInto` asynchronously.

   tableName

     Name of the table where the data should be saved.

   targetColumnNames

     Name of the columns in the table where the data should be saved.

   transformations

     Seq of Column expressions that specify the transformations to apply (similar to transformation parameters).

   options

     Map of the names of options (e.g. `compression` , `skip_header` , etc.) and their corresponding values.NOTE: By default, the `CopyableDataFrame` object uses the options set in the DataFrameReader used to create that object. You can use this `options` parameter to override the default options or set additional options.

   returns

     A TypedAsyncJob object that you can use to check the status of the action and get the results.

   Since

     0.11.0

9.  def copyInto(tableName: String, transformations: Seq[Column], options: Map[String, Any]): TypedAsyncJob[Unit]

   Executes `CopyableDataFrame.copyInto` asynchronously.

   Executes `CopyableDataFrame.copyInto` asynchronously.

   tableName

     Name of the table where the data should be saved.

   transformations

     Seq of Column expressions that specify the transformations to apply (similar to transformation parameters).

   options

     Map of the names of options (e.g. `compression` , `skip_header` , etc.) and their corresponding values.NOTE: By default, the `CopyableDataFrame` object uses the options set in the DataFrameReader used to create that object. You can use this `options` parameter to override the default options or set additional options.

   returns

     A TypedAsyncJob object that you can use to check the status of the action and get the results.

   Since

     0.11.0

10.  def copyInto(tableName: String, transformations: Seq[Column]): TypedAsyncJob[Unit]

    Executes `CopyableDataFrame.copyInto` asynchronously.

    Executes `CopyableDataFrame.copyInto` asynchronously.

    tableName

      Name of the table where the data should be saved.

    transformations

      Seq of Column expressions that specify the transformations to apply (similar to transformation parameters).

    returns

      A TypedAsyncJob object that you can use to check the status of the action and get the results.

    Since

      0.11.0

11.  def copyInto(tableName: String): TypedAsyncJob[Unit]

    Executes `CopyableDataFrame.copyInto` asynchronously.

    Executes `CopyableDataFrame.copyInto` asynchronously.

    tableName

      Name of the table where the data should be saved.

    returns

      A TypedAsyncJob object that you can use to check the status of the action and get the results.

    Since

      0.11.0

12.  def count(): TypedAsyncJob[Long]

    Executes DataFrame.count asynchronously.

    Executes DataFrame.count asynchronously.

    returns

      A TypedAsyncJob object that you can use to check the status of the action and get the results.

    Definition Classes
      DataFrameAsyncActor
    Since

      0.11.0

13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
15.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @HotSpotIntrinsicCandidate() @native()
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @HotSpotIntrinsicCandidate() @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @HotSpotIntrinsicCandidate() @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @HotSpotIntrinsicCandidate() @native()
21.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
22.  def toLocalIterator(): TypedAsyncJob[Iterator[Row]]

    Executes DataFrame.toLocalIterator asynchronously.

    Executes DataFrame.toLocalIterator asynchronously.

    returns

      A TypedAsyncJob object that you can use to check the status of the action and get the results.

    Definition Classes
      DataFrameAsyncActor
    Since

      0.11.0

23.  def toString(): String
    Definition Classes
      AnyRef → Any
24.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
25.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
26.  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 DataFrameAsyncActor

### Inherited from AnyRef

### Inherited from Any

### Ungrouped