mysqlc/README

   1 The MySQL driver for LibreOffice.
   2
   3 It ships as an extension (.oxt file).
   4
   5 == Requirements ==
   6
   7 The MySQL driver for LibreOffice (MySQL Connector/LibreOffice - C/LibO)
   8 requires two external libraries to be built:
   9
  10  1) The MySQL Client Library (libmysql) or MariaDB Client library
  11  2) The MySQL Connector/C++ Library (libmysqlcppconn)
  12
  13 The MariaDB client library is provided as an external and will be
  14 automatically built if you pass "--without-system-mariadb" to
  15 autogen.sh.
  16
  17 libmysqlcppconn is provided as an external and will be automatically
  18 compiled if you pass "--without-system-mysql-cppconn" to autogen.sh.
  19
  20 The MySQL driver for LibreOffice does not reimplement the MySQL
  21 Client/Server communication protocol. The protocol implementation is
  22 part of the MySQL Client Library. The SDBC(X) driver is implemented as
  23 a wrapper of the MySQL Connector/C++ Library which implements a
  24 JDBC-like interface (which suits SDBC(X) well) and which in turn uses
  25 the C based MySQL Client Library.
  26
  27 == Variants ==
  28
  29 If configured with --with-system-mariadb --disable-bundle-mariadb, the
  30 driver will *not* ship a copy of the MySQL client C library and will
  31 expect it to be installed in a standard location on each system that
  32 it runs on. That is usually the right choice to create a native
  33 package/port for GNU/Linux, BSD, etc, where the packaging system
  34 handles dependencies and will ensure the availability of the MySQL
  35 client C library in the standard location.
  36
  37 If configured with --with-system-mariadb --enable-bundle-mariadb, the
  38 driver will ship a copy of the MariaDB (or MySQL) client C library so
  39 that it works "out of the box" on any system. That (or
  40 --without-system-mariadb) is usually the right choice to create a
  41 stand-alone .oxt file that users can just install through the
  42 LibreOffice extensions manager, as is typical for Microsoft Windows
  43 and Apple MacOS X native (as opposed to MacPorts / fink / pkgsrc /
  44 ...).
  45
  46 --disable-bundle-mariadb is the default.
  47
  48 == Installing the Requirements ==
  49
  50 On modern/free-as-in-free-speech Unices, libmysql and libmysqlcppconn
  51 are probably available as a package/port. Install them using your
  52 distribution's tools. Make sure to install the development packages
  53 (whose name usually ends with -dev or -devel), and not only the
  54 libraries themselves.
  55
  56 Else you can install the MariaDB Client Library from official MariaDB
  57 packages at https://downloads.mariadb.org/client-native/ .
  58 They have source and binary distributions for several platforms.
  59 At least series 2.0 is recommended, as series 1.0 are known to be too
  60 buggy. Additionally, version 2.0.0 is known to be incompatible with
  61 MySQL Connector/C++ version 1.1.4, which --without-system-mysqlcppconn
  62 uses, and which --with-system-mysqlcppconn could use
  63 (see https://mariadb.atlassian.net/browse/CONC-104).
  64 Use a version where the above incompatibility has been solved.
  65
  66 Alternatively, MySQL Client Library from official MySQL
  67 packages are at http://dev.mysql.com/downloads/connector/c/ .
  68
  69 You can also install the MySQL Client Library (libmysql) as part of
  70 the MariaDB or MySQL Server, version 5.0 or later. Check the MariaDB
  71 or MySQL manual for instructions:
  72 https://mariadb.com/kb/en/mariadb/documentation/getting-started/getting-installing-and-upgrading-mariadb/
  73 http://dev.mysql.com/doc/refman/5.5/en/installing.html
  74 The typical installation path of the libmysql.so on Unix is
  75 /usr/local/mysql/lib/mysql/ .
  76
  77
  78 Official packages for libmysqlcppconn can be downloaded from
  79 http://dev.mysql.com/downloads/connector/cpp/