django.db.models.functions.JSONObject

class documentation

class JSONObject(Func): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method as_oracle Undocumented
Method as_postgresql Undocumented
Method as_sql Responsible for returning a (sql, [params]) tuple to be included in the current query.
Class Variable function Undocumented
Class Variable output_field Return the output type of this expressions.

Inherited from Func:

Method __repr__ Undocumented
Method copy Undocumented
Method get_source_expressions Undocumented
Method resolve_expression Provide the chance to do any preprocessing or validation before being added to the query.
Method set_source_expressions Undocumented
Class Variable arg_joiner Undocumented
Class Variable arity Undocumented
Class Variable template Undocumented
Instance Variable extra Undocumented
Instance Variable source_expressions Undocumented
Method _get_repr_options Return a dict of extra __init__() options to include in the repr.

Inherited from SQLiteNumericMixin (via Func):

Method as_sqlite Undocumented

Inherited from Expression (via Func, SQLiteNumericMixin):

Method __eq__ Undocumented
Method __hash__ Undocumented
Property identity Undocumented

Inherited from BaseExpression (via Func, SQLiteNumericMixin, Expression):

Method __getstate__ Undocumented
Method asc Undocumented
Method desc Undocumented
Method flatten Recursively yield this expression and all subexpressions, in depth-first order.
Method get_db_converters Undocumented
Method get_group_by_cols Undocumented
Method get_lookup Undocumented
Method get_source_fields Return the underlying field types used by this aggregate.
Method get_transform Undocumented
Method prefix_references Undocumented
Method relabeled_clone Undocumented
Method replace_references Undocumented
Method reverse_ordering Undocumented
Method select_format Custom format for select clauses. For example, EXISTS expressions need to be wrapped in CASE WHEN on Oracle.
Class Variable filterable Undocumented
Class Variable is_summary Undocumented
Class Variable window_compatible Undocumented
Property conditional Undocumented
Property contains_aggregate Undocumented
Property contains_column_references Undocumented
Property contains_over_clause Undocumented
Property convert_value Expressions provide their own converters because users have the option of manually specifying the output_field which may be a different type from the one the database returns.
Property field Undocumented
Static Method _convert_value_noop Undocumented
Method _parse_expressions Undocumented
Method _resolve_output_field Attempt to infer the output type of the expression.
Class Variable _output_field_resolved_to_none Undocumented
Property _output_field_or_none Return the output field of this expression, or None if _resolve_output_field() didn't return an output type.

Inherited from Combinable (via Func, SQLiteNumericMixin, Expression, BaseExpression):

Method __add__ Undocumented
Method __and__ Undocumented
Method __mod__ Undocumented
Method __mul__ Undocumented
Method __neg__ Undocumented
Method __or__ Undocumented
Method __pow__ Undocumented
Method __radd__ Undocumented
Method __rand__ Undocumented
Method __rmod__ Undocumented
Method __rmul__ Undocumented
Method __ror__ Undocumented
Method __rpow__ Undocumented
Method __rsub__ Undocumented
Method __rtruediv__ Undocumented
Method __rxor__ Undocumented
Method __sub__ Undocumented
Method __truediv__ Undocumented
Method __xor__ Undocumented
Method bitand Undocumented
Method bitleftshift Undocumented
Method bitor Undocumented
Method bitrightshift Undocumented
Method bitxor Undocumented
Constant ADD Undocumented
Constant BITAND Undocumented
Constant BITLEFTSHIFT Undocumented
Constant BITOR Undocumented
Constant BITRIGHTSHIFT Undocumented
Constant BITXOR Undocumented
Constant DIV Undocumented
Constant MOD Undocumented
Constant MUL Undocumented
Constant POW Undocumented
Constant SUB Undocumented
Method _combine Undocumented
def __init__(self, **fields): (source)
overrides django.db.models.expressions.Func.__init__

Undocumented

def as_oracle(self, compiler, connection, **extra_context): (source)

Undocumented

def as_postgresql(self, compiler, connection, **extra_context): (source)

Undocumented

def as_sql(self, compiler, connection, **extra_context): (source)
overrides django.db.models.expressions.Func.as_sql

Responsible for returning a (sql, [params]) tuple to be included in the current query. Different backends can provide their own implementation, by providing an `as_{vendor}` method and patching the Expression: ``` def override_as_sql(self, compiler, connection): # custom logic return super().as_sql(compiler, connection) setattr(Expression, 'as_' + connection.vendor, override_as_sql) ``` Arguments: * compiler: the query compiler responsible for generating the query. Must have a compile method, returning a (sql, [params]) tuple. Calling compiler(value) will return a quoted `value`. * connection: the database connection used for the current query. Return: (sql, params) Where `sql` is a string containing ordered sql parameters to be replaced with the elements of the list `params`.

function: str = (source)
overrides django.db.models.expressions.Func.function

Undocumented

output_field = (source)
overrides django.db.models.expressions.BaseExpression.output_field

Return the output type of this expressions.