Models

class elasticgit.models.BooleanField(doc, required=False, default=None, static=False, fallbacks=(), mapping={}, name=None)[source]

A boolean field

default_mapping = {'type': 'boolean'}

Mapping for Elasticsearch

class elasticgit.models.DictField(doc, fields, default=None, static=False, fallbacks=(), mapping=())[source]

A dictionary field

class elasticgit.models.FloatField(doc, required=False, default=None, static=False, fallbacks=(), mapping={}, name=None)[source]

A float field

default_mapping = {'type': 'float'}

Mapping for Elasticsearch

class elasticgit.models.IntegerField(doc, required=False, default=None, static=False, fallbacks=(), mapping={}, name=None)[source]

An integer field

default_mapping = {'type': 'integer'}

Mapping for Elasticsearch

class elasticgit.models.ListField(doc, fields, default=[], static=False, fallbacks=(), mapping={})[source]

A list field

default_mapping = {'type': 'string'}

Mapping for Elasticsearch

class elasticgit.models.Model(config_data, static=False, es_meta=None)[source]

Base model for all things stored in Git and Elasticsearch. A very thin wrapper around confmodel.Config.

Subclass this model and add more field as needed.

Parameters:config_data (dict) – A dictionary with keys & values to populate this Model instance with.

Configuration options:

Parameters:
  • _version (dict) – Model Version Identifier
  • uuid (str) – Unique Identifier
set_read_only()[source]

Mark this model instance as being read only. Returns self to allow it to be chainable.

Returns:self
class elasticgit.models.TextField(doc, required=False, default=None, static=False, fallbacks=(), mapping={}, name=None)[source]

A text field

class elasticgit.models.URLField(doc, required=False, default=None, static=False, fallbacks=(), mapping={}, name=None)[source]

A url field

mapping = {'type': 'string'}

Mapping for Elasticsearch

class elasticgit.models.UnicodeTextField(doc, required=False, default=None, static=False, fallbacks=(), mapping={}, name=None)[source]

A text field