3 a(@sddlmZddlmZddlmZddlmZdZej ej Z ej de d d d Z ej d e d d d Zej d e d d d Zej d e d d d Zej de d d d Zej de d d d Zej de d d d ZGdddejjZGdddejZGdddeZdS))absolute_import)types)util) operatorsJSONJSONBz->>T) precedenceZnatural_self_precedentZeager_groupingz#>>?z?&z?|z@>z<@c@seZdZddZddZdS) JSONPathTypecs|j|fdd}|S)Ncs>t|tjjstdd|D}ddj|}r:|}|S)NcSsg|]}tj|qS)r text_type).0elemr r I/tmp/pip-build-6_cqtusv/SQLAlchemy/sqlalchemy/dialects/postgresql/json.py Ksz@JSONPathType.bind_processor..process..z{%s}z, ) isinstancercollections_abcSequenceAssertionErrorjoin)valuetokens) super_procr rprocessIs z,JSONPathType.bind_processor..process)Zstring_bind_processor)selfdialectrr )rrbind_processorFs  zJSONPathType.bind_processorcs|j|fdd}|S)Ncs>t|tjjstdd|D}ddj|}r:|}|S)NcSsg|]}tj|qSr )rr )rrr r rrXszCJSONPathType.literal_processor..process..z{%s}z, )rrrrrr)rr)rr rrVs z/JSONPathType.literal_processor..process)Zstring_literal_processor)rrrr )rrliteral_processorSs  zJSONPathType.literal_processorN)__name__ __module__ __qualname__rrr r r rr Es r csBeZdZdZejZdfdd ZGdddejj Z e Z Z S) ra Represent the PostgreSQL JSON type. :class:`_postgresql.JSON` is used automatically whenever the base :class:`_types.JSON` datatype is used against a PostgreSQL backend, however base :class:`_types.JSON` datatype does not provide Python accessors for PostgreSQL-specific comparison methods such as :meth:`_postgresql.JSON.Comparator.astext`; additionally, to use PostgreSQL ``JSONB``, the :class:`_postgresql.JSONB` datatype should be used explicitly. .. seealso:: :class:`_types.JSON` - main documentation for the generic cross-platform JSON datatype. The operators provided by the PostgreSQL version of :class:`_types.JSON` include: * Index operations (the ``->`` operator):: data_table.c.data['some key'] data_table.c.data[5] * Index operations returning text (the ``->>`` operator):: data_table.c.data['some key'].astext == 'some value' Note that equivalent functionality is available via the :attr:`.JSON.Comparator.as_string` accessor. * Index operations with CAST (equivalent to ``CAST(col ->> ['some key'] AS )``):: data_table.c.data['some key'].astext.cast(Integer) == 5 Note that equivalent functionality is available via the :attr:`.JSON.Comparator.as_integer` and similar accessors. * Path index operations (the ``#>`` operator):: data_table.c.data[('key_1', 'key_2', 5, ..., 'key_n')] * Path index operations returning text (the ``#>>`` operator):: data_table.c.data[('key_1', 'key_2', 5, ..., 'key_n')].astext == 'some value' .. versionchanged:: 1.1 The :meth:`_expression.ColumnElement.cast` operator on JSON objects now requires that the :attr:`.JSON.Comparator.astext` modifier be called explicitly, if the cast works only from a textual string. Index operations return an expression object whose type defaults to :class:`_types.JSON` by default, so that further JSON-oriented instructions may be called upon the result type. Custom serializers and deserializers are specified at the dialect level, that is using :func:`_sa.create_engine`. The reason for this is that when using psycopg2, the DBAPI only allows serializers at the per-cursor or per-connection level. E.g.:: engine = create_engine("postgresql://scott:tiger@localhost/test", json_serializer=my_serialize_fn, json_deserializer=my_deserialize_fn ) When using the psycopg2 dialect, the json_deserializer is registered against the database using ``psycopg2.extras.register_default_json``. .. seealso:: :class:`_types.JSON` - Core level JSON type :class:`_postgresql.JSONB` .. versionchanged:: 1.1 :class:`_postgresql.JSON` is now a PostgreSQL- specific specialization of the new :class:`_types.JSON` type. FNcs$tt|j|d|dk r ||_dS)a+Construct a :class:`_types.JSON` type. :param none_as_null: if True, persist the value ``None`` as a SQL NULL value, not the JSON encoding of ``null``. Note that when this flag is False, the :func:`.null` construct can still be used to persist a NULL value:: from sqlalchemy import null conn.execute(table.insert(), data=null()) .. versionchanged:: 0.9.8 - Added ``none_as_null``, and :func:`.null` is now supported in order to persist a NULL value. .. seealso:: :attr:`_types.JSON.NULL` :param astext_type: the type to use for the :attr:`.JSON.Comparator.astext` accessor on indexed attributes. Defaults to :class:`_types.Text`. .. versionadded:: 1.1 ) none_as_nullN)superr__init__ astext_type)rr"r%) __class__r rr$sz JSON.__init__c@seZdZdZeddZdS)zJSON.Comparatorz6Define comparison operations for :class:`_types.JSON`.cCsPt|jjjtjjr0|jjjt |jj|jj dS|jjjt |jj|jj dSdS)aOn an indexed expression, use the "astext" (e.g. "->>") conversion when rendered in SQL. E.g.:: select(data_table.c.data['some key'].astext) .. seealso:: :meth:`_expression.ColumnElement.cast` ) result_typeN) rexprrighttypesqltypesrr leftoperateJSONPATH_ASTEXTr%ASTEXT)rr r rastexts zJSON.Comparator.astextN)rr r!__doc__propertyr0r r r r Comparatorsr3)FN) rr r!r1r+ZTextr%r$rr3comparator_factory __classcell__r r )r&rras Rc@s*eZdZdZdZGdddejZeZdS)raRepresent the PostgreSQL JSONB type. The :class:`_postgresql.JSONB` type stores arbitrary JSONB format data, e.g.:: data_table = Table('data_table', metadata, Column('id', Integer, primary_key=True), Column('data', JSONB) ) with engine.connect() as conn: conn.execute( data_table.insert(), data = {"key1": "value1", "key2": "value2"} ) The :class:`_postgresql.JSONB` type includes all operations provided by :class:`_types.JSON`, including the same behaviors for indexing operations. It also adds additional operators specific to JSONB, including :meth:`.JSONB.Comparator.has_key`, :meth:`.JSONB.Comparator.has_all`, :meth:`.JSONB.Comparator.has_any`, :meth:`.JSONB.Comparator.contains`, and :meth:`.JSONB.Comparator.contained_by`. Like the :class:`_types.JSON` type, the :class:`_postgresql.JSONB` type does not detect in-place changes when used with the ORM, unless the :mod:`sqlalchemy.ext.mutable` extension is used. Custom serializers and deserializers are shared with the :class:`_types.JSON` class, using the ``json_serializer`` and ``json_deserializer`` keyword arguments. These must be specified at the dialect level using :func:`_sa.create_engine`. When using psycopg2, the serializers are associated with the jsonb type using ``psycopg2.extras.register_default_jsonb`` on a per-connection basis, in the same way that ``psycopg2.extras.register_default_json`` is used to register these handlers with the json type. .. versionadded:: 0.9.7 .. seealso:: :class:`_types.JSON` c@s8eZdZdZddZddZddZdd Zd d Zd S) zJSONB.Comparatorz6Define comparison operations for :class:`_types.JSON`.cCs|jt|tjdS)zvBoolean expression. Test for presence of a key. Note that the key may be a SQLA expression. )r')r-HAS_KEYr+Boolean)rotherr r rhas_key(szJSONB.Comparator.has_keycCs|jt|tjdS)z;Boolean expression. Test for presence of all keys in jsonb)r')r-HAS_ALLr+r7)rr8r r rhas_all.szJSONB.Comparator.has_allcCs|jt|tjdS)z:Boolean expression. Test for presence of any key in jsonb)r')r-HAS_ANYr+r7)rr8r r rhas_any2szJSONB.Comparator.has_anycKs|jt|tjdS)zBoolean expression. Test if keys (or array) are a superset of/contained the keys of the argument jsonb expression. )r')r-CONTAINSr+r7)rr8kwargsr r rcontains6szJSONB.Comparator.containscCs|jt|tjdS)z|Boolean expression. Test if keys are a proper subset of the keys of the argument jsonb expression. )r')r- CONTAINED_BYr+r7)rr8r r r contained_by<szJSONB.Comparator.contained_byN) rr r!r1r9r;r=r@rBr r r rr3%s r3N)rr r!r1Z__visit_name__rr3r4r r r rrs.N)rr) __future__rrr+rZsqlr__all__Z _PRECEDENCEZjson_getitem_opZidx_precedenceZ custom_opr/r.r6r:r<r>rArr rr r r rsX