How to query all the GraphQL type fields without writing a long query

Question

Assume you have a GraphQL type and it includes many fields  How to query all the fields without writing down a long query that includes the names of all the fields   For example  If I have these fields     public function fields                 return                id    gt                     type    gt  Type  nonNull Type  string                      description    gt   The id of the user                              username    gt                     type    gt  Type  string                     description    gt   The email of user                                count    gt                     type    gt  Type  int                     description    gt   login count for the user                                    To query all the fields usually the query is something like this    FetchUsers users id  2   id username count     But I want a way to have the same results without writing all the fields  something like this   FetchUsers users id  2         or FetchUsers users id  2      Is there a way to do this in GraphQL     I m using Folkloreatelier laravel-graphql library

User · Answer

GraphQL query format was designed in order to allow:

Both query and result shape be exactly the same.
The server knows exactly the requested fields, thus the client downloads only essential data.

However, according to GraphQL documentation, you may create fragments in order to make selection sets more reusable:

# Only most used selection properties

fragment UserDetails on User {
    id,
    username
}

Then you could query all user details by:

FetchUsers {
    users() {
        ...UserDetails
    }
}

You can also add additional fields alongside your fragment:

FetchUserById($id: ID!) {
    users(id: $id) {
        ...UserDetails
        count
    }
}

User · Answer

Yes  you can do this using introspection   Make a GraphQL query like  for type UserType          type name  UserType           fields            name          description                    and you ll get a response like  actual field names will depend on your actual schema type definition        data            type            fields                          name    id              description                                      name    username              description    Required  150 characters or fewer  Letters  digits and       -   only                                   name    firstName              description                                      name    lastName              description                                     name    email              description                           etc  etc                             You can then read this list of fields in your client and dynamically build a second GraphQL query to get all of these fields   This relies on you knowing the name of the type that you want to get the fields for -- if you don t know the type  you could get all the types and fields together using introspection like        schema       types         name       fields           name         description                       NOTE  this is the over-the-wire GraphQL data -- you re on your own to figure out how to read and write with your actual client   Your graphQL javascript library may already employ introspection in some capacity  for example the apollo codegen command uses introspection to generate types

User · Answer

Unfortunately what you d like to do is not possible  GraphQL requires you to be explicit about specifying which fields you would like returned from your query

User · Answer

I guess the only way to do this is by utilizing reusable fragments   fragment UserFragment on Users       id     username     count     FetchUsers       users id   2                UserFragment

User · Answer

Package graphql-type-json supports custom-scalars type JSON  Use it can show all the field of your json objects  Here is the link of the example in ApolloGraphql Server  https   www apollographql com docs apollo-server schema scalars-enums  custom-scalars

User · Answer

I faced this same issue when I needed to load location data that I had serialized into the database from the google places API  Generally I would want the whole thing so it works with maps but I didn t want to have to specify all of the fields every time   I was working in Ruby so I can t give you the PHP implementation but the principle should be the same   I defined a custom scalar type called JSON which just returns a literal JSON object   The ruby implementation was like so  using graphql-ruby   module Graph   module Types     JsonType   GraphQL  ScalarType define do       name  JSON        coerce input - gt   x    x         coerce result - gt   x    x       end   end end   Then I used it for our objects like so  field  location  Types  JsonType   I would use this very sparingly though  using it only where you know you always need the whole JSON object  as I did in my case   Otherwise it is defeating the object of GraphQL more generally speaking

[php] How to query all the GraphQL type fields without writing a long query?

Examples related to php

Examples related to laravel

Examples related to graphql

Examples related to graphql-php