zuul
/
zuul
Code Issues Proposed changes

Merge "Docs: reformat sql driver docs" into feature/zuulv3

This commit is contained in:
Jenkins 2017-08-04 22:23:02 +00:00 committed by Gerrit Code Review
parent d0e7aeae2a 83786d4418
commit 3171444fe6
1 changed files with 43 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
doc/source/admin/drivers/sql.rst
View File

@ -4,14 +4,29 @@ SQL
=== ===
The SQL driver supports reporters only. Only one connection per The SQL driver supports reporters only. Only one connection per
database is permitted. The connection options are: database is permitted.
**driver=sql** Connection Configuration
------------------------
**dburi** The connection options for the SQL driver are:
Database connection information in the form of a URI understood by
sqlalchemy. eg http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html#database-urls .. attr:: <sql connection>
``dburi=mysql://user:pass@localhost/db``
.. attr:: driver
:required:
.. value:: sql
The connection must set ``driver=sql`` for SQL connections.
.. attr:: dburi
:required:
Database connection information in the form of a URI understood
by SQLAlchemy. See `The SQLAlchemy manual
<http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html#database-urls>`_
for more information.
Reporter Configuration Reporter Configuration
---------------------- ----------------------
@ -21,9 +36,26 @@ This reporter is used to store results in a database.
A :ref:`connection<connections>` that uses the sql driver must be A :ref:`connection<connections>` that uses the sql driver must be
supplied to the reporter. supplied to the reporter.
zuul.conf contains the database connection and credentials. To store different ``zuul.conf`` contains the database connection and credentials. To
reports in different databases you'll need to create a new connection per store different reports in different databases you'll need to create a
database. new connection per database.
The SQL reporter does nothing on "start" or "merge-failure"; it only The SQL reporter does nothing on :attr:`pipeline.start` or
acts on "success" or "failure" reporting stages. :attr:`pipeline.merge-failure`; it only acts on
:attr:`pipeline.success` or :attr:`pipeline.failure` reporting stages.
For example:
.. code-block:: yaml
- pipeline:
name: post-merge
success:
mydb_conn: {}
failure:
mydb_conn: {}
.. attr:: pipeline.<reporter>.<sql source>
To report to a database, add an empty dictionary to the desired
pipeline :ref:`reporter<reporters>` attributes.