Xpace
Xpace::TableSinkToStore Class Reference

#include <tablesinktostore.h>

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

Classes

class  BadCode
 
class  NoDocID
 

Public Member Functions

 TableSinkToStore (const Configuration &config)
 
virtual uint add (const String &name, DerivedDataType type, uint columnNum, bool *added=0) override
 Add a column by name. More...
 
virtual uint add (const Configuration &config, uint col, bool *added) override
 Add a field from a Configuration. More...
 
virtual int64 start (uint64) override
 Begin a new document/record/row, committing current one (if any) More...
 
virtual bool set (uint column, int64 value) override
 Write an int64. More...
 
virtual bool set (uint column, const DecimalFloat &value) override
 Add a DecimalFloat. More...
 
virtual bool set (uint column, const String8 &value) override
 Add a String8. More...
 
virtual bool set (uint column, const String16 &value) override
 Add a String16. More...
 
virtual bool set (uint column, const BytesRef &value) override
 Add a BytesRef. More...
 
virtual void close () override
 We're finshed with this Sink. More...
 
- Public Member Functions inherited from Xpace::Sink< uint >
virtual bool move (uintlocation)
 Move without setting data. More...
 
virtual bool set (uintlocation, const DateTime &value)
 Add a DateTime. 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...
 

Static Public Attributes

static const char * DOC_ID_TAG
 tag of the field (column) that contains the document identifier More...
 
static const char * LOC_TAG
 tag of fields (columns) that contain location in the final store More...
 

Additional Inherited Members

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

Detailed Description

Definition at line 21 of file tablesinktostore.h.

Constructor & Destructor Documentation

Xpace::TableSinkToStore::TableSinkToStore ( const Configuration config)

Member Function Documentation

virtual uint Xpace::TableSinkToStore::add ( const String name,
DerivedDataType  type,
uint  columnNum,
bool added = 0 
)
inlineoverridevirtual

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

Implements Xpace::Table::Sink.

Definition at line 31 of file tablesinktostore.h.

References added, and col.

virtual uint Xpace::TableSinkToStore::add ( const Configuration config,
uint  location,
bool added 
)
overridevirtual

Add a field from a Configuration.

Parameters
configthe configuration of the field
locationa proposed location; may be null
Return values
addedtrue iff the column was added
Returns
the actual location, NULL to stop

Reimplemented from Xpace::Sink< uint >.

virtual int64 Xpace::TableSinkToStore::start ( uint64  docNum)
inlineoverridevirtual

Begin a new document/record/row, committing current one (if any)

Parameters
docNuma suggested document
Returns
-1 to stop, otherwise a document number

Reimplemented from Xpace::SinkBase.

Definition at line 46 of file tablesinktostore.h.

References Xpace::SA_bulkWrite.

virtual bool Xpace::TableSinkToStore::set ( uint  location,
int64  value 
)
inlineoverridevirtual

Write an int64.

Parameters
location
value
Returns
a RET, usually a bool

Reimplemented from Xpace::Sink< uint >.

Definition at line 57 of file tablesinktostore.h.

References value.

virtual bool Xpace::TableSinkToStore::set ( uint  location,
const DecimalFloat value 
)
inlineoverridevirtual

Add a DecimalFloat.

Parameters
location
value
Returns
a RET, usually a bool

Reimplemented from Xpace::Sink< uint >.

Definition at line 64 of file tablesinktostore.h.

References value.

virtual bool Xpace::TableSinkToStore::set ( uint  location,
const String8 value 
)
inlineoverridevirtual

Add a String8.

Parameters
location
value
Returns
a RET, usually a bool

Reimplemented from Xpace::Sink< uint >.

Definition at line 71 of file tablesinktostore.h.

References value.

virtual bool Xpace::TableSinkToStore::set ( uint  location,
const String16 value 
)
inlineoverridevirtual

Add a String16.

Parameters
location
value
Returns
a RET, usually a bool

Reimplemented from Xpace::Sink< uint >.

Definition at line 78 of file tablesinktostore.h.

References value.

virtual bool Xpace::TableSinkToStore::set ( uint  location,
const BytesRef value 
)
inlineoverridevirtual

Add a BytesRef.

Parameters
location
value
Returns
a RET, usually a bool

Reimplemented from Xpace::Sink< uint >.

Definition at line 86 of file tablesinktostore.h.

References value.

virtual void Xpace::TableSinkToStore::close ( )
inlineoverridevirtual

We're finshed with this Sink.

Reimplemented from Xpace::SinkBase.

Definition at line 93 of file tablesinktostore.h.

Member Data Documentation

const char* Xpace::TableSinkToStore::DOC_ID_TAG
static

tag of the field (column) that contains the document identifier

Definition at line 24 of file tablesinktostore.h.

const char* Xpace::TableSinkToStore::LOC_TAG
static

tag of fields (columns) that contain location in the final store

Definition at line 25 of file tablesinktostore.h.


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

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