C# 클래스 FoundationDB.Client.Fdb.System

Helper class for reading from the reserved System subspace

파일 보기 프로젝트 열기: BedeGaming/foundationdb-dotnet-client

공개 프로퍼티들

프로퍼티	타입	설명
BackupDataFormat	Slice
ConfigPrefix	Slice
Coordinators	Slice
GlobalsPrefix	Slice
InitId	Slice
KeyServers	Slice
MaxValue	Slice
MinValue	Slice
ServerKeys	Slice
ServerList	Slice
WorkersPrefix	Slice

공개 메소드들

메소드	설명
ConfigKey ( [ name ) : Slice	Return the corresponding key for a config attribute
EstimateCountAsync ( [ db, FdbKeyRange range, CancellationToken cancellationToken ) : Task	Estimate the number of keys in the specified range. If the range contains a large of number keys, the operation may need more than one transaction to complete, meaning that the number will not be transactionally accurate.
EstimateCountAsync ( [ db, FdbKeyRange range, Slice>.IProgress onProgress, CancellationToken cancellationToken ) : Task	Estimate the number of keys in the specified range. If the range contains a large of number keys, the operation may need more than one transaction to complete, meaning that the number will not be transactionally accurate.
EstimateCountAsync ( [ db, Slice beginInclusive, Slice endExclusive, Slice>.IProgress onProgress, CancellationToken cancellationToken ) : Task	Estimate the number of keys in the specified range. If the range contains a large of number keys, the operation may need more than one transaction to complete, meaning that the number will not be transactionally accurate.
GetBoundaryKeysAsync ( [ trans, Slice beginInclusive, Slice endExclusive ) : Task>	Returns a list of keys k such that beginInclusive <= k < endExclusive and k is located at the start of a contiguous range stored on a single server This method is not transactional. It will return an answer no older than the Transaction object it is passed, but the returned boundaries are an estimate and may not represent the exact boundary locations at any database version.
GetBoundaryKeysAsync ( [ db, Slice beginInclusive, Slice endExclusive, CancellationToken cancellationToken ) : Task>	Returns a list of keys k such that beginInclusive <= k < endExclusive and k is located at the start of a contiguous range stored on a single server This method is not transactional. It will return an answer no older than the Database object it is passed, but the returned boundaries are an estimate and may not represent the exact boundary locations at any database version.
GetChunksAsync ( [ db, FdbKeyRange range, CancellationToken cancellationToken ) : Task>	Split a range of keys into smaller chunks where each chunk represents a contiguous range stored on a single server This method is not transactional. It will return an answer no older than the Database object it is passed, but the returned ranges are an estimate and may not represent the exact boundary locations at any database version.
GetChunksAsync ( [ db, Slice beginInclusive, Slice endExclusive, CancellationToken cancellationToken ) : Task>	Split a range of keys into chunks representing a contiguous range stored on a single server This method is not transactional. It will return an answer no older than the Database object it is passed, but the returned ranges are an estimate and may not represent the exact boundary locations at any database version.
GetConfigParameterAsync ( [ db, [ name, CancellationToken cancellationToken ) : Task	Return the value of a configuration parameter (located under '\xFF/conf/')
GetCoordinatorsAsync ( [ db, CancellationToken cancellationToken ) : Task	Returns an object describing the list of the current coordinators for the cluster Since the list of coordinators may change at anytime, the results may already be obsolete once this method completes!
GetStatusAsync ( [ trans ) : Task
GetStatusAsync ( [ db, CancellationToken ct ) : Task
GetStorageEngineModeAsync ( [ db, CancellationToken cancellationToken ) : Task	Returns the current storage engine mode of the cluster Will return a string starting with "unknown" if the storage engine mode is not recognized
GlobalsKey ( [ name ) : Slice	Return the corresponding key for a global attribute
WorkersKey ( [ id, [ name ) : Slice	Return the corresponding key for a global attribute

비공개 메소드들

메소드	설명
GetBoundaryKeysInternalAsync ( [ trans, Slice begin, Slice end ) : Task>

메소드 상세

ConfigKey() 공개 정적인 메소드

Return the corresponding key for a config attribute

public static ConfigKey ( [ name ) : Slice
name	[	"foo"
리턴	Slice

EstimateCountAsync() 공개 정적인 메소드

Estimate the number of keys in the specified range.

If the range contains a large of number keys, the operation may need more than one transaction to complete, meaning that the number will not be transactionally accurate.

public static EstimateCountAsync ( [ db, FdbKeyRange range, CancellationToken cancellationToken ) : Task
db	[	Database used for the operation
range	FdbKeyRange	Range defining the keys to count
cancellationToken	System.Threading.CancellationToken	Token used to cancel the operation
리턴	Task

EstimateCountAsync() 공개 정적인 메소드

Estimate the number of keys in the specified range.

If the range contains a large of number keys, the operation may need more than one transaction to complete, meaning that the number will not be transactionally accurate.

public static EstimateCountAsync ( [ db, FdbKeyRange range, Slice>.IProgress onProgress, CancellationToken cancellationToken ) : Task
db	[	Database used for the operation
range	FdbKeyRange	Range defining the keys to count
onProgress	Slice>.IProgress	Optional callback called everytime the count is updated. The first argument is the current count, and the second argument is the last key that was found.
cancellationToken	System.Threading.CancellationToken	Token used to cancel the operation
리턴	Task

EstimateCountAsync() 공개 정적인 메소드

Estimate the number of keys in the specified range.

If the range contains a large of number keys, the operation may need more than one transaction to complete, meaning that the number will not be transactionally accurate.

public static EstimateCountAsync ( [ db, Slice beginInclusive, Slice endExclusive, Slice>.IProgress onProgress, CancellationToken cancellationToken ) : Task
db	[	Database used for the operation
beginInclusive	Slice	Key defining the beginning of the range
endExclusive	Slice	Key defining the end of the range
onProgress	Slice>.IProgress	Optional callback called everytime the count is updated. The first argument is the current count, and the second argument is the last key that was found.
cancellationToken	System.Threading.CancellationToken	Token used to cancel the operation
리턴	Task

GetBoundaryKeysAsync() 공개 정적인 메소드

Returns a list of keys k such that beginInclusive <= k < endExclusive and k is located at the start of a contiguous range stored on a single server

This method is not transactional. It will return an answer no older than the Transaction object it is passed, but the returned boundaries are an estimate and may not represent the exact boundary locations at any database version.

public static GetBoundaryKeysAsync ( [ trans, Slice beginInclusive, Slice endExclusive ) : Task>
trans	[	Transaction to use for the operation
beginInclusive	Slice	First key (inclusive) of the range to inspect
endExclusive	Slice	End key (exclusive) of the range to inspect
리턴	Task>

GetBoundaryKeysAsync() 공개 정적인 메소드

Returns a list of keys k such that beginInclusive <= k < endExclusive and k is located at the start of a contiguous range stored on a single server

This method is not transactional. It will return an answer no older than the Database object it is passed, but the returned boundaries are an estimate and may not represent the exact boundary locations at any database version.

public static GetBoundaryKeysAsync ( [ db, Slice beginInclusive, Slice endExclusive, CancellationToken cancellationToken ) : Task>
db	[	Database to use for the operation
beginInclusive	Slice	First key (inclusive) of the range to inspect
endExclusive	Slice	End key (exclusive) of the range to inspect
cancellationToken	System.Threading.CancellationToken	Token used to cancel the operation
리턴	Task>

GetChunksAsync() 공개 정적인 메소드

Split a range of keys into smaller chunks where each chunk represents a contiguous range stored on a single server

This method is not transactional. It will return an answer no older than the Database object it is passed, but the returned ranges are an estimate and may not represent the exact boundary locations at any database version.

public static GetChunksAsync ( [ db, FdbKeyRange range, CancellationToken cancellationToken ) : Task>
db	[	Database to use for the operation
range	FdbKeyRange	Range of keys to split up into smaller chunks
cancellationToken	System.Threading.CancellationToken	Token used to cancel the operation
리턴	Task>

GetChunksAsync() 공개 정적인 메소드

Split a range of keys into chunks representing a contiguous range stored on a single server

public static GetChunksAsync ( [ db, Slice beginInclusive, Slice endExclusive, CancellationToken cancellationToken ) : Task>
db	[	Database to use for the operation
beginInclusive	Slice	First key (inclusive) of the range to inspect
endExclusive	Slice	End key (exclusive) of the range to inspect
cancellationToken	System.Threading.CancellationToken	Token used to cancel the operation
리턴	Task>

GetConfigParameterAsync() 공개 정적인 메소드

Return the value of a configuration parameter (located under '\xFF/conf/')

public static GetConfigParameterAsync ( [ db, [ name, CancellationToken cancellationToken ) : Task
db	[	Database to use for the operation
name	[	Name of the configuration key (ex: "storage_engine")
cancellationToken	System.Threading.CancellationToken	Token used to cancel the operation
리턴	Task

GetCoordinatorsAsync() 공개 정적인 메소드

Returns an object describing the list of the current coordinators for the cluster

Since the list of coordinators may change at anytime, the results may already be obsolete once this method completes!

public static GetCoordinatorsAsync ( [ db, CancellationToken cancellationToken ) : Task
db	[	Database to use for the operation
cancellationToken	System.Threading.CancellationToken	Token used to cancel the operation
리턴	Task

GetStatusAsync() 공개 정적인 메소드

public static GetStatusAsync ( [ trans ) : Task
trans	[
리턴	Task

GetStatusAsync() 공개 정적인 메소드

public static GetStatusAsync ( [ db, CancellationToken ct ) : Task
db	[
ct	System.Threading.CancellationToken
리턴	Task

GetStorageEngineModeAsync() 공개 정적인 메소드

Returns the current storage engine mode of the cluster

Will return a string starting with "unknown" if the storage engine mode is not recognized

public static GetStorageEngineModeAsync ( [ db, CancellationToken cancellationToken ) : Task
db	[	Database to use for the operation
cancellationToken	System.Threading.CancellationToken	Token used to cancel the operation
리턴	Task

GlobalsKey() 공개 정적인 메소드

Return the corresponding key for a global attribute

public static GlobalsKey ( [ name ) : Slice
name	[	"foo"
리턴	Slice

WorkersKey() 공개 정적인 메소드

Return the corresponding key for a global attribute

public static WorkersKey ( [ id, [ name ) : Slice
id	[	"ABC123"
name	[	"foo"
리턴	Slice

프로퍼티 상세

BackupDataFormat 공개적으로 정적으로 프로퍼티

"\xFF/backupDataFormat"

public static Slice BackupDataFormat
리턴	Slice

ConfigPrefix 공개적으로 정적으로 프로퍼티

"\xFF/conf/"

public static Slice ConfigPrefix
리턴	Slice

Coordinators 공개적으로 정적으로 프로퍼티

"\xFF/coordinators"

public static Slice Coordinators
리턴	Slice

GlobalsPrefix 공개적으로 정적으로 프로퍼티

"\xFF/globals/"

public static Slice GlobalsPrefix
리턴	Slice

InitId 공개적으로 정적으로 프로퍼티

"\xFF/init_id"

public static Slice InitId
리턴	Slice

KeyServers 공개적으로 정적으로 프로퍼티

"\xFF/keyServer/(key_boundary)" => (..., node_id, ...)

public static Slice KeyServers
리턴	Slice

MaxValue 공개적으로 정적으로 프로퍼티

"\xFF\xFF"

public static Slice MaxValue
리턴	Slice

MinValue 공개적으로 정적으로 프로퍼티

"\xFF\x00"

public static Slice MinValue
리턴	Slice

ServerKeys 공개적으로 정적으로 프로퍼티

"\xFF/serverKeys/(node_id)/(key_boundary)" => ('' | '1')

public static Slice ServerKeys
리턴	Slice

ServerList 공개적으로 정적으로 프로퍼티

"\xFF/serverList/(node_id)" => (..., node_id, machine_id, datacenter_id, ...)

public static Slice ServerList
리턴	Slice

WorkersPrefix 공개적으로 정적으로 프로퍼티

"\xFF/workers/(ip:port)/..." => datacenter + machine + mclass

public static Slice WorkersPrefix
리턴	Slice