Class: ElasticGraph::SchemaDefinition::API

Inherits:
Object
  • Object
show all
Defined in:
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb

Overview

Root API object that provides the schema definition API.

Examples:

ElasticGraph.define_schema do |schema|
  # The `schema` object is an instance of `API`
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#factory ⇒ Factory (readonly)

Returns object responsible for instantiating all schema element classes.

Returns:

  • (Factory) —

    object responsible for instantiating all schema element classes



56
57
58
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 56

def factory
  @factory
end

#state ⇒ State (readonly)

Returns object which holds all state for the schema definition.

Returns:

  • (State) —

    object which holds all state for the schema definition



53
54
55
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 53

def state
  @state
end

Instance Method Details

#deleted_type(name) ⇒ void

Note:

In situations where this API applies, ElasticGraph will give you an error message indicating that you need to use this API or SchemaElements::TypeWithSubfields#renamed_from. Likewise, when ElasticGraph no longer needs to know about this, it'll give you a warning indicating the call to this method can be removed.

This method returns an undefined value.

Registers the name of a type that existed in a prior version of the schema but has been deleted.

Examples:

Indicate that Widget has been deleted

ElasticGraph.define_schema do |schema|
  schema.deleted_type "Widget"
end

Parameters:

  • name (String) —

    name of type that used to exist but has been deleted



274
275
276
277
278
279
280
281
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 274

def deleted_type(name)
  @state.register_deleted_type(
    name,
    defined_at: caller_locations(1, 1).to_a.first, # : ::Thread::Backtrace::Location
    defined_via: %(schema.deleted_type "#{name}")
  )
  nil
end

#enum_type(name) {|SchemaElements::EnumType| ... } ⇒ void

This method returns an undefined value.

Defines a GraphQL enum type. The type is restricted to an enumerated set of values, each with a unique name. Use value or values to define the enum values in the passed block.

Note: if required by your configuration, this may generate a pair of Enum types (an input enum and an output enum).

Examples:

Define an enum type

ElasticGraph.define_schema do |schema|
  schema.enum_type "Currency" do |t|
    t.value "USD" do |v|
      v.documentation "US Dollars."
    end

    t.value "JPY" do |v|
      v.documentation "Japanese Yen."
    end

    # You can define multiple values in one call if you don't care about their docs or directives.
    t.values "GBP", "AUD"
  end
end

Parameters:

  • name (String) —

    name of the enum type

Yields:



202
203
204
205
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 202

def enum_type(name, &block)
  @state.register_enum_type @factory.new_enum_type(name.to_s, &block)
  nil
end

#interface_type(name) {|SchemaElements::InterfaceType| ... } ⇒ void

Note:

An interface type can declare an index with Mixins::HasIndices#index. This creates a mixed-type index in the datastore where concrete types that implement the interface coexist. A subtype may opt out of this shared index inheritance and use a dedicated index by declaring its own with Mixins::HasIndices#index.

This method returns an undefined value.

Defines a GraphQL interface. Use it to define an abstract supertype with one or more fields that concrete implementations of the interface must also define. Each implementation can be an SchemaElements::ObjectType or SchemaElements::InterfaceType.

Examples:

Define an interface and implement it

ElasticGraph.define_schema do |schema|
  schema.interface_type "Athlete" do |t|
    t.field "name", "String"
    t.field "team", "String"
  end

  schema.object_type "BaseballPlayer" do |t|
    t.implements "Athlete"
    t.field "name", "String"
    t.field "team", "String"
    t.field "battingAvg", "Float"
  end

  schema.object_type "BasketballPlayer" do |t|
    t.implements "Athlete"
    t.field "name", "String"
    t.field "team", "String"
    t.field "pointsPerGame", "Float"
  end
end

Parameters:

  • name (String) —

    name of the interface

Yields:



171
172
173
174
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 171

def interface_type(name, &block)
  @state.register_object_interface_or_union_type @factory.new_interface_type(name.to_s, &block)
  nil
end

#json_schema_strictness(allow_omitted_fields: false, allow_extra_fields: true) ⇒ void

Note:

If you allow both omitted fields and extra fields, ElasticGraph's JSON schema validation will allow (and ignore) misspelled field names in indexing events. For example, if the ElasticGraph schema has a nullable field named parentId but the publisher accidentally provides it as parent_id, ElasticGraph would happily ignore the parent_id field entirely, because parentId is allowed to be omitted and parent_id would be treated as an extra field. Therefore, we recommend that you only set one of these to true (or none).

