Commit c941012d authored by Thomas Markwalder's avatar Thomas Markwalder

[4277] Added PostgreSQL HR Managment section to developer's guide

src/lib/dhcprsrv/images/pgsql_host_data_source.svg
    - New class diagram for PgSqlHostDataSource

doc/Doxyfile
    - Added src/lib/dhcprsrv/images to IMAGE_PATH

src/lib/dhcpsrv/Makefile.am
    - Added images/pgsql_host_data_source.svg to EXTRA_DIST

src/lib/dhcpsrv/libdhcpsrv.dox
    - Added subsection postgreSQLHostMgr

src/lib/dhcpsrv/pgsql_connection.h
src/lib/dhcpsrv/pgsql_exchange.h
    - Minor cleanup
parent 15b51b62
......@@ -886,7 +886,7 @@ EXAMPLE_RECURSIVE = NO
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH = ../doc/images ../src/lib/hooks/images ../src/bin/d2/images
IMAGE_PATH = ../doc/images ../src/lib/hooks/images ../src/bin/d2/images ../src/lib/dhcpsrv/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
......
......@@ -41,6 +41,9 @@ EXTRA_DIST += parsers/host_reservations_list_parser.h
EXTRA_DIST += parsers/ifaces_config_parser.cc
EXTRA_DIST += parsers/ifaces_config_parser.h
# Devel guide diagrams
EXTRA_DIST += images/pgsql_host_data_source.svg
# Define rule to build logging source files from message file
alloc_engine_messages.h alloc_engine_messages.cc dhcpsrv_messages.h \
dhcpsrv_messages.cc hosts_messages.h hosts_messages.cc: s-messages
......
This diff is collapsed.
......@@ -110,6 +110,15 @@ data source (if present) and concatenate results.
For more information about the \ref isc::dhcp::HostMgr please refer to its
documentation.
@subsection postgreSQLHostMgr PostgreSQL Host Reservation Management
Storing and retrieving host reservations within a PostgreSQL schema is
provided by the class, \ref isc::dhcp::PgSqlHostDataSource, a derivation of
\ref isc::dhcp::BaseHostDataSource and is depicted in the following
class diagram:
@image html pgsql_host_data_source.svg "PgSqlHostDataSource Class Diagram"
@section optionsConfig Options Configuration Information
The \ref isc::dhcp::CfgOption object holds a collection of options being
......
......@@ -132,6 +132,7 @@ public:
///
/// @param col index of the column name to fetch
/// @return string containing the name of the column
/// This method is exception safe.
std::string getColumnLabel(const int col) const;
/// @brief Conversion Operator
......
......@@ -271,7 +271,9 @@ public:
/// string "Unknown column:<index>". Note this is NOT from the
/// list of columns defined in the exchange.
///
/// @param r the result set containing the query results
/// @param col index of the column name to fetch
///
/// @return string containing the name of the column
static std::string getColumnLabel(const PgSqlResult& r, const size_t col);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment