Namespace Poco::Data::Keywords
Author: Applied Informatics Software Engineering GmbH and Contributors

# Poco::Data

# namespace Keywords

## Overview

Functions: async, bind, bulk, deque, format, from, in, into, io, limit, list, lowerLimit, now, out, range, reset, sync, upperLimit, use, useRef, vector

## Functions

### async

inline void async(
Statement & statement
);

Sets the _async flag to true, signalling asynchronous execution.

### bind

template < typename T > inline AbstractBinding::Ptr bind(
T t,
const std::string & name
);

Convenience function for a more compact Binding creation. This funtion differs from use() in its value copy semantics.

### bind

template < typename T > inline AbstractBinding::Ptr bind(
T t
);

Convenience function for a more compact Binding creation. This funtion differs from use() in its value copy semantics.

### bulk

inline Bulk bulk(
const Limit & limit = Limit (Limit::LIMIT_UNLIMITED, false, false)
);

Convenience function for creation of bulk.

### bulk

inline void bulk(
Void
);

Dummy bulk function. Used for bulk binding creation (see BulkBinding) and bulk extraction signalling to Statement.

### deque

inline void deque(
Statement & statement
);

Sets the internal storage to std::deque. std::deque is default storage, so specifying this manipulator only makes sense if list() or deque() were called for the statement before.

### format

template < typename T > inline RowFormatter::Ptr format(
const T & formatter
);

Utility function used to pass formatter to the statement.

### from

template < typename T > inline Position from(
const T & value
);

Convenience function for creation of position.

### in

template < typename T > inline AbstractBinding::Ptr in(
T & t,
const std::string & name = ""
);

Convenience function for a more compact Binding creation.

### in

inline AbstractBinding::Ptr in(
const NullData & t,
const std::string & name = ""
);

NullData overload.

### in

inline AbstractBindingVec & in(
AbstractBindingVec & bv
);

Convenience dummy function (for syntax purposes only).

### in

template < typename T > AbstractBinding::Ptr in(
const std::vector < T > & t,
BulkFnType,
const std::string & name = ""
);

Convenience function for a more compact BulkBinding creation for std::vector.

### in

template < typename T > AbstractBinding::Ptr in(
const std::deque < T > & t,
BulkFnType,
const std::string & name = ""
);

Convenience function for a more compact BulkBinding creation for std::deque.

### in

template < typename T > AbstractBinding::Ptr in(
const std::list < T > & t,
BulkFnType,
const std::string & name = ""
);

Convenience function for a more compact BulkBinding creation for std::list.

### into

template < typename T > AbstractExtraction::Ptr into(
std::vector < T > & t,
const Bulk & bulk,
const Position & pos = Position (0)
);

Convenience function to allow for a more compact creation of an extraction object with std::vector bulk extraction support.

### into

template < typename T > AbstractExtraction::Ptr into(
std::vector < T > & t,
BulkFnType,
const Position & pos = Position (0)
);

Convenience function to allow for a more compact creation of an extraction object with std::vector bulk extraction support.

### into

template < typename T > AbstractExtraction::Ptr into(
std::deque < T > & t,
const Bulk & bulk,
const Position & pos = Position (0)
);

Convenience function to allow for a more compact creation of an extraction object with std::deque bulk extraction support.

### into

template < typename T > AbstractExtraction::Ptr into(
std::deque < T > & t,
BulkFnType,
const Position & pos = Position (0)
);

Convenience function to allow for a more compact creation of an extraction object with std::deque bulk extraction support.

### into

template < typename T > AbstractExtraction::Ptr into(
std::list < T > & t,
const Bulk & bulk,
const Position & pos = Position (0)
);

Convenience function to allow for a more compact creation of an extraction object with std::list bulk extraction support.

### into

template < typename T > AbstractExtraction::Ptr into(
std::list < T > & t,
BulkFnType,
const Position & pos = Position (0)
);

Convenience function to allow for a more compact creation of an extraction object with std::list bulk extraction support.

### into

template < typename T > inline AbstractExtraction::Ptr into(
T & t
);

Convenience function to allow for a more compact creation of an extraction object.

### into

template < typename T > inline AbstractExtraction::Ptr into(
T & t,
const Position & pos
);

Convenience function to allow for a more compact creation of an extraction object with multiple recordset support.

### into

template < typename T > inline AbstractExtraction::Ptr into(
T & t,
const Position & pos,
const T & def
);

Convenience function to allow for a more compact creation of an extraction object with multiple recordset support and the given default

### into

inline AbstractExtractionVecVec & into(
AbstractExtractionVecVec & evv
);

Convenience dummy function (for syntax purposes only).

### into

inline AbstractExtractionVec & into(
AbstractExtractionVec & ev
);

Convenience dummy function (for syntax purposes only).

### io

template < typename T > inline AbstractBinding::Ptr io(
T & t
);

Convenience function for a more compact Binding creation.

### io

inline AbstractBindingVec & io(
AbstractBindingVec & bv
);

Convenience dummy function (for syntax purposes only).

### limit

template < typename T > Limit limit(
T lim,
bool hard = false
);

Creates an upperLimit

### list

inline void list(
Statement & statement
);

Sets the internal storage to std::list.

### lowerLimit

template < typename T > Limit lowerLimit(
T lim
);

### now

inline void now(
Statement & statement
);

Enforces immediate execution of the statement. If _isAsync flag has been set, execution is invoked asynchronously.

### out

template < typename T > inline AbstractBinding::Ptr out(
T & t
);

Convenience function for a more compact Binding creation.

### out

inline AbstractBindingVec & out(
AbstractBindingVec & bv
);

Convenience dummy function (for syntax purposes only).

### range

template < typename T > Range range(
T low,
T upp,
bool hard = false
);

### reset

inline void reset(
Statement & statement
);

Sets all internal settings to their respective default values.

### sync

inline void sync(
Statement & statement
);

Sets the _isAsync flag to false, signalling synchronous execution. Synchronous execution is default, so specifying this manipulator only makes sense if async() was called for the statement before.

### upperLimit

template < typename T > Limit upperLimit(
T lim,
bool hard = false
);

### use

template < typename T > inline AbstractBinding::Ptr use(
T & t,
const std::string & name = ""
);

Convenience function for a more compact Binding creation.

### use

inline AbstractBinding::Ptr use(
const NullData & t,
const std::string & name = ""
);

NullData overload.

### use

inline AbstractBindingVec & use(
AbstractBindingVec & bv
);

Convenience dummy function (for syntax purposes only).

### use

template < typename T > AbstractBinding::Ptr use(
const std::vector < T > & t,
BulkFnType,
const std::string & name = ""
);

Convenience function for a more compact BulkBinding creation for std::vector.

### use

template < typename T > AbstractBinding::Ptr use(
const std::deque < T > & t,
BulkFnType,
const std::string & name = ""
);

Convenience function for a more compact BulkBinding creation for std::deque.

### use

template < typename T > AbstractBinding::Ptr use(
const std::list < T > & t,
BulkFnType,
const std::string & name = ""
);

Convenience function for a more compact BulkBinding creation for std::list.

### useRef

template < typename T > inline AbstractBinding::Ptr useRef(
T & t,
const std::string & name = ""
);

Convenience function for a more compact Binding creation.

### vector

inline void vector(
Statement & statement
);

Sets the internal storage to std::vector.

## Variables

### null

static const NullData null = NULL_GENERIC;