MagicStack / asyncpg

A fast PostgreSQL Database Client Library for Python/asyncio.
Apache License 2.0
6.99k stars 404 forks source link

Support composite types with fields that are of type `citext` #1075

Open kevinvalk opened 1 year ago

kevinvalk commented 1 year ago

I am using citext for fields that really need to be citext (as in, I care about the case only for displaying but other than that the case should not matter). Now I have a query that goes like

SELECT * FROM project WHERE (owner::citext, name::citext)::record = ANY($1);

Throughout asyncpg it is mentioned to get this to work (normally) you add a composite type. So we add a composite type and cast the array to the composite type.

CREATE TYPE project_fqn AS (
    owner citext,
    name citext
);

SELECT * FROM project WHERE (owner::citext, name::citext) = ANY($1::project_fqn[]);

Sadly this fails due to an <class 'asyncpg.exceptions._base.UnsupportedClientFeatureError'>: cannot decode type "public"."project_fqn": text encoding of composite types is not supported. error. It can be "fixed" by changing all citext types for a text type but then we lose the case insensitive search.

Is this something that can be fixed or are there any workarounds? I tried doing a set_builtin_type_codec("citext", codec_name=25) but that seems to have no impact.

Some references:

kevinvalk commented 1 year ago

On alternative that has shortcomings is using LOWER() so you use the text type everywhere and make sure to lowercase your input array from the application layer.

CREATE TYPE project_fqn AS (
    owner text,
    name text
);

SELECT * FROM project WHERE (LOWER(owner::text), LOWER(name::text)) = ANY($1::project_fqn[]);