KateSQL, a new plugin for Kate


today i will show you a new plugin for Kate, called KateSQL.
As you may have guessed, it brings to Kate the basic features of an SQL client, allowing you to open connections, execute queries, and display result data from SELECT statements or stored procedures.
Since this plugin makes an extreme use of the Qt Sql module, most of database drivers are supported..

Said this, let me explain how it works..

Kate MainWindow with KateSQL widgets

First of all, you have to create a new db connection through a simple wizard, specifying driver, connection parameters (hostname, username, password, etc…), and a descriptive name, that KateSQL will use as identifier.
Done this, what you need to do is just select the query text in the editor and press F5 (or your preferred shortcut). The whole text will be executed through the selected connection.

For SQL output, two toolbox are disposed in the bottom area:

  • The first will show messages returned from the server (errors in red, others in green, like number of affected rows).
  • The second contains a table view with a custom model associated, to show resultsets of a query. This custom model does nothing more than a QSqlQueryModel, only provides colors and formatting for each cell..

Ah, about this, my last commit implements a configuration widget that let you choose colors and font styles for text fields, numbers, blobs, nulls, booleans and dates… cool, yeah? :)

KateSQL Configuration Dialog

Last but not least, on the left panel you can find a basic and useful schema browser, that show the tree schema of the database connection currently selected. With this tree widget you can browse through tables, system tables and views, up to individual fields. obviously, primary key fields are distinguished by the classic yellow key icon.

Currently, there are few problems with multiple query handling.. Some engines doesn’t supports it natively, others can receive queries separated by a semicolon, but the QSqlQueryModel can handle only one resultset at time.. probably the best solution is to parse the text, split queries, and execute them separately.. Surely, this feature will be implemented soon.
Stay tuned!

Of course, if you want to help us with development, you are welcome!

