Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an interactive shell for Sqlite3 #77617

Closed
rhettinger opened this issue May 7, 2018 · 13 comments · Fixed by #95026
Closed

Add an interactive shell for Sqlite3 #77617

rhettinger opened this issue May 7, 2018 · 13 comments · Fixed by #95026
Labels
expert-sqlite3 stdlib triaged type-feature

Comments

@rhettinger
Copy link
Contributor

@rhettinger rhettinger commented May 7, 2018

BPO 33436
Nosy @rhettinger, @bitdancer, @serhiy-storchaka, @erlend-aasland, @DiddiLeija
Files
  • sqlite3_repl.py: Minimal proof-of-concept
  • 0001-Add-proof-of-concept-REPL.patch
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
    closed_at = None
    created_at = <Date 2018-05-07.01:47:00.123>
    labels = ['3.8', '3.9', '3.10', '3.11', 'type-feature', 'library']
    title = 'Add an interactive shell for Sqlite3'
    updated_at = <Date 2022-02-11.14:45:10.289>
    user = 'https://github.com/rhettinger'

    bugs.python.org fields:

    activity = <Date 2022-02-11.14:45:10.289>
    actor = 'DiddiLeija'
    assignee = 'none'
    closed = False
    closed_date = None
    closer = None
    components = ['Library (Lib)']
    creation = <Date 2018-05-07.01:47:00.123>
    creator = 'rhettinger'
    dependencies = []
    files = ['47573', '49199']
    hgrepos = []
    issue_num = 33436
    keywords = ['patch']
    message_count = 6.0
    messages = ['316248', '316257', '316261', '327252', '370180', '413072']
    nosy_count = 6.0
    nosy_names = ['rhettinger', 'r.david.murray', 'serhiy.storchaka', 'Big Stone', 'erlendaasland', 'DiddiLeija']
    pr_nums = []
    priority = 'normal'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue33436'
    versions = ['Python 3.8', 'Python 3.9', 'Python 3.10', 'Python 3.11']

    @rhettinger
    Copy link
    Contributor Author

    @rhettinger rhettinger commented May 7, 2018

    To facilitate rapid experimentation with SQL queries, add a shell to run commands and display results.

    Attached is minimal proof-of-concept modeled loosely on the Linux sqlite3 REPL. Here's a sample session:

    SQLite version 2.6.0
    
     Enter "help" for usage hints
    
    sqlite> open Irises.db
    sqlite> select distinct species from irises
    ('Iris-setosa',)
    ('Iris-versicolor',)
    ('Iris-virginica',)
    sqlite> select species, avg(pet_len), avg(sep_len) from irises group by species
    ('Iris-setosa', 1.464, 5.005999999999999)
    ('Iris-versicolor', 4.26, 5.936)
    ('Iris-virginica', 5.552, 6.587999999999998)
    sqlite> select count(*) from irises
    (150,)
    sqlite> quit
    

    @rhettinger rhettinger added 3.8 stdlib type-feature labels May 7, 2018
    @bitdancer
    Copy link
    Member

    @bitdancer bitdancer commented May 7, 2018

    It's not immediately obvious what benefits this provides over the existing sqlite-native repl and the python repl. Can you expand a bit on the use case? Also, I seem to remember that Catherine Devlin had at one point thought about expanding her sqlpython to be multi-db capable, and while it doesn't look like that has happened, maybe that would be an alternative worth investigating? (I've never used it or looked at its code, so it may not be.)

    @serhiy-storchaka
    Copy link
    Member

    @serhiy-storchaka serhiy-storchaka commented May 7, 2018

    It could be added in Tools/scripts directory or as a part of the sqlite3 module.

    It's not immediately obvious what benefits this provides over the existing sqlite-native repl and the python repl.

    The existing sqlite-native repl is not always installed when Python is installed (especially on Windows). It is handy that Python provides CLI to some modules, including zipfile and tarfile.

    I would prefer CLI, but maybe both interfaces can be combined.

    It would be nice to provide also a graphical Sqlite3 browser, which can be ran as a separate application and be integrated with IDLE (as turtledemo).

    @BigStone
    Copy link
    Mannequin

    @BigStone BigStone mannequin commented Oct 6, 2018

    as a graphical sqlite browser, you have sqlite_bro that may give you inspiration. It's about one single file.

    @erlend-aasland
    Copy link
    Contributor

    @erlend-aasland erlend-aasland commented May 28, 2020

    I think this is a good idea. Proof-of-concept implementation added (invoke REPL with python -m sqlite3).

    Possible improvements:
    - Use sqlite3.complete_statement()
    - Support Python syntax as well. For example:
    >>> select * from t
    >>> res = _
    >>> print(res[0])

    @DiddiLeija
    Copy link
    Mannequin

    @DiddiLeija DiddiLeija mannequin commented Feb 11, 2022

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @erlend-aasland
    Copy link
    Contributor

    @erlend-aasland erlend-aasland commented Jul 17, 2022

    @rhettinger, @serhiy-storchaka, are you still +1 on this? I'm +1, because...

    • implementation is easy; low maintenance cost
    • I'm a fan of built-in tools like this (python -m calendar is one of my favourites)
    • there has been some interest in this feature (re. the linked Discourse topic)

    @serhiy-storchaka
    Copy link
    Member

    @serhiy-storchaka serhiy-storchaka commented Jul 18, 2022

    I am +1 on this for the same reasons. Go ahead, it would be fun.

    @kumaraditya303
    Copy link
    Contributor

    @kumaraditya303 kumaraditya303 commented Jul 18, 2022

    I am +1, this would make Windows sqlite users happy.

    @erlend-aasland
    Copy link
    Contributor

    @erlend-aasland erlend-aasland commented Jul 18, 2022

    I'll revive my patch.

    @erlend-aasland
    Copy link
    Contributor

    @erlend-aasland erlend-aasland commented Jul 19, 2022

    I'll revive my patch.

    Rebased and cleaned up slightly. Draft PR up: #95026

    IMO, let's just provide a dead simple sqlite3 shell for now; if more features are needed, let's add those in separate issues.

    @erlend-aasland erlend-aasland added the triaged label Jul 25, 2022
    @erlend-aasland
    Copy link
    Contributor

    @erlend-aasland erlend-aasland commented Jul 31, 2022

    Possible future enhancements:

    • provide switches for overriding row and text factories
    • add more SQLite CLI features:
      • -cmd COMMAND: run "COMMAND" before reading stdin
      • -deserialize: open the database using sqlite3_deserialize()
      • -bail: stop after hitting an error
      • -readonly: open the database read-only
      • .trace command: set trace callback to print
      • .progress command: adds a basic progress handler
      • .connection [close] [#]: Open or close an auxiliary database connection

    erlend-aasland added a commit that referenced this issue Aug 1, 2022
    Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
    @erlend-aasland
    Copy link
    Contributor

    @erlend-aasland erlend-aasland commented Aug 1, 2022

    Thanks Raymond, for the pitch. Thanks Dong-hee, Kumar, and Serhiy for helpful reviews. This has now been implemented by #95026. Enhancement requests go as separate issues.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    expert-sqlite3 stdlib triaged type-feature
    Projects
    Status: Done
    Development

    Successfully merging a pull request may close this issue.

    5 participants