kuzu::common::NodeVal Class Reference

NodeVal represents a node in the graph and stores the nodeID, label and properties of that node. More...

#include <node.h>

Static Public Member Functions
static KUZU_API std::vector< std::pair< std::string, std::unique_ptr< Value > > >	getProperties (const Value *val)
static KUZU_API uint64_t	getNumProperties (const Value *val)
static KUZU_API std::string	getPropertyName (const Value *val, uint64_t index)
static KUZU_API Value *	getPropertyVal (const Value *val, uint64_t index)
static KUZU_API Value *	getNodeIDVal (const Value *val)
static KUZU_API Value *	getLabelVal (const Value *val)
static KUZU_API std::string	toString (const Value *val)

Detailed Description

NodeVal represents a node in the graph and stores the nodeID, label and properties of that node.

Member Function Documentation

getLabelVal()

static KUZU_API Value * kuzu::common::NodeVal::getLabelVal ( const Value * val )

static

Returns

the name of the node as a Value.

getNodeIDVal()

static KUZU_API Value * kuzu::common::NodeVal::getNodeIDVal ( const Value * val )

static

Returns

the nodeID as a Value.

getNumProperties()

static KUZU_API uint64_t kuzu::common::NodeVal::getNumProperties ( const Value * val )

static

Returns

number of properties of the RelVal.

getProperties()

static KUZU_API std::vector< std::pair< std::string, std::unique_ptr< Value > > > kuzu::common::NodeVal::getProperties ( const Value * val )

static

Returns

all properties of the NodeVal.

Note

this function copies all the properties into a vector, which is not efficient. use getPropertyName and getPropertyVal instead if possible.

getPropertyName()

static KUZU_API std::string kuzu::common::NodeVal::getPropertyName ( const Value * val, uint64_t index )

static

Returns

the name of the property at the given index.

getPropertyVal()

static KUZU_API Value * kuzu::common::NodeVal::getPropertyVal ( const Value * val, uint64_t index )

static

Returns

the value of the property at the given index.

toString()

static KUZU_API std::string kuzu::common::NodeVal::toString ( const Value * val )

static

Returns

the current node values in string format.

---

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

• headers/node.h