graphene_elastic package

Subpackages

• graphene_elastic.filter_backends package
  • Subpackages
    • graphene_elastic.filter_backends.faceted_search package
      • Submodules
      • graphene_elastic.filter_backends.faceted_search.common module
      • Module contents
    • graphene_elastic.filter_backends.filtering package
      • Submodules
      • graphene_elastic.filter_backends.filtering.common module
      • graphene_elastic.filter_backends.filtering.mixins module
      • graphene_elastic.filter_backends.filtering.queries module
      • Module contents
    • graphene_elastic.filter_backends.highlight package
      • Submodules
      • graphene_elastic.filter_backends.highlight.common module
      • Module contents
    • graphene_elastic.filter_backends.ordering package
      • Submodules
      • graphene_elastic.filter_backends.ordering.common module
      • Module contents
    • graphene_elastic.filter_backends.post_filter package
      • Submodules
      • graphene_elastic.filter_backends.post_filter.common module
      • Module contents
    • graphene_elastic.filter_backends.score package
      • Submodules
      • graphene_elastic.filter_backends.score.common module
      • Module contents
    • graphene_elastic.filter_backends.search package
      • Submodules
      • graphene_elastic.filter_backends.search.common module
      • graphene_elastic.filter_backends.search.query_string module
      • graphene_elastic.filter_backends.search.simple_query_string module
      • Module contents
    • graphene_elastic.filter_backends.source package
      • Submodules
      • graphene_elastic.filter_backends.source.common module
      • Module contents
  • Submodules
  • graphene_elastic.filter_backends.base module
  • graphene_elastic.filter_backends.queries module
  • Module contents
• graphene_elastic.relay package
  • Submodules
  • graphene_elastic.relay.connection module
  • graphene_elastic.relay.connectiontypes module
  • Module contents
• graphene_elastic.tests package
  • Submodules
  • graphene_elastic.tests.base module
  • graphene_elastic.tests.test_faceted_search_backend module
  • graphene_elastic.tests.test_filter_backend module
  • graphene_elastic.tests.test_highlight_backend module
  • graphene_elastic.tests.test_ordering_backend module
  • graphene_elastic.tests.test_pagination module
  • graphene_elastic.tests.test_post_filter_backend module
  • graphene_elastic.tests.test_query_string_backend module
  • graphene_elastic.tests.test_score_backend module
  • graphene_elastic.tests.test_search_backend module
  • graphene_elastic.tests.test_simple_query_string_backend module
  • graphene_elastic.tests.test_source_backend module
  • graphene_elastic.tests.test_versions module
  • Module contents
• graphene_elastic.types package
  • Submodules
  • graphene_elastic.types.elastic_types module
  • graphene_elastic.types.json_string module
  • Module contents

Submodules

graphene_elastic.advanced_types module

class graphene_elastic.advanced_types.FileFieldType(*args, **kwargs)

Bases: ObjectType

chunk_size = <graphene.types.scalars.Int object>

content_type = <graphene.types.scalars.String object>

data = <graphene.types.scalars.String object>

length = <graphene.types.scalars.Int object>

md5 = <graphene.types.scalars.String object>

resolve_chunk_size(info)

resolve_content_type(info)

resolve_data(info)

resolve_length(info)

resolve_md5(info)

class graphene_elastic.advanced_types.MultiPolygonFieldType(*args, **kwargs)

Bases: _CoordinatesTypeField

coordinates = <graphene.types.structures.List object>

class graphene_elastic.advanced_types.PointFieldType(*args, **kwargs)

Bases: _CoordinatesTypeField

coordinates = <graphene.types.structures.List object>

class graphene_elastic.advanced_types.PolygonFieldType(*args, **kwargs)

Bases: _CoordinatesTypeField

coordinates = <graphene.types.structures.List object>

graphene_elastic.arrayconnection module

graphene_elastic.arrayconnection.connection_from_list_slice(list_slice, args=None, connection_type=None, edge_type=None, pageinfo_type=None, slice_start=0, list_length=0, list_slice_length=None, connection_field=None)

Given a slice (subset) of an array, returns a connection object for use in GraphQL. This function is similar to connectionFromArray, but is intended for use cases where you know the cardinality of the connection, consider it too large to materialize the entire array, and instead wish pass in a slice of the total result large enough to cover the range specified in args.

graphene_elastic.compat module

graphene_elastic.constants module

Constants module. Contains Elasticsearch constants, lookup constants, functional constants, suggesters, etc.

graphene_elastic.converter module

exception graphene_elastic.converter.ElasticsearchConversionError

Bases: Exception

