Enum query_structure::prelude::SelectedField

pub enum SelectedField {
    Scalar(ScalarFieldRef),
    Composite(CompositeSelection),
    Relation(RelationSelection),
    Virtual(VirtualSelection),
}

A selected field. Can be contained on a model or composite type.

Variants

Scalar(ScalarFieldRef)

Composite(CompositeSelection)

Relation(RelationSelection)

Virtual(VirtualSelection)

Implementations

impl SelectedField

pub fn prisma_name(&self) -> Cow<'_, str>

pub fn db_name(&self) -> Cow<'_, str>

Returns the name of the field in the database (if applicable) or other kind of name that is used in the queries for this field. For virtual fields, this returns the alias used in the queries that do not group them into objects.

pub fn db_name_grouping_virtuals(&self) -> Cow<'_, str>

Returns the name of the field in the database (if applicable) or other kind of name that is used in the queries for this field. For virtual fields that are wrapped inside an object in Prisma queries, this returns the name of the surrounding object and not the field itself, so this method can return identical values for multiple fields in the FieldSelection. This is used in queries with relation JOINs which use JSON objects to represent both relations and relation aggregations. For those queries, the result of this method corresponds to the top-level name of the value which is a JSON object that contains this field inside.

pub fn type_identifier_with_arity(&self) -> Option<(TypeIdentifier, FieldArity)>

Returns the type identifier and arity of this field, unless it is a composite field, in which case None is returned.

pub fn type_identifier_with_arity_grouping_virtuals( &self ) -> Option<(TypeIdentifier, FieldArity)>

Returns the type identifier and arity of this field, unless it is a composite field, in which case None is returned.

In the case of virtual fields that are wrapped into objects in Prisma queries (specifically, relation aggregations), the returned information refers not to the current field itself but to the whole object that contains this field. This is used by the queries with relation JOINs because they use JSON objects to reprsent both relations and relation aggregations, so individual virtual fields that correspond to those relation aggregations don’t exist as separate values in the result of the query.

pub fn as_composite(&self) -> Option<&CompositeSelection>

pub fn as_virtual(&self) -> Option<&VirtualSelection>

pub fn container(&self) -> ParentContainer

pub fn is_scalar(&self) -> bool

Returns true if the selected field is [Scalar].

Trait Implementations

impl Clone for SelectedField

fn clone(&self) -> SelectedField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SelectedField

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

Formats the value using the given formatter.

impl Display for SelectedField

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

Formats the value using the given formatter.

impl From<Zipper<ScalarFieldId>> for SelectedField

fn from(f: ScalarFieldRef) -> Self

Converts to this type from the input type.

impl Hash for SelectedField

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SelectedField

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SelectedField

impl StructuralEq for SelectedField

impl StructuralPartialEq for SelectedField