C# Class FoundationDB.Client.FdbCluster

FoundationDB Cluster

Inheritance: IFdbCluster

Private Properties

Property	Type	Description
OpenDatabaseInternalAsync	Task
ThrowIfDisposed	void

Method	Description
Dispose ( ) : void	Close the connection with the FoundationDB cluster
FdbCluster ( IFdbClusterHandler handler, string path ) : FoundationDB.Client.Core	Wraps a cluster handle
OpenDatabaseAsync ( string databaseName, FdbSubspace subspace, bool readOnly, CancellationToken cancellationToken ) : Task	Opens a database on this cluster, configured to only access a specific subspace of keys Any attempt to use a key outside the specified subspace will throw an exception
SetOption ( FdbClusterOption option ) : void	Set an option on this cluster that does not take any parameter
SetOption ( FdbClusterOption option, long value ) : void	Set an option on this cluster that takes an integer value
SetOption ( FdbClusterOption option, string value ) : void	Set an option on this cluster that takes a string value

Method	Description
Dispose ( bool disposing ) : void

Method	Description
OpenDatabaseInternalAsync ( string databaseName, FdbSubspace subspace, bool readOnly, bool ownsCluster, CancellationToken cancellationToken ) : Task	Opens a database on this cluster As of Beta2, the only supported database name is 'DB'
ThrowIfDisposed ( ) : void

Close the connection with the FoundationDB cluster

public Dispose ( ) : void
return	void

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

Wraps a cluster handle

public FdbCluster ( IFdbClusterHandler handler, string path ) : FoundationDB.Client.Core
handler	IFdbClusterHandler
path	string
return	FoundationDB.Client.Core

Opens a database on this cluster, configured to only access a specific subspace of keys

Any attempt to use a key outside the specified subspace will throw an exception

If is anything other than 'DB' If the token is cancelled

public OpenDatabaseAsync ( string databaseName, FdbSubspace subspace, bool readOnly, CancellationToken cancellationToken ) : Task
databaseName	string	Name of the database. Must be 'DB' (as of Beta 2)
subspace	FdbSubspace	Subspace of keys that will be accessed.
readOnly	bool	If true, the database will only allow read operations.
cancellationToken	System.Threading.CancellationToken	Cancellation Token (optionnal) for the connect operation
return	Task

Set an option on this cluster that does not take any parameter

public SetOption ( FdbClusterOption option ) : void
option	FdbClusterOption	Option to set
return	void

Set an option on this cluster that takes an integer value

public SetOption ( FdbClusterOption option, long value ) : void
option	FdbClusterOption	Option to set
value	long	Value of the parameter
return	void

Set an option on this cluster that takes a string value

public SetOption ( FdbClusterOption option, string value ) : void
option	FdbClusterOption	Option to set
value	string	Value of the parameter (can be null)
return	void