Module org.apache.arrow.vector

Package org.apache.arrow.vector.extension

Class UuidType

java.lang.Object

org.apache.arrow.vector.types.pojo.ArrowType

org.apache.arrow.vector.types.pojo.ArrowType.ComplexType

org.apache.arrow.vector.types.pojo.ArrowType.ExtensionType

org.apache.arrow.vector.extension.UuidType

public class UuidType
extends ArrowType.ExtensionType

Extension type for UUID (Universally Unique Identifier) values.

UUIDs are stored as 16-byte fixed-size binary values. This extension type provides a standardized way to represent UUIDs in Arrow, making them interoperable across different systems and languages.π

The extension name is "arrow.uuid" and it uses ArrowType.FixedSizeBinary with 16 bytes as the storage type.

Usage:

 UuidVector vector = new UuidVector("uuid_col", allocator);
 vector.set(0, UUID.randomUUID());
 UUID value = vector.getObject(0);
 

See Also:

• UuidVector
• UuidHolder
• NullableUuidHolder

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.arrow.vector.types.pojo.ArrowType

ArrowType.ArrowTypeID, ArrowType.ArrowTypeVisitor<T>, ArrowType.Binary, ArrowType.BinaryView, ArrowType.Bool, ArrowType.ComplexType, ArrowType.ComplexTypeVisitor<T>, ArrowType.Date, ArrowType.Decimal, ArrowType.Duration, ArrowType.ExtensionType, ArrowType.FixedSizeBinary, ArrowType.FixedSizeList, ArrowType.FloatingPoint, ArrowType.Int, ArrowType.Interval, ArrowType.LargeBinary, ArrowType.LargeList, ArrowType.LargeListView, ArrowType.LargeUtf8, ArrowType.List, ArrowType.ListView, ArrowType.Map, ArrowType.Null, ArrowType.PrimitiveType, ArrowType.PrimitiveTypeVisitor<T>, ArrowType.RunEndEncoded, ArrowType.Struct, ArrowType.Time, ArrowType.Timestamp, ArrowType.Union, ArrowType.Utf8, ArrowType.Utf8View

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION_NAME	Extension name registered in the Arrow extension type registry.
static final UuidType	INSTANCE	Singleton instance of UuidType.
static final ArrowType	STORAGE_TYPE	Storage type for UUID: FixedSizeBinary(16).
static final int	UUID_BYTE_WIDTH	Number of bytes used to store a UUID (128 bits = 16 bytes).
static final int	UUID_STRING_WIDTH	Number of characters in the standard UUID string representation (with hyphens).

Fields inherited from class org.apache.arrow.vector.types.pojo.ArrowType.ExtensionType

EXTENSION_METADATA_KEY_METADATA, EXTENSION_METADATA_KEY_NAME

Method Summary

Modifier and Type	Method	Description
ArrowType	deserialize(ArrowType storageType, String serializedData)	Given saved metadata and the underlying storage type, construct a new instance of the user type.
boolean	extensionEquals(ArrowType.ExtensionType other)	Check equality of this type to another user-defined type.
String	extensionName()	The name of this user-defined type.
FieldWriter	getNewFieldWriter(ValueVector vector)
FieldVector	getNewVector(String name, FieldType fieldType, BufferAllocator allocator)	Construct a vector for the user type.
boolean	isComplex()
String	serialize()	Save any metadata for this type.
ArrowType	storageType()	The on-wire type for this user-defined type.

Methods inherited from class org.apache.arrow.vector.types.pojo.ArrowType.ExtensionType

accept, equals, getType, getTypeID, hashCode, toString

Methods inherited from class org.apache.arrow.vector.types.pojo.ArrowType

getInt, getTypeForField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INSTANCE

public static final UuidType INSTANCE

Singleton instance of UuidType.

EXTENSION_NAME

public static final String EXTENSION_NAME

Extension name registered in the Arrow extension type registry.

See Also:

• Constant Field Values

UUID_BYTE_WIDTH

public static final int UUID_BYTE_WIDTH

Number of bytes used to store a UUID (128 bits = 16 bytes).

See Also:

• Constant Field Values

UUID_STRING_WIDTH

public static final int UUID_STRING_WIDTH

Number of characters in the standard UUID string representation (with hyphens).

See Also:

• Constant Field Values

STORAGE_TYPE

public static final ArrowType STORAGE_TYPE

Storage type for UUID: FixedSizeBinary(16).

Method Details

storageType

public ArrowType storageType()

Description copied from class: ArrowType.ExtensionType

The on-wire type for this user-defined type.

Specified by:

storageType in class ArrowType.ExtensionType

extensionName

public String extensionName()

Description copied from class: ArrowType.ExtensionType

The name of this user-defined type. Used to identify the type during serialization.

Specified by:

extensionName in class ArrowType.ExtensionType

extensionEquals

public boolean extensionEquals(ArrowType.ExtensionType other)

Description copied from class: ArrowType.ExtensionType

Check equality of this type to another user-defined type.

Specified by:

extensionEquals in class ArrowType.ExtensionType

deserialize

public ArrowType deserialize(ArrowType storageType,
 String serializedData)

Description copied from class: ArrowType.ExtensionType

Given saved metadata and the underlying storage type, construct a new instance of the user type.

Specified by:

deserialize in class ArrowType.ExtensionType

serialize

public String serialize()

Description copied from class: ArrowType.ExtensionType

Save any metadata for this type.

Specified by:

serialize in class ArrowType.ExtensionType

isComplex

public boolean isComplex()

Overrides:

isComplex in class ArrowType.ComplexType

getNewVector

public FieldVector getNewVector(String name,
 FieldType fieldType,
 BufferAllocator allocator)

Description copied from class: ArrowType.ExtensionType

Construct a vector for the user type.

Specified by:

getNewVector in class ArrowType.ExtensionType

getNewFieldWriter

public FieldWriter getNewFieldWriter(ValueVector vector)

Overrides:

getNewFieldWriter in class ArrowType.ExtensionType