Struct representation of a GraphQL query or mutation.

If you need to build documents or fragments manually, you can use this methods.

Example

  # Fragments
iex> fragment = GraphqlQuery.Document.new("fragment UserFields on User { id name }", name: "UserFields", type: :fragment)
iex> fragment.__struct__ == GraphqlQuery.Fragment
true
iex> fragment.name
"UserFields"
iex> fragment.name
"UserFields"
iex> fragment.fragment
"fragment UserFields on User { id name }"

# Queries
iex> fragment = GraphqlQuery.Document.new("fragment UserFields on User { id name }", name: "UserFields", type: :fragment)
iex> query = GraphqlQuery.Document.new("query { user { ...UserFields } }", fragments: [fragment])
iex> query.query
"query { user { ...UserFields } }"

# Schemas
iex> schema = GraphqlQuery.Document.new("schema { query: Query }", type: :schema)
iex> schema.query
"schema { query: Query }"
iex> schema.type
:schema

# Manupilate the documents
iex> query = GraphqlQuery.Document.new("query U(userId: ID!) { user(id: $userId) { ...UserFragment } }")
iex> query = GraphqlQuery.Document.add_variable(query, :userId, 1)
iex> query.variables
%{userId: 1}
iex> query = GraphqlQuery.Document.add_variables(query, [userId: 2, anotherVar: "test"])
iex> query.variables
%{userId: 2, anotherVar: "test"}
iex> fragment = GraphqlQuery.Document.new("fragment UserFields on User { id name }", name: "UserFields", type: :fragment)
iex> query = GraphqlQuery.Document.add_fragment(query, fragment)
iex> query.fragments == [fragment]
true
iex> query = GraphqlQuery.Document.add_fragments(query, [fragment])
iex> query.fragments == [fragment]
true
iex> query = GraphqlQuery.Document.set_schema(query, MyApp.Schema)
iex> query.schema
MyApp.Schema

# Convert to string or encode as JSON
iex> fragment = GraphqlQuery.Document.new("fragment UserFragment on User { id name }", name: "UserFragment", type: :fragment)
iex> query = GraphqlQuery.Document.new("query User(userId: ID!) { user(id: $userId) { ...UserFragment } }", fragments: [fragment])
iex> query = GraphqlQuery.Document.add_variable(query, :userId, 1)
iex> to_string(query)   # String representation
"query User(userId: ID!) { user(id: $userId) { ...UserFragment } }\nfragment UserFragment on User { id name }"
iex> query |> Jason.encode!() |> Jason.decode!()   # JSON encoding (works with Jason and JSON libraries)
%{"query" => "query User(userId: ID!) { user(id: $userId) { ...UserFragment } }\nfragment UserFragment on User { id name }", "variables" => %{"userId" => 1}}