Struct SchemaConfig 

#[non_exhaustive]
pub struct SchemaConfig {
    pub exposed_schemas: Vec<String>,
    pub enable_mutations: bool,
    pub enable_subscriptions: bool,
    pub subscription_refresh_seconds: u64,
    pub enum_values: HashMap<String, Vec<(String, Option<String>)>>,
    pub names: NameOverrides,
    pub max_rows: Option<i64>,
    pub enable_federation: bool,
    pub type_prefix: Option<String>,
    pub role: Option<String>,
}

Configuration for schema generation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

exposed_schemas: Vec<String>

Schemas to expose in GraphQL (e.g., [“public”])

enable_mutations: bool

Whether to generate mutation types

enable_subscriptions: bool

Whether to generate subscription types

subscription_refresh_seconds: u64

How often a live query re-reads itself when nothing has notified it.

A subscription is woken by the trigger on the table it reads, which costs nothing while nothing is written. A trigger cannot see everything: a view has none, an embedded row may live in a table that carries none, and a predicate written against the clock changes with no write at all. This is how often those are noticed anyway. Seconds; zero turns the refresh off and leaves only the notifications.

enum_values: HashMap<String, Vec<(String, Option<String>)>>

The members of each enum table, keyed by schema.table, as (value, comment).

These are rows rather than schema, so they cannot come from the schema cache: they are read at startup, and again whenever the schema is rebuilt, for the tables the configuration marks. A table marked as an enum whose values are absent is exposed as an ordinary table – an empty GraphQL enum is not a legal type, and refusing to start over a table with no rows in it would be worse.

names: NameOverrides

Names given rather than derived.

Empty by default, which is every name derived from the schema exactly as before.

max_rows: Option<i64>

Ceiling on rows a single query may return (PGRST_MAX_ROWS).

Applied when a query supplies no limit of its own, and as an upper bound when it supplies a larger one. None leaves queries unbounded.

enable_federation: bool

Whether this schema is emitted as an Apollo Federation subgraph.

type_prefix: Option<String>

Namespace applied to generated table types and root fields.

role: Option<String>

Whose schema this is.

None is the unrestricted one: what an administrator sees, and what every caller sees on a server with no permission document. Some(role) is built from a cache already reduced to what that role may see, so the only thing left for the builders to ask about is the aggregate root.

Implementations

impl SchemaConfig

pub fn new() -> Self

Create a new schema config.

pub fn with_schemas(self, schemas: Vec<String>) -> Self

Set the exposed schemas.

pub fn with_mutations(self, enable: bool) -> Self

Enable or disable mutations.

pub fn with_subscriptions(self, enable: bool) -> Self

Enable or disable subscriptions.

pub fn is_shared_entity(&self, table: &QualifiedIdentifier) -> bool

Whether a table keeps its unprefixed type identity across subgraphs.

pub fn table_type_name( &self, table: &QualifiedIdentifier, base_name: &str, ) -> String

Name a table type, applying the configured namespace unless it is shared.

pub fn root_field_name(&self, base_name: &str) -> String

Namespace a root field so independently generated subgraphs do not collide.

pub fn subscription_refresh(&self) -> Duration

How often a live query re-reads itself when nothing has notified it.

pub fn is_schema_exposed(&self, schema: &str) -> bool

Check if a schema is exposed.

pub fn default_schema(&self) -> &str

The schema whose tables get unqualified GraphQL names.

This is the first exposed schema, mirroring how the REST surface treats the first entry of PGRST_DB_SCHEMAS as the default.

Trait Implementations

impl Clone for SchemaConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaConfig

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

Formats the value using the given formatter.

impl Default for SchemaConfig

fn default() -> Self

Returns the “default value” for a type.