WL#12786: Single include header for JDBC API

Author: rsomla1

CMakeLists.txt

@@ -558,6 +558,10 @@ if(WITH_JDBC)
 
   add_executable(try_jdbc EXCLUDE_FROM_ALL try_jdbc.cc)
   target_link_libraries(try_jdbc connector-jdbc)
+  target_include_directories(try_jdbc
+    PRIVATE "${PROJECT_BINARY_DIR}/include/mysql"
+    PRIVATE "${PROJECT_BINARY_DIR}/include/jdbc/cppconn"
+  )
 
 endif()
 

doc/jdbc_ref.txt

@@ -26,17 +26,11 @@ and reads the result from the server. The source file can be found in
 testapp/jdbc_test.cc in the source distribution of Connector/C++ 8.0.
 See @ref usage for instructions on how to build the sample code.
 
-Each program which uses the legacy C++ API has to include the following
-headers:
+Each program which uses the legacy C++ API has to include this header:
 
 @dontinclude jdbc_test.cc
-@skip #include <jdbc/mysql_connection.h>
-@until #include <jdbc/mysql_driver.h>
-
-These headers are needed for using the `ResultSet` and `Statement` classes:
-
-@skip #include <jdbc/cppconn/resultset.h>
-@until #include <jdbc/cppconn/statement.h>
+@skip #include <mysql/jdbc.h>
+@until #include <mysql/jdbc.h>
 
 Define the credentials for connecting, process command line parameters and
 other housekeeping:

include/CMakeLists.txt

@@ -47,7 +47,7 @@ endif()
 
 setup_headers(${CMAKE_CURRENT_SOURCE_DIR})
 
-
+add_headers_dir(mysql)
 add_headers_dir(mysqlx)
 
 #

include/mysql/CMakeLists.txt

@@ -0,0 +1,49 @@
+# Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2.0, as
+# published by the Free Software Foundation.
+#
+# This program is also distributed with certain software (including
+# but not limited to OpenSSL) that is licensed under separate terms,
+# as designated in a particular file or component or in included license
+# documentation.  The authors of MySQL hereby grant you an
+# additional permission to link the program and your derivative works
+# with the separately licensed software that they have included with
+# MySQL.
+#
+# Without limiting anything contained in the foregoing, this file,
+# which is part of MySQL Connector/C++, is also subject to the
+# Universal FOSS Exception, version 1.0, a copy of which can be found at
+# http://oss.oracle.com/licenses/universal-foss-exception.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU General Public License, version 2.0, for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+
+
+#
+# MySQL Connector/C++ Public Headers
+#
+# see headers.cmake for explanations how project's public
+# headers are declared and processed.
+#
+
+include(headers)
+
+SET(headers jdbc.h)
+
+# TODO: Make it work one beautiful day...
+#check_headers(${headers})
+#ADD_HEADERS(${headers})
+#ADD_HEADER_CHECKS()
+
+INSTALL(FILES ${headers} DESTINATION ${INSTALL_INCLUDE_DIR}/mysql COMPONENT JDBCDev)
+
+
+

include/mysql/jdbc.h

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2018, 2018, Oracle and/or its affiliates. All rights reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2.0, as
+ * published by the Free Software Foundation.
+ *
+ * This program is also distributed with certain software (including
+ * but not limited to OpenSSL) that is licensed under separate terms,
+ * as designated in a particular file or component or in included license
+ * documentation.  The authors of MySQL hereby grant you an
+ * additional permission to link the program and your derivative works
+ * with the separately licensed software that they have included with
+ * MySQL.
+ *
+ * Without limiting anything contained in the foregoing, this file,
+ * which is part of MySQL Connector/C++, is also subject to the
+ * Universal FOSS Exception, version 1.0, a copy of which can be found at
+ * http://oss.oracle.com/licenses/universal-foss-exception.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License, version 2.0, for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+#include "../jdbc/mysql_connection.h"
+#include "../jdbc/mysql_driver.h"
+#include "../jdbc/mysql_error.h"
+#include "../jdbc/cppconn/build_config.h"
+#include "../jdbc/cppconn/config.h"
+#include "../jdbc/cppconn/connection.h"
+#include "../jdbc/cppconn/datatype.h"
+#include "../jdbc/cppconn/driver.h"
+#include "../jdbc/cppconn/exception.h"
+#include "../jdbc/cppconn/metadata.h"
+#include "../jdbc/cppconn/parameter_metadata.h"
+#include "../jdbc/cppconn/prepared_statement.h"
+#include "../jdbc/cppconn/resultset.h"
+#include "../jdbc/cppconn/resultset_metadata.h"
+#include "../jdbc/cppconn/statement.h"
+#include "../jdbc/cppconn/sqlstring.h"
+#include "../jdbc/cppconn/warning.h"
+#include "../jdbc/cppconn/version_info.h"
+#include "../jdbc/cppconn/variant.h"

testapp/jdbc_test.cc

@@ -48,10 +48,7 @@
 
 #include <boost/scoped_ptr.hpp>
 
-#include <jdbc/mysql_connection.h>
-#include <jdbc/mysql_driver.h>
-#include <jdbc/cppconn/resultset.h>
-#include <jdbc/cppconn/statement.h>
+#include <mysql/jdbc.h>
 
 #define DEFAULT_URI "tcp://127.0.0.1"
 #define EXAMPLE_USER "root"

try_jdbc.cc

@@ -29,7 +29,7 @@
  */
 
 #include <iostream>
-#include <jdbc/mysql_driver.h>
+#include <mysql/jdbc.h>
 
 
 using ::std::cout;