Show / Hide Table of Contents

Class Group

Inheritance
object
Group
Implements
IDisposable
Namespace: TileDB.CSharp
Assembly: TileDB.CSharp.dll
Syntax
public sealed class Group : IDisposable

Constructors

| Edit this page View Source

Group(Context, string)

Declaration
public Group(Context ctx, string uri)
Parameters
Type Name Description
Context ctx
string uri

Methods

| Edit this page View Source

AddMember(string, bool, string)

Add a member to a group

Declaration
public void AddMember(string uri, bool relative, string name)
Parameters
Type Name Description
string uri
bool relative
string name
| Edit this page View Source

Close()

Close the group.

Declaration
public void Close()
| Edit this page View Source

Config()

Get config.

Declaration
public Config Config()
Returns
Type Description
Config
| Edit this page View Source

Context()

Get context.

Declaration
public Context Context()
Returns
Type Description
Context
| Edit this page View Source

Create(Context, string)

Declaration
public static void Create(Context ctx, string uri)
Parameters
Type Name Description
Context ctx
string uri
| 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

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()
| Edit this page View Source

Dump(bool)

Dump to string

Declaration
public string Dump(bool recursive)
Parameters
Type Name Description
bool recursive
Returns
Type Description
string
| Edit this page View Source

GetMemberByIndex(ulong)

Get member by index.

Declaration
public (string Uri, ObjectType ObjectType, string Name) GetMemberByIndex(ulong index)
Parameters
Type Name Description
ulong index

The member's index.

Returns
Type Description
(string Uri, ObjectType ObjectType, string Name)
| Edit this page View Source

GetMemberByName(string)

Get member by name.

Declaration
public (string Uri, ObjectType ObjectType) GetMemberByName(string name)
Parameters
Type Name Description
string name

The member's name.

Returns
Type Description
(string Uri, ObjectType ObjectType)
| 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

IsOpen()

Returns if this group is open or not.

Declaration
public bool IsOpen()
Returns
Type Description
bool
| Edit this page View Source

IsUriRelative(string)

Returns if the given URI is relative to this group.

Declaration
public bool IsUriRelative(string uri)
Parameters
Type Name Description
string uri

The URI to test.

Returns
Type Description
bool
| Edit this page View Source

MemberCount()

Get count of members.

Declaration
public ulong MemberCount()
Returns
Type Description
ulong
| 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

Open(QueryType)

Open the group.

Declaration
public void Open(QueryType queryType)
Parameters
Type Name Description
QueryType queryType
| 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 sigle 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

QueryType()

Get query type.

Declaration
public QueryType QueryType()
Returns
Type Description
QueryType
| Edit this page View Source

RemoveMember(string)

Remove a member of the group

Declaration
public void RemoveMember(string name)
Parameters
Type Name Description
string name

Name of member to remove. If the member has no name, this parameter should be set to the URI of the member.In that case, only the unnamed member with the given URI will be removed.

| Edit this page View Source

SetConfig(Config)

Set config.

Declaration
public void SetConfig(Config config)
Parameters
Type Name Description
Config config
| Edit this page View Source

Uri()

Get uri.

Declaration
public string Uri()
Returns
Type Description
string

Implements

IDisposable
  • Edit this page
  • View Source
In this article
Back to top Copyright © 2018-2023 TileDB Inc.