DecimalType (Spark 3.4.1 JavaDoc)

Object
- org.apache.spark.sql.types.DataType
- - org.apache.spark.sql.types.NumericType
  - - org.apache.spark.sql.types.DecimalType

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product
```
public class DecimalType
extends NumericType
implements scala.Product, scala.Serializable
```
The data type representing java.math.BigDecimal values. A Decimal that must have fixed precision (the maximum number of digits) and scale (the number of digits on right side of dot).
The precision can be up to 38, scale can also be up to 38 (less or equal to precision).
The default precision and scale is (10, 0).
Please use DataTypes.createDecimalType() to create a specific instance.

Since:

1.3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DecimalType.Expression$

static class DecimalType.Fixed$

Nested Classes
Modifier and Type	Class and Description
`static class`	`DecimalType.Expression$`
`static class`	`DecimalType.Fixed$`

Constructor Summary

Constructors
Constructor and Description

DecimalType()

DecimalType(int precision)

DecimalType(int precision, int scale)

Constructors
Constructor and Description
`DecimalType()`
`DecimalType(int precision)`
`DecimalType(int precision, int scale)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`DEFAULT_SCALE()`
`int`	`defaultSize()` The default size of a value of the DecimalType is 8 bytes when precision is at most 18, and 16 bytes otherwise.
`static boolean`	`is32BitDecimalType(DataType dt)` Returns if dt is a DecimalType that fits inside an int
`static boolean`	`is64BitDecimalType(DataType dt)` Returns if dt is a DecimalType that fits inside a long
`static boolean`	`isByteArrayDecimalType(DataType dt)` Returns if dt is a DecimalType that doesn't fit inside a long
`static int`	`MAX_PRECISION()`
`static int`	`MAX_SCALE()`
`static int`	`MINIMUM_ADJUSTED_SCALE()`
`int`	`precision()`
`int`	`scale()`
`String`	`simpleString()`
`String`	`sql()`
`static DecimalType`	`SYSTEM_DEFAULT()`
`String`	`toString()`
`String`	`typeName()` Name of the type used in JSON serialization.
`static boolean`	`unapply(DataType t)`
`static boolean`	`unapply(org.apache.spark.sql.catalyst.expressions.Expression e)`
`static DecimalType`	`USER_DEFAULT()`

Methods inherited from class org.apache.spark.sql.types.DataType
canWrite, catalogString, equalsStructurally, equalsStructurallyByName, fromDDL, fromJson, json, parseTypeWithFallback, prettyJson

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Product
$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals
canEqual, equals

- Constructor Detail
  - DecimalType
```
public DecimalType(int precision,
                   int scale)
```
  - DecimalType
```
public DecimalType(int precision)
```
  - DecimalType
```
public DecimalType()
```
- Method Detail
  - MAX_PRECISION
```
public static int MAX_PRECISION()
```
  - MAX_SCALE
```
public static int MAX_SCALE()
```
  - DEFAULT_SCALE
```
public static int DEFAULT_SCALE()
```
  - SYSTEM_DEFAULT
```
public static DecimalType SYSTEM_DEFAULT()
```
  - USER_DEFAULT
```
public static DecimalType USER_DEFAULT()
```
  - MINIMUM_ADJUSTED_SCALE
```
public static int MINIMUM_ADJUSTED_SCALE()
```
  - is32BitDecimalType
```
public static boolean is32BitDecimalType(DataType dt)
```
    Returns if dt is a DecimalType that fits inside an int
    
    Parameters:
    
    dt - (undocumented)
    
    Returns:
    
    (undocumented)
  - is64BitDecimalType
```
public static boolean is64BitDecimalType(DataType dt)
```
    Returns if dt is a DecimalType that fits inside a long
    
    Parameters:
    
    dt - (undocumented)
    
    Returns:
    
    (undocumented)
  - isByteArrayDecimalType
```
public static boolean isByteArrayDecimalType(DataType dt)
```
    Returns if dt is a DecimalType that doesn't fit inside a long
    
    Parameters:
    
    dt - (undocumented)
    
    Returns:
    
    (undocumented)
  - unapply
```
public static boolean unapply(DataType t)
```
  - unapply
```
public static boolean unapply(org.apache.spark.sql.catalyst.expressions.Expression e)
```
  - precision
```
public int precision()
```
  - scale
```
public int scale()
```
  - typeName
```
public String typeName()
```
    Description copied from class: DataType
    
    Name of the type used in JSON serialization.
    
    Overrides:
    
    typeName in class DataType
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - sql
```
public String sql()
```
    Overrides:
    
    sql in class DataType
  - defaultSize
```
public int defaultSize()
```
    The default size of a value of the DecimalType is 8 bytes when precision is at most 18, and 16 bytes otherwise.
    
    Specified by:
    
    defaultSize in class DataType
    
    Returns:
    
    (undocumented)
  - simpleString
```
public String simpleString()
```

Class DecimalType

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.spark.sql.types.DataType

Methods inherited from class Object

Methods inherited from interface scala.Product

Methods inherited from interface scala.Equals

Constructor Detail

DecimalType

DecimalType

DecimalType

Method Detail

MAX_PRECISION

MAX_SCALE

DEFAULT_SCALE

SYSTEM_DEFAULT

USER_DEFAULT

MINIMUM_ADJUSTED_SCALE

is32BitDecimalType

is64BitDecimalType

isByteArrayDecimalType

unapply

unapply

precision

scale

typeName

toString

sql

defaultSize

simpleString