Package com.databricks.sdk.service.sql

Enum Disposition

  • All Implemented Interfaces:
    Serializable, Comparable<Disposition>
    @Generated
public enum Disposition
extends Enum<Disposition>
    The fetch disposition provides two modes of fetching results: `INLINE` and `EXTERNAL_LINKS`.

    Statements executed with `INLINE` disposition will return result data inline, in `JSON_ARRAY` format, in a series of chunks. If a given statement produces a result set with a size larger than 16 MiB, that statement execution is aborted, and no result set will be available.

    **NOTE** Byte limits are computed based upon internal representations of the result set data, and may not match the sizes visible in JSON responses.

    Statements executed with `EXTERNAL_LINKS` disposition will return result data as external links: URLs that point to cloud storage internal to the workspace. Using `EXTERNAL_LINKS` disposition allows statements to generate arbitrarily sized result sets for fetching up to 100 GiB. The resulting links have two important properties:

    1. They point to resources _external_ to the Databricks compute; therefore any associated authentication information (typically a personal access token, OAuth token, or similar) _must be removed_ when fetching from these links.

    2. These are presigned URLs with a specific expiration, indicated in the response. The behavior when attempting to use an expired link is cloud specific.

    • Enum Constant Detail

      • EXTERNAL_LINKS

        public static final Disposition EXTERNAL_LINKS

    • Method Detail

      • values

        public static Disposition[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Disposition c : Disposition.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Disposition valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null