duckdb::BaseResultRenderer Class Reference

Inheritance diagram for duckdb::BaseResultRenderer:

Collaboration diagram for duckdb::BaseResultRenderer:

Public Member Functions
virtual void	RenderLayout (const string &text)=0
virtual void	RenderColumnName (const string &text)=0
virtual void	RenderType (const string &text)=0
virtual void	RenderValue (const string &text, const LogicalType &type)=0
virtual void	RenderNull (const string &text, const LogicalType &type)=0
virtual void	RenderStringLiteral (const string &text, const LogicalType &type)
virtual void	RenderFooter (const string &text)=0
BaseResultRenderer &	operator<< (char c)
BaseResultRenderer &	operator<< (const string &val)
void	Render (ResultRenderType render_mode, const string &val)
void	SetResultTypes (vector< LogicalType > new_column_types)
void	SetValueColumn (optional_idx index)
const LogicalType &	GetValueType ()

Private Attributes
vector< LogicalType >	column_types
LogicalType	invalid_type
optional_idx	column_idx

Constructor & Destructor Documentation

BaseResultRenderer()

duckdb::BaseResultRenderer::BaseResultRenderer

(

)

                                       : invalid_type(LogicalTypeId::INVALID) {
}

~BaseResultRenderer()

duckdb::BaseResultRenderer::~BaseResultRenderer ( )

virtual

                                        {
}

Member Function Documentation

RenderStringLiteral()

virtual void duckdb::BaseResultRenderer::RenderStringLiteral ( const string &  text, const LogicalType &  type  )

inlinevirtual

                                                                                  {
        RenderValue(text, type);
    }

operator<<() [1/2]

BaseResultRenderer & duckdb::BaseResultRenderer::operator<<

(

char

c

)

                                                         {
    RenderLayout(string(1, c));
    return *this;
}

operator<<() [2/2]

BaseResultRenderer & duckdb::BaseResultRenderer::operator<<

(

const string &

val

)

                                                                    {
    RenderLayout(val);
    return *this;
}

Render()

void duckdb::BaseResultRenderer::Render	(	ResultRenderType	render_mode,
		const string &	val
	)

                                                                               {
    switch (render_mode) {
    case ResultRenderType::LAYOUT:
        RenderLayout(val);
        break;
    case ResultRenderType::COLUMN_NAME:
        RenderColumnName(val);
        break;
    case ResultRenderType::COLUMN_TYPE:
        RenderType(val);
        break;
    case ResultRenderType::VALUE:
        RenderValue(val, GetValueType());
        break;
    case ResultRenderType::NULL_VALUE:
        RenderNull(val, GetValueType());
        break;
    case ResultRenderType::STRING_LITERAL:
        RenderStringLiteral(val, GetValueType());
        break;
    case ResultRenderType::FOOTER:
        RenderFooter(val);
        break;
    default:
        throw InternalException("Unsupported type for result renderer");
    }
}

SetResultTypes()

void duckdb::BaseResultRenderer::SetResultTypes

(

vector< LogicalType >

new_column_types

)

                                                                            {
    column_types = std::move(new_column_types);
}

SetValueColumn()

void duckdb::BaseResultRenderer::SetValueColumn

(

optional_idx

index

)

                                                          {
    if (index.IsValid() && index.GetIndex() >= column_types.size()) {
        throw InternalException("BaseResultRenderer::SetValueColumn - column out of range");
    }
    column_idx = index;
}

GetValueType()

const LogicalType & duckdb::BaseResultRenderer::GetValueType

(

)

                                                    {
    if (!column_idx.IsValid()) {
        return invalid_type;
    }
    return column_types[column_idx.GetIndex()];
}

---

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

• external/duckdb/duckdb.cpp