Class ColumnDefinition

Namespace

Plank.Schema

Assembly

Plank.dll

public sealed record ColumnDefinition : IEquatable<ColumnDefinition>

Inheritance

object

ColumnDefinition

Implements

IEquatable<ColumnDefinition>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Children

public ImmutableArray<ColumnDefinition> Children { get; init; }

Property Value

ImmutableArray<ColumnDefinition>

Converter

Gets the custom CLR value converter for this leaf, if one is declared.

public ParquetValueConverter? Converter { get; init; }

Property Value

ParquetValueConverter

FieldId

public int? FieldId { get; init; }

Property Value

int?

Kind

public required NodeKind Kind { get; init; }

Property Value

NodeKind

LogicalType

public LogicalType? LogicalType { get; init; }

Property Value

LogicalType

Name

public required string Name { get; init; }

Property Value

string

Options

public ColumnOptions? Options { get; init; }

Property Value

ColumnOptions

PageStrategy

public IPageStrategy? PageStrategy { get; init; }

Property Value

IPageStrategy

PhysicalType

public ParquetPhysicalType? PhysicalType { get; init; }

Property Value

ParquetPhysicalType?

Repetition

public required ParquetRepetition Repetition { get; init; }

Property Value

ParquetRepetition

Methods

Leaf(string, ParquetPhysicalType, ColumnOptions?, LogicalType?, IPageStrategy?, ParquetValueConverter?)

public static ColumnDefinition Leaf(string name, ParquetPhysicalType physicalType, ColumnOptions? options = null, LogicalType? logicalType = null, IPageStrategy? pageStrategy = null, ParquetValueConverter? converter = null)

Parameters

name string

physicalType ParquetPhysicalType

options ColumnOptions

logicalType LogicalType

pageStrategy IPageStrategy

converter ParquetValueConverter

Returns

ColumnDefinition

Leaf(string, ParquetPhysicalType, int, ColumnOptions?, LogicalType?, IPageStrategy?, ParquetValueConverter?)

public static ColumnDefinition Leaf(string name, ParquetPhysicalType physicalType, int fieldId, ColumnOptions? options = null, LogicalType? logicalType = null, IPageStrategy? pageStrategy = null, ParquetValueConverter? converter = null)

Parameters

name string

physicalType ParquetPhysicalType

fieldId int

options ColumnOptions

logicalType LogicalType

pageStrategy IPageStrategy

converter ParquetValueConverter

Returns

ColumnDefinition

List(string, ColumnDefinition, ParquetRepetition)

public static ColumnDefinition List(string name, ColumnDefinition element, ParquetRepetition repetition = ParquetRepetition.Required)

Parameters

name string

element ColumnDefinition

repetition ParquetRepetition

Returns

ColumnDefinition

List(string, ColumnDefinition, int, ParquetRepetition)

public static ColumnDefinition List(string name, ColumnDefinition element, int fieldId, ParquetRepetition repetition = ParquetRepetition.Required)

Parameters

name string

element ColumnDefinition

fieldId int

repetition ParquetRepetition

Returns

ColumnDefinition

Map(string, ColumnDefinition, ColumnDefinition, ParquetRepetition)

public static ColumnDefinition Map(string name, ColumnDefinition key, ColumnDefinition value, ParquetRepetition repetition = ParquetRepetition.Required)

Parameters

name string

key ColumnDefinition

value ColumnDefinition

repetition ParquetRepetition

Returns

ColumnDefinition

Map(string, ColumnDefinition, ColumnDefinition, int, ParquetRepetition)

public static ColumnDefinition Map(string name, ColumnDefinition key, ColumnDefinition value, int fieldId, ParquetRepetition repetition = ParquetRepetition.Required)

Parameters

name string

key ColumnDefinition

value ColumnDefinition

fieldId int

repetition ParquetRepetition

Returns

ColumnDefinition

OptionalGroup(string, params ColumnDefinition[])