This method returns an undefined value.

Defines strictness of the JSON schema validation. By default, the JSON schema will require all fields to be provided by the publisher (but they can be nullable) and will ignore extra fields that are not defined in the schema. Use this method to configure this behavior.

Examples:

Allow omitted fields and disallow extra fields

ElasticGraph.define_schema do |schema|
  schema.json_schema_strictness allow_omitted_fields: true, allow_extra_fields: false
end

Parameters:

  • allow_omitted_fields (bool) (defaults to: false) —

    Whether nullable fields can be omitted from indexing events.

  • allow_extra_fields (bool) (defaults to: true) —

    Whether extra fields (e.g. beyond fields defined in the schema) can be included in indexing events.



461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 461

def json_schema_strictness(allow_omitted_fields: false, allow_extra_fields: true)
  unless [true, false].include?(allow_omitted_fields)
    raise Errors::SchemaError, "`allow_omitted_fields` must be true or false"
  end

  unless [true, false].include?(allow_extra_fields)
    raise Errors::SchemaError, "`allow_extra_fields` must be true or false"
  end

  @state.allow_omitted_json_schema_fields = allow_omitted_fields
  @state.allow_extra_json_schema_fields = allow_extra_fields
  nil
end

#json_schema_version(version) ⇒ void

Note:

While this is an important part of how ElasticGraph is designed to support schema evolution, it can be annoying constantly have to increment this while rapidly changing the schema during prototyping. You can disable the requirement to increment this on every JSON schema change by setting enforce_json_schema_version to false in your Rakefile.

This method returns an undefined value.

Defines the version number of the current JSON schema. Importantly, every time a change is made that impacts the JSON schema artifact, the version number must be incremented to ensure that each different version of the JSON schema is identified by a unique version number. The publisher will then include this version number in published events to identify the version of the schema it was using. This avoids the need to deploy the publisher and ElasticGraph indexer at the same time to keep them in sync.

Examples:

Set the JSON schema version to 1

ElasticGraph.define_schema do |schema|
  schema.json_schema_version 1
end

Parameters:

  • version (Integer) —

    current version number of the JSON schema artifact

See Also:



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 429

def json_schema_version(version)
  if !version.is_a?(Integer) || version < 1
    raise Errors::SchemaError, "`json_schema_version` must be a positive integer. Specified version: #{version}"
  end

  if @state.json_schema_version
    raise Errors::SchemaError, "`json_schema_version` can only be set once on a schema. Previously-set version: #{@state.json_schema_version}"
  end

  @state.json_schema_version = version
  @state.json_schema_version_setter_location = caller_locations(1, 1).to_a.first
  nil
end

#object_type(name) {|SchemaElements::ObjectType| ... } ⇒ void

This method returns an undefined value.

Defines a GraphQL object type Use it to define a concrete type that has subfields. Object types can either be indexed (e.g. directly indexed in the datastore, and available to query from the root Query object) or embedded in other indexed types.

Examples:

Define embedded and indexed object types

ElasticGraph.define_schema do |schema|
  # `Money` is an embedded object type
  schema.object_type "Money" do |t|
    t.field "currency", "String"
    t.field "amount", "JsonSafeLong"
  end

  # `Transaction` is an indexed object type
  schema.object_type "Transaction" do |t|
    t.root_query_fields plural: "transactions"
    t.field "id", "ID"
    t.field "cost", "Money"
    t.index "transactions"
  end
end

Parameters:

  • name (String) —

    name of the object type

Yields:



133
134
135
136
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 133

def object_type(name, &block)
  @state.register_object_interface_or_union_type @factory.new_object_type(name.to_s, &block)
  nil
end

#on_built_in_types {|SchemaElements::EnumType, SchemaElements::InputType, SchemaElements::InterfaceType, SchemaElements::ObjectType, SchemaElements::ScalarType, SchemaElements::UnionType| ... } ⇒ void

This method returns an undefined value.

Registers a customization callback that will be applied to every built-in type automatically provided by ElasticGraph. Provides an opportunity to customize the built-in types (e.g. to add directives to them or whatever).

Examples:

Customize documentation of built-in types

ElasticGraph.define_schema do |schema|
  schema.on_built_in_types do |type|
    type.append_to_documentation "This is a built-in ElasticGraph type."
  end
