duckdb::ComplexJSON Struct Reference

Custom struct to handle both strings and nested JSON objects. More...

Collaboration diagram for duckdb::ComplexJSON:

Public Member Functions
	ComplexJSON (const string &str)
	Constructor for string values.
	ComplexJSON ()
	Basic empty constructor.
void	AddObjectEntry (const string &key, unique_ptr< ComplexJSON > object)
	Adds entry to the underlying map, also sets the type to OBJECT.
void	AddArrayElement (unique_ptr< ComplexJSON > object)
	Adds element to the underlying list, also sets the type to ARRAY.
ComplexJSON &	GetObject (const string &key)
	Gets a ComplexJSON object from the map.
ComplexJSON &	GetArrayElement (const idx_t &index)
	Gets a ComplexJSON element from the list.
string	GetValue (const string &key) const
	Gets a string version of the underlying ComplexJSON object from the map.
string	GetValue (const idx_t &index) const
	Gets a string version of the underlying ComplexJSON array from the list.
unordered_map< string, string >	Flatten () const
	Flattens this json to a top level key -> nested json.

Static Public Member Functions
static string	GetValueRecursive (const ComplexJSON &child)
	Recursive function for GetValue.

Private Attributes
string	str_value
	Basic string value, in case this is the last value of a nested json.
unordered_map< string, unique_ptr< ComplexJSON > >	obj_value
	If this is a json object a map of key/value.
vector< unique_ptr< ComplexJSON > >	arr_value
	If this is a json array a list of values.
ComplexJSONType	type
	If this json is an object (i.e., map or not)

Detailed Description

Custom struct to handle both strings and nested JSON objects.

Constructor & Destructor Documentation

ComplexJSON() [1/2]

duckdb::ComplexJSON::ComplexJSON ( const string &  str )

explicit

Constructor for string values.

                                          : str_value(str), type(ComplexJSONType::VALUE) {
}

ComplexJSON() [2/2]

duckdb::ComplexJSON::ComplexJSON

(

)

Basic empty constructor.

                         : type(ComplexJSONType::VALUE) {
}

Member Function Documentation

AddObjectEntry()

void duckdb::ComplexJSON::AddObjectEntry	(	const string &	key,
		unique_ptr< ComplexJSON >	object
	)

Adds entry to the underlying map, also sets the type to OBJECT.

                                                                                  {
    type = ComplexJSONType::OBJECT;
    obj_value[key] = std::move(object);
}

AddArrayElement()

void duckdb::ComplexJSON::AddArrayElement

(

unique_ptr< ComplexJSON >

object

)

Adds element to the underlying list, also sets the type to ARRAY.

                                                                {
    type = ComplexJSONType::ARRAY;
    arr_value.push_back(std::move(object));
}

GetObject()

ComplexJSON & duckdb::ComplexJSON::GetObject

(

const string &

key

)

Gets a ComplexJSON object from the map.

                                                     {
    if (type == ComplexJSONType::OBJECT) {
        if (obj_value.find(key) == obj_value.end()) {
            throw InvalidInputException("Complex JSON Key not found");
        }
        return *obj_value[key];
    }
    throw InvalidInputException("ComplexJson is not an object");
}

GetArrayElement()

ComplexJSON & duckdb::ComplexJSON::GetArrayElement

(

const idx_t &

index

)

Gets a ComplexJSON element from the list.

                                                            {
    if (type == ComplexJSONType::ARRAY) {
        if (index >= arr_value.size()) {
            throw InvalidInputException("Complex JSON array element out of bounds");
        }
        return *arr_value[index];
    }
    throw InvalidInputException("ComplexJson is not an array");
}

Flatten()

unordered_map< string, string > duckdb::ComplexJSON::Flatten

(

)

const

Flattens this json to a top level key -> nested json.

                                                         {
    unordered_map<string, string> result;
    for (auto &obj : obj_value) {
        result[obj.first] = obj.second->GetValueRecursive(*obj.second);
    }
    return result;
}

---

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

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