Increments the value of a key by the delta as an asynchronous operation. If the key doesn't exist, it will be created
and seeded with the defaut initial value 1.
Namespace: CouchbaseAssembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 0.0.0.0 (0.0.0.0)
Syntaxpublic Task<IOperationResult<ulong>> IncrementAsync(
string key,
ulong delta,
ulong initial,
uint expiration
)
public Task<IOperationResult<ulong>> IncrementAsync(
string key,
ulong delta,
ulong initial,
uint expiration
)
Public Function IncrementAsync (
key As String,
delta As ULong,
initial As ULong,
expiration As UInteger
) As Task(Of IOperationResult(Of ULong))
Public Function IncrementAsync (
key As String,
delta As ULong,
initial As ULong,
expiration As UInteger
) As Task(Of IOperationResult(Of ULong))
public:
virtual Task<IOperationResult<unsigned long long>^>^ IncrementAsync(
String^ key,
unsigned long long delta,
unsigned long long initial,
unsigned int expiration
) sealed
public:
virtual Task<IOperationResult<unsigned long long>^>^ IncrementAsync(
String^ key,
unsigned long long delta,
unsigned long long initial,
unsigned int expiration
) sealed
abstract IncrementAsync :
key : string *
delta : uint64 *
initial : uint64 *
expiration : uint32 -> Task<IOperationResult<uint64>>
override IncrementAsync :
key : string *
delta : uint64 *
initial : uint64 *
expiration : uint32 -> Task<IOperationResult<uint64>> abstract IncrementAsync :
key : string *
delta : uint64 *
initial : uint64 *
expiration : uint32 -> Task<IOperationResult<uint64>>
override IncrementAsync :
key : string *
delta : uint64 *
initial : uint64 *
expiration : uint32 -> Task<IOperationResult<uint64>> Parameters
- key
- Type: System.String
The key to us for the counter.
- delta
- Type: System.UInt64
The number to increment the key by.
- initial
- Type: System.UInt64
The initial value to use. If the key doesn't exist, this value will returned.
- expiration
- Type: System.UInt32
The time-to-live (ttl) for the counter in seconds.
Return Value
Type:
Task<IOperationResult<UInt64>>The
Task<TResult> object representing the asynchronous operation.
Implements
IBucket.IncrementAsync(String, UInt64, UInt64, UInt32)Remarks Expirations over 30 * 24 * 60 * 60 (the amount of seconds in 30 days) are interpreted as a UNIX timestamp of the date at which the document expires.
see
documentation section about expiration.
Remarks If the key doesn't exist, the server will respond with the initial value. If not the incremented value will be returned.
See Also