Class ShredOptions

Namespace

Apache.Arrow.Operations.Shredding

Assembly

Apache.Arrow.Operations.dll

Options controlling how ShredSchemaInferer infers a shredding schema.

public sealed class ShredOptions

Inheritance

object

ShredOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Default

Default options.

public static ShredOptions Default { get; }

Property Value

ShredOptions

MaxDepth

Maximum nesting depth for shredded objects and arrays. 0 means only top-level fields are shredded. Default is 3.

public int MaxDepth { get; set; }

Property Value

int

MinFieldFrequency

Minimum fraction of values (0.0–1.0) in which a field must appear to be considered for shredding. Fields appearing less frequently than this threshold are left in the binary residual. Default is 0.5 (50%).

public double MinFieldFrequency { get; set; }

Property Value

double

MinTypeConsistency

Minimum fraction of non-null values (0.0–1.0) for a field that must share the same type for the field to be shredded as a typed column. If the type consistency is below this threshold, the field gets a None schema (binary-only). Default is 0.8 (80%).

public double MinTypeConsistency { get; set; }

Property Value

double