NextPartitionKey Property

Indicates the next partition key to be returned in a subsequent query against the table.

Syntax

 table.getNextPartitionKey([callback])
 table.setNextPartitionKey( nextPartitionKey, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getNextPartitionKey([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setNextPartitionKey([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property may be populated when ListEntities is called. If the results exceed 1000 entities or the request does not complete within the timeout interval (30 seconds), the results will paged. After calling ListEntities check this property to determine if there are additional results. If this property has a value call ListEntities again to retrieve the next set of results.

If this property is empty after calling ListEntities there are no further results.

This property is not available at design time.

Data Type

String