blob: 6158a012db5a4043ebb1cce1c0fbac95621eb1f4 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.logging.log4j.core.appender.db.jdbc (Apache Log4j Core 2.23.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.logging.log4j.core.appender.db.jdbc">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Package org.apache.logging.log4j.core.appender.db.jdbc" class="title">Package org.apache.logging.log4j.core.appender.db.jdbc</h1>
</div>
<hr>
<div class="package-signature"><span class="annotations">@Export
@Version("2.20.1")
</span>package <span class="element-name">org.apache.logging.log4j.core.appender.db.jdbc</span></div>
<section class="package-description" id="package-description">
<div class="block">The JDBC Appender supports writing log events to a relational database using standard JDBC connections. You will need
a JDBC driver on your classpath for the database you wish to log to.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.logging.log4j.core.appender.db</a></div>
<div class="col-last even-row-color">
<div class="block">The classes in this package and sub packages provide appenders for various types of databases and methods for
accessing databases.</div>
</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractConnectionSource.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">AbstractConnectionSource</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractDriverManagerConnectionSource.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">AbstractDriverManagerConnectionSource</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc"><code>ConnectionSource</code></a> that uses a JDBC connection string, a user name, and a password to call
<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/DriverManager.html#getConnection-java.lang.String-java.lang.String-java.lang.String-" title="class or interface in java.sql" class="external-link"><code>DriverManager.getConnection(String, String, String)</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractDriverManagerConnectionSource.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">AbstractDriverManagerConnectionSource.Builder</a>&lt;B extends <a href="AbstractDriverManagerConnectionSource.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">AbstractDriverManagerConnectionSource.Builder</a>&lt;B&gt;&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Builds DriverManagerConnectionSource instances.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ColumnConfig.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A configuration element used to configure which event properties are logged to which columns in the database table.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ColumnConfig.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">ColumnConfig.Builder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc">ConnectionSource</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Configuration element for <a href="JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc"><code>JdbcAppender</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DataSourceConnectionSource.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">DataSourceConnectionSource</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A <a href="JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc"><code>JdbcAppender</code></a> connection source that uses a <a href="https://docs.oracle.com/javase/8/docs/api/javax/sql/DataSource.html" title="class or interface in javax.sql" class="external-link"><code>DataSource</code></a> to connect to the database.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DriverManagerConnectionSource.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">DriverManagerConnectionSource</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A <a href="ConnectionSource.html" title="interface in org.apache.logging.log4j.core.appender.db.jdbc"><code>ConnectionSource</code></a> that uses a JDBC connection string, a user name, and a password to call
<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/DriverManager.html#getConnection-java.lang.String-java.lang.String-java.lang.String-" title="class or interface in java.sql" class="external-link"><code>DriverManager.getConnection(String, String, String)</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DriverManagerConnectionSource.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">DriverManagerConnectionSource.Builder</a>&lt;B extends <a href="DriverManagerConnectionSource.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">DriverManagerConnectionSource.Builder</a>&lt;B&gt;&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Builds DriverManagerConnectionSource instances.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="FactoryMethodConnectionSource.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">FactoryMethodConnectionSource</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A <a href="JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc"><code>JdbcAppender</code></a> connection source that uses a public static factory method to obtain a <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html" title="class or interface in java.sql" class="external-link"><code>Connection</code></a> or
<a href="https://docs.oracle.com/javase/8/docs/api/javax/sql/DataSource.html" title="class or interface in javax.sql" class="external-link"><code>DataSource</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="JdbcAppender.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcAppender</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This Appender writes logging events to a relational database using standard JDBC mechanisms.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JdbcAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcAppender.Builder</a>&lt;B extends <a href="JdbcAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcAppender.Builder</a>&lt;B&gt;&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="JdbcDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db.jdbc">JdbcDatabaseManager</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An <a href="../AbstractDatabaseManager.html" title="class in org.apache.logging.log4j.core.appender.db"><code>AbstractDatabaseManager</code></a> implementation for relational databases accessed via JDBC.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>