[[PageOutline(2-5,Contents,pullout)]]

= Perform SQL queries on the Trac database =

== Description ==

The TracSQL plugin adds a "SQL" tab to the trac project. Inside this tab, the plugin
supports interacting with the project database.  

Some features include:

 * perform queries on the project database
 * view results as raw or formatted (and hyper-linked) output
 * export result set in CSV
 * browse the database schema

This plugin supports Trac installations with SQLite, MySQL, and PostgreSQL
database backends (although the queries will need to be written differently
according to which SQL database is being used).

== Source ==

See http://github.com/mrjbq7/tracsql for more details and the source code, or to report issues or request features.

== Configuration ==

It is configured in the trac.ini file by enabling and configuring:

{{{
[components]
tracsql.* = enabled
}}}

The TRAC_ADMIN permission is used to control access to the query pages.

By default, the TracSQL plugin connects to the project database.  To use an
external database, set the database parameter in the tracsql section
of the trac.ini file to a valid database connection string:

{{{
[tracsql]
database = sqlite:db/external.db
}}}

== Example ==

Some screenshots, showing a few of the features:

[[Image(sql-query.png)]]

[[Image(sql-schema.png)]]

[[Image(sql-query2.png)]]

== Recent Changes ==

[[ChangeLog(tracsqlplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:mrjbq7] [[BR]]
'''Maintainer:''' [wiki:mrjbq7] [[BR]]
'''Contributors:'''