[This is preliminary documentation and is subject to change.]
Generates one ID for the supplied sequence name.
Note: do not confuse with block pre-allocation, which is an internal optimization.
Even if 100 IDs are pre-allocated the method returns one unique ID
Namespace: NFX.DataAccessAssembly: NFX (in NFX.dll) Version: 3.0.0.1 (3.0.0.1)
ulong GenerateOneSequenceID(
string scopeName,
string sequenceName,
int blockSize = 0,
Nullable<ulong> vicinity = 18446744073709551615,
bool noLWM = false
)
ulong GenerateOneSequenceID(
string scopeName,
string sequenceName,
int blockSize = 0,
Nullable<ulong> vicinity = 18446744073709551615,
bool noLWM = false
)
Function GenerateOneSequenceID (
scopeName As String,
sequenceName As String,
Optional blockSize As Integer = 0,
Optional vicinity As Nullable(Of ULong) = 18446744073709551615,
Optional noLWM As Boolean = false
) As ULong
Function GenerateOneSequenceID (
scopeName As String,
sequenceName As String,
Optional blockSize As Integer = 0,
Optional vicinity As Nullable(Of ULong) = 18446744073709551615,
Optional noLWM As Boolean = false
) As ULong
unsigned long long GenerateOneSequenceID(
String^ scopeName,
String^ sequenceName,
int blockSize = 0,
Nullable<unsigned long long> vicinity = 18446744073709551615,
bool noLWM = false
)
unsigned long long GenerateOneSequenceID(
String^ scopeName,
String^ sequenceName,
int blockSize = 0,
Nullable<unsigned long long> vicinity = 18446744073709551615,
bool noLWM = false
)
abstract GenerateOneSequenceID :
scopeName : string *
sequenceName : string *
?blockSize : int *
?vicinity : Nullable<uint64> *
?noLWM : bool
(* Defaults:
let _blockSize = defaultArg blockSize 0
let _vicinity = defaultArg vicinity 18446744073709551615
let _noLWM = defaultArg noLWM false
*)
-> uint64abstract GenerateOneSequenceID :
scopeName : string *
sequenceName : string *
?blockSize : int *
?vicinity : Nullable<uint64> *
?noLWM : bool
(* Defaults:
let _blockSize = defaultArg blockSize 0
let _vicinity = defaultArg vicinity 18446744073709551615
let _noLWM = defaultArg noLWM false
*)
-> uint64Parameters
- scopeName
- Type:
System String
The name of scope where sequences are kept
- sequenceName
- Type: System String
The name of sequence within the scope for which ID to be obtained
- blockSize (Optional)
- Type: System Int32
If >0 specifies how many sequence values to pre-allocate, otherwise provider would use its default setting
- vicinity (Optional)
- Type: System Nullable UInt64
The location on ID counter scale, the issuing authority may disregard this parameter
- noLWM (Optional)
- Type: System Boolean
When true, does not start async fetch of the next ID block while the current block reaches low-water-mark.
This may not be desired in some short-lived processes.
The provider may disregard this flag
Return Value
Type:
UInt64The new ULONG sequence value
