duckdb::ArrowType Class Reference

Collaboration diagram for duckdb::ArrowType:

Public Member Functions
	ArrowType (LogicalType type_p, unique_ptr< ArrowTypeInfo > type_info=nullptr)
	From a DuckDB type.
	ArrowType (string error_message_p, bool not_implemented_p=false)
LogicalType	GetDuckType (bool use_dictionary=false) const
void	SetDictionary (unique_ptr< ArrowType > dictionary)
bool	HasDictionary () const
const ArrowType &	GetDictionary () const
bool	RunEndEncoded () const
void	SetRunEndEncoded ()
template<class T >
const T &	GetTypeInfo () const
void	ThrowIfInvalid () const
bool	HasExtension () const
ArrowArrayPhysicalType	GetPhysicalType () const

Static Public Member Functions
static unique_ptr< ArrowType >	GetTypeFromFormat (string &format)
static unique_ptr< ArrowType >	GetTypeFromFormat (ClientContext &context, ArrowSchema &schema, string &format)
static unique_ptr< ArrowType >	GetTypeFromSchema (ClientContext &context, ArrowSchema &schema)
static unique_ptr< ArrowType >	CreateListType (ClientContext &context, ArrowSchema &child, ArrowVariableSizeType size_type, bool view)
static unique_ptr< ArrowType >	GetArrowLogicalType (ClientContext &context, ArrowSchema &schema)

Public Attributes
shared_ptr< ArrowTypeExtensionData >	extension_data
	The Arrow Type Extension data, if any.

Protected Attributes
LogicalType	type
unique_ptr< ArrowType >	dictionary_type
	Hold the optional type if the array is a dictionary.
bool	run_end_encoded = false
	Is run-end-encoded.
unique_ptr< ArrowTypeInfo >	type_info
string	error_message
	Error message in case of an invalid type (i.e., from an unsupported extension)
bool	not_implemented = false
	In case of an error do we throw not implemented?

Constructor & Destructor Documentation

ArrowType() [1/2]

duckdb::ArrowType::ArrowType ( LogicalType  type_p, unique_ptr< ArrowTypeInfo >  type_info = nullptr  )

inlineexplicit

From a DuckDB type.

        : type(std::move(type_p)), type_info(std::move(type_info)) {
    }

ArrowType() [2/2]

duckdb::ArrowType::ArrowType ( string  error_message_p, bool  not_implemented_p = false  )

inlineexplicit

        : type(LogicalTypeId::INVALID), type_info(nullptr), error_message(std::move(error_message_p)),
          not_implemented(not_implemented_p) {
    }

Member Function Documentation

GetTypeInfo()

template<class T >

const T & duckdb::ArrowType::GetTypeInfo ( ) const

inline

                                 {
        return type_info->Cast<T>();
    }

---

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

• external/duckdb/duckdb.hpp