end

Yields:



487
488
489
490
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 487

def on_built_in_types(&customization_block)
  @state.built_in_types_customization_blocks << customization_block
  nil
end

#on_root_query_type {|SchemaElements::ObjectType| ... } ⇒ void

This method returns an undefined value.

Registers a customization callback that will be applied to the root Query type when it is generated.

Examples:

Customize documentation of built-in types

ElasticGraph.define_schema do |schema|
  schema.on_root_query_type do |type|
    type.append_to_documentation "This schema has been generated by ElasticGraph."
  end
end

Yields:



503
504
505
506
507
508
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 503

def on_root_query_type(&customization_block)
  on_built_in_types do |type|
    customization_block.call(_ = type) if type.name == "Query"
  end
  nil
end

#raw_sdl(string) ⇒ void

This method returns an undefined value.

Defines a raw GraphQL SDL snippet that will be included in the generated schema.graphql artifact. Designed to be an escape hatch, for when ElasticGraph doesn’t provide another way to write some type of GraphQL SDL element that you need. Currently, the only known use case is to define custom GraphQL directives.

Examples:

Define a custom directive and use it

ElasticGraph.define_schema do |schema|
  # Define a directive we can use to annotate what system a data type comes from.
  schema.raw_sdl "directive @sourcedFrom(system: String!) on OBJECT"

  schema.object_type "Transaction" do |t|
    t.directive "sourcedFrom", system: "transaction-processor"
  end
end

Parameters:

  • string (String) —

    Raw snippet of SDL



104
105
106
107
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 104

def raw_sdl(string)
  @state.sdl_parts << string
  nil
end

#register_graphql_extension(extension_module, defined_at:, **config) ⇒ void

This method returns an undefined value.

Registers a GraphQL extension module that will be loaded and used by elasticgraph-graphql. While such extension modules can also be configured in a settings YAML file, it can be useful to register it here when you want to ensure that the extension is used in all environments. For example, an extension library that defines custom schema elements (such as elasticgraph-apollo) may need to ensure its corresponding GraphQL extension module is used since the custom schema elements would not work correctly otherwise.

Examples:

Register elasticgraph-query_registry extension module

require(query_registry_require_path = "elastic_graph/query_registry/graphql_extension")

ElasticGraph.define_schema do |schema|
  schema.register_graphql_extension ElasticGraph::QueryRegistry::GraphQLExtension,
    defined_at: query_registry_require_path
end

Parameters:

  • extension_module (Module) —

    GraphQL extension module

  • defined_at (String) —

    the require path of the extension module

  • config (Hash<Symbol, Object>) —

    configuration options for the extension module



301
302
303
304
305
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 301

def register_graphql_extension(extension_module, defined_at:, **config)
  extension = SchemaArtifacts::RuntimeMetadata::Extension.new(extension_module, defined_at, config)
  @state.graphql_extension_modules << SchemaArtifacts::RuntimeMetadata::GraphQLExtension.new(extension.to_dumpable_hash)
  nil
end

#register_graphql_resolver(name, klass, defined_at:, built_in: false, **resolver_config) ⇒ void

This method returns an undefined value.

Registers a GraphQL resolver that will be loaded and used by elasticgraph-graphql. To use a GraphQL resolver you have registered, set a field's resolver to the name you provide when registering your resolver.

Examples:

Register a custom resolver for use by a custom Query field

# In `add_resolver.rb`:
class AddResolver
  def initialize(elasticgraph_graphql:, config:)
    @multiplier = config.fetch(:multiplier, 1)
  end

  def resolve(field:, object:, args:, context:)
    sum = args.fetch("x") + args.fetch("y")
    sum * @multiplier
  end
end

# In `config/schema.rb`:
ElasticGraph.define_schema do |schema|
  require(resolver_path = "add_resolver")
  schema.register_graphql_resolver :add,
    AddResolver,
    defined_at: resolver_path,
    multiplier: 2 # extra args are passed to the resolver within `config`.

  schema.on_root_query_type do |t|
    t.field "add", "Int" do |f|
      f.argument "x", "Int!"
      f.argument "y", "Int!"
      f.resolve_with :add
    end
  end
end

Register a custom resolver that uses lookahead


