Versions in this module Expand all Collapse all v1 v1.0.5 Apr 8, 2026 Changes in this version type Client + func (client *Client) WithApiKey(apiKey string) *Client + func (client Client) GetVersion() (getVersionResponse, error) v1.0.3 Jul 30, 2025 Changes in this version + func CypherQueryReadGeneric[T any](client *Client, db string, cypher string, parameters Parameters) ([]T, error) + func CypherQueryWriteGeneric[T any](client *Client, db string, cypher string, parameters Parameters) ([]T, error) + type AnyLogicalType struct + func (lt *AnyLogicalType) UnmarshalJSON(data []byte) error + func (lt AnyLogicalType) IsKuzuLogicalType() + func (lt AnyLogicalType) MarshalJSON() ([]byte, error) + type ArrayLogicalType struct + ChildType LogicalType + NumElements uint64 + func (lt *ArrayLogicalType) UnmarshalJSON(data []byte) error + func (lt ArrayLogicalType) IsKuzuLogicalType() + func (lt ArrayLogicalType) MarshalJSON() ([]byte, error) + type ArrayValue struct + LogicalType LogicalType + Values []Value + func (v *ArrayValue) UnmarshalJSON(data []byte) error + func (v ArrayValue) IsKuzuValue() + func (v ArrayValue) MarshalJSON() ([]byte, error) + type BlobLogicalType struct + func (lt *BlobLogicalType) UnmarshalJSON(data []byte) error + func (lt BlobLogicalType) IsKuzuLogicalType() + func (lt BlobLogicalType) MarshalJSON() ([]byte, error) + type BlobValue []uint8 + func (v *BlobValue) UnmarshalJSON(data []byte) error + func (v BlobValue) IsKuzuValue() + func (v BlobValue) MarshalJSON() ([]byte, error) + type BoolLogicalType struct + func (lt *BoolLogicalType) UnmarshalJSON(data []byte) error + func (lt BoolLogicalType) IsKuzuLogicalType() + func (lt BoolLogicalType) MarshalJSON() ([]byte, error) + type BoolValue bool + func (v *BoolValue) UnmarshalJSON(data []byte) error + func (v BoolValue) IsKuzuValue() + func (v BoolValue) MarshalJSON() ([]byte, error) + type Client struct + func DefaultClient(address string) (*Client, error) + func NewClient(address string, httpClient *http.Client) (*Client, error) + func (client *Client) CypherQueryRead(db string, cypher string, parameters Parameters) ([]map[string]any, error) + func (client *Client) CypherQueryWrite(db string, cypher string, parameters Parameters) ([]map[string]any, error) + func (client Client) CreateDatabase(name string) error + func (client Client) DeleteDatabase(name string) error + func (client Client) GetDatabases() ([]string, error) + func (client Client) GetHealth() (bool, error) + type DateLogicalType struct + func (lt *DateLogicalType) UnmarshalJSON(data []byte) error + func (lt DateLogicalType) IsKuzuLogicalType() + func (lt DateLogicalType) MarshalJSON() ([]byte, error) + type DateValue civil.Date + func (v *DateValue) UnmarshalJSON(data []byte) error + func (v DateValue) IsKuzuValue() + func (v DateValue) MarshalJSON() ([]byte, error) + type DecimalLogicalType struct + Precision uint32 + Scale uint32 + func (lt *DecimalLogicalType) UnmarshalJSON(data []byte) error + func (lt DecimalLogicalType) IsKuzuLogicalType() + func (lt DecimalLogicalType) MarshalJSON() ([]byte, error) + type DecimalValue decimal.Decimal + func (v *DecimalValue) UnmarshalJSON(data []byte) error + func (v DecimalValue) IsKuzuValue() + func (v DecimalValue) MarshalJSON() ([]byte, error) + type DoubleLogicalType struct + func (lt *DoubleLogicalType) UnmarshalJSON(data []byte) error + func (lt DoubleLogicalType) IsKuzuLogicalType() + func (lt DoubleLogicalType) MarshalJSON() ([]byte, error) + type DoubleValue float64 + func (v *DoubleValue) UnmarshalJSON(data []byte) error + func (v DoubleValue) IsKuzuValue() + func (v DoubleValue) MarshalJSON() ([]byte, error) + type FloatLogicalType struct + func (lt *FloatLogicalType) UnmarshalJSON(data []byte) error + func (lt FloatLogicalType) IsKuzuLogicalType() + func (lt FloatLogicalType) MarshalJSON() ([]byte, error) + type FloatValue float32 + func (v *FloatValue) UnmarshalJSON(data []byte) error + func (v FloatValue) IsKuzuValue() + func (v FloatValue) MarshalJSON() ([]byte, error) + type Int128LogicalType struct + func (lt *Int128LogicalType) UnmarshalJSON(data []byte) error + func (lt Int128LogicalType) IsKuzuLogicalType() + func (lt Int128LogicalType) MarshalJSON() ([]byte, error) + type Int128Value int64 + func (v *Int128Value) UnmarshalJSON(data []byte) error + func (v Int128Value) IsKuzuValue() + func (v Int128Value) MarshalJSON() ([]byte, error) + type Int16LogicalType struct + func (lt *Int16LogicalType) UnmarshalJSON(data []byte) error + func (lt Int16LogicalType) IsKuzuLogicalType() + func (lt Int16LogicalType) MarshalJSON() ([]byte, error) + type Int16Value int16 + func (v *Int16Value) UnmarshalJSON(data []byte) error + func (v Int16Value) IsKuzuValue() + func (v Int16Value) MarshalJSON() ([]byte, error) + type Int32LogicalType struct + func (lt *Int32LogicalType) UnmarshalJSON(data []byte) error + func (lt Int32LogicalType) IsKuzuLogicalType() + func (lt Int32LogicalType) MarshalJSON() ([]byte, error) + type Int32Value int32 + func (v *Int32Value) UnmarshalJSON(data []byte) error + func (v Int32Value) IsKuzuValue() + func (v Int32Value) MarshalJSON() ([]byte, error) + type Int64LogicalType struct + func (lt *Int64LogicalType) UnmarshalJSON(data []byte) error + func (lt Int64LogicalType) IsKuzuLogicalType() + func (lt Int64LogicalType) MarshalJSON() ([]byte, error) + type Int64Value int64 + func (v *Int64Value) UnmarshalJSON(data []byte) error + func (v Int64Value) IsKuzuValue() + func (v Int64Value) MarshalJSON() ([]byte, error) + type Int8LogicalType struct + func (lt *Int8LogicalType) UnmarshalJSON(data []byte) error + func (lt Int8LogicalType) IsKuzuLogicalType() + func (lt Int8LogicalType) MarshalJSON() ([]byte, error) + type Int8Value int8 + func (v *Int8Value) UnmarshalJSON(data []byte) error + func (v Int8Value) IsKuzuValue() + func (v Int8Value) MarshalJSON() ([]byte, error) + type InternalID struct + Offset uint64 + TableID uint64 + type InternalIDLogicalType struct + func (lt *InternalIDLogicalType) UnmarshalJSON(data []byte) error + func (lt InternalIDLogicalType) IsKuzuLogicalType() + func (lt InternalIDLogicalType) MarshalJSON() ([]byte, error) + type InternalIDValue InternalID + func (v *InternalIDValue) UnmarshalJSON(data []byte) error + func (v InternalIDValue) IsKuzuValue() + func (v InternalIDValue) MarshalJSON() ([]byte, error) + type IntervalLogicalType struct + func (lt *IntervalLogicalType) UnmarshalJSON(data []byte) error + func (lt IntervalLogicalType) IsKuzuLogicalType() + func (lt IntervalLogicalType) MarshalJSON() ([]byte, error) + type IntervalValue time.Duration + func (v *IntervalValue) UnmarshalJSON(data []byte) error + func (v IntervalValue) IsKuzuValue() + func (v IntervalValue) MarshalJSON() ([]byte, error) + type ListLogicalType struct + ChildType LogicalType + func (lt *ListLogicalType) UnmarshalJSON(data []byte) error + func (lt ListLogicalType) IsKuzuLogicalType() + func (lt ListLogicalType) MarshalJSON() ([]byte, error) + type ListValue struct + LogicalType LogicalType + Values []Value + func (v *ListValue) UnmarshalJSON(data []byte) error + func (v ListValue) IsKuzuValue() + func (v ListValue) MarshalJSON() ([]byte, error) + type LogicalType interface + IsKuzuLogicalType func() + type MapLogicalType struct + KeyType LogicalType + ValueType LogicalType + func (lt *MapLogicalType) UnmarshalJSON(data []byte) error + func (lt MapLogicalType) IsKuzuLogicalType() + func (lt MapLogicalType) MarshalJSON() ([]byte, error) + type MapValue struct + KeyType LogicalType + Pairs map[Value]Value + ValueType LogicalType + func (v *MapValue) UnmarshalJSON(data []byte) error + func (v MapValue) IsKuzuValue() + func (v MapValue) MarshalJSON() ([]byte, error) + type NodeLogicalType struct + func (lt *NodeLogicalType) UnmarshalJSON(data []byte) error + func (lt NodeLogicalType) IsKuzuLogicalType() + func (lt NodeLogicalType) MarshalJSON() ([]byte, error) + type NodeValue struct + ID InternalID + Label string + Properties map[string]Value + func (v *NodeValue) UnmarshalJSON(data []byte) error + func (v NodeValue) IsKuzuValue() + func (v NodeValue) MarshalJSON() ([]byte, error) + type NullValue struct + LogicalType LogicalType + func (v *NullValue) UnmarshalJSON(data []byte) error + func (v NullValue) IsKuzuValue() + func (v NullValue) MarshalJSON() ([]byte, error) + type ParameterMap map[string]Value + func (params ParameterMap) AsParameters() (map[string]Value, error) + func (pm *ParameterMap) UnmarshalJSON(data []byte) error + type Parameters interface + AsParameters func() (map[string]Value, error) + type RecursiveRelLogicalType struct + func (lt *RecursiveRelLogicalType) UnmarshalJSON(data []byte) error + func (lt RecursiveRelLogicalType) IsKuzuLogicalType() + func (lt RecursiveRelLogicalType) MarshalJSON() ([]byte, error) + type RecursiveRelValue struct + Nodes []NodeValue + Rels []RelValue + func (v *RecursiveRelValue) UnmarshalJSON(data []byte) error + func (v RecursiveRelValue) IsKuzuValue() + func (v RecursiveRelValue) MarshalJSON() ([]byte, error) + type RelLogicalType struct + func (lt *RelLogicalType) UnmarshalJSON(data []byte) error + func (lt RelLogicalType) IsKuzuLogicalType() + func (lt RelLogicalType) MarshalJSON() ([]byte, error) + type RelValue struct + DstNode InternalID + Label string + Properties map[string]Value + SrcNode InternalID + func (v *RelValue) UnmarshalJSON(data []byte) error + func (v RelValue) IsKuzuValue() + func (v RelValue) MarshalJSON() ([]byte, error) + type SerialLogicalType struct + func (lt *SerialLogicalType) UnmarshalJSON(data []byte) error + func (lt SerialLogicalType) IsKuzuLogicalType() + func (lt SerialLogicalType) MarshalJSON() ([]byte, error) + type StringLogicalType struct + func (lt *StringLogicalType) UnmarshalJSON(data []byte) error + func (lt StringLogicalType) IsKuzuLogicalType() + func (lt StringLogicalType) MarshalJSON() ([]byte, error) + type StringValue string + func (v *StringValue) UnmarshalJSON(data []byte) error + func (v StringValue) IsKuzuValue() + func (v StringValue) MarshalJSON() ([]byte, error) + type StructLogicalType struct + Fields []Twople[string, LogicalType] + func (lt *StructLogicalType) UnmarshalJSON(data []byte) error + func (lt StructLogicalType) IsKuzuLogicalType() + func (lt StructLogicalType) MarshalJSON() ([]byte, error) + type StructValue map[string]Value + func (v *StructValue) UnmarshalJSON(data []byte) error + func (v StructValue) IsKuzuValue() + func (v StructValue) MarshalJSON() ([]byte, error) + type TimestampLogicalType struct + func (lt *TimestampLogicalType) UnmarshalJSON(data []byte) error + func (lt TimestampLogicalType) IsKuzuLogicalType() + func (lt TimestampLogicalType) MarshalJSON() ([]byte, error) + type TimestampMsLogicalType struct + func (lt *TimestampMsLogicalType) UnmarshalJSON(data []byte) error + func (lt TimestampMsLogicalType) IsKuzuLogicalType() + func (lt TimestampMsLogicalType) MarshalJSON() ([]byte, error) + type TimestampMsValue time.Time + func (v *TimestampMsValue) UnmarshalJSON(data []byte) error + func (v TimestampMsValue) IsKuzuValue() + func (v TimestampMsValue) MarshalJSON() ([]byte, error) + type TimestampNsLogicalType struct + func (lt *TimestampNsLogicalType) UnmarshalJSON(data []byte) error + func (lt TimestampNsLogicalType) IsKuzuLogicalType() + func (lt TimestampNsLogicalType) MarshalJSON() ([]byte, error) + type TimestampNsValue time.Time + func (v *TimestampNsValue) UnmarshalJSON(data []byte) error + func (v TimestampNsValue) IsKuzuValue() + func (v TimestampNsValue) MarshalJSON() ([]byte, error) + type TimestampSecLogicalType struct + func (lt *TimestampSecLogicalType) UnmarshalJSON(data []byte) error + func (lt TimestampSecLogicalType) IsKuzuLogicalType() + func (lt TimestampSecLogicalType) MarshalJSON() ([]byte, error) + type TimestampSecValue time.Time + func (v *TimestampSecValue) UnmarshalJSON(data []byte) error + func (v TimestampSecValue) IsKuzuValue() + func (v TimestampSecValue) MarshalJSON() ([]byte, error) + type TimestampTzLogicalType struct + func (lt *TimestampTzLogicalType) UnmarshalJSON(data []byte) error + func (lt TimestampTzLogicalType) IsKuzuLogicalType() + func (lt TimestampTzLogicalType) MarshalJSON() ([]byte, error) + type TimestampTzValue time.Time + func (v *TimestampTzValue) UnmarshalJSON(data []byte) error + func (v TimestampTzValue) IsKuzuValue() + func (v TimestampTzValue) MarshalJSON() ([]byte, error) + type TimestampValue time.Time + func (v *TimestampValue) UnmarshalJSON(data []byte) error + func (v TimestampValue) IsKuzuValue() + func (v TimestampValue) MarshalJSON() ([]byte, error) + type Twople struct + func (tup *Twople[A, B]) UnmarshalJSON(data []byte) error + func (tup Twople[A, B]) MarshalJSON() ([]byte, error) + type UInt16LogicalType struct + func (lt *UInt16LogicalType) UnmarshalJSON(data []byte) error + func (lt UInt16LogicalType) IsKuzuLogicalType() + func (lt UInt16LogicalType) MarshalJSON() ([]byte, error) + type UInt16Value uint16 + func (v *UInt16Value) UnmarshalJSON(data []byte) error + func (v UInt16Value) IsKuzuValue() + func (v UInt16Value) MarshalJSON() ([]byte, error) + type UInt32LogicalType struct + func (lt *UInt32LogicalType) UnmarshalJSON(data []byte) error + func (lt UInt32LogicalType) IsKuzuLogicalType() + func (lt UInt32LogicalType) MarshalJSON() ([]byte, error) + type UInt32Value uint32 + func (v *UInt32Value) UnmarshalJSON(data []byte) error + func (v UInt32Value) IsKuzuValue() + func (v UInt32Value) MarshalJSON() ([]byte, error) + type UInt64LogicalType struct + func (lt *UInt64LogicalType) UnmarshalJSON(data []byte) error + func (lt UInt64LogicalType) IsKuzuLogicalType() + func (lt UInt64LogicalType) MarshalJSON() ([]byte, error) + type UInt64Value uint64 + func (v *UInt64Value) UnmarshalJSON(data []byte) error + func (v UInt64Value) IsKuzuValue() + func (v UInt64Value) MarshalJSON() ([]byte, error) + type UInt8LogicalType struct + func (lt *UInt8LogicalType) UnmarshalJSON(data []byte) error + func (lt UInt8LogicalType) IsKuzuLogicalType() + func (lt UInt8LogicalType) MarshalJSON() ([]byte, error) + type UInt8Value uint8 + func (v *UInt8Value) UnmarshalJSON(data []byte) error + func (v UInt8Value) IsKuzuValue() + func (v UInt8Value) MarshalJSON() ([]byte, error) + type UUIDLogicalType struct + func (lt *UUIDLogicalType) UnmarshalJSON(data []byte) error + func (lt UUIDLogicalType) IsKuzuLogicalType() + func (lt UUIDLogicalType) MarshalJSON() ([]byte, error) + type UUIDValue uuid.UUID + func (v *UUIDValue) UnmarshalJSON(data []byte) error + func (v UUIDValue) IsKuzuValue() + func (v UUIDValue) MarshalJSON() ([]byte, error) + type UnionLogicalType struct + Fields []Twople[string, LogicalType] + func (lt *UnionLogicalType) UnmarshalJSON(data []byte) error + func (lt UnionLogicalType) IsKuzuLogicalType() + func (lt UnionLogicalType) MarshalJSON() ([]byte, error) + type UnionValue struct + Types map[string]LogicalType + Value Value + func (v *UnionValue) UnmarshalJSON(data []byte) error + func (v UnionValue) IsKuzuValue() + func (v UnionValue) MarshalJSON() ([]byte, error) + type Value interface + IsKuzuValue func()