Project

cetusql

0.0
No commit activity in last 3 years
No release in over 3 years
cetusqlrkumar/cetusqlHomepageDocumentationSource CodeBug TrackerWiki
command line based sqlite db navigator. ruby 1.9.3 .. 2.4.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,595
Stars
1
Forks
1
Watchers
1
 Releases
Current version
0.0.1
Total releases
1
First release
2017-04-07
Latest release
2017-04-07
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-03-26
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.12
rake
~> 10.0

Runtime

sqlite3
>= 1.3.11, ~> 1.3
 Project Readme

Cetusql

Command-line based sqlite3 database explorer. The idea is to minimize typing of basic queries/tablenames and column names by allowing for selection of the same.

Some basic features:

  • Lists databases in current folder and allows menu for selection.
  • selection of tablenames from list, and of columns names and creates formatted output to a local temp file which is then displayed.
  • bookmark/save common SQL queries and recall later.

Uses sqlite3 gem, readline for editing. In the case of columns, uses fzf for selection.

Also, uses 'term-table.rb' for formatting of output. This needs to be placed in your path as an executable.

You may replace that with your own formatter such as csvlook or column -t. However, these two crash on non-ascii characters on a Mac, so I've written a ruby replacement. You can forgo it entirely and just have comma or tab separated output sent to a file.

Installation

$ gem install cetusql
$ brew install fzf
$ brew install readline

Usage

run cetusql on the command line.

If no database name is passed, will prompt for one from *.db and *.sqlite files in current directory. After selection, one may select one or more tables from a list. Then one may select one ore more columns from a list. Edit the SQL statement if need be, and press ENTER. The output is displayed in vim using a temp file.

Use the menu to change table or database file, or set other options, save last SQL query, select from favorite queries, etc.

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rkumar/cetusql.

License

The gem is available as open source under the terms of the MIT License.