io.picodata.driver.api.space.options.crud

Interface OperationWithBucketIdOptions<T extends OperationWithBucketIdOptions<T>>

All Superinterfaces:

Options, Self<T>

All Known Subinterfaces:

DeleteOptions<T>, InsertOptions<T>, ReplaceOptions<T>, SelectOptions<T>, UpdateOptions<T>, UpsertOptions<T>

All Known Implementing Classes:

ProxyDeleteOptions, ProxyInsertOptions, ProxyReplaceOptions, ProxySelectOptions, ProxyUpdateOptions, ProxyUpsertOptions

public interface OperationWithBucketIdOptions<T extends OperationWithBucketIdOptions<T>>
extends Options, Self<T>

Base interface for all operation options that may have a configurable bucket id.

Method Summary

Modifier and Type	Method and Description
default Optional<Integer>	getBucketId() Return bucket id that is used by operation to find storage location.
default T	withBucketId(Integer bucketId) Specifies bucket id for an operation to perform it on storage with this bucket.

Methods inherited from interface io.picodata.driver.api.space.options.Options

addOption, asMap, getOption

Methods inherited from interface io.picodata.driver.api.space.options.Self

self

Method Detail

withBucketId

default T withBucketId(Integer bucketId)

Specifies bucket id for an operation to perform it on storage with this bucket. It may be useful if a non-default sharding function is used or in other specific cases. By default, crud extracts primary key from a tuple and calculates a strcrc32 hash function value and gets the remainder after dividing the value by the number of buckets. You can use your own implementation of the sharding function. For retrieving the number of buckets the vshard.router.bucket_count API method can be used.

Parameters:

bucketId - number determining the location in the cluster

Returns:

this options instance

See Also:

vshard, crud

getBucketId

default Optional<Integer> getBucketId()

Return bucket id that is used by operation to find storage location.

Returns:

bucket id