CODEWITHSUNDEEP
graphqlgraphql-js
Rafael Sedrakyan
Rafael Sedrakyan

Reputation: 2629

How to query list of objects with array as an argument in GraphQL

I'm trying to query a list of objects having array of IDs. Something similar to following SQL query:

SELECT name FROM events WHERE id IN(1,2,3,...);

How do I achieve this in GraphQL?

Upvotes: 66

Views: 129097

Answers (3)

Félix Paradis
Félix Paradis

Reputation: 6011

I just do this:

query nameOfYourQuery {
  allEvents(filter: { id: { in: [1,2,3] } }) {
    nodes {
      name
    }
  }
}

If the array is a variable, then it would look like this (in Gatsby, at least):

query nameOfYourQuery($arrayOfID: [String]) {
  allEvents(filter: { id: { in: $arrayOfID: [String] } }) {
    nodes {
      name
    }
  }
}

Upvotes: 1

Gabriel Borges Oliveira
Gabriel Borges Oliveira

Reputation: 557

In my use case I did as:

query:

vehicleTypes: { name: ["Small", "Minivan"] }

input:

vehicleTypes: VehicleTypesInput

then use like this:

Input VehicleTypesInput {
    name: [String]!
}

Upvotes: 0

browserless
browserless

Reputation: 2132

You can definitely query with an array of values! Here's what the query itself would look like:

{
  events(containsId: [1,2,3]) {
    ...
  }
}

And the type would look something like:

const eventsType = new GraphQLObjectType({
  name: 'events',
  type: // your type definition for events,
  args: {
    containsId: new GraphQLList(GraphQLID)
  },
  ...
});

If you wanted to parameterize this query, here's an example of that:

{
  query: `
    query events ($containsId: [Int]) {
      events(containsId: $containsId) {
        id
        name
      }
    }
  `,
  variables: {
    containsId: [1,2,3]
  }
}

Upvotes: 78

Related Questions