Struct Route

pub struct Route { /* private fields */ }

Statement route.

PgDog uses this to decide where a query should be sent to. Read statements are sent to a replica, while write ones are sent the primary. If the cluster has more than one shard, the statement can be sent to a specific database, or all of them.

Example

use pgdog_plugin::{Shard, ReadWrite, Route};

// This sends the query to the primary database of shard 0.
let route = Route::new(Shard::Direct(0), ReadWrite::Write);

// This sends the query to all shards, routing them to a replica
// of each shard, if any are configured.
let route = Route::new(Shard::All, ReadWrite::Read);

// No routing information is available. PgDog will ignore it
// and make its own decision.
let route = Route::unknown();

Implementations

impl Route

pub fn new(shard: Shard, read_write: ReadWrite) -> Route

Create new route.

Arguments

• shard: Which shard the statement should be sent to.
• read_write: Does the statement read or write data. Read statements are sent to a replica. Write statements are sent to the primary.

pub fn unknown() -> Route

Create new route with no sharding or read/write information. Use this if you don’t want your plugin to do query routing. Plugins that do something else with queries, e.g., logging, metrics, can return this route.

pub fn block() -> Route

Block the query from being sent to a database. PgDog will abort the query and return an error to the client, telling them which plugin blocked it.

Trait Implementations

impl Default for Route

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Route

type Target = PdRoute

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<PdRoute> for Route

fn from(value: PdRoute) -> Self

Converts to this type from the input type.

impl From<Route> for PdRoute

fn from(value: Route) -> Self

Converts to this type from the input type.