Class StringArray

Namespace

Apache.Arrow

Assembly

Apache.Arrow.dll

public class StringArray : BinaryArray, IArrowArray, IDisposable, IReadOnlyList<byte[]>, IReadOnlyCollection<byte[]>, ICollection<byte[]>, IEnumerable<byte[]>, IReadOnlyList<string>, IReadOnlyCollection<string>, ICollection<string>, IEnumerable<string>, IEnumerable

Inheritance

object

Array

BinaryArray

StringArray

Implements

IArrowArray

IDisposable

IReadOnlyList<byte[]>

IReadOnlyCollection<byte[]>

ICollection<byte[]>

IEnumerable<byte[]>

IReadOnlyList<string>

IReadOnlyCollection<string>

ICollection<string>

IEnumerable<string>

IEnumerable

Inherited Members

BinaryArray.ValueOffsetsBuffer

BinaryArray.ValueBuffer

BinaryArray.ValueOffsets

BinaryArray.Values

BinaryArray.GetValueOffset(int)

BinaryArray.GetValueLength(int)

BinaryArray.GetBytes(int)

BinaryArray.GetBytes(int, out bool)

Array.Data

Array.Length

Array.Offset

Array.NullCount

Array.NullBitmapBuffer

Array.IsValid(int)

Array.IsNull(int)

Array.Slice(int, int)

Array.Dispose()

Array.Dispose(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

StringArray(ArrayData)

public StringArray(ArrayData data)

Parameters

data ArrayData

StringArray(int, ArrowBuffer, ArrowBuffer, ArrowBuffer, int, int)

public StringArray(int length, ArrowBuffer valueOffsetsBuffer, ArrowBuffer dataBuffer, ArrowBuffer nullBitmapBuffer, int nullCount = 0, int offset = 0)

Parameters

length int

valueOffsetsBuffer ArrowBuffer

dataBuffer ArrowBuffer

nullBitmapBuffer ArrowBuffer

nullCount int

offset int

Fields

DefaultEncoding

public static readonly Encoding DefaultEncoding

Field Value

Encoding

Methods

Accept(IArrowArrayVisitor)

public override void Accept(IArrowArrayVisitor visitor)

Parameters

visitor IArrowArrayVisitor

GetString(int, Encoding)

Get the string value at the given index

public string GetString(int index, Encoding encoding = null)

Parameters

index int

Input index

encoding Encoding

Optional: the string encoding, default is UTF8

Returns

string

The string object at the given index

IsMaterialized(Encoding)

Check if the array has been materialized for the given encoding

public bool IsMaterialized(Encoding encoding = null)

Parameters

encoding Encoding

Optional: the string encoding, default is UTF8

Returns

bool

True of false whether the array has been materialized

Materialize(Encoding)

Materialize the array for the given encoding to accelerate the string access

public void Materialize(Encoding encoding = null)

Parameters

encoding Encoding

Optional: the string encoding, default is UTF8

Remarks

This method is not thread safe when it is called in parallel with GetString(int, Encoding) or Materialize(Encoding).