Module: ElasticGraph::SchemaArtifacts

Extended by:
Support::FromYamlFile
Defined in:
lib/elastic_graph/schema_artifacts.rb,
lib/elastic_graph/schema_artifacts/from_disk.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/enum.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/params.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/schema.rb,
lib/elastic_graph/schema_artifacts/artifacts_helper_methods.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/relation.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/extension.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/sort_field.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/hash_dumper.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/index_field.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/object_type.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/scalar_type.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/graphql_field.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/update_target.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/extension_loader.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/graphql_resolver.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/index_definition.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/graphql_extension.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/computation_detail.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/interface_verifier.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/schema_element_names.rb,
lib/elastic_graph/schema_artifacts/runtime_metadata/configured_graphql_resolver.rb

Overview

Namespace for all code related to ElasticGraph schema artifacts. Schema artifacts are generated by SchemaDefinition and dumped to disk. Later, they are used to power ElasticGraph.

Defined Under Namespace

Modules: ArtifactsHelperMethods, RuntimeMetadata Classes: FromDisk

Constant Summary collapse

Config = 
Support::Config.define(:directory) do
  # @implements Config
  json_schema at: "schema_artifacts",
    optional: false,
    description: "Configuration for schema artifact management used by all parts of ElasticGraph.",
    properties: {
      directory: {
        description: "Path to the directory where schema artifacts are stored.",
        examples: ["config/schema/artifacts"],
        default: "config/schema/artifacts",
        type: "string",
        minLength: 1
      }
    }
end

Class Method Summary collapse

Class Method Details

.from_parsed_yaml(parsed_yaml) ⇒ FromDisk

Builds a ‘SchemaArtifacts::FromDisk` instance using the provided YAML settings.

Parameters:

  • parsed_yaml (Hash<String, Object>) —

    hash parsed from a settings YAML file

Returns:



25
26
27
28
 
# File 'lib/elastic_graph/schema_artifacts.rb', line 25

def self.from_parsed_yaml(parsed_yaml)
  config = Config.from_parsed_yaml(parsed_yaml) || Config.new
  FromDisk.new(config.directory)
end