> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # gpudb::GPUdbIngestor > gpudb::GPUdbIngestor — Kinetica C++ API

#include \<gpudb/GPUdbIngestor.hpp>

Inherits boost::noncopyable.

Public Member Functions
  GPUdbIngestor (const gpudb::GPUdb \&db, const gpudb::Type \&record\_type, const std::string \&table\_name, const WorkerList \&worker\_list, const std::map\< std::string, std::string > \&insert\_options, size\_t batch\_size)
 
  GPUdbIngestor (const gpudb::GPUdb \&db, const gpudb::Type \&record\_type, const std::string \&table\_name, const WorkerList \&worker\_list, size\_t batch\_size)
 
  GPUdbIngestor (const gpudb::GPUdb \&db, const gpudb::Type \&record\_type, const std::string \&table\_name, const std::map\< std::string, std::string > \&insert\_options, size\_t batch\_size)
 
  GPUdbIngestor (const gpudb::GPUdb \&db, const gpudb::Type \&record\_type, const std::string \&table\_name, size\_t batch\_size)
 
  \~GPUdbIngestor ()
 
const std::string &  getTableName () const
  Returns the name of the table on which this class operates.
 
const gpudb::GPUdb &  getGPUdb () const
  Returns the GPUdb client handle that this class uses internally.
 
const std::map\< std::string, std::string > &  getOptions () const
  Returns the insertion options the ingestor uses.
 
size\_t  getCountInserted () const
  Returns the count of records inserted so far through this ingestor instance; An atomic operation.
 
size\_t  getCountUpdated () const
  Returns the count of records updated so far through this ingestor instance; An atomic operation.
 
std::vector\< GPUdbInsertionException >  getErrors ()
  Returns the list of errors received since the last call to getErrors(), and clears the list.
 
std::vector\< GPUdbInsertionException >  getWarnings ()
  Returns the list of warnings received since the last call to getWarnings(), and clears the list.
 
void  flush ()
  Ensures that all queued records are inserted into the database.
 
void  insert (gpudb::GenericRecord record)
  Queues a record for insertion into GPUdb.
 
void  insert (std::vector\< gpudb::GenericRecord > records)
  Queues a list of records for insertion into Kientica.
 

Detailed Description

Definition at line 33 of file GPUdbIngestor.hpp.

Constructor & Destructor Documentation

◆ GPUdbIngestor() \[1/4]

gpudb::GPUdbIngestor::GPUdbIngestor ( const gpudb::GPUdb & db,
const gpudb::Type & record\_type,
const std::string & table\_name,
const WorkerList & worker\_list,
const std::map\< std::string, std::string > & insert\_options,
size\_t batch\_size )

◆ GPUdbIngestor() \[2/4]

gpudb::GPUdbIngestor::GPUdbIngestor ( const gpudb::GPUdb & db,
const gpudb::Type & record\_type,
const std::string & table\_name,
const WorkerList & worker\_list,
size\_t batch\_size )

◆ GPUdbIngestor() \[3/4]

gpudb::GPUdbIngestor::GPUdbIngestor ( const gpudb::GPUdb & db,
const gpudb::Type & record\_type,
const std::string & table\_name,
const std::map\< std::string, std::string > & insert\_options,
size\_t batch\_size )

◆ GPUdbIngestor() \[4/4]

gpudb::GPUdbIngestor::GPUdbIngestor ( const gpudb::GPUdb & db,
const gpudb::Type & record\_type,
const std::string & table\_name,
size\_t batch\_size )

◆ \~GPUdbIngestor()

gpudb::GPUdbIngestor::\~GPUdbIngestor ( )

Member Function Documentation

◆ flush()

void gpudb::GPUdbIngestor::flush ( )

Ensures that all queued records are inserted into the database.

If an error occurs while inserting the records from any queue, the recoreds will no longer be in that queue nor in the database; catch GPUdbInsertException\ to get the list of records that were being inserted if needed (for example, to retry). Other queues may also still contain unflushed records if this occurs.

◆ getCountInserted()

size\_t gpudb::GPUdbIngestor::getCountInserted ( ) const
inline

Returns the count of records inserted so far through this ingestor instance; An atomic operation.

Definition at line 79 of file GPUdbIngestor.hpp.

◆ getCountUpdated()

size\_t gpudb::GPUdbIngestor::getCountUpdated ( ) const
inline

Returns the count of records updated so far through this ingestor instance; An atomic operation.

Definition at line 85 of file GPUdbIngestor.hpp.

◆ getErrors()

std::vector\< GPUdbInsertionException > gpudb::GPUdbIngestor::getErrors ( )

Returns the list of errors received since the last call to getErrors(), and clears the list.

◆ getGPUdb()

const gpudb::GPUdb & gpudb::GPUdbIngestor::getGPUdb ( ) const
inline

Returns the GPUdb client handle that this class uses internally.

Definition at line 68 of file GPUdbIngestor.hpp.

◆ getOptions()

const std::map\< std::string, std::string > & gpudb::GPUdbIngestor::getOptions ( ) const
inline

Returns the insertion options the ingestor uses.

Definition at line 73 of file GPUdbIngestor.hpp.

◆ getTableName()

const std::string & gpudb::GPUdbIngestor::getTableName ( ) const
inline

Returns the name of the table on which this class operates.

Definition at line 63 of file GPUdbIngestor.hpp.

◆ getWarnings()

std::vector\< GPUdbInsertionException > gpudb::GPUdbIngestor::getWarnings ( )

Returns the list of warnings received since the last call to getWarnings(), and clears the list.

◆ insert() \[1/2]

void gpudb::GPUdbIngestor::insert ( gpudb::GenericRecord record )

Queues a record for insertion into GPUdb.

If the queue reaches the configured batch size, all records in the queue will be inserted into Kinetica before the method returns. If an error occurs while inserting the records, the records will no longer be in the queue nor in Kinetica; catch InsertException\ to get the list of records that were being inserted if needed (for example, to retry).

Parameters
record The record to insert.

◆ insert() \[2/2]

void gpudb::GPUdbIngestor::insert ( std::vector\< gpudb::GenericRecord > records )

Queues a list of records for insertion into Kientica.

If any queue reaches the configured batch size, all records in the queue will be inserted into Kinetica before the method returns. If an error occurs while inserting the records, the records will no longer be in the queue nor in Kinetica; catch InsertException\ to get the list of records that were being inserted if needed (for example, to retry).

Parameters
records The records to insert.
The documentation for this class was generated from the following file: