From: Phil Estival <pe@7d.nz>
To: Adam Porter <adam@alphapapa.net>
Cc: emacs-devel@gnu.org, Org Mode List <emacs-orgmode@gnu.org>
Subject: Re: package submission : ob-sql-session
Date: Wed, 18 Sep 2024 03:41:23 +0200 [thread overview]
Message-ID: <3a694658-9184-4c45-ac17-6e6083a21517@7d.nz> (raw)
In-Reply-To: <1a69c5fb-4069-45c8-b37b-4d54ef88b92d@alphapapa.net>
Hi Adam,
* [2024-09-18 00:25] Adam Porter:
>
> Hi Phil,
>
> On 9/17/24 05:00, Phil Estival wrote:
>
>>> Also, for org-sql-session (which sounds very useful), it would be good
>>> to compare and contrast it with the package it's meant to supersede.
>>
>> The following comparison was added to the readme file.
>>
>> ob-sql-mode :
>> - is very simple : forward the sql source through `sql-redirect'
>> - has a test suite
>> - but gives clunky output
>> - no :results table
>> - sql client shell commands messes up output
>> - prompt again for connection parameters when restarting a session
>>
>> ob-sql-session :
>> - handle large results
>> - has :results tables
>> - accept header variables (:var)
>> - accept sql client shell commands
>> - keep login parameters
>> - prompt only for blank connection parameters
>> - can use `with-environment-variables'
>> - provide some more tests
>>
>>> since it's meant to integrate with org-babel, it might be good to
>>> discuss its inclusion on the Org mailing list also.
> To be clear, this makes 3 implementations of SQL support for Org Babel
> that I know of:
>
> 1. The built-in Org Babel SQL support, aka ob-sql, documented at
> <https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-sql.html>
>
> 2. ob-sql-mode, hosted at <https://github.com/nikclayton/ob-sql-mode>,
> which advertises itself as "an alternative backend for Org-Babel SQL SRC
> blocks that uses sql-mode to evaluate the query instead of Org-Babel's
> built-in SQL backends."
>
> 3. Your new ob-sql-session library.
>
> You've mentioned how your library compares to ob-sql-mode, but how does
> it compare to the built-in ob-sql library?
>
Here is a comparison with ob-sql-mode
ob-sql-session exists is for session support, which is in the TODOs
of ob-sql.
- ob-sql command execution relies on org-babel-eval
(→ process-file → call-process).
- ob-sql-session runs an inferior process (in which
sqli-interactive-mode can be activated when needed).
The process output is filtered (e.g. results and prompts).
When a session is demanded, this shell stays open for further commands
and can keep a state (typically, when given special SQL commands).
|-----------+----------------------------+----------------------------|
| | ob-sql | ob-sql-session |
|-----------+----------------------------+----------------------------|
| Feat. | - cmdline | - support for sessions |
| | - colnames as header arg | - optionnal colnames |
|-----------+----------------------------+----------------------------|
| TODO | | |
|-----------+----------------------------+----------------------------|
| | - support for sessions | - colnames as header arg |
| | - support for more engines | - support for more engines |
|-----------+----------------------------+----------------------------|
| engines | | |
| supported | | |
|-----------+----------------------------+----------------------------|
| | - mysql | - Postgresql |
| | - dbi | - sqlite |
| | - mssql | |
| | - sqsh | |
| | - postgresql | |
| | - oracle | |
| | - vertica | |
| | - saphana | |
|-----------+----------------------------+----------------------------|
ob-sql-session adapts sql-connect of sql.el by declaring
ob-sql-connect, in order to prompt only for missing connection
parameters.
- ob-sql defines org-babel-sql-dbstring-[engine]
to be provided on a shell command line.
- likewise, ob-sql-session has to define
- a connection string,
- the prompt,
- and the terminal command prefix
for a every supported SQL client shell (or "engines")
- ob-sql-session requires sql.el.
With the above defined, it should be compatible
with most database of the sql.el's zoo. maybe.
Phil
next prev parent reply other threads:[~2024-09-18 1:43 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <b1ca8e9e-be59-4740-8ea8-c3ebd4ba56fe@7d.nz>
[not found] ` <daabaaef-70a0-4e4a-b0f9-64e8c05dcb21@alphapapa.net>
2024-09-17 10:00 ` packages submissions : ob-sql-session and org-blog Phil Estival
2024-09-17 22:25 ` Adam Porter
2024-09-18 1:41 ` Phil Estival [this message]
2024-10-20 12:34 ` package submission : ob-sql-session Ihor Radchenko
2024-11-04 18:16 ` Phil Estival
2024-11-09 14:43 ` Ihor Radchenko
2024-11-11 10:51 ` patch : ob-sql :session Phil Estival
2024-11-11 15:57 ` Ihor Radchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=3a694658-9184-4c45-ac17-6e6083a21517@7d.nz \
--to=pe@7d.nz \
--cc=adam@alphapapa.net \
--cc=emacs-devel@gnu.org \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).