o gK2@sddlmZddlmZddlmZddlmZddlmZddlmZddlmZdd l m Z dd l m Z dd l m Z dd l mZdd l mZddl mZddl mZddl mZddl mZddl mZddl mZddl mZddlmZddlmZddlmZerddlmZddl 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*eZdZdddZdd d Zdd dZdS) JSONPathTypedialectr super_procOptional[Callable[[Any], Any]]returnCallable[[Any], Any]csdfdd }|S)Nvaluerr%cs<t|tr|S|rddtt|}nd}r|}|S)Nz{%s}z, z{}) isinstancestrjoinmap)r'r#_/var/www/html/flaskapp/venv/lib/python3.10/site-packages/sqlalchemy/dialects/postgresql/json.pyprocess/s z(JSONPathType._processor..process)r'rr%rr-)selfr"r#r/r-r,r. _processor,szJSONPathType._processor_BindProcessorType[Any]cC||||SN)r1string_bind_processorr0r"r-r-r.bind_processor@szJSONPathType.bind_processor_LiteralProcessorType[Any]cCr3r4)r1string_literal_processorr6r-r-r.literal_processorCszJSONPathType.literal_processorN)r"rr#r$r%r&)r"rr%r2)r"rr%r8)__name__ __module__ __qualname__r1r7r:r-r-r-r.r!+s  r!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)r;r<r=__doc____visit_name__r-r-r-r.r>Isr>csZeZdZUdZdZeZded<  ddfd 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_typeFN none_as_nullboolOptional[TypeEngine[str]]cs$tj|d|dur||_dSdS)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`. )rBN)super__init__rA)r0rBrA __class__r-r.rFs z JSON.__init__c@s(eZdZUdZded<ed ddZdS) zJSON.Comparator6Define comparison operations for :class:`_types.JSON`.rtyper%ColumnElement[str]cCsLt|jjjtjjr|jjjt |jj|jj dS|jjjt |jj|jj dS)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_type) r(exprrightrJsqltypesrr!leftoperaterrAr )r0r-r-r.astextszJSON.Comparator.astextN)r%rK)r;r<r=r?__annotations__propertyrSr-r-r-r. Comparators rV)FN)rBrCrArD)r;r<r=r?render_bind_castrPTextrArTrFrrVrcomparator_factory __classcell__r-r-rGr.r[s M rc@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@sjeZdZUdZded<ddd Zdd d Zdd d ZdddZdddZ dddZ dddZ dddZ dS) zJSONB.ComparatorrIr rJotherrr%ColumnElement[bool]cC|jt|tjdS)zBoolean expression. Test for presence of a key (equivalent of the ``?`` operator). Note that the key may be a SQLA expression. rL)rRrrPBooleanr0r[r-r-r.has_key#zJSONB.Comparator.has_keycCr])zxBoolean expression. Test for presence of all keys in jsonb (equivalent of the ``?&`` operator) rL)rRrrPr^r_r-r-r.has_all)razJSONB.Comparator.has_allcCr])zwBoolean expression. Test for presence of any key in jsonb (equivalent of the ``?|`` operator) rL)rRrrPr^r_r-r-r.has_any/razJSONB.Comparator.has_anykwargscKr])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. rL)rRrrPr^)r0r[rdr-r-r.contains5szJSONB.Comparator.containscCr])zBoolean expression. Test if keys are a proper subset of the keys of the argument jsonb expression (equivalent of the ``<@`` operator). rL)rRr rPr^r_r-r-r. contained_by?szJSONB.Comparator.contained_byr Union[List[str], _pg_array[str]]ColumnElement[JSONB]cCs2t|ts t|}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 rL) r( _pg_arrayrr rPTEXTrRrr )r0r right_sider-r-r. delete_pathHs zJSONB.Comparator.delete_pathcCr])zBoolean expression. Test for presence of item given by the argument JSONPath expression (equivalent of the ``@?`` operator). .. versionadded:: 2.0 rL)rRrrPr^r_r-r-r. path_existsXszJSONB.Comparator.path_existscCr])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 rL)rRrrPr^r_r-r-r. path_matchbs zJSONB.Comparator.path_matchN)r[rr%r\)r[rrdrr%r\)r rgr%rh) r;r<r=r?rTr`rbrcrerfrlrmrnr-r-r-r.rVs       rVN) r;r<r=r?r@rrVrrYr-r-r-r.r s 1Qr N)+ __future__rtypingrrrrrrr r ri operatorsr r rrrrrrrrrrPsqlr sql._typingrengine.interfacesr sql.elementsr sql.type_apirrr__all__rr!r>r r-r-r-r.sD