# In `artist_resolver.rb`:
class ArtistResolver
  def initialize(elasticgraph_graphql:, config:)
  end

  def resolve(field:, object:, args:, context:, lookahead:)
    # The extra `lookahead` argument can be used to see what child fields are selected.
    # See https://graphql-ruby.org/queries/lookahead.html for details.
    #
    # Note: there is overhead involved in providing the `lookahead`, so it's best to not
    # request it (by defining it as one of the `resolve` arguments) unless it's really needed.
  end
end

# In `config/schema.rb`:
ElasticGraph.define_schema do |schema|
  require(resolver_path = "artist_resolver")
  schema.register_graphql_resolver :artist, ArtistResolver, defined_at: resolver_path

  schema.object_type "Artist" do |t|
    t.field "name", "String"
    # ...
  end

  schema.on_root_query_type do |t|
    t.field "artist", "Artist" do |f|
      f.resolve_with :artist
    end
  end
end

Parameters:

  • name (Symbol) —

    unique name of the resolver

  • klass (Class) —

    resolver class

  • defined_at (String) —

    the require path of the resolver

  • built_in (bool) (defaults to: false) —

    Whether this resolver is built-in to ElasticGraph or one of its extensions. Built-in resolvers that are unused in a schema will not trigger a warning.

  • resolver_config (Hash<Symbol, Object>) —

    configuration options for the resolver, to support parameterized resolvers

See Also:



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 382

def register_graphql_resolver(name, klass, defined_at:, built_in: false, **resolver_config)
  extension = SchemaArtifacts::RuntimeMetadata::Extension.new(klass, defined_at, resolver_config)

  needs_lookahead =
    if extension.verify_against(SchemaArtifacts::RuntimeMetadata::GraphQLResolver::InterfaceWithLookahead).empty?
      true
    else
      extension.verify_against!(SchemaArtifacts::RuntimeMetadata::GraphQLResolver::InterfaceWithoutLookahead)
      false
    end

  resolver = SchemaArtifacts::RuntimeMetadata::GraphQLResolver.new(
    needs_lookahead: needs_lookahead,
    resolver_ref: extension.to_dumpable_hash
  )

  @state.graphql_resolvers_by_name[name] = resolver
  if built_in
    @state.built_in_graphql_resolvers << name
  else
    @state.built_in_graphql_resolvers.delete(name)
  end
  nil
end

#results ⇒ Object

Returns the results of the schema definition.

Returns:

  • the results of the schema definition



408
409
410
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 408

def results
  @results ||= @factory.new_results
end

#scalar_type(name) {|SchemaElements::ScalarType| ... } ⇒ void

This method returns an undefined value.

Defines a GraphQL scalar type. ElasticGraph itself uses this to define a few common scalar types (e.g. Date and DateTime), but it is also available to you to use to define your own custom scalar types.

Examples:

Define a scalar type

ElasticGraph.define_schema do |schema|
  schema.scalar_type "URL" do |t|
    t.mapping type: "keyword"
    t.json_schema type: "string", format: "uri"
  end
end

Parameters:

  • name (String) —

    name of the scalar type

Yields:



256
257
258
259
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 256

def scalar_type(name, &block)
  @state.register_scalar_type @factory.new_scalar_type(name.to_s, &block)
  nil
end

#union_type(name) {|SchemaElements::UnionType| ... } ⇒ void

Note:

A union type can declare an index with Mixins::HasIndices#index. This creates a mixed-type index in the datastore where the union members coexist. A subtype may opt out of this shared index inheritance and use a dedicated index by declaring its own with Mixins::HasIndices#index.

This method returns an undefined value.

Defines a GraphQL union type. Use it to define an abstract supertype with one or more concrete subtypes. Each subtype must be an SchemaElements::ObjectType, but they do not have to share any fields in common.

Examples:

Define a union type

ElasticGraph.define_schema do |schema|
  schema.object_type "Card" do |t|
    # ...
  end

  schema.object_type "BankAccount" do |t|
    # ...
  end

  schema.object_type "BitcoinWallet" do |t|
    # ...
  end

  schema.union_type "FundingSource" do |t|
    t.subtype "Card"
    t.subtypes "BankAccount", "BitcoinWallet"
  end
end

Parameters:

  • name (String) —

    name of the union type

Yields:



237
238
239
240
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 237

def union_type(name, &block)
  @state.register_object_interface_or_union_type @factory.new_union_type(name.to_s, &block)
  nil
end