The highest tagged major version is v3.

given

package

v2.0.0 Latest Latest Go to latest Published: Sep 17, 2026 License: MIT Imports: 2 Imported by: 0

Details

Package given defines typed TypeQL input rows without a driver or CGo dependency.

This section is empty.

This section is empty.

This section is empty.

type Rows interface {
	MarshalGivenRows() ([]byte, error)
}

Rows supplies typed input rows for a TypeQL given stage.

type TypedRows struct {
	Variables []string  `json:"variables"`
	Rows      [][]Value `json:"rows"`
}

TypedRows contains values ordered by the declared TypeQL variable names.

func NewRows(variables ...string) *TypedRows

NewRows declares the variables shared by every row.

func (r *TypedRows) Add(values ...Value) error

Add appends one row of values in variable order.

func (r *TypedRows) MarshalGivenRows() ([]byte, error)

MarshalGivenRows validates and encodes the rows for the driver.

type Value struct {
	Type  string `json:"type"`
	Value any    `json:"value,omitzero"`
}

Value is a typed value in a TypeQL given row.