Class GroupMetadata

Inheritance

object

GroupMetadata

Implements

IDictionary<string, byte[]>

ICollection<KeyValuePair<string, byte[]>>

IEnumerable<KeyValuePair<string, byte[]>>

IEnumerable

Namespace: TileDB.CSharp

Assembly: TileDB.CSharp.dll

Syntax

public class GroupMetadata : IDictionary<string, byte[]>, ICollection<KeyValuePair<string, byte[]>>, IEnumerable<KeyValuePair<string, byte[]>>, IEnumerable

Constructors

| Edit this page View Source

GroupMetadata(Group)

Declaration

public GroupMetadata(Group group)

Parameters

Type	Name	Description
Group	group

Fields

| Edit this page View Source

_group

Declaration

protected Group _group

Field Value

Type	Description
Group

Properties

| Edit this page View Source

Count

Gets the number of elements contained in the ICollection<T>.

Declaration

public int Count { get; }

Property Value

Type	Description
int	The number of elements contained in the ICollection<T>.

| Edit this page View Source

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
bool	true if the ICollection<T> is read-only; otherwise, false.

| Edit this page View Source

this[string]

Gets or sets the element with the specified key.

Declaration

public byte[] this[string key] { get; set; }

Parameters

Type	Name	Description
string	key	The key of the element to get or set.

Property Value

Type	Description
byte[]	The element with the specified key.

Exceptions

Type	Condition
ArgumentNullException	`key` is null.
KeyNotFoundException	The property is retrieved and `key` is not found.
NotSupportedException	The property is set and the IDictionary<TKey, TValue> is read-only.

| Edit this page View Source

Keys

Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>.

Declaration

public ICollection<string> Keys { get; }

Property Value

Type	Description
ICollection<string>	An ICollection<T> containing the keys of the object that implements IDictionary<TKey, TValue>.

| Edit this page View Source

Values

Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>.

Declaration

public ICollection<byte[]> Values { get; }

Property Value

Type	Description
ICollection<byte[]>	An ICollection<T> containing the values in the object that implements IDictionary<TKey, TValue>.

Methods

| Edit this page View Source

Add(KeyValuePair<string, byte[]>)

Adds an item to the ICollection<T>.

Declaration

public void Add(KeyValuePair<string, byte[]> item)

Parameters

Type	Name	Description
KeyValuePair<string, byte[]>	item	The object to add to the ICollection<T>.

Exceptions

Type	Condition
NotSupportedException	The ICollection<T> is read-only.

| Edit this page View Source

Add(string, byte[])

Adds an element with the provided key and value to the IDictionary<TKey, TValue>.

Declaration

public void Add(string key, byte[] value)

Parameters

Type	Name	Description
string	key	The object to use as the key of the element to add.
byte[]	value	The object to use as the value of the element to add.

Exceptions

Type	Condition
ArgumentNullException	`key` is null.
ArgumentException	An element with the same key already exists in the IDictionary<TKey, TValue>.
NotSupportedException	The IDictionary<TKey, TValue> is read-only.

| Edit this page View Source

Clear()

Removes all items from the ICollection<T>.

Declaration

public void Clear()

Exceptions

Type	Condition
NotSupportedException	The ICollection<T> is read-only.

| Edit this page View Source

ConsolidateMetadata(Context, string, Config)

Consolidate metadata.

Declaration

public static void ConsolidateMetadata(Context ctx, string uri, Config config)

Parameters

Type	Name	Description
Context	ctx
string	uri
Config	config

| Edit this page View Source

Contains(KeyValuePair<string, byte[]>)

Determines whether the ICollection<T> contains a specific value.

Declaration

public bool Contains(KeyValuePair<string, byte[]> item)

Parameters

Type	Name	Description
KeyValuePair<string, byte[]>	item	The object to locate in the ICollection<T>.

Returns

Type	Description
bool	true if `item` is found in the ICollection<T>; otherwise, false.

| Edit this page View Source

ContainsKey(string)

Determines whether the IDictionary<TKey, TValue> contains an element with the specified key.

Declaration

public bool ContainsKey(string key)

Parameters

Type	Name	Description
string	key	The key to locate in the IDictionary<TKey, TValue>.

Returns

Type	Description
bool	true if the IDictionary<TKey, TValue> contains an element with the key; otherwise, false.

Exceptions

Type	Condition
ArgumentNullException	`key` is null.

| Edit this page View Source

