Class FragmentInfo

Represents a TileDB fragment info object.

Inheritance

object

FragmentInfo

Implements

IDisposable

Namespace: TileDB.CSharp

Assembly: TileDB.CSharp.dll

Syntax

public sealed class FragmentInfo : IDisposable

Constructors

FragmentInfo(Context, string)

Creates a FragmentInfo object.

Declaration

public FragmentInfo(Context ctx, string uri)

Parameters

Type	Name	Description
Context	ctx	The Context associated with this object.
string	uri	The URI of the array to load the fragment info for.

Properties

FragmentCount

The number of fragments in the array.

Declaration

public uint FragmentCount { get; }

Property Value

Type	Description
uint

FragmentToVacuumCount

The number of fragments to vacuum in the array.

Declaration

public uint FragmentToVacuumCount { get; }

Property Value

Type	Description
uint

FragmentWithUnconsolidatedMetadataCount

The number of fragments with unconsolidated metadata in the array.

Declaration

public uint FragmentWithUnconsolidatedMetadataCount { get; }

Property Value

Type	Description
uint

TotalCellCount

The number of cells written to the fragments by the user.

Declaration

public ulong TotalCellCount { get; }

Property Value

Type	Description
ulong

Methods

Dispose()

Disposes this FragmentInfo object.

Declaration

public void Dispose()

GetCellsWritten(uint)

Gets the number of cells written in a fragment.

Declaration

public ulong GetCellsWritten(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
ulong

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

GetConfig()

Creates a Config object that contains this FragmentInfo's configuration.

Declaration

public Config GetConfig()

Returns

Type	Description
Config

GetFormatVersion(uint)

Gets the format version of a fragment.

Declaration

public uint GetFormatVersion(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
uint

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

GetFragmentName(uint)

Gets the name of a fragment.

Declaration

public string GetFragmentName(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
string

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

See Also

ConsolidateFragments(Context, string, IReadOnlyList<string>, Config)

GetFragmentSize(uint)

Gets the size in bytes of a fragment.

Declaration

public ulong GetFragmentSize(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
ulong

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

GetFragmentToVacuumUri(uint)

Gets the URI of a fragment to vacuum.

Declaration

public string GetFragmentToVacuumUri(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
string

Remarks

The maximum value fragmentIndex can take is determined by the FragmentToVacuumCount property.

GetFragmentUri(uint)

Gets the URI of a fragment.

Declaration

public string GetFragmentUri(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
string

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

GetMinimumBoundedRectangleCount(uint)

Gets the number of Minimum Bounded Rectangles (MBRs) of a fragment.

Declaration

public ulong GetMinimumBoundedRectangleCount(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
ulong

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

GetMinimumBoundedRectangle<T>(uint, uint, string)

Gets the Minimum Bounded Rectangle (MBR) from one of a fragment's dimensions, identified by its name.

Declaration

public (T Start, T End) GetMinimumBoundedRectangle<T>(uint fragmentIndex, uint minimumBoundedRectangleIndex, string dimensionName)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.
uint	minimumBoundedRectangleIndex	The index of the MBR of interest.
string	dimensionName	The name of the dimension of interest.

Returns

Type	Description
(T Start, T End)	The start and end values of the MBR, inclusive.

Type Parameters

Name	Description
T	The dimension's data type.

Exceptions

Type	Condition
NotSupportedException	T is unsupported.
InvalidOperationException	T is incompatible with the dimension's data type.

GetMinimumBoundedRectangle<T>(uint, uint, uint)

Gets the Minimum Bounded Rectangle (MBR) from one of a fragment's dimensions, identified by its index.

Declaration

public (T Start, T End) GetMinimumBoundedRectangle<T>(uint fragmentIndex, uint minimumBoundedRectangleIndex, uint dimensionIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.
uint	minimumBoundedRectangleIndex	The index of the MBR of interest.
uint	dimensionIndex	The index of the dimension of interest, following the order as it was defined in the domain of the array schema.

Returns

Type	Description
(T Start, T End)	The start and end values of the MBR, inclusive.

Type Parameters

Name	Description
T	The dimension's data type.

Exceptions

Type	Condition
NotSupportedException	T is unsupported.
InvalidOperationException	T is incompatible with the dimension's data type.

GetNonEmptyDomain<T>(uint, string)

Gets the non-empty domain from one of a fragment's dimensions, identified by its index.

Declaration

public (T Start, T End) GetNonEmptyDomain<T>(uint fragmentIndex, string dimensionName)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.
string	dimensionName	The name of the dimension of interest.

Returns

Type	Description
(T Start, T End)	The start and end values of the domain, inclusive.

Type Parameters

Name	Description
T	The dimension's data type.

Exceptions

Type	Condition
NotSupportedException	T is unsupported.
InvalidOperationException	T is incompatible with the dimension's data type.

GetNonEmptyDomain<T>(uint, uint)

Gets the non-empty domain from one of a fragment's dimensions, identified by its index.

Declaration

public (T Start, T End) GetNonEmptyDomain<T>(uint fragmentIndex, uint dimensionIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.
uint	dimensionIndex	The index of the dimension of interest, following the order as it was defined in the domain of the array schema.

Returns

Type	Description
(T Start, T End)	The start and end values of the domain, inclusive.

Type Parameters

Name	Description
T	The dimension's data type.

Exceptions

Type	Condition
NotSupportedException	T is unsupported.
InvalidOperationException	T is incompatible with the dimension's data type.

GetSchema(uint)

Gets the ArraySchema of a fragment.

Declaration

public ArraySchema GetSchema(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
ArraySchema

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

GetSchemaName(uint)

Gets the schema name of a fragment.

Declaration

public string GetSchemaName(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
string

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

GetTimestampRange(uint)

Gets the timestamp range of a fragment.

Declaration

public (ulong Start, ulong End) GetTimestampRange(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
(ulong Start, ulong End)	The start and end timestamps of the fragment.

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

HasConsolidatedMetadata(uint)

Checks whether a fragment has consolidated metadata.

Declaration

public bool HasConsolidatedMetadata(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
bool

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

IsDense(uint)

Checks whether a fragment is dense.

Declaration

public bool IsDense(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
bool

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

IsSparse(uint)

Checks whether a fragment is sparse.

Declaration

public bool IsSparse(uint fragmentIndex)

Parameters

Type	Name	Description
uint	fragmentIndex	The index of the fragment of interest.

Returns

Type	Description
bool

Remarks

The maximum value fragmentIndex can take is determined by the FragmentCount property.

Load()

Loads the fragment info.

Declaration

public void Load()

SetConfig(Config)

Set the fragment info object's Config.

Declaration

public void SetConfig(Config config)

Parameters

Type	Name	Description
Config	config	The Config object to set.

Implements

IDisposable