Class ArraySchema

Represents a TileDB array schema object.

Inheritance

object

ArraySchema

Implements

IDisposable

Namespace: TileDB.CSharp

Assembly: TileDB.CSharp.dll

Syntax

public sealed class ArraySchema : IDisposable

Constructors

ArraySchema(Context, ArrayType)

Creates a new ArraySchema.

Declaration

public ArraySchema(Context ctx, ArrayType arrayType)

Parameters

Type	Name	Description
Context	ctx	The Context associated with this schema.
ArrayType	arrayType	The array's type.

Methods

AddAttribute(Attribute)

Adds an Attribute in the ArraySchema.

Declaration

public void AddAttribute(Attribute attr)

Parameters

Type	Name	Description
Attribute	attr	The attribute to add.

AddAttributes(params Attribute[])

Adds an array of Attributes in the ArraySchema.

Declaration

public void AddAttributes(params Attribute[] attrs)

Parameters

Type	Name	Description
Attribute[]	attrs	The attributes to add.

AddEnumeration(Enumeration)

Adds an Enumeration in the ArraySchema.

Declaration

public void AddEnumeration(Enumeration enumeration)

Parameters

Type	Name	Description
Enumeration	enumeration	The enumeration to add.

AllowsDups()

Gets whether cells with duplicate coordinates are allowed in the ArraySchema.

Declaration

public bool AllowsDups()

Returns

Type	Description
bool

Remarks

Applicable to only Sparse arrays.

ArrayType()

Gets the ArraySchema's ArrayType.

Declaration

public ArrayType ArrayType()

Returns

Type	Description
ArrayType

Attribute(string)

Gets an Attribute from the ArraySchema by name.

Declaration

public Attribute Attribute(string name)

Parameters

Type	Name	Description
string	name	The attribute's name.

Returns

Type	Description
Attribute

Attribute(uint)

Gets an Attribute from the ArraySchema by index.

Declaration

public Attribute Attribute(uint i)

Parameters

Type	Name	Description
uint	i	The attribute's index.

Returns

Type	Description
Attribute

AttributeNum()

Gets the number of Attributes in the ArraySchema.

Declaration

public uint AttributeNum()

Returns

Type	Description
uint

Attributes()

Gets a collection with all Attributes of the ArraySchema.

Declaration

public SortedDictionary<string, Attribute> Attributes()

Returns

Type	Description
SortedDictionary<string, Attribute>

Capacity()

Gets the ArraySchema's sparse fragment capacity.

Declaration

public ulong Capacity()

Returns

Type	Description
ulong

CellOrder()

Gets the ArraySchema's cell order.

Declaration

public LayoutType CellOrder()

Returns

Type	Description
LayoutType

Check()

Performs validity checks in the ArraySchema.

Declaration

public void Check()

CoordsFilterList()

Gets the FilterList of filters that will be applied in the ArraySchema's coordinates.

Declaration

public FilterList CoordsFilterList()

Returns

Type	Description
FilterList

Dimensions()

Gets a collection with all Dimensions of the ArraySchema.

Declaration

public SortedDictionary<string, Dimension> Dimensions()

Returns

Type	Description
SortedDictionary<string, Dimension>

Dispose()

Disposes this ArraySchema

Declaration

public void Dispose()

Domain()

Gets the ArraySchema's Domain().

Declaration

public Domain Domain()

Returns

Type	Description
Domain

FormatVersion()

Gets the ArraySchema's format version.

Declaration

public uint FormatVersion()

Returns

Type	Description
uint

GetEnumeration(string)

Gets the Enumeration of the ArraySchema with the given name.

Declaration

public Enumeration GetEnumeration(string name)

Parameters

Type	Name	Description
string	name	The name of the enumeration.

Returns

Type	Description
Enumeration

GetEnumerationOfAttribute(string)

Gets the Enumeration attached to the Attribute of the ArraySchema with the given name.

Declaration

public Enumeration GetEnumerationOfAttribute(string name)

Parameters

Type	Name	Description
string	name	The name of the attribute.

Returns

Type	Description
Enumeration

HasAttribute(string)

Checks if an Attribute with the given name exists in the ArraySchema or not.

Declaration

public bool HasAttribute(string name)

Parameters

Type	Name	Description
string	name	The name to check.

Returns

Type	Description
bool

IsNullable(string)

Checks if an Attribute or Dimension in the ArraySchema is nullable.

Declaration

public bool IsNullable(string name)

Parameters

Type	Name	Description
string	name	The attribute or dimension's name.

Returns

Type	Description
bool

IsVarSize(string)

Checks if an Attribute or Dimension in the ArraySchema has variable size.

Declaration

public bool IsVarSize(string name)

Parameters

Type	Name	Description
string	name	The attribute or dimension's name.

Returns

Type	Description
bool

Load(Context, string)

Load an ArraySchema from a URI.

Declaration

public static ArraySchema Load(Context ctx, string uri)

Parameters

Type	Name	Description
Context	ctx	The Context associated with this schema.
string	uri	The array's URI.

Returns

Type	Description
ArraySchema

OffsetsFilterList()

Gets the FilterList of filters that will be applied in the ArraySchema's offsets of variable-sized Attributes or Dimensions.

Declaration

public FilterList OffsetsFilterList()

Returns

Type	Description
FilterList

SetAllowsDups(bool)

Sets whether cells with duplicate coordinates are allowed in the ArraySchema.

Declaration

public void SetAllowsDups(bool allowsDups)

Parameters

Type	Name	Description
bool	allowsDups

Remarks

Applicable to only Sparse arrays.

SetCapacity(ulong)

Sets the ArraySchema's sparse fragment capacity.

Declaration

public void SetCapacity(ulong capacity)

Parameters

Type	Name	Description
ulong	capacity	The capacity.

SetCellOrder(LayoutType)

Sets the ArraySchema's cell order.

Declaration

public void SetCellOrder(LayoutType layoutType)

Parameters

Type	Name	Description
LayoutType	layoutType	The cell order.

SetCoordsFilterList(FilterList)

Sets the FilterList of filters that will be applied in the ArraySchema's coordinates.

Declaration

public void SetCoordsFilterList(FilterList filterList)

Parameters

Type	Name	Description
FilterList	filterList	The filter list.

SetDomain(Domain)

Sets the ArraySchema's Domain().

Declaration

public void SetDomain(Domain domain)

Parameters

Type	Name	Description
Domain	domain	The domain to set

SetOffsetsFilterList(FilterList)

Sets the FilterList of filters that will be applied in the ArraySchema's offsets of variable-sized Attributes or Dimensions.

Declaration

public void SetOffsetsFilterList(FilterList filterList)

Parameters

Type	Name	Description
FilterList	filterList	The filter list.

SetTileOrder(LayoutType)

Sets the ArraySchema's tile order.

Declaration

public void SetTileOrder(LayoutType layoutType)

Parameters

Type	Name	Description
LayoutType	layoutType	The tile order.

SetValidityFilterList(FilterList)

Sets the FilterList of filters that will be applied in the ArraySchema's the validity array of nullable Attribute values.

Declaration

public void SetValidityFilterList(FilterList filterList)

Parameters

Type	Name	Description
FilterList	filterList	The filter list.

TileOrder()

Gets the ArraySchema's tile order.

Declaration

public LayoutType TileOrder()

Returns

Type	Description
LayoutType

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

ValidityFilterList()

Gets the FilterList of filters that will be applied in the ArraySchema's the validity array of nullable Attribute values.

Declaration

public FilterList ValidityFilterList()

Returns

Type	Description
FilterList

Implements

IDisposable