graphene_elastic.converter.convert_elasticsearch_field(field, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Keyword, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Text, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Short, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Long, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Integer, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Byte, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Boolean, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: ScaledFloat, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Float, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: HalfFloat, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Double, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Date, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Nested, registry=None)

graphene_elastic.converter.convert_elasticsearch_field(field: Object, registry=None)

graphene_elastic.converter.convert_field_to_boolean(field, registry=None)

graphene_elastic.converter.convert_field_to_complex_object(field, registry=None)

graphene_elastic.converter.convert_field_to_datetime(field, registry=None)

graphene_elastic.converter.convert_field_to_float(field, registry=None)

graphene_elastic.converter.convert_field_to_int(field, registry=None)

graphene_elastic.converter.convert_field_to_jsonstring(field, registry=None)

graphene_elastic.converter.convert_field_to_string(field, registry=None)

graphene_elastic.converter.singledispatch(func)

Single-dispatch generic function decorator.

Transforms a function into a generic function, which can have different behaviours depending upon the type of its first argument. The decorated function acts as the default implementation, and additional implementations can be registered using the register() attribute of the generic function.

graphene_elastic.enums module

class graphene_elastic.enums.NoValue(value)

Bases: Enum

String values in enum.

Example:

>>> class Color(NoValue):
>>>     RED = 'stop'
>>>     GREEN = 'go'
>>>     BLUE = 'too fast!'

Graphene example:

>>> @graphene.Enum.from_enum
>>> class ColorOptions(NoValue):
>>>
>>>     RED = 'stop'
>>>     GREEN = 'go'
>>>     BLUE = 'too fast!'

graphene_elastic.enums.convert_list_to_enum(values, enum_name='DynamicEnum', upper=True)

Prepare list values for creating an Enum.

Example:

>>> values = ['red', 'green', 'blue']
>>> print(prepare_list_for_enum(values))
{'RED': 'red', 'GREEN': 'green', 'BLUE': 'blue'}

graphene_elastic.fields module

class graphene_elastic.fields.ElasticsearchConnectionField(type, *args, **kwargs)

Bases: IterableConnectionField

property args

chained_resolver(resolver, is_partial, root, info, **args)

classmethod connection_resolver(resolver, connection_type, root, info, connection_field=None, **args)

property default_filter_backends

default_resolver(_root, info, **args)

property doc_type

property document

property field_args

property fields

property filter_backends

get_queryset(document, info, **args)

get_resolver(parent_resolver)

property node_type

property reference_args

property registry

classmethod resolve_connection(connection_type, args, resolved, connection_field=None)

property type

graphene_elastic.logging module

graphene_elastic.registry module

class graphene_elastic.registry.Registry

Bases: object

get_converted_field(field)

get_type_for_document(document)

register(cls)

register_converted_field(field, converted)

graphene_elastic.registry.get_global_registry()

graphene_elastic.registry.reset_global_registry()

graphene_elastic.settings module

graphene_elastic.utils module

graphene_elastic.utils.get_document_fields(document, excluding=None)

graphene_elastic.utils.get_field_description(field, registry=None)

Common metadata includes verbose_name and help_text.

http://docs.mongoengine.org/apireference.html#fields

graphene_elastic.utils.get_node_from_global_id(node, info, global_id)

graphene_elastic.utils.get_type_for_document(schema, document)

graphene_elastic.utils.import_single_dispatch()

graphene_elastic.utils.is_valid_elasticsearch_document(document)

graphene_elastic.versions module

Contains information about the current Elasticsearch version in use, including (LTE and GTE).

graphene_elastic.versions.get_elasticsearch_version(default=(2, 0, 0))

Get Elasticsearch version.

Parameters:

default (tuple) – Default value. Mainly added for building the docs when Elasticsearch is not running.

Returns:

Return type:

list

Module contents

class graphene_elastic.ElasticsearchConnectionField(type, *args, **kwargs)

Bases: IterableConnectionField

property args

chained_resolver(resolver, is_partial, root, info, **args)

classmethod connection_resolver(resolver, connection_type, root, info, connection_field=None, **args)

property default_filter_backends

default_resolver(_root, info, **args)

property doc_type

property document

property field_args

property fields

property filter_backends

get_queryset(document, info, **args)

get_resolver(parent_resolver)

property node_type

property reference_args

property registry

classmethod resolve_connection(connection_type, args, resolved, connection_field=None)

property type

class graphene_elastic.ElasticsearchObjectType(*args, **kwargs)

Bases: ObjectType

classmethod get_node(info, id)

property id

classmethod is_type_of(root, info)

classmethod rescan_fields()

Attempts to rescan fields and will insert any not converted initially.

resolve_id(info)