MagicStack / MagicStack/asyncpg
Feature request: A way to inspect the query string run by asyncpg
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 8.1k
- Fork
- 469
- Merge medio
- 18m
- PR unite (30g)
- 4
Descrizione
I have hasked this before SO (https://stackoverflow.com/questions/69814471/is-there-a-way-to-inspect-the-query-string-run-by-asyncpg) but I am getting no answer, so this is a feature request.
When I use asyncpg to run a query on my database (and I have to run several queries),
I always split up things like this:
- the string of the query, with parameters placeholders:
QUERY_1 = """ UPDATE TABLE my_table SET field_1 = $1 WHERE field_id = $2; """ - a dictionary with the query parameters:
query_params_dict = { "field_1" : "value_1", "field_id" : "10" } - and the function that will get the query string, replace the placeholders with the parameters values, run the query with connection.execute, and manage the errors:
async def run_query_1(query_params_dict): connection = await Utils.get_connection_to_db(**conf.asyncpg_db_conn) # custom function to open the connection to my db query = QUERY_1 try: await connection.execute( query, query_params_dict["field_1"], int(query_params_dict["field_id"]) ) return None except (Exception, asyncpg.UniqueViolationError) as integrError: logger.error("Violated unique constraint: {}".format(integrError), exc_info=True) return "{}".format(integrError) except (Exception, asyncpg.ConnectionFailureError) as error: logger.error("Failed connection: {}".format(error), exc_info=True) return "{}".format(error) finally: if (connection): await Utils.close_connection(connection)
But the queries I have to run often require many mores parameters, so that I always make some mistake in assigning values to the variables,
so that the query fails/returns unwanted results,
and the only way I know to determine what is wrong with it, is to check carefully the value assigned to every parameter of query_params_dict.
This takes a lot of time.
Instead, I could understand quickly what is wrong by checking the query run by asyncpg.
So, is there a way to inspect the query string run by asyncpg?
I would expect a command of asyncpg taking the same arguments of connection.execute as input, and returning as output the string of the query filled up with parameters, without running any query on the database.
Let's suppose this command exists and is connection.expected_query, in my case it would work like this:
connection.expected_query(
query, query_params_dict["field_1"], int(query_params_dict["field_id"])
>>>
"""
UPDATE TABLE my_table
SET field_1 = 'value_1'
WHERE field_id = 10;
"""
Could you please implement a feature like this?
Thanks in advance!
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Non vengono indicati file del repository né test. Inizia tracciando l’entry point Connection.execute e il modo in cui asyncpg gestisce i parametri delle query; il lavoro sarebbe completato da un’API definita che accetti gli argomenti di execute, restituisca la rappresentazione della query parametrizzata senza eseguirla e includa test che coprano il comportamento richiesto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- postgresql, python
- Ambito
- databases
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100