CopyTo(KeyValuePair<string, byte[]>[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

Declaration

public void CopyTo(KeyValuePair<string, byte[]>[] array, int arrayIndex)

Parameters

Type	Name	Description
KeyValuePair<string, byte[]>[]	array	The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.
int	arrayIndex	The zero-based index in `array` at which copying begins.

Exceptions

Type	Condition
ArgumentNullException	`array` is null.
ArgumentOutOfRangeException	`arrayIndex` is less than 0.
ArgumentException	The number of elements in the source ICollection<T> is greater than the available space from `arrayIndex` to the end of the destination `array`.

| Edit this page View Source

DeleteMetadata(string)

Delete metadata.

Declaration

public void DeleteMetadata(string key)

Parameters

Type	Name	Description
string	key

| Edit this page View Source

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<KeyValuePair<string, byte[]>> GetEnumerator()

Returns

Type	Description
IEnumerator<KeyValuePair<string, byte[]>>	An enumerator that can be used to iterate through the collection.

| Edit this page View Source

GetMetadata(string)

Get string metadata

Declaration

public string GetMetadata(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
string

| Edit this page View Source

GetMetadataFromIndex<T>(ulong)

Get metadata from index.

Declaration

public (string key, T[] data) GetMetadataFromIndex<T>(ulong index) where T : struct

Parameters

Type	Name	Description
ulong	index

Returns

Type	Description
(string key, T[] data)

Type Parameters

Name	Description
T

| Edit this page View Source

GetMetadata<T>(string)

Get metadata list.

Declaration

public T[] GetMetadata<T>(string key) where T : struct

Parameters

Type	Name	Description
string	key

Returns

Type	Description
T[]

Type Parameters

Name	Description
T

| Edit this page View Source

HasMetadata(string)

Test if a metadata with key exists or not.

Declaration

public (bool has_key, DataType datatype) HasMetadata(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
(bool has_key, DataType datatype)

| Edit this page View Source

MetadataKeys()

Get metadata keys.

Declaration

public string[] MetadataKeys()

Returns

Type	Description
string[]

| Edit this page View Source

MetadataNum()

Get number of metadata.

Declaration

public ulong MetadataNum()

Returns

Type	Description
ulong

| Edit this page View Source

PutMetadata(string, string)

Put string metadata.

Declaration

public void PutMetadata(string key, string value)

Parameters

Type	Name	Description
string	key
string	value

| Edit this page View Source

PutMetadata<T>(string, T)

Put a single value metadata.

Declaration

public void PutMetadata<T>(string key, T v) where T : struct

Parameters

Type	Name	Description
string	key
T	v

Type Parameters

Name	Description
T

| Edit this page View Source

PutMetadata<T>(string, T[])

Put metadata array.

Declaration

public void PutMetadata<T>(string key, T[] data) where T : struct

Parameters

Type	Name	Description
string	key
T[]	data

Type Parameters

Name	Description
T

| Edit this page View Source

Remove(KeyValuePair<string, byte[]>)

Removes the first occurrence of a specific object from the ICollection<T>.

Declaration

public bool Remove(KeyValuePair<string, byte[]> item)

Parameters

Type	Name	Description
KeyValuePair<string, byte[]>	item	The object to remove from the ICollection<T>.

Returns

Type	Description
bool	true if `item` was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if `item` is not found in the original ICollection<T>.

Exceptions

Type	Condition
NotSupportedException	The ICollection<T> is read-only.

| Edit this page View Source

Remove(string)

Removes the element with the specified key from the IDictionary<TKey, TValue>.

Declaration

public bool Remove(string key)

Parameters

Type	Name	Description
string	key	The key of the element to remove.

Returns

Type	Description
bool	true if the element is successfully removed; otherwise, false. This method also returns false if `key` was not found in the original IDictionary<TKey, TValue>.

Exceptions

Type	Condition
ArgumentNullException	`key` is null.
NotSupportedException	The IDictionary<TKey, TValue> is read-only.

| Edit this page View Source

TryGetValue(string, out byte[])

Gets the value associated with the specified key.

Declaration

public bool TryGetValue(string key, out byte[] value)

Parameters

Type	Name	Description
string	key	The key whose value to get.
byte[]	value	When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the `value` parameter. This parameter is passed uninitialized.

Returns

Type	Description
bool	true if the object that implements IDictionary<TKey, TValue> contains an element with the specified key; otherwise, false.

Exceptions

Type	Condition
ArgumentNullException	`key` is null.

Implements

IDictionary<TKey, TValue>

ICollection<T>

IEnumerable<T>

IEnumerable