Reactive Relational Database Connectivity - SPI 1.0.0.RELEASE · io.r2dbc.spi.ReadableMetadata

Method Summary

Modifier and Type	Method and Description
public default Class<?>	Returns: the primary Java `type` or `null` if the type is not available. getJavaType() Returns the primary Java `type`.
public String	Returns: the name of the item getName() Returns the name.
public default Object	Returns: the native type descriptor that potentially exposes more metadata or `null` if no native type descriptor is available. getNativeTypeMetadata() Returns the native type descriptor that potentially exposes more metadata.
public default Nullability	Returns: the nullability of values. getNullability() Returns the nullability of values.
public default Integer	Returns: the precision or `null` if the precision is not available. getPrecision() Returns the precision.
public default Integer	Returns: the scale or `null` if the scale is not available. getScale() Returns the scale.
public Type	Returns: the database `Type` descriptor. getType() Returns the database `Type`.

Method Detail

getJavaType back to summary

getJavaType	back to summary
public default Class<?> getJavaType() Returns the primary Java `type`. This type can be considered the native representation that is used to exchange values with the least loss in precision. Implementation Notes Drivers should implement this method. The method should return the actual type and refrain from returning `Object.class`. The default implementation returns `null`. Drivers may need to inspect the value and perform parts of decoding to determine the native Java type. This method should be expected to run in non-constant time. Returns:Class<?> the primary Java `type` or `null` if the type is not available. Annotations @Nullable See Also `Row#get`, `OutParameters#get`

public default Class<?> getJavaType()

Returns the primary Java type. This type can be considered the native representation that is used to exchange values with the least loss in precision.

Implementation Notes

Drivers should implement this method. The method should return the actual type and refrain from returning Object.class. The default implementation returns null. Drivers may need to inspect the value and perform parts of decoding to determine the native Java type. This method should be expected to run in non-constant time.

Returns:Class<?>

the primary Java type or null if the type is not available.

Annotations

@Nullable

See Also

Row#get, OutParameters#get

getName	back to summary
public String getName() Returns the name. The name does not necessarily reflect the names how they are in the underlying tables but rather how results are represented (e.g. aliased) in the result. Returns:String the name of the item

getName

back to summary

public String getName()

Returns the name.

The name does not necessarily reflect the names how they are in the underlying tables but rather how results are represented (e.g. aliased) in the result.

Returns:String: the name of the item

getNativeTypeMetadata back to summary

public default Object getNativeTypeMetadata()

Returns the native type descriptor that potentially exposes more metadata.

Implementation Notes

Drivers should implement this method if they can expose a driver-specific type metadata object exposing additional information. The default implementation returns null.

Returns:Object

the native type descriptor that potentially exposes more metadata or null if no native type descriptor is available.

Annotations

@Nullable

getNullability back to summary

getNullability	back to summary
public default Nullability getNullability() Returns the nullability of values. Implementation Notes Implementation of this method is optional. The default implementation returns `Nullability#UNKNOWN`. Returns:Nullability the nullability of values. See Also `Nullability`

public default Nullability getNullability()

Returns the nullability of values.

Implementation Notes

Implementation of this method is optional. The default implementation returns Nullability#UNKNOWN.

Returns:Nullability: the nullability of values.
See Also: Nullability

getPrecision back to summary

getPrecision	back to summary
public default Integer getPrecision() Returns the precision. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime data types, this is the length in bytes required to represent the value (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. Returns `null` for data types where data type size is not applicable or if the precision cannot be provided. Implementation Notes Implementation of this method is optional. The default implementation returns `null`. Returns:Integer the precision or `null` if the precision is not available. Annotations @Nullable

public default Integer getPrecision()

Returns the precision.

For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime data types, this is the length in bytes required to represent the value (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. Returns null for data types where data type size is not applicable or if the precision cannot be provided.

Implementation Notes

Implementation of this method is optional. The default implementation returns null.

Returns:Integer

the precision or null if the precision is not available.

Annotations

@Nullable

getScale back to summary

getScale	back to summary
public default Integer getScale() Returns the scale. This is the number of digits to right of the decimal point. Returns `null` for data types where the scale is not applicable or if the scale cannot be provided. Implementation Notes Implementation of this method is optional. The default implementation returns `null`. Returns:Integer the scale or `null` if the scale is not available. Annotations @Nullable

public default Integer getScale()

Returns the scale.

This is the number of digits to right of the decimal point. Returns null for data types where the scale is not applicable or if the scale cannot be provided.

Implementation Notes

Implementation of this method is optional. The default implementation returns null.

Returns:Integer

the scale or null if the scale is not available.

Annotations

@Nullable

getType back to summary

getType	back to summary
public Type getType() Returns the database `Type`. Returns:Type the database `Type` descriptor. Since 0.9

public Type getType()

Returns the database Type.

Returns:Type: the database Type descriptor.
Since: 0.9

public Interface ReadableMetadata

Method Summary

Method Detail