Struct TomlSchema 

pub struct TomlSchema {

    pub schema: SchemaMetadata,
    pub database: DatabaseRuntimeConfig,
    pub server: ServerRuntimeConfig,
    pub types: BTreeMap<String, TypeDefinition>,
    pub queries: BTreeMap<String, QueryDefinition>,
    pub mutations: BTreeMap<String, MutationDefinition>,
    pub federation: FederationConfig,
    pub security: SecuritySettings,
    pub observers: ObserversConfig,
    pub caching: CachingConfig,
    pub analytics: AnalyticsConfig,
    pub observability: ObservabilityConfig,
    pub includes: SchemaIncludes,
    pub domain_discovery: DomainDiscovery,
    pub query_defaults: QueryDefaults,
    pub auth: Option<OidcClientConfig>,
    pub subscriptions: SubscriptionsConfig,
    pub validation: ValidationConfig,
    pub debug: DebugConfig,
    pub mcp: McpConfig,
    pub rest: RestTomlConfig,
    pub naming_convention: NamingConvention,
    pub crud: Option<CrudNamingConfig>,
    pub hierarchies: Option<HashMap<String, HierarchyConfig>>,
}

Complete TOML schema configuration

Fields

schema: SchemaMetadata

Schema metadata

database: DatabaseRuntimeConfig

Database connection pool configuration (optional — all fields have defaults).

Supports ${VAR} environment variable interpolation in the url field.

server: ServerRuntimeConfig

HTTP server runtime configuration (optional — all fields have defaults).

CLI flags (--port, --bind) take precedence over these settings.

types: BTreeMap<String, TypeDefinition>

Type definitions

queries: BTreeMap<String, QueryDefinition>

Query definitions

mutations: BTreeMap<String, MutationDefinition>

Mutation definitions

federation: FederationConfig

Federation configuration

security: SecuritySettings

Security configuration

observers: ObserversConfig

Observers/event system configuration

caching: CachingConfig

Result caching configuration

analytics: AnalyticsConfig

Analytics configuration

observability: ObservabilityConfig

Observability configuration

includes: SchemaIncludes

Schema includes configuration for multi-file composition

domain_discovery: DomainDiscovery

Domain discovery configuration for domain-based organization

query_defaults: QueryDefaults

Global defaults for list-query auto-params.

Provides project-wide defaults for where, order_by, limit, and offset parameters on list queries. Per-query auto_params overrides are partial — only the specified flags override the defaults. Relay queries and single-item queries are never affected.

auth: Option<OidcClientConfig>

OAuth2 client identity for server-side PKCE flows.

Required when [security.pkce] enabled = true. Holds the OIDC provider discovery URL, client_id, and a reference to the env var containing the client secret. Never stores the secret itself.

subscriptions: SubscriptionsConfig

WebSocket subscription configuration (hooks, limits).

validation: ValidationConfig

Query validation limits (depth, complexity).

debug: DebugConfig

Debug/development settings (database EXPLAIN, SQL exposure).

mcp: McpConfig

MCP (Model Context Protocol) server configuration.

rest: RestTomlConfig

REST transport configuration.

naming_convention: NamingConvention

Naming convention for GraphQL operation names.

"preserve" (default) keeps names as authored (snake_case from Python SDKs). "camelCase" converts operation names to standard GraphQL camelCase.

crud: Option<CrudNamingConfig>

CRUD function naming config for automatic sql_source resolution.

When set, mutations that omit sql_source have their PostgreSQL function name resolved at compile time using the configured template and the entity name derived from return_type.

Example:

[crud]
function_schema = "app"
function_naming = "trinity"

hierarchies: Option<HashMap<String, HierarchyConfig>>

Hierarchy definitions for ID-based ltree operators (descendantOfId, ancestorOfId).

Maps a hierarchy name to its table and ltree path column. Used by the compiler to generate subquery-based ltree WHERE clauses that resolve an entity’s ltree path from its UUID.

Example:

[hierarchies.category]
table = "tb_category"
path_column = "category_path"

Implementations

impl TomlSchema

pub fn from_file(path: &str) -> Result<Self>

Load schema from TOML file

Errors

Returns an error if the file cannot be read or cannot be parsed as a valid TomlSchema.

pub fn parse_toml(content: &str) -> Result<Self>

Parse schema from TOML string.

Expands ${VAR} environment variable placeholders before parsing.

Errors

Returns an error if the TOML string cannot be deserialized into a TomlSchema.

pub fn validate(&self) -> Result<()>

Validate schema

Errors

Returns an error if any query or mutation references an undefined type, if a field auth rule references an undefined policy, if a federation entity references an undefined type, or if server/database/circuit-breaker configuration values are invalid.

pub fn to_intermediate_schema(&self) -> Value

Convert to intermediate schema format (compatible with language-generated types.json)

Trait Implementations

impl Clone for TomlSchema

fn clone(&self) -> TomlSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TomlSchema

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

Formats the value using the given formatter.

impl Default for TomlSchema

fn default() -> TomlSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TomlSchema

where TomlSchema: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TomlSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.