Xpace
Xpace::Table::Sink Class Referenceabstract

A write-only, forward cursor into a table. More...

#include <table.h>

Inheritance diagram for Xpace::Table::Sink:
Xpace::Sink< uint > Xpace::SinkBase Xpace::JavaTableSink Xpace::TableSinkToStore

Public Member Functions

virtual uint add (const String &name, DerivedDataType type, uint columnNum, bool *added=0) override=0
 Add a column by name. More...
 
- Public Member Functions inherited from Xpace::Sink< uint >
virtual uint add (const Configuration &config, uintlocation, bool *added=0)
 Add a field from a Configuration. More...
 
virtual bool move (uintlocation)
 Move without setting data. More...
 
virtual bool set (uintlocation, int64 value)
 Write an int64. More...
 
virtual bool set (uintlocation, const DecimalFloat &value)
 Add a DecimalFloat. More...
 
virtual bool set (uintlocation, const String8 &value)
 Add a String8. More...
 
virtual bool set (uintlocation, const String16 &value)
 Add a String16. More...
 
virtual bool set (uintlocation, const DateTime &value)
 Add a DateTime. More...
 
virtual bool set (uintlocation, const BytesRef &value)
 Add a BytesRef. More...
 
- Public Member Functions inherited from Xpace::SinkBase
virtual ~SinkBase ()
 
virtual bool setCount (uint64 docs)
 Inform the Sink how many documents/records/rows to expect. More...
 
virtual int64 start (uint64 docNum)
 Begin a new document/record/row, committing current one (if any) More...
 
virtual void close ()
 We're finshed with this Sink. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Xpace::SinkBase
 SinkBase ()
 

Detailed Description

A write-only, forward cursor into a table.

Definition at line 142 of file table.h.

Member Function Documentation

virtual uint Xpace::Table::Sink::add ( const String name,
DerivedDataType  type,
uint  columnNum,
bool added = 0 
)
overridepure virtual

Add a column by name.

Parameters
namethe name of the column
typethe type of the column
columnNuma proposed column number
Return values
addedtrue iff the field or column was added
Returns
the actual column number, ~0 to stop

Reimplemented from Xpace::Sink< uint >.

Implemented in Xpace::JavaTableSink, and Xpace::TableSinkToStore.


The documentation for this class was generated from the following file:

current as of Wed Jun 10 2026 12:00:06