Class JSONField

Declaration

Methods

• ▶ def __init__(self, verbose_name=None, name=None, encoder=None, decoder=None, **kwargs) override

  source link

  This method overrides django.db.models.fields.Field.__init__.

• ▶ def check(self, **kwargs) override

  source link

  This method overrides django.db.models.fields.mixins.CheckFieldDefaultMixin.check.

• ▶ def deconstruct(self) override

  inherited doc Return enough information to recreate the field as a 4-tuple:

  source link

  This method overrides django.db.models.fields.Field.deconstruct.

  * The name of the field on the model, if contribute_to_class() has
     been run.
   * The import path of the field, including the class:e.g.
     django.db.models.IntegerField This should be the most portable
     version, so less specific may be better.
   * A list of positional arguments.
   * A dict of keyword arguments.
  
  Note that the positional or keyword arguments must contain values of
  the following types (including inner values of collection types):
  
   * None, bool, str, int, float, complex, set, frozenset, list, tuple,
     dict
   * UUID
   * datetime.datetime (naive), datetime.date
   * top-level classes, top-level functions - will be referenced by their
     full import path
   * Storage instances - these have their own deconstruct() method
  
  This is because the values here must be serialized into a text format
  (possibly new Python code, possibly JSON) and these are the only types
  with encoding handlers defined.
  
  There's no need to return the exact way the field was instantiated this
  time, just ensure that the resulting field is the same - prefer keyword
  arguments over positional ones, and omit parameters with their default
  values.

• ▶ def formfield(self, **kwargs) override

  inherited doc Return a django.forms.Field instance for this field.

  source link

  This method overrides django.db.models.fields.Field.formfield.

• ▷ def from_db_value(self, value, expression, connection)

  source link
• ▶ def get_internal_type(self) override

  source link

  This method overrides django.db.models.fields.Field.get_internal_type.

• ▶ def get_prep_value(self, value) override

  inherited doc Perform preliminary non-db specific value checks and conversions.

  source link

  This method overrides django.db.models.fields.Field.get_prep_value.

• ▶ def get_transform(self, name) override

  source link

  This method overrides django.db.models.query_utils.RegisterLookupMixin.get_transform.

• ▶ def validate(self, value, model_instance) override

  inherited doc Validate value and raise ValidationError if necessary. Subclasses should override this to provide validation logic.

  source link

  This method overrides django.db.models.fields.Field.validate.

• ▶ def value_to_string(self, obj) override

  inherited doc Return a string value of this field from the passed obj. This is used by the serialization framework.

  source link

  This method overrides django.db.models.fields.Field.value_to_string.

Inherited methods

• Methods inherited from django.db.models.fields.Field:
  __copy__, __deepcopy__, __eq__, __hash__, __lt__, __reduce__, __repr__, __str__, cached_col, cast_db_type, clean, clone, contribute_to_class, db_check, db_parameters, db_returning, db_tablespace, db_type, db_type_parameters, db_type_suffix, get_attname, get_attname_column, get_choices, get_col, get_db_converters, get_db_prep_save, get_db_prep_value, get_default, get_filter_kwargs_for_object, get_pk_value_on_save, has_default, pre_save, rel_db_type, run_validators, save_form_data, select_format, set_attributes_from_name, to_python, unique, validators, value_from_object
• Methods inherited from django.db.models.query_utils.RegisterLookupMixin:
  get_lookup, get_lookups, merge_dicts, register_lookup

Subclasses

• django.contrib.postgres.fields.jsonb.JSONField

Reexports

• Imported in django.contrib.postgres.aggregates.general.
• Imported in django.contrib.postgres.fields.jsonb as BuiltinJSONField.
• Imported in django.db.models.

Generated by nedoc v0.9 at 2020-12-29 14:04