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
|
<!DOCTYPE html>
<html lang="en" data-bs-theme="light">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Vagrant - SOCI (4.1.2)</title>
<link href="../css/bootstrap.min.css" rel="stylesheet">
<link href="../css/fontawesome.min.css" rel="stylesheet">
<link href="../css/brands.min.css" rel="stylesheet">
<link href="../css/solid.min.css" rel="stylesheet">
<link href="../css/v4-font-face.min.css" rel="stylesheet">
<link href="../css/base.css" rel="stylesheet">
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href="..">SOCI (4.1.2)</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="nav-item">
<a href=".." class="nav-link">Home</a>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Overview</a>
<ul class="dropdown-menu">
<li>
<a href="../quickstart/" class="dropdown-item">Getting Started</a>
</li>
<li>
<a href="../installation/" class="dropdown-item">Installation</a>
</li>
<li>
<a href="../structure/" class="dropdown-item">Library Structure</a>
</li>
<li>
<a href="../license/" class="dropdown-item">License</a>
</li>
<li>
<a href="../faq/" class="dropdown-item">FAQ</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">User Guide</a>
<ul class="dropdown-menu">
<li>
<a href="../connections/" class="dropdown-item">Connections</a>
</li>
<li>
<a href="../queries/" class="dropdown-item">Queries</a>
</li>
<li>
<a href="../binding/" class="dropdown-item">Data Binding</a>
</li>
<li>
<a href="../indicators/" class="dropdown-item">Data Indicators</a>
</li>
<li>
<a href="../types/" class="dropdown-item">Data Types</a>
</li>
<li>
<a href="../lobs/" class="dropdown-item">LOBs</a>
</li>
<li>
<a href="../statements/" class="dropdown-item">Statements</a>
</li>
<li>
<a href="../transactions/" class="dropdown-item">Transactions</a>
</li>
<li>
<a href="../procedures/" class="dropdown-item">Procedures</a>
</li>
<li>
<a href="../errors/" class="dropdown-item">Errors</a>
</li>
<li>
<a href="../logging/" class="dropdown-item">Logging</a>
</li>
<li>
<a href="../interfaces/" class="dropdown-item">Interfaces</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Backends</a>
<ul class="dropdown-menu">
<li>
<a href="../backends/" class="dropdown-item">Features</a>
</li>
<li>
<a href="../backends/db2/" class="dropdown-item">DB2</a>
</li>
<li>
<a href="../backends/firebird/" class="dropdown-item">Firebird</a>
</li>
<li>
<a href="../backends/mysql/" class="dropdown-item">MySQL</a>
</li>
<li>
<a href="../backends/odbc/" class="dropdown-item">ODBC</a>
</li>
<li>
<a href="../backends/oracle/" class="dropdown-item">Oracle</a>
</li>
<li>
<a href="../backends/postgresql/" class="dropdown-item">PostgreSQL</a>
</li>
<li>
<a href="../backends/sqlite3/" class="dropdown-item">SQLite3</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">Miscellaneous</a>
<ul class="dropdown-menu">
<li>
<a href="../beyond/" class="dropdown-item">Beyond SQL</a>
</li>
<li>
<a href="../multithreading/" class="dropdown-item">Multi-threading</a>
</li>
<li>
<a href="../boost/" class="dropdown-item">Boost</a>
</li>
<li>
<a href="../utilities/" class="dropdown-item">Utilities</a>
</li>
<li>
<a href="./" class="dropdown-item active" aria-current="page">Vagrant</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">API</a>
<ul class="dropdown-menu">
<li>
<a href="../api/client/" class="dropdown-item">Client API</a>
</li>
<li>
<a href="../api/backend/" class="dropdown-item">Backend API</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Ada</a>
<ul class="dropdown-menu">
<li>
<a href="../languages/ada/" class="dropdown-item">Ada Bindings</a>
</li>
<li>
<a href="../languages/ada/concepts/" class="dropdown-item">Ada Concepts</a>
</li>
<li>
<a href="../languages/ada/idioms/" class="dropdown-item">Ada Idioms</a>
</li>
<li>
<a href="../languages/ada/reference/" class="dropdown-item">Ada API Reference</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav ms-md-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a rel="prev" href="../utilities/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../api/client/" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li class="nav-item">
<a href="https://github.com/SOCI/soci/edit/master/docs/vagrant.md" class="nav-link"><i class="fa-brands fa-github"></i> Edit on GitHub</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="1"><a href="#vagrant-soci" class="nav-link">Vagrant SOCI</a>
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#features" class="nav-link">Features</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#prerequisites" class="nav-link">Prerequisites</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#usage" class="nav-link">Usage</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#troubleshooting" class="nav-link">Troubleshooting</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="vagrant-soci">Vagrant SOCI</h1>
<p><a href="https://www.vagrantup.com/">Vagrant</a> used to build and provision
virtual environments for <strong>hassle-free</strong> SOCI development.</p>
<h2 id="features">Features</h2>
<ul>
<li>Ubuntu 14.04 (Trusty) virtual machine</li>
<li>Multi-machine set-up with three VMs: <code>soci</code>, <code>oracle</code>, <code>db2</code>.</li>
<li>Support networking between the configured machines.</li>
<li><code>soci.vm</code>:</li>
<li>hostname: <code>vmsoci.local</code></li>
<li>build essentials</li>
<li>core dependencies</li>
<li>backend dependencies</li>
<li>FOSS databases installed with sample <code>soci</code> user and instance pre-configured</li>
<li>during provision, automatically clones and builds SOCI from <code>master</code> branch.</li>
<li><code>db2.vm</code>:</li>
<li>hostname: <code>vmdb2.local</code></li>
<li>IBM DB2 Express-C 9.7 installed from <a href="https://archive.canonical.com">archive.canonical.com</a> packages.</li>
<li><code>oracle.vm</code>:</li>
<li><em>TODO</em>: provision with Oracle XE</li>
<li>SOCI local git repository (aka <code>$SOCI_HOME</code>) is automatically shared on host
and all guest machines.</li>
</ul>
<h2 id="prerequisites">Prerequisites</h2>
<ul>
<li>Speedy broadband, time and coffee.</li>
<li>Recommended 4GB or much more RAM (tested with 16GB only).</li>
</ul>
<h3 id="soci-db2-backend">SOCI DB2 backend</h3>
<p>The <code>soci.vm</code> will be configured properly to build the DB2 backend only if
it is provisioned with complete DB2 CLI client (libraries and headers).
You need to download "IBM Data Server Driver Package (DS Driver)" manually
and make it visible to Vagrant:</p>
<ol>
<li>Go to <a href="https://www-01.ibm.com/support/docview.wss?uid=swg21385217">IBM Data Server Client Packages</a>.</li>
<li>Download "IBM Data Server Driver Package (DS Driver)".</li>
<li>Copy the package to <code>${SOCI_HOME}/tmp</code> directory, on host machine.</li>
</ol>
<h2 id="usage">Usage</h2>
<p>Below, simple and easy development workflow with Vagrant is outlined:</p>
<ul>
<li><a href="https://docs.vagrantup.com/v2/getting-started/up.html">Boot</a></li>
</ul>
<pre><code class="language-console">vagrant up
</code></pre>
<p>or boot VMs selectively:</p>
<pre><code class="language-console">vagrant up {soci|db2}
</code></pre>
<p>First time you run it, be patient as Vagrant downloads VM box and
provisions it installing all the necessary packages.</p>
<ul>
<li>You can SSH into the machine</li>
</ul>
<pre><code class="language-console">vagrant ssh {soci|db2}
</code></pre>
<ul>
<li>Run git commands can either from host or VM <code>soci</code> (once connected via SSH)</li>
</ul>
<pre><code class="language-console">cd /vagrant # aka $SOCI_HOME
git pull origin master
</code></pre>
<ul>
<li>You can edit source code on both, on host or VM <code>soci</code>.</li>
<li>For example, edit in your favourite editor on host machine, then build, run, test and debug on guest machine from command line.</li>
<li>
<p>Alternatively, edit and build on host machine using your favourite IDE, then test and debug connecting to DBs on guest machines via network.</p>
</li>
<li>
<p>Build on VM <code>soci</code></p>
</li>
</ul>
<pre><code class="language-console">vagrant ssh soci
cd /vagrant # aka $SOCI_HOME
cd soci-build # aka $SOCI_BUILD
make
</code></pre>
<p>You can also execute the <code>build.h</code> script provided to run CMake and make</p>
<pre><code class="language-console">vagrant ssh soci
cd $SOCI_BUILD
/vagrant/scripts/vagrant/build.sh
</code></pre>
<ul>
<li>
<p>Debug, only on VM <code>soci</code>, for example, with gdb or remotely Visual Studio 2017.</p>
</li>
<li>
<p><a href="https://docs.vagrantup.com/v2/getting-started/teardown.html">Teardown</a></p>
</li>
</ul>
<pre><code class="language-console">vagrant {suspend|halt|destroy} {soci|db2}
</code></pre>
<p>Check Vagrant <a href="https://docs.vagrantup.com/v2/cli/index.html">command-line interface</a> for complete list of commands.</p>
<h3 id="environment-variables">Environment variables</h3>
<p>All variables available to the <code>vagrant</code> user on the VMs are defined in and sourced from <code>/vagrant/scripts/vagrant/common.env</code>:</p>
<ul>
<li><code>SOCI_HOME</code> where SOCI master is cloned (<code>/vagrant</code> on VM <code>soci</code>)</li>
<li><code>SOCI_BUILD</code> where CMake generates build configuration (<code>/home/vagrant/soci-build</code> on VM <code>soci</code>)</li>
<li><code>SOCI_HOST</code> network accessible VM <code>soci</code> hostname (<code>ping vmsoci.local</code>)</li>
<li><code>SOCI_USER</code> default database user and database name</li>
<li><code>SOCI_PASS</code> default database password for both, <code>SOCI_USER</code> and root/sysdba
of particular database.</li>
<li><code>SOCI_DB2_HOST</code> network accessible VM <code>db2</code> hostname (<code>ping vmdb2.local</code>)</li>
<li><code>SOCI_DB2_USER</code> admin username to DB2 instance.</li>
<li><code>SOCI_DB2_USER</code> admin password to DB2 instance.</li>
</ul>
<p>Note, those variables are also used by provision scripts to set up databases.</p>
<h2 id="troubleshooting">Troubleshooting</h2>
<ul>
<li>Analyze <code>vagrant up</code> output.</li>
<li>On Windows, prefer <code>vagrant ssh</code> from inside MinGW Shell where <code>ssh.exe</code> is available or learn how to use Vagrant with PuTTY.</li>
<li>If you modify any of <code>scripts/vagrant/*.sh</code> scripts, <strong>ensure</strong> they have unified end-of-line characters to <code>LF</code> only. Otherwise, provisioning steps may fail.</li>
</ul></div>
</div>
</div>
<footer class="col-md-12">
<hr>
<p>Copyright © 2017-2025 <a href="https://soci.sourceforge.net/people.html">SOCI Team</a>.</p>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../js/bootstrap.bundle.min.js"></script>
<script>
var base_url = "..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../js/base.js"></script>
<script src="../search/main.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>
|
