1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>3.Tutorial</title><link rel="stylesheet" type="text/css" href="tangentsoft.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="MySQL++ v3.2.2 User Manual"><link rel="up" href="index.html" title="MySQL++ v3.2.2 User Manual"><link rel="prev" href="overview.html" title="2.Overview"><link rel="next" href="tquery.html" title="4.Template Queries"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.Tutorial</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="overview.html">Prev</a></td><th width="60%" align="center"></th><td width="20%" align="right"><a accesskey="n" href="tquery.html">Next</a></td></tr></table><hr></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="tutorial"></a>3.Tutorial</h2></div></div></div><p>The <a class="link" href="overview.html" title="2.Overview">previous chapter</a> introduced
the major top-level mechanisms in MySQL++. Now we’ll dig down a
little deeper and get into real examples. We start off with the basics
that every MySQL++ program will have to deal with, then work up to
more complex topics that are still widely interesting. You can stop
reading the manual after this chapter and still get a lot out of
MySQL++, ignoring the more advanced parts we present in later
chapters.</p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="examples"></a>3.1.Running the Examples</h3></div></div></div><p>All of the examples are complete running programs. If you
built the library from source, the examples should have been built
as well. If you use RPMs instead, the example programs’ source
code and a simplified <code class="filename">Makefile</code> are in the
<code class="filename">mysql++-devel</code> package. They are typically
installed in
<code class="filename">/usr/share/doc/mysql++-devel-*/examples</code>, but it
can vary on different Linuxes.</p><p>Before you get started, please read through any of the
<code class="filename">README*.txt</code> files included with the MySQL++
distribution that are relevant to your platform. We won’t
repeat all of that here.</p><p>Most of the examples require a test database, created by
<code class="filename">resetdb</code>. You can run it like so:</p><pre class="screen">resetdb [-s server_addr] [-u user] [-p password]</pre><p>Actually, there’s a problem with that. It assumes that
the MySQL++ library is already installed in a directory that the
operating system’s dynamic linker can find. (MySQL++ is almost
never built statically.) Unless you’re installing from RPMs,
you’ve had to build the library from source, and you should
run at least a few of the examples before installing the library to
be sure it’s working correctly. Since your operating
system’s dynamic linkage system can’t find the MySQL++
libraries without help until they’re installed, we’ve
created a few helper scripts to help run the examples.</p><p>MySQL++ comes with the <code class="filename">exrun</code> shell script
for Unixy systems, and the <code class="filename">exrun.bat</code> batch file
for Windows. You pass the example program and its arguments to the
<code class="filename">exrun</code> helper, which sets up the library search
path so that it will use the as-yet uninstalled version of the
MySQL++ library in preference to any other on your system:</p><pre class="screen">./exrun resetdb [-s server_addr] [-u user] [-p password]</pre><p>That’s the typical form for a Unixy system. You leave
off the <span class="command"><strong>./</strong></span> bit on Windows. You can leave it
off on a Unixy system, too, if you have <code class="filename">.</code>
in your <code class="varname">PATH</code>. (Not a recommendation, just
an observation.)</p><p>All of the program arguments are optional.</p><p>If you don’t give <code class="option">-s</code>,
the underlying MySQL C API (a.k.a. <a class="ulink" href="https://dev.mysql.com/downloads/connector/c/" target="_top">Connector/C</a>)
assumes the server is on the local machine. It chooses
one of several different IPC options based on the platform
configuration. There are many different forms you can give
as <code class="varname">server_addr</code> with <code class="option">-s</code> to
override this default behavior:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="emphasis"><em>localhost</em></span> — this is the
default; it doesn’t buy you anything</p></li><li class="listitem"><p>On Windows, a simple period tells the underlying MySQL C
API to use named pipes, if it’s available.</p></li><li class="listitem"><p><span class="emphasis"><em>172.20.0.252:12345</em></span> — this would
connect to IP address
<code class="computeroutput">172.20.0.252</code> on TCP port
<code class="computeroutput">12345</code>.</p></li><li class="listitem"><p><span class="emphasis"><em>my.server.name:svc_name</em></span> — this
would first look up TCP service name
<code class="computeroutput">svc_name</code> in your system’s
network services database (<code class="filename">/etc/services</code> on
Unixy systems, and something like
<code class="filename">c:\windows\system32\drivers\etc\services</code> on
modern Windows variants). If it finds an entry for the service,
it then tries to connect to that port on the domain name
given.</p></li></ul></div><p>For the TCP forms, you can mix names and numbers for the host
and port/service parts in any combination. If the server name
doesn’t contain a colon, it uses the default port,
3306.</p><p>If you don’t give <code class="option">-u</code>, it assumes your
user name on the database server is the same as your login name on
the local machine.</p><p>If you don’t give <code class="option">-p</code>, it will assume
the MySQL user doesn’t have a password. (One hopes this
isn’t the case...)</p><p>When running <code class="filename">resetdb</code>, the user name needs
to be for an account with permission to create the test database.
Once the database is created, you can use any account when running
the other examples that has DELETE, INSERT, SELECT and UPDATE
permissions for the test database. The MySQL root user can do all
this, of course, but you might want to set up a separate user,
having only the permissions necessary to work with the test
database:</p><pre class="screen">
CREATE USER mysqlpp_test@'%' IDENTIFIED BY ’nunyabinness';
GRANT ALL PRIVILEGES ON mysql_cpp_data.* TO mysqlpp_test@'%';</pre><p>You could then create the sample database with the following
command:</p><pre class="screen">./exrun resetdb -u mysqlpp_test -p nunyabinness</pre><p>(Again, leave off the <span class="command"><strong>./</strong></span> bit on
Windows.)</p><p>You may have to re-run <code class="filename">resetdb</code> after
running some of the other examples, as they change the
database.</p><p>See <code class="filename">README-examples.txt</code> for more
details on running the examples.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="simple"></a>3.2.A Simple Example</h3></div></div></div><p>The following example demonstrates how to open a connection,
execute a simple query, and display the results. This is
<code class="filename">examples/simple1.cpp</code>:</p><pre class="programlisting">#include "cmdline.h"
#include "printdata.h"
#include <mysql++.h>
#include <iostream>
#include <iomanip>
using namespace std;
int
main(int argc, char *argv[])
{
// Get database access parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
// Connect to the sample database.
mysqlpp::Connection conn(false);
if (conn.connect(mysqlpp::examples::db_name, cmdline.server(),
cmdline.user(), cmdline.pass())) {
// Retrieve a subset of the sample stock table set up by resetdb
// and display it.
mysqlpp::Query query = conn.query("select item from stock");
if (mysqlpp::StoreQueryResult res = query.store()) {
cout << "We have:" << endl;
mysqlpp::StoreQueryResult::const_iterator it;
for (it = res.begin(); it != res.end(); ++it) {
mysqlpp::Row row = *it;
cout << '\t' << row[0] << endl;
}
}
else {
cerr << "Failed to get item list: " << query.error() << endl;
return 1;
}
return 0;
}
else {
cerr << "DB connection failed: " << conn.error() << endl;
return 1;
}
}
</pre><p>This example simply gets the entire "item" column from the
example table, and prints those values out.</p><p>Notice that MySQL++’s <tt><a href="../refman/classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a></tt> derives from
<code class="classname">std::vector</code>, and <tt><a href="../refman/classmysqlpp_1_1Row.html">Row</a></tt> provides an interface that makes it a
<code class="classname">vector</code> work-alike. This means you can access
elements with subscript notation, walk through them with iterators,
run STL algorithms on them, etc.</p><p><code class="classname">Row</code> provides a little more in this area
than a plain old <code class="classname">vector</code>: you can also access
fields by name using subscript notation.</p><p>The only thing that isn’t explicit in the code above is
that we delegate command line argument parsing to
<code class="function">parse_command_line()</code> in the
<code class="filename">excommon</code> module. This function exists to give
the examples a consistent interface, not to hide important details.
You can treat it like a black box: it takes <code class="varname">argc</code>
and <code class="varname">argv</code> as inputs and sends back database
connection parameters.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="simple2"></a>3.3.A More Complicated Example</h3></div></div></div><p>The <code class="filename">simple1</code> example above was pretty
trivial. Let’s get a little deeper. Here is
<code class="filename">examples/simple2.cpp</code>:</p><pre class="programlisting">#include "cmdline.h"
#include "printdata.h"
#include <mysql++.h>
#include <iostream>
#include <iomanip>
using namespace std;
int
main(int argc, char *argv[])
{
// Get database access parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
// Connect to the sample database.
mysqlpp::Connection conn(false);
if (conn.connect(mysqlpp::examples::db_name, cmdline.server(),
cmdline.user(), cmdline.pass())) {
// Retrieve the sample stock table set up by resetdb
mysqlpp::Query query = conn.query("select * from stock");
mysqlpp::StoreQueryResult res = query.store();
// Display results
if (res) {
// Display header
cout.setf(ios::left);
cout << setw(31) << "Item" <<
setw(10) << "Num" <<
setw(10) << "Weight" <<
setw(10) << "Price" <<
"Date" << endl << endl;
// Get each row in result set, and print its contents
for (size_t i = 0; i < res.num_rows(); ++i) {
cout << setw(30) << res[i]["item"] << ' ' <<
setw(9) << res[i]["num"] << ' ' <<
setw(9) << res[i]["weight"] << ' ' <<
setw(9) << res[i]["price"] << ' ' <<
setw(9) << res[i]["sdate"] <<
endl;
}
}
else {
cerr << "Failed to get stock table: " << query.error() << endl;
return 1;
}
return 0;
}
else {
cerr << "DB connection failed: " << conn.error() << endl;
return 1;
}
}
</pre><p>The main point of this example is that we’re accessing
fields in the row objects by name, instead of index. This is slower,
but obviously clearer. We’re also printing out the entire
table, not just one column.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="exceptions"></a>3.4.Exceptions</h3></div></div></div><p>By default, MySQL++ uses exceptions to signal errors.
We’ve been suppressing this in all the examples so far by
passing <span class="symbol">false</span> to
<code class="classname">Connection</code>’s constructor. This kept
these early examples simple at the cost of some flexibility and
power in error handling. In a real program, we recommend that you
leave exceptions enabled. You do this by either using the default
<code class="classname">Connection</code> constructor, or by using the
create-and-connect constructor.</p><p>All of MySQL++’s custom exceptions
derive from a common base class, <tt><a href="../refman/classmysqlpp_1_1Exception.html">Exception</a></tt>. That in turn derives from Standard C++’s
<code class="classname">std::exception</code> class. Since the library
can indirectly cause exceptions to come from the Standard
C++ Library, it’s possible to catch all exceptions from
MySQL++ by just catching <code class="classname">std::exception</code>.
However, it’s better to have individual catch blocks
for each of the concrete exception types that you expect, and
add a handler for either <code class="classname">Exception</code>
or <code class="classname">std::exception</code> to act as a
“catch-all” for unexpected exceptions.</p><p>When exceptions are suppressed, MySQL++ signals errors
by returning either an error code or an object that tests
as false, or by setting an error flag on the object. Classes
that allow you to suppress exceptions derive from the <tt><a href="../refman/classmysqlpp_1_1OptionalExceptions.html">OptionalExceptions</a></tt> interface. When
an <code class="classname">OptionalExceptions</code> derivative
creates another object that also derives from this interface,
it passes on its exception flag. Since everything flows from
the <tt><a href="../refman/classmysqlpp_1_1Connection.html">Connection</a></tt> object, disabling
exceptions on it at the start of the program disables all optional
exceptions. This is why passing <span class="symbol">false</span> for the
<code class="classname">Connection</code> constructor’s “throw
exceptions” parameter suppresses all optional exceptions
in the <code class="filename">simple[1-3]</code> examples. It keeps them,
well, simple.</p><p>This exception suppression mechanism is quite granular.
It’s possible to leave exceptions enabled most of the time,
but suppress them in sections of the code where they aren’t
helpful. To do this, put the section of code that you want to not
throw exceptions inside a block, and create a <tt><a href="../refman/classmysqlpp_1_1NoExceptions.html">NoExceptions</a></tt> object at the top of that block. When created,
it saves the exception flag of the
<code class="classname">OptionalExceptions</code> derivative you pass to it,
and then disables exceptions on it. When the
<code class="classname">NoExceptions</code> object goes out of scope at the
end of the block, it restores the exceptions flag to its previous
state:</p><pre class="programlisting">mysqlpp::Connection con; // default ctor, so exceptions enabled
{
mysqlpp::NoExceptions ne(con);
if (!con.select_db("a_db_that_might_not_exist_yet")) {
// Our DB doesn’t exist yet, so create and select it here; no need
// to push handling of this case way off in an exception handler.
}
}</pre><p>When one <code class="classname">OptionalExceptions</code> derivative
passes its exceptions flag to another such object, it is only
passing a copy; the two objects’ flags operate independently.
There’s no way to globally enable or disable this flag on
existing objects in a single call. If you’re using the
<code class="classname">NoExceptions</code> feature and you’re
still seeing optional exceptions thrown, you disabled exceptions
on the wrong object. The exception thrower could be unrelated to
the object you disabled exceptions on, it could be its parent,
or it could be a child created before you disabled optional
exceptions.</p><p>MySQL++ throws some exceptions unconditionally:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>MySQL++ checks array indices,
always. For instance, if your code said
“<code class="varname">row[21]</code>” on a
row containing only 5 fields, you’d get a
<code class="classname">BadIndex</code> exception. If you
say “<code class="varname">row["fred"]</code>”
on a row without a “fred” field, you get
a <code class="classname">BadFieldName</code> exception. In
the past, MySQL++ delegated some of its index checking
to the STL containers underpinning it, so you could get
<code class="classname">std::range_error</code> instead. As of MySQL++
v3.0.7, this should no longer happen, but there may be instances
where it still does.</p></li><li class="listitem"><p><tt><a href="../refman/classmysqlpp_1_1String.html">String</a></tt> will always
throw <tt><a href="../refman/classmysqlpp_1_1BadConversion.html">BadConversion</a></tt> when you ask it
to do an improper type conversion. For example, you’ll get
an exception if you try to convert “1.25” to
<span class="type">int</span>, but not when you convert “1.00” to
<span class="type">int</span>. In the latter case, MySQL++ knows that it can
safely throw away the fractional part.</p></li><li class="listitem"><p>If you use template queries and don’t pass
enough parameters when instantiating the template,
<code class="classname">Query</code> will throw a <tt><a href="../refman/classmysqlpp_1_1BadParamCount.html">BadParamCount</a></tt> exception.</p></li><li class="listitem"><p>If you use a C++ data type in a query
that MySQL++ doesn’t know to convert to SQL, MySQL++
will throw a <tt><a href="../refman/classmysqlpp_1_1TypeLookupFailed.html">TypeLookupFailed</a></tt>
exception. It typically happens with <a class="xref" href="ssqls.html" title="5.Specialized SQL Structures">Section5, “Specialized SQL Structures”</a>,
especially when using data types other than the ones defined
in <code class="filename">lib/sql_types.h</code>.</p></li></ul></div><p>It’s educational to modify the examples to force
exceptions. For instance, misspell a field name, use an out-of-range
index, or change a type to force a <code class="classname">String</code>
conversion error.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="qescape"></a>3.5.Quoting and Escaping</h3></div></div></div><p>SQL syntax often requires certain data to be quoted. Consider
this query:</p><pre class="programlisting">
SELECT * FROM stock WHERE item = 'Hotdog Buns' </pre><p>Because the string “Hotdog Buns” contains a space,
it must be quoted. With MySQL++, you don’t have to add these
quote marks manually:</p><pre class="programlisting">
string s = "Hotdog Buns";
query << "SELECT * FROM stock WHERE item = " << quote_only << s; </pre><p>That code produces the same query string as in the previous
example. We used the MySQL++ <span class="type">quote_only</span> manipulator,
which causes single quotes to be added around the next item inserted
into the stream. This works for any type of data that can be
converted to MySQL++’s <tt><a href="../refman/classmysqlpp_1_1SQLTypeAdapter.html">SQLTypeAdapter</a></tt> type, plus the <tt><a href="../refman/classmysqlpp_1_1Set.html">Set</a></tt> template. <a class="link" href="ssqls.html" title="5.Specialized SQL Structures">SSQLS</a> also uses these manipulators
internally.</p><p>Quoting is pretty simple, but SQL syntax also often requires
that certain characters be “escaped”. Imagine if the
string in the previous example was “Frank’s Brand Hotdog
Buns” instead. The resulting query would be:</p><pre class="programlisting">
SELECT * FROM stock WHERE item = 'Frank's Brand Hotdog Buns' </pre><p>That’s not valid SQL syntax. The correct syntax is:</p><pre class="programlisting">
SELECT * FROM stock WHERE item = 'Frank''s Brand Hotdog Buns' </pre><p>As you might expect, MySQL++ provides that feature, too,
through its <span class="type">escape</span> manipulator. But here, we want both
quoting and escaping. That brings us to the most widely useful
manipulator:</p><pre class="programlisting">
string s = "Frank’s Brand Hotdog Buns";
query << "SELECT * FROM stock WHERE item = " << quote << s; </pre><p>The <span class="type">quote</span> manipulator both quotes strings and
escapes any characters that are special in SQL.</p><p>MySQL++ provides other manipulators as well. See the <a class="ulink" href="../refman/manip_8h.html" target="_top">manip.h</a> page in the <a class="ulink" href="../refman/index.html" target="_top">reference manual</a>.</p><p>It’s important to realize that MySQL++’s quoting
and escaping mechanism is type-aware. Manipulators have no effect
unless you insert the manipulator into a
<code class="classname">Query</code> or <tt><a href="../refman/classmysqlpp_1_1SQLQueryParms.html">SQLQueryParms</a></tt> stream.
<a href="#ftn.idm47108348350992" class="footnote" name="idm47108348350992"><sup class="footnote">[2]</sup></a> Also, values are only quoted and/or
escaped if they are of a data type that may need it. For example,
<tt><a href="../refman/structmysqlpp_1_1Date.html">Date</a></tt> must be quoted but
never needs to be escaped, and integer types need neither quoting
nor escaping. Manipulators are suggestions to the library, not
commands: MySQL++ will ignore these suggestions if it knows it
won’t result in syntactically-incorrect SQL.</p><p>It’s also important to realize that quoting and escaping
in <code class="classname">Query</code> streams and template queries is
never implicit.<a href="#ftn.idm47108348347408" class="footnote" name="idm47108348347408"><sup class="footnote">[3]</sup></a> You must use
manipulators and template query flags as necessary to tell MySQL++
where quoting and escaping is necessary. It would be nice if MySQL++
could do quoting and escaping implicitly based on data type, but
this isn’t possible in all cases.<a href="#ftn.whyexpmanip" class="footnote" name="whyexpmanip"><sup class="footnote">[4]</sup></a> Since
MySQL++ can’t reliably guess when quoting and escaping is
appropriate, and the programmer doesn’t need
to<a href="#ftn.idm47108348341904" class="footnote" name="idm47108348341904"><sup class="footnote">[5]</sup></a>, MySQL++ makes you
tell it.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="sql-types"></a>3.6.C++ vs. SQL Data Types</h3></div></div></div><p>The C++ and SQL data type systems have several differences
that can cause problems when using MySQL++, or any other SQL
based system, for that matter.</p><p>Most of the data types you can store in a SQL database are
either numbers or text strings. If you’re only looking at
the data going between the database server and your application,
there aren’t even numbers: SQL is a textual language, so
numbers and everything else gets transferred between the client
and the database server in text string form.<a href="#ftn.idm47108348338352" class="footnote" name="idm47108348338352"><sup class="footnote">[6]</sup></a> Consequently, MySQL++
has a lot of <a class="link" href="tutorial.html#string-types" title="3.8.MySQL++’s Special String Types">special support</a>
for text strings, and can translate to several C++ numeric data
types transparently.</p><p>Some people worry that this translation via an intermediate
string form will cause data loss. Obviously the text string data
types are immune from problems in this regard. We’re also
confident that MySQL++ translates <a class="link" href="tutorial.html#blob" title="3.9.Dealing with Binary Data">BLOB</a>
and integer data types losslessly.</p><p>The biggest worry is with floating-point numbers. (The FLOAT
and DOUBLE SQL data types.) We did have a problem with this in
older versions of MySQL++, but we believe we fixed it completely
in v3.0.2. No one has since proven data loss via this path. There
is still a known problem
<a href="#ftn.idm47108348333776" class="footnote" name="idm47108348333776"><sup class="footnote">[7]</sup></a>
with the SQL DECIMAL type, which is somewhat related to the
floating-point issue, but it’s apparently rarely encountered,
which is why it hasn’t been fixed yet.</p><p>The best way to avoid problems with data translation
is to always use the special MySQL++ data types defined in
<code class="filename">lib/sql_types.h</code> corresponding to your
SQL schema. These typedefs begin with <span class="type">sql_</span> and
end with a lowercase version of the standard SQL type name,
with spaces replaced by underscores. There are variants
ending in <span class="type">_null</span> that wrap these base types
so they’re <a class="link" href="tutorial.html#sql-null" title="3.7.Handling SQL Nulls">compatible with
SQL null</a>. For instance, the SQL type <span class="type">TINYINT
UNSIGNED NOT NULL</span> is represented in MySQL++ by
<code class="classname">mysqlpp::sql_tinyint_unsigned</code>. If you drop
the <span class="type">NOT NULL</span> part, the corresponding C++ type is
<code class="classname">mysqlpp::sql_tinyint_unsigned_null</code>.</p><p>MySQL++ doesn’t force you to use these typedefs. It
tries to be flexible with regard to data conversions,
so you could probably use <span class="type">int</span> anywhere you
use <code class="classname">mysqlpp::sql_tinyint_unsigned</code>,
for example. That said, the MySQL++ typedefs give several
advantages:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Space efficiency: the MySQL++ types are no
larger than necessary to hold the MySQL data.</p></li><li class="listitem"><p>Portability: if your program has to run on
multiple different system types (even just 32- and 64-bit
versions of the same operating system and processor type)
using the MySQL++ typedefs insulates your code from platform
changes.</p></li><li class="listitem"><p>Clarity: using C++ types named similarly to the
SQL types reduces the risk of confusion when working with code in
both languages at the same time.</p></li><li class="listitem"><p>Compatibility: using the MySQL++ types ensures
that data conversions between SQL and C++ forms are compatible.
Nave use of plain old C++ types can result in data
truncation, <tt><a href="../refman/classmysqlpp_1_1TypeLookupFailed.html">TypeLookupFailed</a></tt>
exceptions, and worse.</p><p>Type compatibility is important not just at the time
you write your program, it also helps forward compatibility:
we occasionally change the definitions of the MySQL++
typedefs to reduce the differences between the C++
and SQL type systems. We’ll be fixing the DECIMAL issue
brought up above this way, for instance; if your program
uses <code class="classname">sql_decimal</code> instead of the
current underlying type, <span class="type">double</span>, your program
will pick up this improvement automatically with just a
recompile.</p></li></ul></div><p>Most of these typedefs use standard C++ data types, but
a few are aliases for a MySQL++ specific type. For instance,
the SQL type <code class="classname">DATETIME</code> is mirrored in
MySQL++ by <code class="classname">mysqlpp::DateTime</code>. For
consistency, <code class="filename">sql_types.h</code> includes a
typedef alias for <code class="classname">DateTime</code> called
<code class="classname">mysqlpp::sql_datetime</code>.</p><p>MySQL++ doesn’t have typedefs for the most exotic data
types, like those for the geospatial types. Patches to correct
this will be thoughtfully considered.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="sql-null"></a>3.7.Handling SQL Nulls</h3></div></div></div><p>Both C++ and SQL have things in them called NULL, but they
differ in several ways. Consequently, MySQL++ has to provide
special support for this, rather than just wrap native C++
facilities as it can with most data type issues.</p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="sql-null-type"></a>SQL NULL is a type modifier</h4></div></div></div><p>The primary distinction is one of type. In SQL,
“NULL” is a type modifier, which affects whether
you can legally store a null value in that column. There’s
simply nothing like it in C++.</p><p>To emulate SQL NULL, MySQL++ provides the <tt><a href="../refman/classmysqlpp_1_1null.html">Null</a></tt> template to allow
the creation of distinct “nullable” versions of
existing C++ types. So for example, if you have a <span class="type">TINYINT
UNSIGNED</span> column that can have nulls, the proper
declaration for MySQL++ would be:</p><pre class="programlisting">
mysqlpp::Null<mysqlpp::sql_tinyint_unsigned> myfield;</pre><p>As of MySQL++ 3.1, we also provide shorter aliases for
such types:</p><pre class="programlisting">
mysqlpp::sql_tinyint_unsigned_null myfield;</pre><p>These types are declared in
<code class="filename">lib/sql_types.h</code>. You might want to scan
through that to see what all is available.</p><p>Template instantiations are first-class types in the C++
language, so there’s no possible confusion between this
feature of MySQL++ and C++’s native NULL concept.</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="sql-null-value"></a>SQL NULL is a unique value</h4></div></div></div><p>There’s a secondary distinction between SQL null and
anything available in the standard C++ type system: SQL null
is a distinct value, equal to nothing else. We can’t
use C++’s <span class="symbol">NULL</span> for this because it
is ambiguous, being equal to 0 in integer context. MySQL++
provides the global <code class="varname">null</code> object, which you
can assign to a <code class="classname">Null</code> template instance
to make it equal to SQL null:</p><pre class="programlisting">
myfield = mysqlpp::null;</pre><p>If you insert a MySQL++ field holding a SQL null into a
C++ IOstream, you get “(NULL)”, something fairly
unlikely to be in a normal output string, thus reasonably
preserving the uniqueness of the SQL null value.</p><p>MySQL++ also tries to enforce the uniqueness of the
SQL null value at compile time in assignments and data
conversions. If you try to store a SQL null in a field type
that isn’t wrapped by <code class="classname">Null</code>
or try to assign a <code class="classname">Null</code>-wrapped
field value to a variable of the inner non-wrapped type,
the compiler will emit some ugly error message, yelling about
<span class="type">CannotConvertNullToAnyOtherDataType</span>. (The exact
message is compiler-dependent.)</p><p>If you don’t like these behaviors, you can change
them by passing a different value for the second parameter
to template <code class="classname">Null</code>. By default, this
parameter is <tt><a href="../refman/structmysqlpp_1_1NullIsNull.html">NullIsNull</a></tt>,
meaning that we should enforce the uniqueness of SQL
null. To relax the distinctions, you can instantiate the
<code class="classname">Null</code> template with a different behavior
type: <tt><a href="../refman/structmysqlpp_1_1NullIsZero.html">NullIsZero</a></tt> or <tt><a href="../refman/structmysqlpp_1_1NullIsBlank.html">NullIsBlank</a></tt>. Consider this code:</p><pre class="programlisting">
mysqlpp::Null<unsigned char, mysqlpp::NullIsZero> myfield(mysqlpp::null);
cout << myfield << endl;
cout << int(myfield) << endl;</pre><p>This will print “0” twice. If you had used the
default for the second <code class="classname">Null</code> template
parameter, the first output statement would have printed
“(NULL)”, and the second wouldn’t even
compile.</p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="string-types"></a>3.8.MySQL++’s Special String Types</h3></div></div></div><p>MySQL++ has two classes that work like
<code class="classname">std::string</code> to some degree: <tt><a href="../refman/classmysqlpp_1_1String.html">String</a></tt> and <tt><a href="../refman/classmysqlpp_1_1SQLTypeAdapter.html">SQLTypeAdapter</a></tt>. These classes exist to provide functionality
that <code class="classname">std::string</code> doesn’t provide, but
they are neither derivatives of nor complete supersets of
<code class="classname">std::string</code>. As a result, end-user code
generally doesn’t deal with these classes directly, because
<code class="classname">std::string</code> is a better general-purpose
string type. In fact, MySQL++ itself uses
<code class="classname">std::string</code> most of the time, too. But, the
places these specialized stringish types do get used are so
important to the way MySQL++ works that it’s well worth taking
the time to understand them.</p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="SQLTypeAdapter"></a>SQLTypeAdapter</h4></div></div></div><p>The simpler of the two is
<code class="classname">SQLTypeAdapter</code>, or
<code class="classname">STA</code> for short.<a href="#ftn.idm47108348285248" class="footnote" name="idm47108348285248"><sup class="footnote">[8]</sup></a></p><p>As its name suggests, its only purpose is to adapt other
data types to be used with SQL. It has a whole bunch of conversion
constructors, one for all data types we expect to be used with
MySQL++ for values in queries. SQL queries are strings, so
constructors that take stringish types just make a copy of that
string, and all the others “stringize” the value in
the format needed by
SQL.<a href="#ftn.idm47108348282480" class="footnote" name="idm47108348282480"><sup class="footnote">[9]</sup></a> The conversion
constructors preserve type information, so this stringization
process doesn’t throw away any essential information.</p><p><code class="classname">STA</code> is used anywhere MySQL++ needs to
be able to accept any of several data types for use in a SQL
query. Major users are <code class="classname">Query</code>’s
template query mechanism and the <code class="classname">Query</code>
stream quoting and escaping mechanism. You care about
<code class="classname">STA</code> because any time you pass a data value
to MySQL++ to be used in building a SQL query, it goes through
<code class="classname">STA</code>. <code class="classname">STA</code> is one of
the key pieces in MySQL++ that makes it easy to generate
syntactically-correct SQL queries.</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="String"></a>String</h4></div></div></div><p>If MySQL++ can be said to have its own generic string type,
it’s <code class="classname">String</code>, but it’s not
really functional enough for general use. It’s possible that
in future versions of MySQL++ we’ll expand its interface to
include everything <code class="classname">std::string</code> does, so
that’s why it’s called that.<a href="#ftn.idm47108348274480" class="footnote" name="idm47108348274480"><sup class="footnote">[10]</sup></a></p><p>The key thing <code class="classname">String</code> provides over
<code class="classname">std::string</code> is conversion of strings in SQL
value formats to their plain old C++ data types. For example, if you
initialize it with the string “2007-11-19”, you can
assign the <code class="classname">String</code> to a <tt><a href="../refman/structmysqlpp_1_1Date.html">Date</a></tt>, not because
<code class="classname">Date</code> knows how to initialize itself from
<code class="classname">String</code>, but the reverse:
<code class="classname">String</code> has a bunch of implicit conversion
operators defined for it, so you can use it in any type context
that makes sense in your application.</p><p>Because <code class="methodname">Row::operator[]</code> returns
<code class="classname">String</code>, you can say things like
this:</p><pre class="programlisting">int x = row["x"];</pre><p>In a very real sense, <code class="classname">String</code> is the
inverse of <code class="classname">STA</code>:
<code class="classname">String</code> converts SQL value strings to C++
data types, and <code class="classname">STA</code> converts C++ data types
to SQL value strings.<a href="#ftn.idm47108348262784" class="footnote" name="idm47108348262784"><sup class="footnote">[11]</sup></a></p><p><code class="classname">String</code> has two main uses.</p><p>By far the most common use is as the field value type of
<code class="classname">Row</code>, as exemplified above. It’s not
just the return type of <code class="methodname">Row::operator[]</code>,
though: it’s actually the value type used within
<code class="classname">Row</code>’s internal array. As a result,
any time MySQL++ pulls data from the database, it goes through
<code class="classname">String</code> when converting it from the string
form used in SQL result sets to the C++ data type you actually
want the data in. It’s the core of the structure population
mechanism in <a class="link" href="ssqls.html" title="5.Specialized SQL Structures">the SSQLS feature</a>, for
example.</p><p>Because <code class="classname">String</code> is the last pristine
form of data in a result set before it gets out of MySQL++’s
internals where end-user code can see it, MySQL++’s
<span class="type">sql_blob</span> and related <span class="type">typedef</span>s are
aliases for <code class="classname">String</code>. Using anything else
would require copies; while the whole “networked database
server” thing means most of MySQL++ can be quite inefficient
and still not affect benchmark results meaningfully, BLOBs tend to
be big, so making unnecessary copies can really make a difference.
Which brings us to...</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="string-refcount"></a>Reference Counting</h4></div></div></div><p>To avoid unnecessary buffer copies, both
<code class="classname">STA</code> and <code class="classname">String</code>
are implemented in terms of a reference-counted copy-on-write
buffer scheme. Both classes share the same underlying mechanism,
and so are interoperable. This means that if you construct
one of these objects from another, it doesn’t actually
copy the string data, it only copies a pointer to the data
buffer, and increments its reference count. If the object
has new data assigned to it or it’s otherwise modified,
it decrements its reference count and creates its own copy of
the buffer. This has a lot of practical import, such as the
fact that even though <code class="methodname">Row::operator[]</code>
returns <code class="classname">String</code>s by value, it’s
still efficient.</p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="blob"></a>3.9.Dealing with Binary Data</h3></div></div></div><p>Historically, there was no way to hold arbitrary-sized blocks
of raw binary data in an SQL database. There was resistance to
adding such a feature to SQL for a long time because it’s
better, where possible, to decompose blocks of raw binary data into
a series of numbers and text strings that <span class="emphasis"><em>can</em></span>
be stored in the database. This lets you query, address and
manipulate elements of the data block individually.</p><p>A classic SQL newbie mistake is trying to treat the database
server as a file system. Some embedded platforms use a database
engine as a file system, but MySQL doesn’t typically live
in that world. When your platform already has a perfectly good
file system, you should use it for big, nondecomposable blocks
of binary data in most cases.</p><p>A common example people use when discussing this is images
in database-backed web applications. If you store the image in the
database, you have to write code to retrieve the image from the
database and send it to the client; there’s more overhead,
and less efficient use of the system’s I/O caching system. If
you store the image in the filesystem, all you have to do is
point the web server to the directory where the images live,
and put a URL for that image in your generated HTML. Because
you’re giving the web server a direct path to a file on
disk, operation is far more efficient. Web servers are very
good at slurping whole files off of disk and sending them out
to the network, and operating systems are very good at caching
file accesses. Plus, you avoid the overhead of pushing the data
through the high-level language your web app is written in, which
is typically an interpreted language, not C++. Some people still
hold out on this, claiming that database engines have superior
security features, but I call bunk on that, too. Operating systems
and web servers are capable of building access control systems
every bit as granular and secure as a database system.</p><p>Occasionally you really do need to store a nondecomposable
block of binary data in the database. For such cases, modern
SQL database servers support BLOB data types, for Binary Large
OBject. This is often just called binary data, though of course
all data in a modern computer is binary at some level.</p><p>The tricky part about dealing with binary data in MySQL++ is
to ensure that you don’t ever treat the data as a C string,
which is really easy to do accidentally. C strings treat zero bytes
as special end-of-string characters, but they’re not special
at all in binary data. We’ve made a lot of improvements
to the way MySQL++ handles <a class="link" href="tutorial.html#string-types" title="3.8.MySQL++’s Special String Types">string
data</a> to avoid this problem, but it’s still possible
to bypass these features, wrecking your BLOBs. These examples
demonstrate correct techniques.</p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="blob-save"></a>Loading a binary file into a BLOB column</h4></div></div></div><p>Above, I opined that it’s usually incorrect to
store image data in a database, particularly with web apps,
of which CGI is a primitive form. Still, it makes a nice,
simple example.</p><p>Instead of a single example program, we have here a
matched pair. The first example takes the name of a JPEG
file on the command line along with all the other <a class="link" href="tutorial.html#examples" title="3.1.Running the Examples">common example program parameters</a>,
loads that file into memory, and stores it in a BLOB column in
the database.</p><p>This example also demonstrates how to retrieve the
value assigned to an auto-increment column in the previous
insertion. This example uses that feature in the typical way,
to create unique IDs for rows as they’re inserted.</p><p>Here is <code class="filename">examples/load_jpeg.cpp</code>:</p><pre class="programlisting">#include "cmdline.h"
#include "images.h"
#include "printdata.h"
#include <fstream>
using namespace std;
using namespace mysqlpp;
// This is just an implementation detail for the example. Skip down to
// main() for the concept this example is trying to demonstrate. You
// can simply assume that, given a BLOB containing a valid JPEG, it
// returns true.
static bool
is_jpeg(const mysqlpp::sql_blob& img, const char** whynot)
{
// See http://stackoverflow.com/questions/2253404/ for
// justification for the various tests.
const unsigned char* idp =
reinterpret_cast<const unsigned char*>(img.data());
if (img.size() < 125) {
*whynot = "a valid JPEG must be at least 125 bytes";
}
else if ((idp[0] != 0xFF) || (idp[1] != 0xD8)) {
*whynot = "file does not begin with JPEG sigil bytes";
}
else if ((memcmp(idp + 6, "JFIF", 4) != 0) &&
(memcmp(idp + 6, "Exif", 4) != 0)) {
*whynot = "file does not contain JPEG type word";
}
else {
*whynot = 0;
return true;
}
return false;
}
// Skip to main() before studying this. This is a little too
// low-level to bother with on your first pass thru the code.
static bool
load_jpeg_file(const mysqlpp::examples::CommandLine& cmdline,
images& img, string& img_name)
{
if (cmdline.extra_args().size() == 0) {
// Nothing for us to do here. Caller will insert NULL BLOB.
return true;
}
// Got a file's name on the command line, so open it.
img_name = cmdline.extra_args()[0];
ifstream img_file(img_name.c_str(), ios::binary);
if (img_file) {
// Slurp file contents into RAM with minimum copying. (Idiom
// explained here: http://stackoverflow.com/questions/116038/)
//
// By loading the file into a C++ string (stringstream::str())
// and assigning that directly to a mysqlpp::sql_blob, we avoid
// truncating the binary data at the first null character.
img.data.data = static_cast<const stringstream*>(
&(stringstream() << img_file.rdbuf()))->str();
// Check JPEG data for sanity.
const char* error;
if (is_jpeg(img.data.data, &error)) {
return true;
}
else {
cerr << '"' << img_name << "\" isn't a JPEG: " <<
error << '!' << endl;
}
}
cmdline.print_usage("[jpeg_file]");
return false;
}
int
main(int argc, char *argv[])
{
// Get database access parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
try {
// Establish the connection to the database server.
mysqlpp::Connection con(mysqlpp::examples::db_name,
cmdline.server(), cmdline.user(), cmdline.pass());
// Load the file named on the command line
images img(mysqlpp::null, mysqlpp::null);
string img_name("NULL");
if (load_jpeg_file(cmdline, img, img_name)) {
// Insert image data or SQL NULL into the images.data BLOB
// column. The key here is that we're holding the raw
// binary data in a mysqlpp::sql_blob, which avoids data
// conversion problems that can lead to treating BLOB data
// as C strings, thus causing null-truncation. The fact
// that we're using SSQLS here is a side issue, simply
// demonstrating that mysqlpp::Null<mysqlpp::sql_blob> is
// now legal in SSQLS, as of MySQL++ 3.0.7.
Query query = con.query();
query.insert(img);
SimpleResult res = query.execute();
// Report successful insertion
cout << "Inserted \"" << img_name <<
"\" into images table, " << img.data.data.size() <<
" bytes, ID " << res.insert_id() << endl;
}
}
catch (const BadQuery& er) {
// Handle any query errors
cerr << "Query error: " << er.what() << endl;
return -1;
}
catch (const BadConversion& er) {
// Handle bad conversions
cerr << "Conversion error: " << er.what() << endl <<
"\tretrieved data size: " << er.retrieved <<
", actual size: " << er.actual_size << endl;
return -1;
}
catch (const Exception& er) {
// Catch-all for any other MySQL++ exceptions
cerr << "Error: " << er.what() << endl;
return -1;
}
return 0;
}
</pre><p>Notice that we used the <span class="type">escape</span> manipulator
when building the INSERT query above. This is because
<span class="type">mysqlpp::sql_blob</span> is just an alias for one of the
special MySQL++ <a class="link" href="tutorial.html#string-types" title="3.8.MySQL++’s Special String Types">string types</a>,
which don’t do automatic <a class="link" href="tutorial.html#qescape" title="3.5.Quoting and Escaping">quoting
and escaping</a>. They can’t, because MySQL++ also
uses these data types to hold raw SQL query strings, which
would break due to doubled quoting and/or escaping if it were
automatic.</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="blob-retreive"></a>Serving images from BLOB column via CGI</h4></div></div></div><p>The other example in this pair is rather short,
considering how much it does. It parses a CGI query string
giving the image ID, uses that to retreive data loaded into
the database by <code class="filename">load_jpeg</code>, and writes
it out in the form a web server wants when processing a CGI
call, all with adequate real-world error handling. This is
<code class="filename">examples/cgi_jpeg.cpp</code>:</p><pre class="programlisting">#include "cmdline.h"
#include "images.h"
#define CRLF "\r\n"
#define CRLF2 "\r\n\r\n"
int
main(int argc, char* argv[])
{
// Get database access parameters from command line if present, else
// use hard-coded values for true CGI case.
mysqlpp::examples::CommandLine cmdline(argc, argv, "root",
"nunyabinness");
if (!cmdline) {
return 1;
}
// Parse CGI query string environment variable to get image ID
unsigned int img_id = 0;
char* cgi_query = getenv("QUERY_STRING");
if (cgi_query) {
if ((strlen(cgi_query) < 4) || memcmp(cgi_query, "id=", 3)) {
std::cout << "Content-type: text/plain" << std::endl << std::endl;
std::cout << "ERROR: Bad query string" << std::endl;
return 1;
}
else {
img_id = atoi(cgi_query + 3);
}
}
else {
std::cerr << "Put this program into a web server's cgi-bin "
"directory, then" << std::endl;
std::cerr << "invoke it with a URL like this:" << std::endl;
std::cerr << std::endl;
std::cerr << " http://server.name.com/cgi-bin/cgi_jpeg?id=2" <<
std::endl;
std::cerr << std::endl;
std::cerr << "This will retrieve the image with ID 2." << std::endl;
std::cerr << std::endl;
std::cerr << "You will probably have to change some of the #defines "
"at the top of" << std::endl;
std::cerr << "examples/cgi_jpeg.cpp to allow the lookup to work." <<
std::endl;
return 1;
}
// Retrieve image from DB by ID
try {
mysqlpp::Connection con(mysqlpp::examples::db_name,
cmdline.server(), cmdline.user(), cmdline.pass());
mysqlpp::Query query = con.query();
query << "SELECT * FROM images WHERE id = " << img_id;
mysqlpp::StoreQueryResult res = query.store();
if (res && res.num_rows()) {
images img = res[0];
if (img.data.is_null) {
std::cout << "Content-type: text/plain" << CRLF2;
std::cout << "No image content!" << CRLF;
}
else {
std::cout << "X-Image-Id: " << img_id << CRLF; // for debugging
std::cout << "Content-type: image/jpeg" << CRLF;
std::cout << "Content-length: " <<
img.data.data.length() << CRLF2;
std::cout << img.data;
}
}
else {
std::cout << "Content-type: text/plain" << CRLF2;
std::cout << "ERROR: No image with ID " << img_id << CRLF;
}
}
catch (const mysqlpp::BadQuery& er) {
// Handle any query errors
std::cout << "Content-type: text/plain" << CRLF2;
std::cout << "QUERY ERROR: " << er.what() << CRLF;
return 1;
}
catch (const mysqlpp::Exception& er) {
// Catch-all for any other MySQL++ exceptions
std::cout << "Content-type: text/plain" << CRLF2;
std::cout << "GENERAL ERROR: " << er.what() << CRLF;
return 1;
}
return 0;
}
</pre><p>While you can run it by hand, it’s
best to install this in a web server’s
CGI program directory, then call it with a URL like
<code class="filename">http://my.server.com/cgi-bin/cgi_jpeg?id=1</code>.
That retrieves the JPEG with ID 1 from the database and
returns it to the web server, which will send it on to the
browser.</p><p>We’ve included an image with MySQL++
that you can use with this example pair,
<code class="filename">examples/logo.jpg</code>.</p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="Transaction"></a>3.10.Using Transactions</h3></div></div></div><p>The <tt><a href="../refman/classmysqlpp_1_1Transaction.html">Transaction</a></tt> class makes it
easier to use SQL transactions in an exception-safe manner. Normally
you create the <code class="classname">Transaction</code> object on the
stack before you issue the queries in your transaction set. Then,
when all the queries in the transaction set have been issued, you
call <code class="function">Transaction::commit()</code>, which commits the
transaction set. If the <code class="classname">Transaction</code> object
goes out of scope before you call <code class="function">commit()</code>, the
transaction set is rolled back. This ensures that if some code
throws an exception after the transaction is started but before it
is committed, the transaction isn’t left unresolved.</p><p><code class="filename">examples/transaction.cpp</code> illustrates
this:</p><pre class="programlisting">#include "cmdline.h"
#include "printdata.h"
#include "stock.h"
#include <iostream>
#include <cstdio>
using namespace std;
int
main(int argc, char *argv[])
{
// Get database access parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
try {
// Establish the connection to the database server.
mysqlpp::Connection con(mysqlpp::examples::db_name,
cmdline.server(), cmdline.user(), cmdline.pass());
// Show initial state
mysqlpp::Query query = con.query();
cout << "Initial state of stock table:" << endl;
print_stock_table(query);
// Insert a few rows in a single transaction set
{
// Use a higher level of transaction isolation than MySQL
// offers by default. This trades some speed for more
// predictable behavior. We've set it to affect all
// transactions started through this DB server connection,
// so it affects the next block, too, even if we don't
// commit this one.
mysqlpp::Transaction trans(con,
mysqlpp::Transaction::serializable,
mysqlpp::Transaction::session);
stock row("Sauerkraut", 42, 1.2, 0.75,
mysqlpp::sql_date("2006-03-06"), mysqlpp::null);
query.insert(row);
query.execute();
cout << "\nRow inserted, but not committed." << endl;
cout << "Verify this with another program (e.g. simple1), "
"then hit Enter." << endl;
getchar();
cout << "\nCommitting transaction gives us:" << endl;
trans.commit();
print_stock_table(query);
}
// Now let's test auto-rollback
{
// Start a new transaction, keeping the same isolation level
// we set above, since it was set to affect the session.
mysqlpp::Transaction trans(con);
cout << "\nNow adding catsup to the database..." << endl;
stock row("Catsup", 3, 3.9, 2.99,
mysqlpp::sql_date("2006-03-06"), mysqlpp::null);
query.insert(row);
query.execute();
}
cout << "\nNo, yuck! We don't like catsup. Rolling it back:" <<
endl;
print_stock_table(query);
}
catch (const mysqlpp::BadQuery& er) {
// Handle any query errors
cerr << "Query error: " << er.what() << endl;
return -1;
}
catch (const mysqlpp::BadConversion& er) {
// Handle bad conversions
cerr << "Conversion error: " << er.what() << endl <<
"\tretrieved data size: " << er.retrieved <<
", actual size: " << er.actual_size << endl;
return -1;
}
catch (const mysqlpp::Exception& er) {
// Catch-all for any other MySQL++ exceptions
cerr << "Error: " << er.what() << endl;
return -1;
}
return 0;
}
</pre><p>One of the downsides of transactions is that the locking it
requires in the database server is prone to deadlocks. The classic
case where this happens is when two programs both want access to the
same two rows within a single transaction each, but they modify them
in opposite orders. If the timing is such that the programs
interleave their lock acquisitions, the two come to an impasse:
neither can get access to the other row they want to modify until
the other program commits its transaction and thus release the row
locks, but neither can finish the transaction because they’re
waiting on row locks the database server is holding on behalf of the
other program.</p><p>The MySQL server is smart enough to detect this condition, but
the best it can do is abort the second transaction. This breaks the
impasse, allowing the first program to complete its
transaction.</p><p>The second program now has to deal with the fact that its
transaction just got aborted. There’s a subtlety in detecting
this situation when using MySQL++. By default, MySQL++ signals
errors like these with exceptions. In the exception handler, you
might expect to get <code class="constant">ER_LOCK_DEADLOCK</code> from
<code class="methodname">Query::errnum()</code> (or
<code class="methodname">Connection::errnum()</code>, same thing), but what
you’ll almost certainly get instead is 0, meaning “no
error.” Why? It’s because you’re probably using a
<code class="classname">Transaction</code> object to get automatic
roll-backs in the face of exceptions. In this case, the roll-back
happens before your exception handler is called by issuing a
<span class="command"><strong>ROLLBACK</strong></span> query to the database server. Thus,
<code class="methodname">Query::errnum()</code> returns the error code
associated with this roll-back query, not the deadlocked transaction
that caused the exception.</p><p>To avoid this problem, a few of the exception objects as of
MySQL++ v3.0 include this last error number in the exception object
itself. It’s populated at the point of the exception, so it
can differ from the value you would get from
<code class="methodname">Query::errnum()</code> later on when the exception
handler runs.</p><p>The example <code class="filename">examples/deadlock.cpp</code>
demonstrates the problem:</p><pre class="programlisting">#include "cmdline.h"
#include <mysql++.h>
#include <mysqld_error.h>
#include <iostream>
using namespace std;
// Bring in global holding the value given to the -m switch
extern int run_mode;
int
main(int argc, char *argv[])
{
// Get database access parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
// Check that the mode parameter was also given and it makes sense
const int run_mode = cmdline.run_mode();
if ((run_mode != 1) && (run_mode != 2)) {
cerr << argv[0] << " must be run with -m1 or -m2 as one of "
"its command-line arguments." << endl;
return 1;
}
mysqlpp::Connection con;
try {
// Establish the connection to the database server
mysqlpp::Connection con(mysqlpp::examples::db_name,
cmdline.server(), cmdline.user(), cmdline.pass());
// Start a transaction set. Transactions create mutex locks on
// modified rows, so if two programs both touch the same pair of
// rows but in opposite orders at the wrong time, one of the two
// programs will deadlock. The MySQL server knows how to detect
// this situation, and its error return causes MySQL++ to throw
// a BadQuery exception. The point of this example is that if
// you want to detect this problem, you would check the value of
// BadQuery::errnum(), not Connection::errnum(), because the
// transaction rollback process executes a query which succeeds,
// setting the MySQL C API's "last error number" value to 0.
// The exception object carries its own copy of the error number
// at the point the exception was thrown for this very reason.
mysqlpp::Query query = con.query();
mysqlpp::Transaction trans(con);
// Build and run the queries, with the order depending on the -m
// flag, so that a second copy of the program will deadlock if
// run while the first is waiting for Enter.
char dummy[100];
for (int i = 0; i < 2; ++i) {
int lock = run_mode + (run_mode == 1 ? i : -i);
cout << "Trying lock " << lock << "..." << endl;
query << "select * from deadlock_test" << lock <<
" where x = " << lock << " for update";
query.store();
cout << "Acquired lock " << lock << ". Press Enter to ";
cout << (i == 0 ? "try next lock" : "exit");
cout << ": " << flush;
cin.getline(dummy, sizeof(dummy));
}
}
catch (mysqlpp::BadQuery e) {
if (e.errnum() == ER_LOCK_DEADLOCK) {
cerr << "Transaction deadlock detected!" << endl;
cerr << "Connection::errnum = " << con.errnum() <<
", BadQuery::errnum = " << e.errnum() << endl;
}
else {
cerr << "Unexpected query error: " << e.what() << endl;
}
return 1;
}
catch (mysqlpp::Exception e) {
cerr << "General error: " << e.what() << endl;
return 1;
}
return 0;
}
</pre><p>This example works a little differently than the others. You
run one copy of the example, then when it pauses waiting for you to
press <span class="keycap"><strong>Enter</strong></span>, you run another copy. Then, depending
on which one you press <span class="keycap"><strong>Enter</strong></span> in, one of the two
will abort with the deadlock exception. You can see from the error
message you get that it matters which method you call to get the
error number. What you do about it is up to you as it depends on
your program’s design and system architecture.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="querytypes"></a>3.11.Which Query Type to Use?</h3></div></div></div><p>There are three major ways to execute a query in MySQL++:
<code class="methodname">Query::execute()</code>,
<code class="methodname">Query::store()</code>, and
<code class="methodname">Query::use()</code>. Which should you use, and
why?</p><p><code class="methodname">execute()</code> is for queries that do not
return data <span class="emphasis"><em>per se</em></span>. For instance,
<span class="command"><strong>CREATE INDEX</strong></span>. You do get back some information
from the MySQL server, which <code class="methodname">execute()</code>
returns to its caller in a <tt><a href="../refman/classmysqlpp_1_1SimpleResult.html">SimpleResult</a></tt> object. In addition to the obvious — a
flag stating whether the query succeeded or not — this object
also contains things like the number of rows that the query
affected. If you only need the success status, it’s a little
more efficient to call <code class="methodname">Query::exec()</code>
instead, as it simply returns <span class="type">bool</span>.</p><p>If your query does pull data from the database, the simplest
option is <code class="methodname">store()</code>. (All of the examples up
to this point have used this method.) This returns a <tt><a href="../refman/classmysqlpp_1_1StoreQueryResult.html">StoreQueryResult</a></tt> object, which contains the
entire result set. It’s especially convenient because
<code class="classname">StoreQueryResult</code> derives from
<code class="classname">std::vector<mysqlpp::Row></code>, so it opens
the whole panoply of STL operations for accessing the rows in the
result set. Access rows randomly with subscript notation, iterate
forwards and backwards over the result set, run STL algorithms on
the set...it all works naturally.</p><p>If you like the idea of storing your results in an STL
container but don’t want to use
<code class="classname">std::vector</code>, you can call
<code class="methodname">Query::storein()</code> instead. It lets you store
the results in any standard STL container (yes, both sequential and
set-associative types) instead of using
<code class="classname">StoreQueryResult</code>. You do miss out on some of
the additional database information held by
<code class="classname">StoreQueryResult</code>’s other base class,
<tt><a href="../refman/classmysqlpp_1_1ResultBase.html">ResultBase</a></tt>, however.</p><p><code class="methodname">store*()</code> queries are convenient, but
the cost of keeping the entire result set in main memory can
sometimes be too high. It can be surprisingly costly, in fact. A
MySQL database server stores data compactly on disk, but it returns
query data to the client in a textual form. This results in a kind
of data bloat that affects numeric and BLOB types the most. MySQL++
and the underlying C API library also have their own memory
overheads in addition to this. So, if you happen to know that the
database server stores every record of a particular table in 1 KB,
pulling a million records from that table could easily take several
GB of memory with a <code class="methodname">store()</code> query,
depending on what’s actually stored in that table.</p><p>For these large result sets, the superior option is a
<code class="methodname">use()</code> query. This returns a <tt><a href="../refman/classmysqlpp_1_1UseQueryResult.html">UseQueryResult</a></tt> object, which is similar to
<code class="classname">StoreQueryResult</code>, but without all of the
random-access features. This is because a “use” query
tells the database server to send the results back one row at a
time, to be processed linearly. It’s analogous to a C++
stream’s input iterator, as opposed to a random-access
iterator that a container like vector offers. By accepting this
limitation, you can process arbitrarily large result sets. This
technique is demonstrated in
<code class="filename">examples/simple3.cpp</code>:</p><pre class="programlisting">#include "cmdline.h"
#include "printdata.h"
#include <mysql++.h>
#include <iostream>
#include <iomanip>
using namespace std;
int
main(int argc, char *argv[])
{
// Get database access parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
// Connect to the sample database.
mysqlpp::Connection conn(false);
if (conn.connect(mysqlpp::examples::db_name, cmdline.server(),
cmdline.user(), cmdline.pass())) {
// Ask for all rows from the sample stock table and display
// them. Unlike simple2 example, we retreive each row one at
// a time instead of storing the entire result set in memory
// and then iterating over it.
mysqlpp::Query query = conn.query("select * from stock");
if (mysqlpp::UseQueryResult res = query.use()) {
// Display header
cout.setf(ios::left);
cout << setw(31) << "Item" <<
setw(10) << "Num" <<
setw(10) << "Weight" <<
setw(10) << "Price" <<
"Date" << endl << endl;
// Get each row in result set, and print its contents
while (mysqlpp::Row row = res.fetch_row()) {
cout << setw(30) << row["item"] << ' ' <<
setw(9) << row["num"] << ' ' <<
setw(9) << row["weight"] << ' ' <<
setw(9) << row["price"] << ' ' <<
setw(9) << row["sdate"] <<
endl;
}
// Check for error: can't distinguish "end of results" and
// error cases in return from fetch_row() otherwise.
if (conn.errnum()) {
cerr << "Error received in fetching a row: " <<
conn.error() << endl;
return 1;
}
return 0;
}
else {
cerr << "Failed to get stock item: " << query.error() << endl;
return 1;
}
}
else {
cerr << "DB connection failed: " << conn.error() << endl;
return 1;
}
}
</pre><p>This example does the same thing as
<code class="filename">simple2</code>, only with a “use” query
instead of a “store” query.</p><p>Valuable as <code class="methodname">use()</code> queries are, they
should not be the first resort in solving problems of excessive
memory use. It’s better if you can find a way to simply not
pull as much data from the database in the first place. Maybe
you’re saying <span class="command"><strong>SELECT *</strong></span> even though you
don’t immedidately need all the columns from the table. Or,
maybe you’re filtering the result set with C++ code after you
get it from the database server. If you can do that filtering with a
more restrictive <span class="command"><strong>WHERE</strong></span> clause on the
<span class="command"><strong>SELECT</strong></span>, it’ll not only save memory,
it’ll save bandwidth between the database server and client,
and can even save CPU time. If the filtering criteria can’t be
expressed in a <span class="command"><strong>WHERE</strong></span> clause, however, read on to
the next section.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="store_if"></a>3.12.Conditional Result Row Handling</h3></div></div></div><p>Sometimes you must pull more data from the database server
than you actually need and filter it in memory. SQL’s
<span class="command"><strong>WHERE</strong></span> clause is powerful, but not as powerful as
C++. Instead of storing the full result set and then picking over it
to find the rows you want to keep, use
<code class="methodname">Query::store_if()</code>. This is
<code class="filename">examples/store_if.cpp</code>:</p><pre class="programlisting">#include "cmdline.h"
#include "printdata.h"
#include "stock.h"
#include <mysql++.h>
#include <iostream>
#include <math.h>
// Define a functor for testing primality.
struct is_prime
{
bool operator()(const stock& s)
{
if ((s.num == 2) || (s.num == 3)) {
return true; // 2 and 3 are trivial cases
}
else if ((s.num < 2) || ((s.num % 2) == 0)) {
return false; // can't be prime if < 2 or even
}
else {
// The only possibility left is that it's divisible by an
// odd number that's less than or equal to its square root.
for (int i = 3; i <= sqrt(double(s.num)); i += 2) {
if ((s.num % i) == 0) {
return false;
}
}
return true;
}
}
};
int
main(int argc, char *argv[])
{
// Get database access parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
try {
// Establish the connection to the database server.
mysqlpp::Connection con(mysqlpp::examples::db_name,
cmdline.server(), cmdline.user(), cmdline.pass());
// Collect the stock items with prime quantities
std::vector<stock> results;
mysqlpp::Query query = con.query();
query.store_if(results, stock(), is_prime());
// Show the results
print_stock_header(results.size());
std::vector<stock>::const_iterator it;
for (it = results.begin(); it != results.end(); ++it) {
print_stock_row(it->item.c_str(), it->num, it->weight,
it->price, it->sDate);
}
}
catch (const mysqlpp::BadQuery& e) {
// Something went wrong with the SQL query.
std::cerr << "Query failed: " << e.what() << std::endl;
return 1;
}
catch (const mysqlpp::Exception& er) {
// Catch-all for any other MySQL++ exceptions
std::cerr << "Error: " << er.what() << std::endl;
return 1;
}
return 0;
}
</pre><p>I doubt anyone really needs to select rows from a table that
have a prime number in a given field. This example is meant to be
just barely more complex than SQL can manage, to avoid obscuring the
point. That point being, the
<code class="methodname">Query::store_if()</code> call here gives you a
container full of results meeting a criterion that you probably
can’t express in SQL. You will no doubt have much more useful
criteria in your own programs.</p><p>If you need a more complex query than the one
<code class="methodname">store_if()</code> knows how to build when given an
SSQLS examplar, there are two overloads that let you use your own
query string. One overload takes the query string directly, and the
other uses the query string built with
<code class="classname">Query</code>’s stream interface.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="for_each"></a>3.13.Executing Code for Each Row In a Result Set</h3></div></div></div><p>SQL is more than just a database query language. Modern
database engines can actually do some calculations on the data on
the server side. But, this isn’t always the best way to get
something done. When you need to mix code and a query,
MySQL++’s <code class="methodname">Query::for_each()</code> facility
might be just what you need. This is
<code class="filename">examples/for_each.cpp</code>:</p><pre class="programlisting">#include "cmdline.h"
#include "printdata.h"
#include "stock.h"
#include <mysql++.h>
#include <iostream>
#include <math.h>
// Define a functor to collect statistics about the stock table
class gather_stock_stats
{
public:
gather_stock_stats() :
items_(0),
weight_(0),
cost_(0)
{
}
void operator()(const stock& s)
{
items_ += s.num;
weight_ += (s.num * s.weight);
cost_ += (s.num * s.price.data);
}
private:
mysqlpp::sql_bigint items_;
mysqlpp::sql_double weight_, cost_;
friend std::ostream& operator<<(std::ostream& os,
const gather_stock_stats& ss);
};
// Dump the contents of gather_stock_stats to a stream in human-readable
// form.
std::ostream&
operator<<(std::ostream& os, const gather_stock_stats& ss)
{
os << ss.items_ << " items " <<
"weighing " << ss.weight_ << " stone and " <<
"costing " << ss.cost_ << " cowrie shells";
return os;
}
int
main(int argc, char *argv[])
{
// Get database access parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
try {
// Establish the connection to the database server.
mysqlpp::Connection con(mysqlpp::examples::db_name,
cmdline.server(), cmdline.user(), cmdline.pass());
// Gather and display the stats for the entire stock table
mysqlpp::Query query = con.query();
std::cout << "There are " << query.for_each(stock(),
gather_stock_stats()) << '.' << std::endl;
}
catch (const mysqlpp::BadQuery& e) {
// Something went wrong with the SQL query.
std::cerr << "Query failed: " << e.what() << std::endl;
return 1;
}
catch (const mysqlpp::Exception& er) {
// Catch-all for any other MySQL++ exceptions
std::cerr << "Error: " << er.what() << std::endl;
return 1;
}
return 0;
}
</pre><p>You only need to read the <code class="function">main()</code> function
to get a good idea of what the program does. The key line of code
passes an SSQLS examplar and a functor to
<code class="methodname">Query::for_each()</code>.
<code class="methodname">for_each()</code> uses the SSQLS instance to build
a <code class="computeroutput">select * from TABLE</code> query,
<code class="computeroutput">stock</code> in this case. It runs that
query internally, calling <code class="classname">gather_stock_stats</code>
on each row. This is a pretty contrived example; you could actually
do this in SQL, but we’re trying to prevent the complexity of
the code from getting in the way of the demonstration here.</p><p>Just as with <code class="methodname">store_if()</code>, described
above, there are two other overloads for
<code class="methodname">for_each()</code> that let you use your own query
string.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="connopts"></a>3.14.Connection Options</h3></div></div></div><p>MySQL has a large number of options that control how it makes
the connection to the database server, and how that connection
behaves. The defaults are sufficient for most programs, so only one
of the MySQL++ example programs make any connection option changes.
Here is <code class="filename">examples/multiquery.cpp</code>:</p><pre class="programlisting">#include "cmdline.h"
#include "printdata.h"
#include <mysql++.h>
#include <algorithm>
#include <iostream>
#include <iomanip>
#include <vector>
using namespace std;
using namespace mysqlpp;
typedef vector<size_t> IntVectorType;
static void
print_header(IntVectorType& widths, StoreQueryResult& res)
{
cout << " |" << setfill(' ');
for (size_t i = 0; i < res.field_names()->size(); i++) {
cout << " " << setw(widths.at(i)) << res.field_name(int(i)) << " |";
}
cout << endl;
}
static void
print_row(IntVectorType& widths, Row& row)
{
cout << " |" << setfill(' ');
for (size_t i = 0; i < row.size(); ++i) {
cout << " " << setw(widths.at(i)) << row[int(i)] << " |";
}
cout << endl;
}
static void
print_row_separator(IntVectorType& widths)
{
cout << " +" << setfill('-');
for (size_t i = 0; i < widths.size(); i++) {
cout << "-" << setw(widths.at(i)) << '-' << "-+";
}
cout << endl;
}
static void
print_result(StoreQueryResult& res, int index)
{
// Show how many rows are in result, if any
StoreQueryResult::size_type num_results = res.size();
if (res && (num_results > 0)) {
cout << "Result set " << index << " has " << num_results <<
" row" << (num_results == 1 ? "" : "s") << ':' << endl;
}
else {
cout << "Result set " << index << " is empty." << endl;
return;
}
// Figure out the widths of the result set's columns
IntVectorType widths;
size_t size = res.num_fields();
for (size_t i = 0; i < size; i++) {
widths.push_back(max(
res.field(i).max_length(),
res.field_name(i).size()));
}
// Print result set header
print_row_separator(widths);
print_header(widths, res);
print_row_separator(widths);
// Display the result set contents
for (StoreQueryResult::size_type i = 0; i < num_results; ++i) {
print_row(widths, res[i]);
}
// Print result set footer
print_row_separator(widths);
}
static void
print_multiple_results(Query& query)
{
// Execute query and print all result sets
StoreQueryResult res = query.store();
print_result(res, 0);
for (int i = 1; query.more_results(); ++i) {
res = query.store_next();
print_result(res, i);
}
}
int
main(int argc, char *argv[])
{
// Get connection parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
try {
// Enable multi-queries. Notice that you almost always set
// MySQL++ connection options before establishing the server
// connection, and options are always set using this one
// interface. If you're familiar with the underlying C API,
// you know that there is poor consistency on these matters;
// MySQL++ abstracts these differences away.
Connection con;
con.set_option(new MultiStatementsOption(true));
// Connect to the database
if (!con.connect(mysqlpp::examples::db_name, cmdline.server(),
cmdline.user(), cmdline.pass())) {
return 1;
}
// Set up query with multiple queries.
Query query = con.query();
query << "DROP TABLE IF EXISTS test_table; " <<
"CREATE TABLE test_table(id INT); " <<
"INSERT INTO test_table VALUES(10); " <<
"UPDATE test_table SET id=20 WHERE id=10; " <<
"SELECT * FROM test_table; " <<
"DROP TABLE test_table";
cout << "Multi-query: " << endl << query << endl;
// Execute statement and display all result sets.
print_multiple_results(query);
#if MYSQL_VERSION_ID >= 50000
// If it's MySQL v5.0 or higher, also test stored procedures, which
// return their results the same way multi-queries do.
query << "DROP PROCEDURE IF EXISTS get_stock; " <<
"CREATE PROCEDURE get_stock" <<
"( i_item varchar(20) ) " <<
"BEGIN " <<
"SET i_item = concat('%', i_item, '%'); " <<
"SELECT * FROM stock WHERE lower(item) like lower(i_item); " <<
"END;";
cout << "Stored procedure query: " << endl << query << endl;
// Create the stored procedure.
print_multiple_results(query);
// Call the stored procedure and display its results.
query << "CALL get_stock('relish')";
cout << "Query: " << query << endl;
print_multiple_results(query);
#endif
return 0;
}
catch (const BadOption& err) {
cerr << err.what() << endl;
cerr << "This example requires MySQL 4.1.1 or later." << endl;
return 1;
}
catch (const ConnectionFailed& err) {
cerr << "Failed to connect to database server: " <<
err.what() << endl;
return 1;
}
catch (const Exception& er) {
// Catch-all for any other MySQL++ exceptions
cerr << "Error: " << er.what() << endl;
return 1;
}
}
</pre><p>This is a fairly complex example demonstrating the multi-query
and stored procedure features in newer versions of MySQL. Because
these are new features, and they change the communication between
the client and server, you have to enable these features in a
connection option. The key line is right up at the top of
<code class="function">main()</code>, where it creates a <tt><a href="../refman/classmysqlpp_1_1MultiStatementsOption.html">MultiStatementsOption</a></tt> object and passes it
to <code class="methodname">Connection::set_option()</code>. That method
will take a pointer to any derivative of <tt><a href="../refman/classmysqlpp_1_1Option.html">Option</a></tt>: you just create such an object on the heap and pass
it in, which gives <code class="classname">Connection</code> the data values
it needs to set the option. You don’t need to worry about
releasing the memory used by the <code class="classname">Option</code>
objects; it’s done automatically.</p><p>The only tricky thing about setting options is that only a few
of them can be set after the connection is up. Most need to be set
just as shown in the example above: create an unconnected
<code class="classname">Connection</code> object, set your connection
options, and only then establish the connection. The option setting
mechanism takes care of applying the options at the correct time in
the connection establishment sequence.</p><p>If you’re familiar with setting connection options in
the MySQL C API, you’ll have to get your head around the fact
that MySQL++’s connection option mechanism is a much simpler,
higher-level design that doesn’t resemble the C API in any
way. The C API has something like half a dozen different mechanisms
for setting options that control the connection. The flexibility of
the C++ type system allows us to wrap all of these up into a single
high-level mechanism while actually getting greater type safety than
the C API allows.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="conn-timeout"></a>3.15.Dealing with Connection Timeouts</h3></div></div></div><p>By default, current MySQL servers have an 8 hour idle
timeout on connections. This is not a problem if your program
never has to run for more than 8 hours or reliably queries the
database more often than that. And, it’s a good thing for
the database server, because even an idle connection takes up
server resources.</p><p>Many programs must run continually, however, and may
experience long idle periods, such as nights and weekends
when no one is around to make the program issue database
queries. It’s therefore common for people writing such
programs to get a bug report from the field complaining that the
program died overnight or over a long weekend, usually with some
error message about the database server going away. They then check
the DB server, find that it’s still running and never did
restart and scratch their heads wondering what happened. What
happened is that the server’s connection idle timeout
expired, so it closed the connection to the client.</p><p>You cannot detect this condition by calling
<code class="methodname">Connection::connected()</code>. When
that returns <span class="symbol">true</span>, it just means
that either the connect-on-create constructor or the
<code class="methodname">connect()</code> call succeeded and that we
haven’t observed the connection to be down since then.
When the database server closes an idle connection, you won’t
know it until after you try to issue a query. This is simply due
to the nature of network programming.</p><p>One way around this problem is to <a class="ulink" href="http://dev.mysql.com/doc/refman/5.0/en/gone-away.html" target="_top">configure
MySQL</a> to have a longer idle timeout. This timeout is
in seconds, so the default of 8 hours is 28,800 seconds. You
would want to figure out the longest possible time that your
program could be left idle, then pick a value somewhat longer
than that. For instance, you might decide that the longest
reasonable idle time is a long 4-day weekend — 345,600
seconds — which you could round up to 350,000 or 400,000
to allow for a little bit of additional idle time on either end
of that period.</p><p>Another way around this, on a per-connection basis from
the client side, would be to set the <tt><a href="../refman/classmysqlpp_1_1ReconnectOption.html">ReconnectOption</a></tt> <a class="link" href="tutorial.html#connopts" title="3.14.Connection Options">connection
option</a>. This will cause MySQL++ to reconnect to the server
automatically if it drops the connection. Beware that unless
you’re using MySQL 5.1.6 or higher, you have to set this
only after the connection is established, or it won’t take
effect. This means there’s a potential race condition:
it’s possible the connection could drop shortly enough
after being established that you don’t have time to apply
the option, so it won’t come back up automatically. MySQL
5.1.6+ fixes this by allowing this option to be set before the
connection is established.</p><p>A completely different way to tackle this, if your program
doesn’t block forever waiting on I/O while idle, is to
periodically call <code class="methodname">Connection::ping()</code>.
<a href="#ftn.idm47108345309712" class="footnote" name="idm47108345309712"><sup class="footnote">[12]</sup></a>
This sends the smallest possible amount of data to the
database server, which will reset its idle timer and cause
it to respond, so <code class="methodname">ping()</code> returns
<span class="symbol">true</span>. If it returns <span class="symbol">false</span>
instead, you know you need to reconnect to the server. Periodic
pinging is easiest to do if your program uses asynchronous I/O,
<a class="link" href="threads.html" title="7.Using MySQL++ in a Multithreaded Program">threads</a>, or some kind of event
loop to ensure that you can call something periodically even
while the rest of the program has nothing to do.</p><p>An interesting variant on this strategy is to ping the server
before each query, or, better, before each group of queries within
a larger operation. It has an advantage over pinging during idle
time in that the client is about to use far more server resources
to handle the query than it will take to handle the ping, so the
ping time gets lost in the overhead. On the other hand, if the
client issues queries frequently when not idle, it can result
in a lot more pings than would happen if you just pinged every
N hours while idle.</p><p>Finally, some programmers prefer to wrap the querying
mechanism in an error handler that catches the “server has
gone away” error and tries to reestablish the connection and
reissue the query. This adds some complexity, but it makes your
program more robust without taking up unnecessary resources. If you
did this, you could even change the server to drop idle connections
more often, thus tying up fewer TCP/IP stack resources.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="concurrentqueries"></a>3.16.Concurrent Queries on a Connection</h3></div></div></div><p>An important limitation of the MySQL C API library —
which MySQL++ is built atop, so it shares this limitation —
is that you can only have one query in progress on each connection
to the database server. If you try to issue a second query while
one is still in progress, you get an obscure error message about
“Commands out of sync” from the underlying C API
library. (You normally get this message in a MySQL++ exception
unless you have exceptions disabled, in which case you get a
failure code and <code class="methodname">Connection::error()</code>
returns this message.)</p><p>There are lots of ways to run into this limitation:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>The easiest way is to try to use a single <tt><a href="../refman/classmysqlpp_1_1Connection.html">Connection</a></tt> object in a multithreaded
program, with more than one thread attempting to use it to
issue queries. Unless you put in a lot of work to synchronize
access, this is almost guaranteed to fail at some point, giving
the dread “Commands out of sync” error.</p></li><li class="listitem"><p>You might then think to give each thread that issues
queries its own <code class="classname">Connection</code> object.
You can still run into trouble if you pass the data you get
from queries around to other threads. What can happen is
that one of these child objects indirectly calls back to the
<code class="classname">Connection</code> at a time where it’s
involved with another query. This is properly covered
elsewhere, in <a class="xref" href="threads.html#thread-data-sharing" title="7.4.Sharing MySQL++ Data Structures">Section7.4, “Sharing MySQL++ Data Structures”</a>.)</p></li><li class="listitem"><p>One way to run into this problem without using
threads is with “use” queries, discussed <a class="link" href="tutorial.html#querytypes" title="3.11.Which Query Type to Use?">above</a>. If you don’t
consume all rows from a query before you issue another on
that connection, you are effectively trying to have multiple
concurrent queries on a single connection. Here’s a
recipie for this particular disaster:</p><pre class="programlisting">
UseQueryResult r1 = query.use("select garbage from plink where foobie='tamagotchi'");
UseQueryResult r2 = query.use("select blah from bonk where bletch='smurf'");</pre><p>The second <code class="methodname">use()</code> call fails because
the first result set hasn’t been consumed yet.</p></li><li class="listitem"><p>Still another way to run into this limitation
is if you use MySQL’s multi-query feature. This
lets you give multiple queries in a single call,
separated by semicolons, and get back the results for
each query separately. If you issue three queries using
<code class="methodname">Query::store()</code>, you only get
back the first query’s results with that call, and
then have to call <code class="methodname">store_next()</code>
to get the subsequent query results. MySQL++ provides
<code class="methodname">Query::more_results()</code> so
you know whether you’re done, or need to call
<code class="methodname">store_next()</code> again. Until you reach
the last result set, you can’t issue another query on
that connection.</p></li><li class="listitem"><p>Finally, there’s a way to run into this
that surprises almost everyone sooner or later: stored
procedures. MySQL normally returns <span class="emphasis"><em>at least
two</em></span> result sets for a stored procedure call. The
simple case is that the stored procedure contains a single
SQL query, and it succeeds: you get two results, first the
results of the embedded SQL query, and then the result
of the call itself. If there are multiple SQL queries
within the stored procedure, you get more than two result
sets. Until you consume them all, you can’t start a
new query on the connection. As above, you want to have
a loop calling <code class="methodname">more_results()</code>
and <code class="methodname">store_next()</code> to work your
way through all of the result sets produced by the stored
procedure call.</p></li></ul></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="fieldinf"></a>3.17.Getting Field Meta-Information</h3></div></div></div><p>The following example demonstrates how to get information
about the fields in a result set, such as the name of the field and
the SQL type. This is
<code class="filename">examples/fieldinf.cpp</code>:</p><pre class="programlisting">#include "cmdline.h"
#include "printdata.h"
#include <iostream>
#include <iomanip>
using namespace std;
int
main(int argc, char *argv[])
{
// Get database access parameters from command line
mysqlpp::examples::CommandLine cmdline(argc, argv);
if (!cmdline) {
return 1;
}
try {
// Establish the connection to the database server.
mysqlpp::Connection con(mysqlpp::examples::db_name,
cmdline.server(), cmdline.user(), cmdline.pass());
// Get contents of main example table
mysqlpp::Query query = con.query("select * from stock");
mysqlpp::StoreQueryResult res = query.store();
// Show info about each field in that table
char widths[] = { 12, 22, 46 };
cout.setf(ios::left);
cout << setw(widths[0]) << "Field" <<
setw(widths[1]) << "SQL Type" <<
setw(widths[2]) << "Equivalent C++ Type" <<
endl;
for (size_t i = 0; i < sizeof(widths) / sizeof(widths[0]); ++i) {
cout << string(widths[i] - 1, '=') << ' ';
}
cout << endl;
for (size_t i = 0; i < res.field_names()->size(); i++) {
// Suppress C++ type name outputs when run under dtest,
// as they're system-specific.
const char* cname = res.field_type(int(i)).name();
mysqlpp::FieldTypes::value_type ft = res.field_type(int(i));
ostringstream os;
os << ft.sql_name() << " (" << ft.id() << ')';
cout << setw(widths[0]) << res.field_name(int(i)).c_str() <<
setw(widths[1]) << os.str() <<
setw(widths[2]) << cname <<
endl;
}
cout << endl;
// Simple type check
if (res.field_type(0) == typeid(string)) {
cout << "SQL type of 'item' field most closely resembles "
"the C++ string type." << endl;
}
// Tricky type check: the 'if' path shouldn't happen because the
// description field has the NULL attribute. We need to dig a
// little deeper if we want to ignore this in our type checks.
if (res.field_type(5) == typeid(string)) {
cout << "Should not happen! Type check failure." << endl;
}
else if (res.field_type(5) == typeid(mysqlpp::sql_blob_null)) {
cout << "SQL type of 'description' field resembles "
"a nullable variant of the C++ string type." << endl;
}
else {
cout << "Weird: fifth field's type is now " <<
res.field_type(5).name() << endl;
cout << "Did something recently change in resetdb?" << endl;
}
}
catch (const mysqlpp::BadQuery& er) {
// Handle any query errors
cerr << "Query error: " << er.what() << endl;
return -1;
}
catch (const mysqlpp::Exception& er) {
// Catch-all for any other MySQL++ exceptions
cerr << "Error: " << er.what() << endl;
return -1;
}
return 0;
}
</pre></div><div class="footnotes"><br><hr style="width:100; text-align:left;margin-left: 0"><div id="ftn.idm47108348350992" class="footnote"><p><a href="#idm47108348350992" class="para"><sup class="para">[2] </sup></a><code class="classname">SQLQueryParms</code> is used as a
stream only as an implementation detail within the library. End user
code simply sees it as a <code class="classname">std::vector</code>
derivative.</p></div><div id="ftn.idm47108348347408" class="footnote"><p><a href="#idm47108348347408" class="para"><sup class="para">[3] </sup></a>By contrast, the
<code class="classname">Query</code> methods that take an <a class="link" href="ssqls.html" title="5.Specialized SQL Structures">SSQLS</a> <span class="emphasis"><em>do</em></span> add quotes and
escape strings implicitly. It can do this because SSQLS knows all
the SQL code and data types, so it never has to guess whether
quoting or escaping is appropriate.</p></div><div id="ftn.whyexpmanip" class="footnote"><p><a href="#whyexpmanip" class="para"><sup class="para">[4] </sup></a>Unless you’re smarter than I am, you
don’t immediately see why explicit manipulators are necessary.
We can tell when quoting and escaping is <span class="emphasis"><em>not</em></span>
appropriate based on type, so doesn’t that mean we know when
it <span class="emphasis"><em>is</em></span> appropriate? Alas, no. For most data
types, it is possible to know, or at least make an awfully good
guess, but it’s a complete toss-up for C strings, <span class="type">const
char*</span>. A C string could be either a literal string of SQL
code, or it can be a value used in a query. Since there’s no
easy way to know and it would damage the library’s usability
to mandate that C strings only be used for one purpose or the other,
the library requires you to be explicit.</p></div><div id="ftn.idm47108348341904" class="footnote"><p><a href="#idm47108348341904" class="para"><sup class="para">[5] </sup></a>One hopes the programmer
<span class="emphasis"><em>knows</em></span>.</p></div><div id="ftn.idm47108348338352" class="footnote"><p><a href="#idm47108348338352" class="para"><sup class="para">[6] </sup></a>Yes,
we’re aware that there is a feature in MySQL that lets you
transfer row data in a binary form, but we don’t support
this yet. We may, someday, probably as an extension to <a class="link" href="ssqls.html" title="5.Specialized SQL Structures">SSQLS</a>. The only real reason to do so
is to shave off some of the data translation overhead, which
is typically neglibible in practice, swamped by the far greater
disk and network I/O overheads inherent in use of a client-server
database system like MySQL.</p></div><div id="ftn.idm47108348333776" class="footnote"><p><a href="#idm47108348333776" class="para"><sup class="para">[7] </sup></a>SQL’s DECIMAL data type is a configurable-precision
fixed-point number format. MySQL++ currently translates these to
<span class="type">double</span>, a floating-point data format, the closest
thing available in the C++ type system. Since the main reason
to use DECIMAL is to get away from the weird roundoff behavior
of floating-point numbers, this could be viewed as a serious
problem. The thing is, though, in all the years MySQL++ has
been around, I don’t remember anyone actually complaining
about it. Apparently there’s either no one using DECIMAL
with MySQL++, or they’re ignoring any roundoff errors
they get as a result. Until this wheel squeaks, it’s not
likely to be greased. To fix this, we’ll have to create
a new custom data type to hold such column values, which will
be a lot of work for apparently little return.</p></div><div id="ftn.idm47108348285248" class="footnote"><p><a href="#idm47108348285248" class="para"><sup class="para">[8] </sup></a>In version 2
of MySQL++ and earlier, <code class="classname">SQLTypeAdapter</code> was
called <code class="classname">SQLString</code>, but it was confusing
because its name and the fact that it derived from
<code class="classname">std::string</code> suggested that it was a
general-purpose string type. MySQL++ even used it this way in a
few places internally. In v3, we made it a simple base class and
renamed it to reflect its proper limited
function.</p></div><div id="ftn.idm47108348282480" class="footnote"><p><a href="#idm47108348282480" class="para"><sup class="para">[9] </sup></a><code class="classname">SQLTypeAdapter</code>
doesn’t do <a class="xref" href="tutorial.html#qescape" title="3.5.Quoting and Escaping">quoting and escaping</a> itself. That happens
elsewhere, right at the point that the <code class="classname">STA</code>
gets used to build a query.</p></div><div id="ftn.idm47108348274480" class="footnote"><p><a href="#idm47108348274480" class="para"><sup class="para">[10] </sup></a>If you
used MySQL++ before v3, <code class="classname">String</code> used to be
called <code class="classname">ColData</code>. It was renamed because
starting in v2.3, we began using it for holding more than just
column data. I considered renaming it
<code class="classname">SQLString</code> instead, but that would have
confused old MySQL++ users to no end. Instead, I followed the
example of <code class="classname">Set</code>, MySQL++’s specialized
<code class="classname">std::set</code> variant.</p></div><div id="ftn.idm47108348262784" class="footnote"><p><a href="#idm47108348262784" class="para"><sup class="para">[11] </sup></a>During the development of
MySQL++ v3.0, I tried merging
<code class="classname">SQLTypeAdapter</code> and
<code class="classname">String</code> into a single class to take
advantage of this. The resulting class gave the C++ compiler the
freedom to tie itself up in knots, because it was then allowed to
convert almost any data type to almost any other. You’d get
a tangle of ambiguous data type conversion errors from the most
innocent code.</p></div><div id="ftn.idm47108345309712" class="footnote"><p><a href="#idm47108345309712" class="para"><sup class="para">[12] </sup></a>Don’t ping the server too often! It takes a tiny
amount of processing capability to handle a ping, which can add
up to a significant amount if done often enough by a client, or
even just rarely by enough clients. Also, a lower ping frequency
can let your program ride through some types of network faults
— a switch reboot, for instance — without needing
a reconnect. I like to ping the DB server no more often than
half the connection timeout. With the default of 8 hours, then,
I’d ping between every 4 and 7 hours.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="overview.html">Prev</a></td><td width="20%" align="center"></td><td width="40%" align="right"><a accesskey="n" href="tquery.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.Overview</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">4.Template Queries</td></tr></table></div></body></html>
|