44 thoughts on “KateSQL, a new plugin for Kate

  1. i’m using this plugin for a project i’m working on and all i can say is this: thank you, thank you, thank you. i’m no longer dependent on psql in konsole. multiple tabs for queries == pure win.

    the one thing that’s keeping psql around still though is the innability to do things like “alter table ..”; it would be great if it could run such data definition statements as well.

    as for the use of F5, that conflicts with the default shortcut in kate for reloading a file. could i recommend Ctrl+E for execute?

  2. This looks just great – will be definitely used a lot here.
    But why do you store passwords as plain text? Don’t you use KWallet?

  3. @aseigo:
    about dds, have you tried to execute it? on mysql works fine, i think that there shouldn’t be differences with pgsql.
    CTRL+E, promoted :) certainly better than a shortcut conflict.

    i did a test few weeks ago (kwallet is very easy to implement), but i encountered some logical problems.. i’ll ask in IRC for a solution!

  4. :) Thanks again for creating this plugin, it is that nice to see that Kate is extensible enough for such workflows ;)
    Too bad we still lack a good howto about writing plugins, whereas the plugin architecture is more or less stable since 5 years :(
    Perhaps should find time to write howto .P

  5. Hope this doesn’t come across as negative:

    I’d rather see this turned on it’s head and as an SQL editor which uses a Kate part and all the stuff you’ve shown above. I think it’d have more scope for you to provide a better SQL front end.

    From a user POV, I wouldn’t think to fire up a text editor if I wanted an SQL query tool/editor. I’d search for an app to do it, which means I’d end up using kmysqladmin instead of this – and frankly yours looks better. When I’m in Kate for anything else, even hacking together some websites, I don’t think I’d have an urge to fire off SQL directly. It’d be less confusing for it to be a different program.

    Good work anyway, just sharing my initial thoughts.


    1. Whereas I can understand that some people prefer one tool for one task, the problem with that idea is: Kate provides already a nice framework to put in toolviews, to handle multiple text documents and so on. If you create a plugin for Kate, you can focus on your task. This is here to provide best possible SQL integration for an editor. If you start from scratch and build a standalone application that uses KatePart, which is nice too, you need to come up with the whole application infrastructure yourself.

      Therefor I think a lot stuff like this should more likely be a plugin for Kate than a standalone application, to share the framework code.
      For example an other nice plugin is the Kate GDB plugin. It provides a very simple GDB integration, which doesn’t do much more than give you the GDB commandline in Kate but auto-open all sources in Kate itself.
      That is really easy to implement but of great value. And given it is a plugin that uses the whole Kate infrastructure, it is much less stuff to maintain than yet an other standalone debugger.

      One point that is valid thought: Kate’s plugin architecture needs to be enhanced, to provide even tighter integration, for example passing command line arguments to a plugin or enabling a plugin via command line (for example to have a simple “alias katesql=”kate –plugin=katesql” that fires up a Kate instance with loaded sql plugin ready to go)

      1. Thanks for replying :-)

        I can see what you mean, when looking at it from a developer POV. It makes a lot of sense. Though all your arguments are from the developer’s side (your side) not arguing against any of the benefits on the user side.

        I’d like to think you’ll get a lot of developer’s on board with the Kate plugin, now you have something very usable, and then a move gets considered at some point way in the future.

  6. are there any plans for a formatter that formats the sql string. because that would be really helpful for very long sql statements.

  7. Really nice! I like that and will surely be using it :-D

    Would it be possible to also extend that into the LDAP-world? :-) KDE is missing any GUI for LDAP-work for now.

  8. I am aware that this might be a bit off-topic here, but I’m enjoying this new KateSQL plugin so much, and it’s adding so much productivity to my PHP development, that I can’t help thinking about how much I miss the Kate HTMLtools Plugin of KDE 3. It was so nice to easily insert HTML tags, I really wonder why it disappeared.

    Is there a place where those old plugins can be downloaded, or do they have to be rewritten to be compatible with Kate 3.4.x?

    1. Oh wait, I just read the XML Completion Plugin post and realised that tags can actually be inserted via the all-new ported XML Completion Plugin – yay!

      Just one problem… It’s a bit buggy. Although pressing Ctrl+Enter brings up the tag insertion dialog, nothing happens when it’s submitted. I guess I would post this in the XML Completion Plugin topic, but it looks like comments are disabled over there.

    1. Yes, this plugin can also be ported to kdevelop infrastructure without heavy changes, i think..
      i’ll look for this in the near future ;) ..i hope
      ps: some months ago i found a similar plugin for kdevelop in playground, but it looked like a draft, and now the readme file says that the plugin is now ported to Quanta :|

      1. It would be more useful to have this, if we could actually share plugins between kate/kdevelop, as otherwise, lots of code needs to be duplicated. But I guess that will be hard, as kate and kdevelop have a very different interface.

  9. Fantastic work. I’ve been in love with kate for years, and I can’t believe my luck with all these new features that it’s getting.

    This SQL functionality could really improve my efficiency.

    Will these features also be implemented into Kdevelop soon, or are they already there?

  10. Is there any support for PostgreSQL?
    I’m using KATE a lot lot lot and pgadmin3 aside, if I could kick out pgadmin3 (I use it mostly for super simple SELECT queries on work) out of that bundle I’d be happy as a piggy in mud :o)

  11. The plugin is very useful but needs some improvements. I’m talking about a reconnect button, now after a while the database gets disconnected and i have to quit and start again Kate. The other one is that i’m not using Kwallet so the password for the database is not saved, which is annoying to type it in every time.

    Greetings! :)

    1. I agree with you, disconnections are not well managed, mainly because i don’t receive any kind of signal from qt about disconnection. i’ll try to improve this, i promise :)
      also about password management, i can add an option to save passwords in the session configuration, but of course they will be stored in clear text. what do you think?

  12. I love your work.I have a question.Is there a way to set the encoding during connection?This would be very useful to me…

    1. according to qt documentation the sql framework automatically uses unicode if supported by the database engine, otherwise UTF. Also searching in api documentation it seems that there’s no way to set text encoding. Maybe with a particular connection option. which database driver are you using?

      1. First of all thank you for your fast reply.

        I am using mostly the freedts library (QDTS7) from the list of the connection wizard of the plugin…
        Thanks in advance for your time…

      2. Sorry i meant the ‘freetds’ library and (QTDS7) option from the list of the connection wizard :D

  13. My Remote hosts are only allowing ssl encrypted connections. Can I and how – can I use your awesome plugin with ssl encrypted connections?

    Mythli <3

  14. Small patch for allowing loading of external sqlite plugins like spatialite or custom

    by default sqlite has turned off permision to do so and we need to call
    sqlite3_enable_load_extension( handle, 1 );
    on opened database handle.

    diff –git kate/plugins/katesql/CMakeLists.txt kate/plugins/katesql/CMakeLists.txt
    index 6b088ad..9baf7f9 100644
    — kate/plugins/katesql/CMakeLists.txt
    +++ kate/plugins/katesql/CMakeLists.txt
    @@ -27,7 +27,7 @@ kde4_add_plugin(katesqlplugin ${katesql_SRCS})


    -target_link_libraries(katesqlplugin ${KDE4_KDECORE_LIBS} ${KDE4_KDEUI_LIBS} ${QT_QTSQL_LIBRARY} kateinterfaces ${KDE4_KTEXTEDITOR_LIBS} )
    +target_link_libraries(katesqlplugin ${KDE4_KDECORE_LIBS} ${KDE4_KDEUI_LIBS} ${QT_QTSQL_LIBRARY} kateinterfaces ${KDE4_KTEXTEDITOR_LIBS} sqlite3)

    install(TARGETS katesqlplugin DESTINATION ${PLUGIN_INSTALL_DIR} )

    diff –git kate/plugins/katesql/sqlmanager.cpp kate/plugins/katesql/sqlmanager.cpp
    index 8405cca..b80117b 100644
    — kate/plugins/katesql/sqlmanager.cpp
    +++ kate/plugins/katesql/sqlmanager.cpp
    @@ -29,6 +29,7 @@

    using KWallet::Wallet;

    @@ -37,6 +38,7 @@ SQLManager::SQLManager(QObject *parent)
    , m_model(new ConnectionModel(this))
    , m_wallet(0)
    + sqlite3_initialize();

    @@ -83,7 +85,17 @@ void SQLManager::createConnection(const Connection &conn)

    // try to open connection, with or without password
    if (db.open())
    + {
    m_model->setStatus(conn.name, Connection::ONLINE);
    + QVariant v = db.driver()->handle();
    + if (v.isValid() && qstrcmp(v.typeName(), “sqlite3*”) == 0) {
    + // v.data() returns a pointer to the handle
    + sqlite3 *handle = *static_cast(v.data());
    + if (handle != 0) {
    + sqlite3_enable_load_extension( handle, 1 );
    + }
    + }
    + }
    if (conn.status != Connection::REQUIRE_PASSWORD)

  15. Ich verstehe es nicht, wie kann ich diesen Plugin herunterladen?
    Debian 6 / 2.6.32 amd64
    Gnome 2.30.2
    Kate 4.4.5 (3.4.5)

  16. How does one connect to oracle as sysdba?

    Thanks to all who have contributed to this plugin. It really is very nicely done.

  17. I wanted to post information about how I connected to a MS sql server using ODBC.

    I first had to install freetds and supportive libraries in my opensuse 12.3 installation:

    zypper install libqt4-sql-unixODBC libfreetds freetds-tools libtdsodbc0

    Then configure your ODBC settings in /etc/unixODBC/odbc.ini using the following driver:

    Driver = /usr/lib64/libtdsodbc.so.0
    Server = dbserver.example.com
    Database = foodb
    Port = 1433
    TDS_Version = 8.0

    Your specific odbc settings may be different.

    Finally, in KateSQL, create a new QODBC3 connection. Specify the ODBC datasource name from your odbc.ini in the server field (not the actual database server).

    This is what worked for me.

  18. Hello!

    I’d like to ask for a little usability improvement: if no text selected, apply ‘execute query’ command not to all editor contents, but to statement under cursor. Statements could be easily separated by ‘;’

  19. Great plugin! For a mysql connection, is there a way to specify a different socket? Using for example the mysql CLI you can pass a –socket=/opt/lampp/var/mysql/mysql.sock. I’m using lampp to test stuff besides the regular mysql instance that has a socket in /var/run/mysqld

  20. I have a following problem. When i try to add a connection, the first step of wizard is to choose a database driver, BUT in the select menu is no one in, that i can choose, it is empty :(

    I have Debian7 x64, MySQL 5.5.37 , DE – MATE

    How I can get a driver for KateSQL plugin?

Leave a Reply

Your email address will not be published. Required fields are marked *

Scroll to top