Cassandra

v1.0.2

Cassandra v1.0.2 Cassandra.Cluster View Source

Represents a cassandra cluster. It serves as a Session factory and a collection of metadata.

It always keeps a control connection open to one of cluster hosts to get notified about topological and status changes in the cluster, and keeps its metadata is sync.

Link to this section Summary

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor

find_replicas(cluster, keyspace, partition_key)

Returns replications containing partition_key of keyspace

host(cluster, ips)

Returns list of cluster hosts matching given list if ips

hosts(cluster)

Returns list of clusters Cassandra.Hosts

start(options \\ [])

Starts a Cluster process without links (outside of a supervision tree)

start_link(options \\ [])

Starts a Cluster process linked to the current process

up_hosts(cluster)

Returns list of clusters up Cassandra.Hosts

Link to this section Functions

Link to this function child_spec(arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function find_replicas(cluster, keyspace, partition_key) View Source

Returns replications containing partition_key of keyspace

Link to this function host(cluster, ips) View Source

Returns list of cluster hosts matching given list if ips

Link to this function hosts(cluster) View Source

Returns list of clusters Cassandra.Hosts

Link to this function start(options \\ []) View Source

Starts a Cluster process without links (outside of a supervision tree).

See start_link/1 for more information.

Link to this function start_link(options \\ []) View Source

Starts a Cluster process linked to the current process.

options is the keyword list of options:

  • :contact_points - The initial list host of addresses. Note that the entire list of cluster members will be discovered automatically once a connection to any hosts from the original list is successful. (default: ["127.0.0.1"])
  • :port - Cassandra native protocol port (default: 9042)
  • :connection_timeout - connection timeout in milliseconds (defult: 5000)
  • :timeout - request execution timeout in milliseconds (default: :infinity)

Return values

It returns {:ok, pid} when connection to one of contact_points established and metadata fetched, on any error it returns {:error, reason}.

Link to this function up_hosts(cluster) View Source

Returns list of clusters up Cassandra.Hosts