ExScylla.LoadBalancing.DefaultPolicyBuilder (ex_scylla v0.10.2)

Wrapper around rust module See rust documentation for more usage details: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html

Summary

Types

opaque()

Functions

build(dpb)

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.build

enable_shuffling_replicas(epb, enable)

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.enable_shuffling_replicas

latency_awareness(epb, latency_awareness_builder)

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.latency_awareness

new()

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.new

permit_dc_failover(epb, permit)

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.permit_dc_failover

prefer_datacenter(epb, datacenter_name)

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.prefer_datacenter

prefer_datacenter_and_rack(epb, datacenter_name, rack_name)

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.prefer_datacenter_and_rack

token_aware(epb, is_token_aware)

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.token_aware

Types

opaque()

@type opaque() :: any()

Functions

build(dpb)

@spec build(ExScylla.Types.default_policy_builder()) ::
  ExScylla.Types.load_balancing_policy()

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.build

Example

iex> lbp = DefaultPolicyBuilder.new()
...>        |> DefaultPolicyBuilder.build()
iex> true = is_reference(lbp)

enable_shuffling_replicas(epb, enable)

@spec enable_shuffling_replicas(ExScylla.Types.default_policy_builder(), boolean()) ::
  ExScylla.Types.default_policy_builder()

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.enable_shuffling_replicas

Example

iex> dpb = DefaultPolicyBuilder.new()
...>        |> DefaultPolicyBuilder.enable_shuffling_replicas(true)
iex> true = is_reference(dpb)

latency_awareness(epb, latency_awareness_builder)

@spec latency_awareness(
  ExScylla.Types.default_policy_builder(),
  ExScylla.Types.latency_awareness_builder()
) :: ExScylla.Types.default_policy_builder()

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.latency_awareness

Example

iex> lab = LatencyAwarenessBuilder.new()
iex> dpb = DefaultPolicyBuilder.new()
...>        |> DefaultPolicyBuilder.latency_awareness(lab)
iex> true = is_reference(dpb)

new()

@spec new() :: ExScylla.Types.default_policy_builder()

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.new

Example

iex> dpb = DefaultPolicyBuilder.new()
iex> true = is_reference(dpb)

permit_dc_failover(epb, permit)

@spec permit_dc_failover(ExScylla.Types.default_policy_builder(), boolean()) ::
  ExScylla.Types.default_policy_builder()

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.permit_dc_failover

Example

iex> dpb = DefaultPolicyBuilder.new()
...>        |> DefaultPolicyBuilder.permit_dc_failover(true)
iex> true = is_reference(dpb)

prefer_datacenter(epb, datacenter_name)

@spec prefer_datacenter(ExScylla.Types.default_policy_builder(), String.t()) ::
  ExScylla.Types.default_policy_builder()

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.prefer_datacenter

Example

iex> dpb = DefaultPolicyBuilder.new()
...>        |> DefaultPolicyBuilder.prefer_datacenter("dc1")
iex> true = is_reference(dpb)

prefer_datacenter_and_rack(epb, datacenter_name, rack_name)

@spec prefer_datacenter_and_rack(
  ExScylla.Types.default_policy_builder(),
  String.t(),
  String.t()
) ::
  ExScylla.Types.default_policy_builder()

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.prefer_datacenter_and_rack

Example

iex> dpb = DefaultPolicyBuilder.new()
...>        |> DefaultPolicyBuilder.prefer_datacenter_and_rack("dc1", "rack1")
iex> true = is_reference(dpb)

token_aware(epb, is_token_aware)

@spec token_aware(ExScylla.Types.default_policy_builder(), boolean()) ::
  ExScylla.Types.default_policy_builder()

See: https://docs.rs/scylla/1.8.0/scylla/policies/load_balancing/struct.DefaultPolicyBuilder.html#method.token_aware

Example

iex> dpb = DefaultPolicyBuilder.new()
...>        |> DefaultPolicyBuilder.token_aware(true)
iex> true = is_reference(dpb)