kuzu::common::RelVal Class Reference

RelVal represents a rel in the graph and stores the relID, src/dst nodes and properties of that rel. More...

#include <rel.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 *	getSrcNodeIDVal (const Value *val)
static KUZU_API Value *	getDstNodeIDVal (const Value *val)
static KUZU_API Value *	getIDVal (const Value *val)
static KUZU_API Value *	getLabelVal (const Value *val)
static KUZU_API std::string	toString (const Value *val)

Detailed Description

RelVal represents a rel in the graph and stores the relID, src/dst nodes and properties of that rel.

Member Function Documentation

getDstNodeIDVal()

static KUZU_API Value * kuzu::common::RelVal::getDstNodeIDVal ( const Value * val )

static

Returns

the dst nodeID value of the RelVal in Value.

getIDVal()

static KUZU_API Value * kuzu::common::RelVal::getIDVal ( const Value * val )

static

Returns

the internal ID value of the RelVal in Value.

getLabelVal()

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

static

Returns

the label value of the RelVal.

getNumProperties()

static KUZU_API uint64_t kuzu::common::RelVal::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::RelVal::getProperties ( const Value * val )

static

Returns

all properties of the RelVal.

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::RelVal::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::RelVal::getPropertyVal ( const Value * val, uint64_t index )

static

Returns

the value of the property at the given index.

getSrcNodeIDVal()

static KUZU_API Value * kuzu::common::RelVal::getSrcNodeIDVal ( const Value * val )

static

Returns

the src nodeID value of the RelVal in Value.

toString()

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

static

Returns

the value of the RelVal in string format.

---

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

• headers/rel.h