Feature add sql formatter

[astroshot]

Description

Add sql-formatter for *clis, which convert output data to sql format like insertion sqls or updating sqls.

For example, in pgcli, you can get sql-insert output like this:

PostgreSQL [email protected]:5432/test ➜ SELECT * FROM "user";
INSERT INTO "user" ("id", "name", "email", "phone", "description", "created_at", "updated_at") VALUES
('1', 'Jackson', '[email protected]', '132454789', '', '2022-09-09 19:44:32.712343+08', '2022-09-09 19:44:32.712343+08')
;
SELECT 1
Time: 0.004s

Checklist

• I've added this contribution to the CHANGELOG.
• I've added my name to the AUTHORS file (or it's already there).
• I installed pre-commit hooks (pip install pre-commit && pre-commit install), and ran black on my code.
• Please squash merge this pull request (uncheck if you'd like us to merge as multiple commits)

[gfrlv]

cli-helpers is meant to be a general library, common for all dbcli projects. It would be great to have an sql formatter in the base library, however, it would have to use the correct dialect (mysql vs postgres vs whatever). I don't know how to do it correctly. But to add the mysql-specific format, like you're proposing, seems a little out of place here. Should it not live in mycli?

UPD ah, my bad, I see what you're doing. Interesting.

[astroshot]

Hi, I opened a PR to pgcli last month (dbcli/pgcli#1366) to export output to sqls like mycli
and it's suggested to move sql-formatter to cli_helpers.

My idea is that:

1. Move adapter and register function here,
2. Call register function from clis by passing different delimiter chars (for example, mycli pass ` and pgcli pass ") and extract_tables function.

For sql output, table name is needed, so parsing function is required. Since cli_helpers only does output format job, so I think it's not good enough to import sqlparse pkg here.

So any suggestions? Thanks for your attention. 😁

[j-bennet]

Hi @astroshot, sorry it took forever to review this. I think this change can be useful to multiple CLIs, even if it will need some tweaking in the future. I left a couple of small comments, but otherwise this looks nice.

[j-bennet]

These formats will need documenting.

[astroshot]

Sure, I'll add some later

[j-bennet]

This is one way to do it. Alternatively, the CLI could pass in tables as part of kwargs.

[astroshot]

I'll try it

[j-bennet]

This adapter doesn't really make sense for more than one table, correct? Perhaps there should be an error if we have more than one table.

[astroshot]

Yes, this formatter is convenient is generate INSERTION SQL or UPDATING SQL relates to one table. In those cases when SQL with multiple tables is run, usually queried results earn more concern than considering to importing them. So I thought it was ok to use a fake table name "DUAL" to indicate this situation, and you?

[j-bennet]

I think we should raise an exception in this case.