duckdb::ArrowExtensionMetadata Struct Reference

Collaboration diagram for duckdb::ArrowExtensionMetadata:

Public Member Functions
	ArrowExtensionMetadata (string extension_name, string vendor_name, string type_name, string arrow_format)
hash_t	GetHash () const
string	ToString () const
string	GetExtensionName () const
string	GetVendorName () const
string	GetTypeName () const
string	GetArrowFormat () const
void	SetArrowFormat (string arrow_format)
bool	IsCanonical () const
bool	operator== (const ArrowExtensionMetadata &other) const

Static Public Attributes
static constexpr const char *	ARROW_EXTENSION_NON_CANONICAL = "arrow.opaque"
	Arrow Extension for non-canonical types.

Private Attributes
string	extension_name {}
	The extension name (e.g., 'arrow.uuid', 'arrow.opaque',...)
string	vendor_name {}
string	type_name {}
	The type_name is the name of the type produced by the vendor (e.g., hugeint)
string	arrow_format {}
	The arrow format (e.g., z)

Constructor & Destructor Documentation

ArrowExtensionMetadata() [1/2]

duckdb::ArrowExtensionMetadata::ArrowExtensionMetadata ( )

inline

                             {
    }

ArrowExtensionMetadata() [2/2]

duckdb::ArrowExtensionMetadata::ArrowExtensionMetadata	(	string	extension_name,
		string	vendor_name,
		string	type_name,
		string	arrow_format
	)

    : extension_name(std::move(extension_name)), vendor_name(std::move(vendor_name)), type_name(std::move(type_name)),
      arrow_format(std::move(arrow_format)) {
}

Member Function Documentation

GetHash()

hash_t duckdb::ArrowExtensionMetadata::GetHash

(

)

const

                                             {
    const auto h_extension = Hash(extension_name.c_str());
    const auto h_vendor = Hash(vendor_name.c_str());
    const auto h_type = Hash(type_name.c_str());
    // Most arrow extensions are unique on the extension name
    // However we use arrow.opaque as all the non-canonical extensions, hence we do a hash-aroo of all.
    return CombineHash(h_extension, CombineHash(h_vendor, h_type));
}

ToString()

string duckdb::ArrowExtensionMetadata::ToString

(

)

const

                                              {
    std::ostringstream info;
    info << "Extension Name: " << extension_name << "\n";
    if (!vendor_name.empty()) {
        info << "Vendor: " << vendor_name << "\n";
    }
    if (!type_name.empty()) {
        info << "Type: " << type_name << "\n";
    }
    if (!arrow_format.empty()) {
        info << "Format: " << arrow_format << "\n";
    }
    return info.str();
}

GetExtensionName()

string duckdb::ArrowExtensionMetadata::GetExtensionName

(

)

const

                                                      {
    return extension_name;
}

GetVendorName()

string duckdb::ArrowExtensionMetadata::GetVendorName

(

)

const

                                                   {
    return vendor_name;
}

GetTypeName()

string duckdb::ArrowExtensionMetadata::GetTypeName

(

)

const

                                                 {
    return type_name;
}

GetArrowFormat()

string duckdb::ArrowExtensionMetadata::GetArrowFormat

(

)

const

                                                    {
    return arrow_format;
}

SetArrowFormat()

void duckdb::ArrowExtensionMetadata::SetArrowFormat

(

string

arrow_format

)

                                                                 {
    arrow_format = std::move(arrow_format_p);
}

IsCanonical()

bool duckdb::ArrowExtensionMetadata::IsCanonical

(

)

const

                                               {
    D_ASSERT((!vendor_name.empty() && !type_name.empty()) || (vendor_name.empty() && type_name.empty()));
    return vendor_name.empty();
}

operator==()

bool duckdb::ArrowExtensionMetadata::operator==

(

const ArrowExtensionMetadata &

other

)

const

                                                                                 {
    return extension_name == other.extension_name && type_name == other.type_name && vendor_name == other.vendor_name;
}

Member Data Documentation

extension_name

string duckdb::ArrowExtensionMetadata::extension_name {}

private

The extension name (e.g., 'arrow.uuid', 'arrow.opaque',...)

{};

vendor_name

string duckdb::ArrowExtensionMetadata::vendor_name {}

private

If the extension name is 'arrow.opaque' a vendor and type must be defined. The vendor_name is the system that produced the type (e.g., DuckDB)

{};

type_name

string duckdb::ArrowExtensionMetadata::type_name {}

private

The type_name is the name of the type produced by the vendor (e.g., hugeint)

{};

arrow_format

string duckdb::ArrowExtensionMetadata::arrow_format {}

private

The arrow format (e.g., z)

{};

---

The documentation for this struct was generated from the following files:

• external/duckdb/duckdb.hpp
• external/duckdb/duckdb.cpp