Class ExtensionDefinition

Namespace

Apache.Arrow

Assembly

Apache.Arrow.dll

Defines a factory for a particular extension type. Register instances with ExtensionTypeRegistry to enable automatic resolution during deserialization.

public abstract class ExtensionDefinition

Inheritance

object

ExtensionDefinition

Derived

Bool8ExtensionDefinition

GuidExtensionDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ExtensionName

The canonical extension type name (e.g. "arrow.uuid").

public abstract string ExtensionName { get; }

Property Value

string

Methods

AddToDefaultRegistry()

Adds this extension type to the default registry

public void AddToDefaultRegistry()

TryCreateType(IArrowType, string, out ExtensionType)

Attempt to create an ExtensionType from a storage type and serialized metadata.

public abstract bool TryCreateType(IArrowType storageType, string metadata, out ExtensionType type)

Parameters

storageType IArrowType

The underlying Arrow storage type.

metadata string

The serialized extension metadata string, or null.

type ExtensionType

The created extension type, if successful.

Returns

bool

True if the type was created successfully; false otherwise.