.. You may want to use the usual include line. Uncomment and adjust the path. 
.. include:: ../Includes.txt


==========================
EXT: Database query logger
==========================

:Author:
      Kasper Skårhøj

:Created:
      2002-11-01T00:32:00

:Changed:
      2008-11-21T15:43:46

:Classification:
      vara_dblog

:Description:
      The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ----

:Keywords:
      forDevelopers, forIntermediates

:Author:
      Emiel Nijpels (Omroepvereniging VARA)

:Email:
      webmaster@vara.nl

:Info 4:


:Language:
      en


|img-1| |img-2| EXT: Database query logger - vara\_dblog


.. _EXT-Database-query-logger:

EXT: Database query logger
==========================

Extension Key: vara\_dblog

Language: en

Keywords: forDevelopers, forIntermediates

Copyright 2000-2008, Emiel Nijpels (Omroepvereniging VARA),
<webmaster@vara.nl>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

\- a GNU/GPL CMS/Framework available from www.typo3.org

.. _Table-of-Contents:

Table of Contents
-----------------

`EXT: Database query logger 1
<#1.EXT:%20Database%20query%20logger|outline>`_

**`Introduction 3 <#1.1.Introduction|outline>`_**

`What does it do? 3 <#1.1.1.What%20does%20it%20do_|outline>`_

`Screenshots 3 <#1.1.2.Screenshots|outline>`_

**`Users manual 4 <#1.2.Users%20manual|outline>`_**

**`Administration 5 <#1.3.Administration|outline>`_**

**`Configuration 6 <#1.4.Configuration|outline>`_**

`Reference 6 <#1.4.1.Reference|outline>`_

**`Known problems 7 <#1.5.Known%20problems|outline>`_**

**`To-Do list 8 <#1.6.To-Do%20list|outline>`_**

**`ChangeLog 9 <#1.7.ChangeLog|outline>`_**


.. _Introduction:

Introduction
------------


.. _What-does-it-do:

What does it do?
^^^^^^^^^^^^^^^^

This extensions can be used to log all queries or some queries that
are executed on the database. This can be useful for developing or
debugging an extension. Use this extension with caution, because it
can generate a large amount of database traffic if logging is enabled
for all queries.


.. _Screenshots:

Screenshots
^^^^^^^^^^^

No screenshots yet.


.. _Users-manual:

Users manual
------------

- For now there is no log analyzing tool included in the extension, so
  the best way to view the queries is probably by using the phpmyadmin
  extension.

- Adding extra information to the log can be done by using the
  *logInfoHook* hook in this extension. Create a new extension to add
  new fields to the tx\_varadblog\_query table and use this hook to
  store the extra information.

- IP addresses are stored in numeric format in the database. Use the
  mysql function inet\_ntoa() to convert them back to human-readable
  addresses.


.. _Administration:

Administration
--------------

- After installing this extension a new database table should be
  generated by the extension manager which will be used to log the
  queries. After creating the table there will still be a message about
  the field timestamp not being set up correctly, but this can be
  ignored.

- You can configure this extension from the extension manager; here you
  can enable or disable logging, or enable it just for the frontend or
  the backend. You can also limit logging by filtering by query or URL.
  Both can be specified as a regular expression.

- This extension uses an XCLASS on t3lib\_db and is therefor
  incompatible with other extensions with also use an XCLASS on this
  class, such as dbal. This extension is specifically written for use
  with a mysql database.


.. _Configuration:

Configuration
-------------

All configuration can be done from the extension manager.


.. _Reference:

Reference
^^^^^^^^^

Configuration options in the extension manager:

.. ### BEGIN~OF~TABLE ###


.. _enabled:

enabled
"""""""

.. container:: table-row

   Property
         enabled
   
   Data type
         Option (Disabled, Frontend, Backend, Both)
   
   Description
         Enables or disables logging for backend and frontend queries
   
   Default
         Disabled



.. _queryfilter:

queryfilter
"""""""""""

.. container:: table-row

   Property
         queryfilter
   
   Data type
         Regular expression
   
   Description
         Only log queries with a query that matches this regular expression.
   
   Default



.. _urlfilter:

urlfilter
"""""""""

.. container:: table-row

   Property
         urlfilter
   
   Data type
         Regular expression
   
   Description
         Only log queries with an URL that matches this regular expression.
   
   Default


.. ###### END~OF~TABLE ######


.. _Known-problems:

Known problems
--------------

None at this moment.


.. _To-Do-list:

To-Do list
----------

Add option to write the log information to a file.


.. _ChangeLog:

ChangeLog
---------

Version 0.0.1: first version.

9


.. ######CUTTER_MARK_IMAGES######

.. |img-1| image:: img-1.png
.. :align: left

.. |img-2| image:: img-2.png
.. :border: 0
.. :height: 21
.. :hspace: 9
.. :id: Grafik2
.. :name: Grafik2
.. :width: 87