U h*2@sddlmZddlmZddlmZddlmZddlmZddlmZddlmZdd l m Z dd l m Z dd l m Z dd l mZdd l mZddl mZddl mZddl mZddl mZddl mZddl mZddl mZddlmZddlmZddlmZerJddlmZddl m!Z!ddl"m#Z#ddl"m$Z$ddl"m%Z%dZ&Gdd d ej'j(Z(Gd!d"d"e(Z)Gd#d$d$ej'Z'Gd%d&d&e'Z*d'S)() annotations)Any)Callable)List)Optional) TYPE_CHECKING)Union)ARRAY)array)ASTEXT) CONTAINED_BY)CONTAINS) DELETE_PATH)HAS_ALL)HAS_ANY)HAS_KEY)JSONPATH_ASTEXT) PATH_EXISTS) PATH_MATCH)types)cast)_T)Dialect) ColumnElement)_BindProcessorType)_LiteralProcessorType) TypeEngine)JSONJSONBc@s>eZdZddddddZdddd d Zdd dd d ZdS) JSONPathTyperzOptional[Callable[[Any], Any]]zCallable[[Any], Any])dialect super_procreturncsdddfdd }|S)Nr)valuer$cs<t|tr|S|r(ddtt|}nd}r8|}|S)Nz{%s}z, z{}) isinstancestrjoinmap)r%r#G/tmp/pip-unpacked-wheel-y9ln43lq/sqlalchemy/dialects/postgresql/json.pyprocess/s z(JSONPathType._processor..processr+)selfr"r#r-r+r*r, _processor,szJSONPathType._processorz_BindProcessorType[Any])r"r$cCs||||SN)r/Zstring_bind_processorr.r"r+r+r,bind_processor@szJSONPathType.bind_processorz_LiteralProcessorType[Any]cCs||||Sr0)r/Zstring_literal_processorr1r+r+r,literal_processorCszJSONPathType.literal_processorN)__name__ __module__ __qualname__r/r2r3r+r+r+r,r!+sr!c@seZdZdZdZdS)JSONPATHadJSON Path Type. This is usually required to cast literal values to json path when using json search like function, such as ``jsonb_path_query_array`` or ``jsonb_path_exists``:: stmt = sa.select( sa.func.jsonb_path_query_array( table.c.jsonb_col, cast("$.address.id", JSONPATH) ) ) N)r4r5r6__doc____visit_name__r+r+r+r,r7Isr7cs\eZdZUdZdZeZded<dddd fd d Z Gd d d ej j e Z e Z ZS)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" 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+psycopg2://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` TzTypeEngine[str] astext_typeFNboolzOptional[TypeEngine[str]]) none_as_nullr:cs tj|d|dk r||_dS)aConstruct 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()}) .. 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`. )r<N)super__init__r:)r.r<r: __class__r+r,r>sz JSON.__init__c@s,eZdZUdZded<eddddZdS) zJSON.Comparator6Define comparison operations for :class:`_types.JSON`.rtypezColumnElement[str])r$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` Z result_typeN) r&exprrightrBsqltypesrr!leftoperaterr:r )r.r+r+r,astextszJSON.Comparator.astextN)r4r5r6r8__annotations__propertyrIr+r+r+r, Comparators rL)FN)r4r5r6r8Zrender_bind_castrFTextr:rJr>rrLrcomparator_factory __classcell__r+r+r?r,r[s Mrc@s.eZdZdZdZGdddejeZeZdS)r aRepresent 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`, :meth:`.JSONB.Comparator.contained_by`, :meth:`.JSONB.Comparator.delete_path`, :meth:`.JSONB.Comparator.path_exists` and :meth:`.JSONB.Comparator.path_match`. 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. .. seealso:: :class:`_types.JSON` c@seZdZUdZded<dddddZdddd d Zdddd d Zdddd ddZdddddZ dddddZ dddddZ dddddZ dS)zJSONB.ComparatorrAr rBrzColumnElement[bool])otherr$cCs|jt|tjdS)zBoolean expression. Test for presence of a key (equivalent of the ``?`` operator). Note that the key may be a SQLA expression. rC)rHrrFBooleanr.rPr+r+r,has_key#szJSONB.Comparator.has_keycCs|jt|tjdS)zxBoolean expression. Test for presence of all keys in jsonb (equivalent of the ``?&`` operator) rC)rHrrFrQrRr+r+r,has_all)szJSONB.Comparator.has_allcCs|jt|tjdS)zwBoolean expression. Test for presence of any key in jsonb (equivalent of the ``?|`` operator) rC)rHrrFrQrRr+r+r,has_any/szJSONB.Comparator.has_any)rPkwargsr$cKs|jt|tjdS)a"Boolean expression. Test if keys (or array) are a superset of/contained the keys of the argument jsonb expression (equivalent of the ``@>`` operator). kwargs may be ignored by this operator but are required for API conformance. rC)rHrrFrQ)r.rPrVr+r+r,contains5szJSONB.Comparator.containscCs|jt|tjdS)zBoolean expression. Test if keys are a proper subset of the keys of the argument jsonb expression (equivalent of the ``<@`` operator). rC)rHr rFrQrRr+r+r, contained_by?s zJSONB.Comparator.contained_byz Union[List[str], _pg_array[str]]zColumnElement[JSONB])r r$cCs2t|tst|}t|ttj}|jt|tdS)a=JSONB expression. Deletes field or array element specified in the argument array (equivalent of the ``#-`` operator). The input may be a list of strings that will be coerced to an ``ARRAY`` or an instance of :meth:`_postgres.array`. .. versionadded:: 2.0 rC) r& _pg_arrayrr rFZTEXTrHrr )r.r Z right_sider+r+r, delete_pathHs zJSONB.Comparator.delete_pathcCs|jt|tjdS)zBoolean expression. Test for presence of item given by the argument JSONPath expression (equivalent of the ``@?`` operator). .. versionadded:: 2.0 rC)rHrrFrQrRr+r+r, path_existsXs zJSONB.Comparator.path_existscCs|jt|tjdS)aBoolean expression. Test if JSONPath predicate given by the argument JSONPath expression matches (equivalent of the ``@@`` operator). Only the first item of the result is taken into account. .. versionadded:: 2.0 rC)rHrrFrQrRr+r+r, path_matchbs zJSONB.Comparator.path_matchN) r4r5r6r8rJrSrTrUrWrXrZr[r\r+r+r+r,rLs    rLN) r4r5r6r8r9rrLrrNr+r+r+r,r s1Qr N)+ __future__rtypingrrrrrrr r rY operatorsr r rrrrrrrrrrFZsqlrZ sql._typingrZengine.interfacesrZ sql.elementsrZ sql.type_apirrr__all__rr!r7r r+r+r+r,sB