Module: ElasticGraph

Defined in:
elasticgraph-apollo/lib/elastic_graph/apollo/graphql/engine_extension.rb,
elasticgraph-admin_lambda/lib/elastic_graph/admin_lambda.rb,
elasticgraph-admin_lambda/lib/elastic_graph/admin_lambda/rake_adapter.rb,
elasticgraph-admin_lambda/lib/elastic_graph/admin_lambda/lambda_function.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/graphql/service_field_resolver.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/graphql/entities_field_resolver.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/graphql/http_endpoint_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/api_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/field_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/state_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/apollo_directives.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/factory_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/argument_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/enum_type_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/enum_value_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/input_type_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/union_type_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/entity_type_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/object_type_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/scalar_type_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/interface_type_extension.rb,
elasticgraph-apollo/lib/elastic_graph/apollo/schema_definition/graphql_sdl_enumerator_extension.rb,
elasticgraph-elasticsearch/lib/elastic_graph/elasticsearch/client.rb,
elasticgraph-graphql_lambda/lib/elastic_graph/graphql_lambda.rb,
elasticgraph-graphql_lambda/lib/elastic_graph/graphql_lambda/lambda_function.rb,
elasticgraph-graphql_lambda/lib/elastic_graph/graphql_lambda/graphql_endpoint.rb,
elasticgraph-indexer_autoscaler_lambda/lib/elastic_graph/indexer_autoscaler_lambda.rb,
elasticgraph-indexer_autoscaler_lambda/lib/elastic_graph/indexer_autoscaler_lambda/details_logger.rb,
elasticgraph-indexer_autoscaler_lambda/lib/elastic_graph/indexer_autoscaler_lambda/lambda_function.rb,
elasticgraph-indexer_autoscaler_lambda/lib/elastic_graph/indexer_autoscaler_lambda/concurrency_scaler.rb,
elasticgraph-indexer_lambda/lib/elastic_graph/indexer_lambda.rb,
elasticgraph-indexer_lambda/lib/elastic_graph/indexer_lambda/sqs_processor.rb,
elasticgraph-indexer_lambda/lib/elastic_graph/indexer_lambda/lambda_function.rb,
elasticgraph-json_schema/lib/elastic_graph/json_schema/validator.rb,
elasticgraph-json_schema/lib/elastic_graph/json_schema/validator_factory.rb,
elasticgraph-json_schema/lib/elastic_graph/json_schema/meta_schema_validator.rb,
elasticgraph-local/lib/elastic_graph/local/rake_tasks.rb,
elasticgraph-local/lib/elastic_graph/local/docker_runner.rb,
elasticgraph-local/lib/elastic_graph/local/local_indexer.rb,
elasticgraph-local/lib/elastic_graph/local/indexing_coordinator.rb,
elasticgraph-opensearch/lib/elastic_graph/opensearch/client.rb,
elasticgraph-rack/lib/elastic_graph/rack.rb,
elasticgraph-rack/lib/elastic_graph/rack/graphiql.rb,
elasticgraph-rack/lib/elastic_graph/rack/graphql_endpoint.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/state.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/factory.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/results.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/rake_tasks.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/test_support.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/field.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/index.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/scripting/script.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/json_schema_pruner.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/has_indices.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/has_subtypes.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/has_type_info.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/has_directives.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/field.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/event_envelope.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_artifact_manager.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/field_reference.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/field_type/enum.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/rollover_config.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/has_documentation.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/argument.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/field_type/union.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/directive.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/enum_type.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/field_type/object.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/field_type/scalar.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/can_be_graphql_only.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/enum_value.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/field_path.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/input_type.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/type_namer.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/union_type.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/input_field.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/object_type.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/scalar_type.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/list_counts_mapping.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/implements_interfaces.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/verifies_graphql_name.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/field_source.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/relationship.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/derived_indexed_type.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/supports_default_value.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/relationship_resolver.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/update_target_factory.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/built_in_types.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/interface_type.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/type_reference.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/update_target_resolver.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/enum_value_namer.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/scripting/file_system_repository.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/list_counts_state.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/json_schema_with_metadata.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/deprecated_element.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/json_schema_field_metadata.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/type_with_subfields.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/sub_aggregation_path.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/sort_order_enum_value.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/graphql_sdl_enumerator.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/derived_fields/append_only_set.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/derived_fields/immutable_value.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/schema_elements/enums_for_indexed_types.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/derived_fields/min_or_max_value.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/supports_filtering_and_aggregation.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/mixins/has_derived_graphql_type_customizations.rb,
elasticgraph-schema_definition/lib/elastic_graph/schema_definition/indexing/derived_fields/field_initializer_support.rb,
elasticgraph-support/lib/elastic_graph/errors.rb,
elasticgraph-support/lib/elastic_graph/version.rb,
elasticgraph-support/lib/elastic_graph/constants.rb,
elasticgraph-support/lib/elastic_graph/support/logger.rb,
elasticgraph-support/lib/elastic_graph/support/time_set.rb,
elasticgraph-support/lib/elastic_graph/support/hash_util.rb,
elasticgraph-support/lib/elastic_graph/support/threading.rb,
elasticgraph-support/lib/elastic_graph/support/time_util.rb,
elasticgraph-support/lib/elastic_graph/support/from_yaml_file.rb,
elasticgraph-support/lib/elastic_graph/support/memoizable_data.rb,
elasticgraph-support/lib/elastic_graph/support/monotonic_clock.rb,
elasticgraph-support/lib/elastic_graph/support/untyped_encoder.rb,
elasticgraph-support/lib/elastic_graph/support/graphql_formatter.rb,
elasticgraph-support/lib/elastic_graph/support/faraday_middleware/support_timeouts.rb,
elasticgraph-support/lib/elastic_graph/support/faraday_middleware/msearch_using_get_instead_of_post.rb

Overview

Copyright 2024 Block, Inc.

Use of this source code is governed by an MIT-style license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

frozen_string_literal: true

Defined Under Namespace

Modules: Apollo, JSONSchema, Local, Rack, SchemaDefinition, Support

Constant Summary collapse

VERSION =

The version of all ElasticGraph gems.

"0.18.0.5"

Class Method Summary collapse

Class Method Details

.define_schema ⇒ Object

The main entry point for schema definition from ElasticGraph applications.

Call this API from a Ruby file configured as the path_to_schema (or from a Ruby file loaded from the path_to_schema file).

Examples:

ElasticGraph.define_schema do |schema|
  # The `schema` object provides the schema definition API. Use it in this block.
end


25
26
27
28
29
30
31
32
 
# File 'elasticgraph-schema_definition/lib/elastic_graph/schema_definition/api.rb', line 25

def self.define_schema
  if (api_instance = ::Thread.current[:ElasticGraph_SchemaDefinition_API_instance])
    yield api_instance
  else
    raise Errors::SchemaError, "No active `SchemaDefinition::API` instance is available. " \
      "Let ElasticGraph load the schema definition files."
  end
end