Struct TableObjectType 

#[non_exhaustive]
pub struct TableObjectType {
    pub table: Table,
    pub name: String,
    pub local_name: String,
    pub fields: Vec<GraphQLField>,
    pub writable_fields: Vec<GraphQLField>,
    pub description: Option<String>,
}

Represents a GraphQL ObjectType derived from a database table.

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.

table: Table

The original table.

name: String

GraphQL type name (PascalCase).

local_name: String

Base name for generated helper types owned by this table.

fields: Vec<GraphQLField>

Fields derived from columns: the ones a read may name.

Empty where the role may write this table and not read it, which is a table with no GraphQL type – see crate::role.

writable_fields: Vec<GraphQLField>

Fields a write may name, before the write permission narrows them.

The same list before the read permission was applied, which is what makes a column a role may set without seeing expressible: fields is what the type shows and this is what the insert and update inputs are built from. Equal to fields where nothing narrowed them.

description: Option<String>

The type’s description: the table’s comment, or the one metadata gave instead. Some("") is a description that was given and is empty, which is how metadata says the type has none.

Implementations

impl TableObjectType

pub fn from_table(table: &Table) -> Self

Create a GraphQL ObjectType from a database table.

The type is named after the table. Use Self::from_table_named when the name must be disambiguated (for example when the same table name appears in more than one exposed schema).

pub fn from_table_named( table: &Table, base_name: &str, names: &NameOverrides, ) -> Self

Build the field for a table, under a name chosen by the caller.

Separate from the unnamed constructor because a custom table name has to reach the field before its type name is derived from it.

pub fn name(&self) -> &str

Get the GraphQL type name.

pub fn description(&self) -> Option<&str>

Get the description from table comment.

pub fn table_name(&self) -> &str

The name of the table itself, which is not always the type’s: a configured base name renames the type and leaves the table alone.

pub fn fields(&self) -> &[GraphQLField]

Get all fields.

pub fn get_field(&self, name: &str) -> Option<&GraphQLField>

Get a field by name.

pub fn has_field(&self, name: &str) -> bool

Check if a field exists.

pub fn pk_fields(&self) -> Vec<&GraphQLField>

Get primary key fields.

Trait Implementations

impl Clone for TableObjectType

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 TableObjectType

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

Formats the value using the given formatter.