Packages
ash_graphql
1.7.12
1.9.4
1.9.3
1.9.2
1.9.1
1.9.0
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.0
1.5.1
1.5.0
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-rc.5
1.0.0-rc.4
retired
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.28.1
0.28.0
0.27.1
0.27.0
0.26.9
0.26.8
0.26.7
0.26.6
0.26.5
0.26.4
0.26.3
0.26.2
0.26.0
0.25.13
0.25.12
0.25.10
0.25.9
0.25.8
0.25.7
0.25.6
0.25.5
0.25.4
0.25.3
0.25.2
0.25.1
0.25.0
0.24.1
0.24.0
0.23.3
0.23.2
0.23.1
0.23.0
0.22.13
0.22.12
0.22.11
0.22.10
0.22.9
0.22.8
0.22.7
0.22.6
0.22.4
0.22.3
0.22.2
0.22.1
0.22.0
0.21.0
retired
0.20.5
0.20.4
0.20.3
0.20.2
0.20.1
0.20.0-rc.3
0.20.0-rc.2
0.20.0-rc.1
0.20.0-rc.0
0.19.0
0.18.0-rc0
0.17.5
0.17.5-rc0
0.17.4
0.17.2
0.17.1
0.17.0
0.16.28
0.16.27
0.16.26
0.16.25
0.16.24
0.16.23
0.16.22
0.16.21
0.16.20
0.16.18-rc5
0.16.18-rc4
0.16.18-rc3
0.16.18-rc2
0.16.18-rc1
0.16.18-rc0
0.16.17
0.16.16
0.16.15
0.16.14
0.16.13
0.16.12
0.16.11
0.16.10
0.16.9
0.16.8
0.16.7
0.16.6
0.16.5
0.16.4
0.16.3
0.16.2
0.16.1
0.16.0
0.15.10
0.15.9
0.15.8
0.15.7
0.15.6
0.15.5
0.15.4
0.15.3
0.15.2
0.15.1
0.15.0
0.14.1
0.14.0
0.13.1
0.13.0
0.12.5
0.12.4
0.12.3
0.12.1
0.12.0
0.10.0
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.0
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.0
0.3.2
0.3.1
0.3.0
0.2.1
0.2.0
0.1.3
0.1.2
The extension for building GraphQL APIs with Ash
Current section
Files
Jump to
Current section
Files
lib/resource/query.ex
defmodule AshGraphql.Resource.Query do
@moduledoc "Represents a configured query on a resource"
defstruct [
:name,
:action,
:type,
:identity,
:allow_nil?,
:resource,
:modify_resolution,
:relay_id_translations,
:description,
:complexity,
as_mutation?: false,
hide_inputs: [],
metadata_names: [],
metadata_types: [],
paginate_with: :keyset,
show_metadata: nil,
type_name: nil,
relay?: false,
meta: []
]
@query_schema [
name: [
type: :atom,
doc: "The name to use for the query.",
default: :get
],
action: [
type: :atom,
doc: "The action to use for the query.",
required: true
],
type_name: [
type: :atom,
doc: """
Override the type name returned by this query. Must be set if the read action has `metadata` that is not hidden via the `show_metadata` key.
"""
],
description: [
type: :string,
doc:
"The query description that gets shown in the Graphql schema. If not provided, the action description will be used."
],
metadata_names: [
type: :keyword_list,
default: [],
doc: "Name overrides for metadata fields on the read action."
],
metadata_types: [
type: :keyword_list,
default: [],
doc: "Type overrides for metadata fields on the read action."
],
show_metadata: [
type: {:list, :atom},
doc: "The metadata attributes to show. Defaults to all."
],
as_mutation?: [
type: :boolean,
default: false,
doc: """
Places the query in the `mutations` key instead. Not typically necessary, but is often paired with `as_mutation?`. See the [the guide](/documentation/topics/modifying-the-resolution.html) for more.
"""
],
relay_id_translations: [
type: :keyword_list,
doc: """
A keyword list indicating arguments or attributes that have to be translated from global Relay IDs to internal IDs. See the [Relay guide](/documentation/topics/relay.md#translating-relay-global-ids-passed-as-arguments) for more.
""",
default: []
],
hide_inputs: [
type: {:list, :atom},
doc: "A list of inputs to hide from the mutation.",
default: []
],
complexity: [
type: :mod_arg,
doc: """
An {module, function} that will be called with the arguments and complexity value of the child fields query. It should return the complexity of this query.
""",
default: {AshGraphql.Graphql.Resolver, :query_complexity}
],
modify_resolution: [
type: :mfa,
doc: """
An MFA that will be called with the resolution, the query, and the result of the action as the first three arguments. See the [the guide](/documentation/topics/modifying-the-resolution.html) for more.
"""
],
meta: [
type: :keyword_list,
doc: "A keyword list of metadata for the query.",
default: []
]
]
@get_schema [
identity: [
type: :atom,
doc:
"The identity to use for looking up the record. Pass `false` to not use an identity.",
required: false
],
allow_nil?: [
type: :boolean,
default: true,
doc: "Whether or not the action can return nil."
]
]
|> Spark.Options.merge(@query_schema, "Shared Query Options")
@read_one_schema [
allow_nil?: [
type: :boolean,
default: true,
doc: "Whether or not the action can return nil."
]
]
|> Spark.Options.merge(@query_schema, "Shared Query Options")
@list_schema [
relay?: [
type: :boolean,
default: false,
doc: """
If true, the graphql queries/resolvers for this resource will be built to honor the relay specification. See [the relay guide](/documentation/topics/relay.html) for more.
"""
],
paginate_with: [
type: {:one_of, [:keyset, :offset, nil]},
default: :keyset,
doc: """
Determine the pagination strategy to use, if multiple are available. If `nil`, no pagination is applied, otherwise the given strategy is used.
"""
]
]
|> Spark.Options.merge(@query_schema, "Shared Query Options")
def get_schema, do: @get_schema
def read_one_schema, do: @read_one_schema
def list_schema, do: @list_schema
end