|
Apache Log4cxx
Version 2.0.0
|
The ODBCAppender sends log events to a database. More...
#include <odbcappender.h>
Public Types | |
| typedef void * | SQLHDBC |
| typedef void * | SQLHENV |
| typedef void * | SQLHANDLE |
| typedef short | SQLSMALLINT |
Public Member Functions | |
| ODBCAppender () | |
| virtual | ~ODBCAppender () |
| void | setOption (const LogString &option, const LogString &value) override |
Override this method to set option to value. | |
| void | activateOptions () override |
| Activate the specified options. | |
| void | append (const spi::LoggingEventPtr &event) override |
| Adds the event to the buffer. | |
| void | setSql (const LogString &s) |
| Set pre-formated statement eg: insert into LogTable (msg) values ("%m"). | |
| const LogString & | getSql () const |
| Returns pre-formated statement eg: insert into LogTable (msg) values ("%m"). | |
| void | setUser (const LogString &user) |
| void | setURL (const LogString &url) |
| void | setPassword (const LogString &password) |
| void | setBufferSize (size_t newBufferSize) |
| const LogString & | getUser () const |
| const LogString & | getURL () const |
| const LogString & | getPassword () const |
| size_t | getBufferSize () const |
| Public Member Functions inherited from log4cxx::AppenderSkeleton | |
| AppenderSkeleton (const LayoutPtr &layout={}) | |
| virtual | ~AppenderSkeleton () |
| void | addFilter (const spi::FilterPtr &newFilter) override |
Add newFilter to end of the spi::Filter chain. | |
| void | clearFilters () override |
| Clear the spi::Filter chain. | |
| void | close () override |
| Release any resources allocated within the appender such as file handles, network connections, etc. | |
| const spi::ErrorHandlerPtr | getErrorHandler () const |
| The currently set spi::ErrorHandler for this Appender. | |
| spi::FilterPtr | getFilter () const override |
| The first spi::Filter in the filter chain for this Appender. | |
| const spi::FilterPtr | getFirstFilter () const |
| The first spi::Filter in the filter chain for this Appender. | |
| LayoutPtr | getLayout () const override |
| The currently set Layout for this appender. | |
| LogString | getName () const override |
| The name of this Appender. | |
| const LevelPtr | getThreshold () const |
| This appender's current threshold level. | |
| bool | isAsSevereAsThreshold (const LevelPtr &level) const |
Is level greater than or equal to this appender's threshold? | |
| void | doAppend (const spi::LoggingEventPtr &event) override |
| Call doAppendImpl after acquiring a lock that prevents other threads from concurrently executing doAppendImpl. | |
| void | setErrorHandler (const spi::ErrorHandlerPtr &newValue) |
Use newValue as the spi::ErrorHandler for this Appender. | |
| void | setLayout (const LayoutPtr &newValue) override |
Use newValue as the layout for this appender. | |
| void | setName (const LogString &newValue) override |
Use newValue for the name of this Appender. | |
| void | setThreshold (const LevelPtr &newValue) |
Use newValue as this appender's threshold level. | |
| void | activateOptions (helpers::Pool &) |
| Public Member Functions inherited from log4cxx::Appender | |
| virtual | ~Appender () |
| void | doAppend (const spi::LoggingEventPtr &event, helpers::Pool &pool) |
| virtual bool | requiresLayout () const |
| Public Member Functions inherited from log4cxx::spi::OptionHandler | |
| virtual | ~OptionHandler () |
| void | activateOptions (helpers::Pool &) |
| Public Member Functions inherited from log4cxx::helpers::Object | |
| virtual | ~Object () |
| virtual const helpers::Class & | getClass () const =0 |
| virtual bool | instanceof (const Class &clazz) const =0 |
| virtual const void * | cast (const Class &clazz) const =0 |
Protected Member Functions | |
| virtual void | closeConnection (SQLHDBC con) |
| Override this to return the connection to a pool, or to clean up the resource. | |
| virtual SQLHDBC | getConnection () |
| Override this to link with your connection pooling system. | |
| virtual void | flushBuffer () |
| loops through the buffer of LoggingEvents, gets a sql string from getLogStatement() and sends it to execute(). | |
| Protected Member Functions inherited from log4cxx::AppenderSkeleton | |
| AppenderSkeleton (LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv) | |
| void | doAppendImpl (const spi::LoggingEventPtr &event) |
Call the AppenderSkeleton::append method if the level of event is not lower than this appender's threshold and no attached spi::Filter indicates event is rejected. | |
| bool | isAccepted (const spi::LoggingEventPtr &event) const |
Does no attached filter deny event or does an attached filter accept event? | |
The ODBCAppender sends log events to a database.
Each append call adds the spi::LoggingEvent to a buffer. When the buffer is full, values are extracted from each spi::LoggingEvent and the sql insert statement executed.
The SQL insert statement pattern must be provided either in the Log4cxx configuration file using the sql parameter element or programatically by calling the setSql(String sql) method.
The following param elements are optional:
(1) Only available when the LOG4CXX_* macros are used to issue the logging request.
For use as a base class:
Override getConnection() to pass any connection you want. Typically this is used to enable application wide connection pooling.
Override closeConnection – if you override getConnection make sure to implement closeConnection to handle the connection you generated. Typically this would return the connection to the pool it came from.
An example configuration that writes to the data source named "LoggingDSN" is:
You may also want to consider the DBAppender class, which uses APR in order to support logging to databases apart from ODBC.
| typedef void* log4cxx::db::ODBCAppender::SQLHANDLE |
| typedef void* log4cxx::db::ODBCAppender::SQLHDBC |
| typedef void* log4cxx::db::ODBCAppender::SQLHENV |
| typedef short log4cxx::db::ODBCAppender::SQLSMALLINT |
| log4cxx::db::ODBCAppender::ODBCAppender | ( | ) |
|
virtual |
|
overridevirtual |
Activate the specified options.
Reimplemented from log4cxx::AppenderSkeleton.
|
overridevirtual |
Adds the event to the buffer.
When full the buffer is flushed.
Implements log4cxx::AppenderSkeleton.
|
protectedvirtual |
Override this to return the connection to a pool, or to clean up the resource.
The default behavior holds a single connection open until the appender is closed (typically when garbage collected).
|
protectedvirtual |
loops through the buffer of LoggingEvents, gets a sql string from getLogStatement() and sends it to execute().
Errors are sent to the errorHandler.
If a statement fails the LoggingEvent stays in the buffer!
| size_t log4cxx::db::ODBCAppender::getBufferSize | ( | ) | const |
|
protectedvirtual |
Override this to link with your connection pooling system.
By default this creates a single connection which is held open until the object is garbage collected.
| const LogString & log4cxx::db::ODBCAppender::getPassword | ( | ) | const |
| const LogString & log4cxx::db::ODBCAppender::getSql | ( | ) | const |
Returns pre-formated statement eg: insert into LogTable (msg) values ("%m").
| const LogString & log4cxx::db::ODBCAppender::getURL | ( | ) | const |
| const LogString & log4cxx::db::ODBCAppender::getUser | ( | ) | const |
| void log4cxx::db::ODBCAppender::setBufferSize | ( | size_t | newBufferSize | ) |
|
overridevirtual |
Override this method to set option to value.
| Supported options | Supported values | Default value |
|---|---|---|
| BufferSize | {int} | 1 |
| ConnectionString | {any} | - |
| URL | {any} | - |
| DSN | {any} | - |
| User | {any} | - |
| Password | {any} | - |
| SQL | {any} | - |
| ColumnMapping | (^) | - |
(^) One value for each '?' character in the SQL value.
Reimplemented from log4cxx::AppenderSkeleton.
| void log4cxx::db::ODBCAppender::setPassword | ( | const LogString & | password | ) |
| void log4cxx::db::ODBCAppender::setSql | ( | const LogString & | s | ) |
Set pre-formated statement eg: insert into LogTable (msg) values ("%m").
| void log4cxx::db::ODBCAppender::setURL | ( | const LogString & | url | ) |
| void log4cxx::db::ODBCAppender::setUser | ( | const LogString & | user | ) |