Struct ServerGroup 

pub struct ServerGroup {
    pub name: Ident,
    pub servers: IndexMap<SmolStr, Server>,
    pub attributes: Vec<Attribute>,
    pub documentation: Option<Documentation>,
    pub span: Span,
}

A server group containing multiple database servers.

Example

serverGroup MainCluster {
    @@strategy(ReadReplica)
    @@loadBalance(RoundRobin)

    server primary {
        url = env("PRIMARY_DATABASE_URL")
        role = "primary"
        weight = 1
    }

    server replica1 {
        url = env("REPLICA1_DATABASE_URL")
        role = "replica"
        weight = 2
        region = "us-east-1"
    }

    server replica2 {
        url = env("REPLICA2_DATABASE_URL")
        role = "replica"
        weight = 2
        region = "us-west-2"
    }
}

Fields

name: Ident

Group name.

servers: IndexMap<SmolStr, Server>

Servers in this group.

attributes: Vec<Attribute>

Group-level attributes (strategy, load balancing, etc.).

documentation: Option<Documentation>

Documentation comment.

span: Span

Source location.

Implementations

impl ServerGroup

pub fn new(name: Ident, span: Span) -> ServerGroup

Create a new server group.

pub fn add_server(&mut self, server: Server)

Add a server to the group.

pub fn add_attribute(&mut self, attr: Attribute)

Add an attribute to the group.

pub fn set_documentation(&mut self, doc: Documentation)

Set documentation.

pub fn strategy(&self) -> Option<ServerGroupStrategy>

Get the group strategy (e.g., ReadReplica, Sharding, MultiRegion).

pub fn load_balance(&self) -> Option<LoadBalanceStrategy>

Get the load balancing strategy.

pub fn primary(&self) -> Option<&Server>

Get the primary server.

pub fn replicas(&self) -> Vec<&Server>

Get all replica servers.

pub fn servers_in_region(&self, region: &str) -> Vec<&Server>

Get servers by region.

pub fn failover_order(&self) -> Vec<&Server>

Get the failover order (sorted by priority).

Trait Implementations

impl Clone for ServerGroup

fn clone(&self) -> ServerGroup

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServerGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerGroup

fn deserialize<__D>( __deserializer: __D, ) -> Result<ServerGroup, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ServerGroup

fn eq(&self, other: &ServerGroup) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ServerGroup

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ServerGroup