public static ColumnDefinition OptionalGroup(string name, params ColumnDefinition[] children)

Parameters

name string

children ColumnDefinition[]

Returns

ColumnDefinition

OptionalGroup(string, LogicalType, params ColumnDefinition[])

public static ColumnDefinition OptionalGroup(string name, LogicalType logicalType, params ColumnDefinition[] children)

Parameters

name string

logicalType LogicalType

children ColumnDefinition[]

Returns

ColumnDefinition

OptionalGroup(string, int, params ColumnDefinition[])

public static ColumnDefinition OptionalGroup(string name, int fieldId, params ColumnDefinition[] children)

Parameters

name string

fieldId int

children ColumnDefinition[]

Returns

ColumnDefinition

OptionalLeaf(string, ParquetPhysicalType, ColumnOptions?, LogicalType?, IPageStrategy?, ParquetValueConverter?)

public static ColumnDefinition OptionalLeaf(string name, ParquetPhysicalType physicalType, ColumnOptions? options = null, LogicalType? logicalType = null, IPageStrategy? pageStrategy = null, ParquetValueConverter? converter = null)

Parameters

name string

physicalType ParquetPhysicalType

options ColumnOptions

logicalType LogicalType

pageStrategy IPageStrategy

converter ParquetValueConverter

Returns

ColumnDefinition

OptionalLeaf(string, ParquetPhysicalType, int, ColumnOptions?, LogicalType?, IPageStrategy?, ParquetValueConverter?)

public static ColumnDefinition OptionalLeaf(string name, ParquetPhysicalType physicalType, int fieldId, ColumnOptions? options = null, LogicalType? logicalType = null, IPageStrategy? pageStrategy = null, ParquetValueConverter? converter = null)

Parameters

name string

physicalType ParquetPhysicalType

fieldId int

options ColumnOptions

logicalType LogicalType

pageStrategy IPageStrategy

converter ParquetValueConverter

Returns

ColumnDefinition

RequiredGroup(string, params ColumnDefinition[])

public static ColumnDefinition RequiredGroup(string name, params ColumnDefinition[] children)

Parameters

name string

children ColumnDefinition[]

Returns

ColumnDefinition

RequiredGroup(string, LogicalType, params ColumnDefinition[])

public static ColumnDefinition RequiredGroup(string name, LogicalType logicalType, params ColumnDefinition[] children)

Parameters

name string

logicalType LogicalType

children ColumnDefinition[]

Returns

ColumnDefinition

RequiredGroup(string, int, params ColumnDefinition[])

public static ColumnDefinition RequiredGroup(string name, int fieldId, params ColumnDefinition[] children)

Parameters

name string

fieldId int

children ColumnDefinition[]

Returns

ColumnDefinition

RequiredLeaf(string, ParquetPhysicalType, ColumnOptions?, LogicalType?, IPageStrategy?, ParquetValueConverter?)

public static ColumnDefinition RequiredLeaf(string name, ParquetPhysicalType physicalType, ColumnOptions? options = null, LogicalType? logicalType = null, IPageStrategy? pageStrategy = null, ParquetValueConverter? converter = null)

Parameters

name string

physicalType ParquetPhysicalType

options ColumnOptions

logicalType LogicalType

pageStrategy IPageStrategy

converter ParquetValueConverter

Returns

ColumnDefinition

RequiredLeaf(string, ParquetPhysicalType, int, ColumnOptions?, LogicalType?, IPageStrategy?, ParquetValueConverter?)

public static ColumnDefinition RequiredLeaf(string name, ParquetPhysicalType physicalType, int fieldId, ColumnOptions? options = null, LogicalType? logicalType = null, IPageStrategy? pageStrategy = null, ParquetValueConverter? converter = null)

Parameters

name string

physicalType ParquetPhysicalType

fieldId int

options ColumnOptions

logicalType LogicalType

pageStrategy IPageStrategy

converter ParquetValueConverter

Returns

ColumnDefinition