duckdb::Blob Class Reference

The Blob class is a static class that holds helper functions for the Blob type. More...

#include <duckdb.hpp>

Static Public Member Functions
static DUCKDB_API idx_t	GetStringSize (string_t blob)
	Returns the string size of a blob -> string conversion.
static DUCKDB_API void	ToString (string_t blob, char *output)
static DUCKDB_API string	ToString (string_t blob)
	Convert a blob object to a string.
static DUCKDB_API bool	TryGetBlobSize (string_t str, idx_t &result_size, CastParameters &parameters)
	Returns the blob size of a string -> blob conversion.
static DUCKDB_API idx_t	GetBlobSize (string_t str)
static DUCKDB_API idx_t	GetBlobSize (string_t str, CastParameters &parameters)
static DUCKDB_API void	ToBlob (string_t str, data_ptr_t output)
static DUCKDB_API string	ToBlob (string_t str)
	Convert a string object to a blob.
static DUCKDB_API string	ToBlob (string_t str, CastParameters &parameters)
static DUCKDB_API string	ToBase64 (string_t blob)
static DUCKDB_API idx_t	ToBase64Size (string_t blob)
	Returns the string size of a blob -> base64 conversion.
static DUCKDB_API void	ToBase64 (string_t blob, char *output)
	Converts a blob to a base64 string, output should have space for at least ToBase64Size(blob) bytes.
static DUCKDB_API string	FromBase64 (string_t blob)
static DUCKDB_API idx_t	FromBase64Size (string_t str)
	Returns the string size of a base64 string -> blob conversion.
static DUCKDB_API void	FromBase64 (string_t str, data_ptr_t output, idx_t output_size)
	Converts a base64 string to a blob, output should have space for at least FromBase64Size(blob) bytes.

Static Public Attributes
static constexpr const char *	HEX_TABLE = "0123456789ABCDEF"
static const int	HEX_MAP [256]
static constexpr const char *	BASE64_MAP = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
	map of index -> base64 character
static constexpr const char	BASE64_PADDING = '='
	padding character used in base64 encoding

Detailed Description

The Blob class is a static class that holds helper functions for the Blob type.

Member Function Documentation

ToString()

static DUCKDB_API void duckdb::Blob::ToString ( string_t  blob, char *  output  )

static

Converts a blob to a string, writing the output to the designated output string. The string needs to have space for at least GetStringSize(blob) bytes.

ToBlob()

static DUCKDB_API void duckdb::Blob::ToBlob ( string_t  str, data_ptr_t  output  )

static

Convert a string to a blob. This function should ONLY be called after calling GetBlobSize, since it does NOT perform data validation.

---

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

• external/duckdb/duckdb.hpp