WriteFileResult (Snowpark Java API Reference 1.19.1)

Package com.snowflake.snowpark_java

## Class WriteFileResult

- java.lang.Object
- - com.snowflake.snowpark_java.WriteFileResult

-     public class WriteFileResult
      extends java.lang.Object

  Represents the results of writing data from a DataFrame to a file in a stage.

  To write the data, the DataFrameWriter effectively executes the COPY INTO <location> command. WriteFileResult encapsulates the output returned by the command:

  - rows represents the rows of output from the command
  - schema defines the schema for these rows.

  For example, if the DETAILED_OUTPUT option is TRUE, each row contains a `file_name`, `file_size`, and `row_count` field. `schema` defines the names and types of these fields. If the DETAILED_OUTPUT option is not specified (meaning that the option is FALSE), each row contains a `rows_unloaded`, `input_bytes`, and `output_bytes` field.

  Since:
    1.5.0

- - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `Row[]` | `getRows()` | Retrieve the output rows produced by the COPY INTO <location> command.
    `StructType` | `getSchema()` | Retrieve the names and types of the fields in the output rows.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### getRows

          public Row[] getRows()

      Retrieve the output rows produced by the COPY INTO <location> command.
      Returns:
        An array of `Row`
      Since:
        1.5.0

    - #### getSchema

          public StructType getSchema()

      Retrieve the names and types of the fields in the output rows.
      Returns:
        A `StructType`
      Since:
        1.5.0