docs/api/client.md

22 class soci_error : public std::runtime_error { /* ... */ };
31 ## class session
33 The `session` class encapsulates the connection to the database.
36 class session
88 This class contains the following members:
107 …of the statement preparation must be provided to the constructor of the `statement` class. Example:
134 ## class connection_parameters
136 The `connection_parameters` class is a simple container for the backend pointer, connection string …
139 class connection_parameters
152 The methods of this class are:
155 * The other constructors correspond to the similar constructors of the `session` class and specify …
158 ## class connection_pool
160 The `connection_pool` class encapsulates the thread-safe pool of connections and ensures that only …
163 class connection_pool
185 ## class transaction
187 The class `transaction` can be used for associating the transaction with some code scope. It is a R…
190 class transaction
205 Note that objects of this class are not notified of other transaction related operations that might…
209 The function `into` is used for binding local output data (in other words, it defines where the res…
235 See [Binding output data](../binding.md#binding-output-data-into) for more examples
239 The function `use` is used for binding local input data (in other words, it defines where the param…
268 See [Binding input data](../binding.md#binding-input-data-use) for more examples.
270 ## class statement
272 The `statement` class encapsulates the prepared statement.
275 class statement
309 This class contains the following members:
317 …ult of using `prepare` on the `session` object, see example provided above for the `session` class.
321 * exchange functions for registering the binding of local data - they expect the result of calling …
330 … exchanged). This is normally called automatically and only when dynamic resultset binding is used.
332 * `exchange_for_rowset` as a special case for binding `rowset` objects.
337 Most of the functions from the `statement` class interface are called automatically, but can be als…
339 ## class procedure
341 The `procedure` class encapsulates the call to the stored procedure and is aimed for higher portabi…
344 class procedure
359 ## class type_conversion
361 The `type_conversion` class is a traits class that is supposed to be provided (specialized) by the …
375 … implement the `from_base` and `to_base` functions in their specializations of this template class.
379 ## class row
381 The `row` class encapsulates the data and type information retrieved for the single row when the dy…
384 class row
421 This class contains the following members:
424 * `uppercase_column_names` - see the same function in the `session` class.
432 See [Dynamic resultset binding](../types.md#dynamic-binding) for examples.
434 ## class column_properties
436 The `column_properties` class provides the type and name information about the particular column in…
439 class column_properties
447 This class contains the following members:
452 See [Dynamic resultset binding](../types.md#dynamic-binding) for examples.
454 ## class values
456 The `values` class encapsulates the data and type information and is used for object-relational map…
459 class values
498 This class contains the same members as the `row` class (with the same meaning) plus:
505 ## class blob
507 The `blob` class encapsulates the "large object" functionality.
510 class blob
526 This class contains the following members:
538 ## class rowid
540 The `rowid` class encapsulates the "row identifier" object.
543 class rowid
553 This class contains the following members:
558 ## class backend_factory
560 The `backend_factory` class provides the abstract interface for concrete backend factories.
570 The only member of this class is the `make_session` function that is supposed to create concrete ba…
572 … provided to the constructor of the `session` class. In simple programs users do not need to use t…
746 …tors; the rationale for this is that modifiable use elements are not supported for bulk operations.