Light
Dark
System
1.0latest

Datatypes

Duration represents the elapsed time between two instants as an int64 microsecond count.

Copy
type Duration int64
Copy
func ParseDuration(s string) (Duration, error)

ParseDuration parses an EdgeDB duration string.

Copy
func (d Duration) String() string

LocalDate is a date without a time zone. https://www.edgedb.com/docs/stdlib/datetime#type::cal::local_date

Copy
type LocalDate struct {
    // contains filtered or unexported fields
}
Copy
func NewLocalDate(year int, month time.Month, day int) LocalDate

NewLocalDate returns a new LocalDate

Copy
func (d LocalDate) MarshalText() ([]byte, error)

MarshalText returns d marshaled as text.

Copy
func (d LocalDate) String() string
Copy
func (d *LocalDate) UnmarshalText(b []byte) error

UnmarshalText unmarshals bytes into *d.

LocalDateTime is a date and time without timezone. https://www.edgedb.com/docs/stdlib/datetime#type::cal::local_datetime

Copy
type LocalDateTime struct {
    // contains filtered or unexported fields
}
Copy
func NewLocalDateTime(
    year int, month time.Month, day, hour, minute, second, microsecond int,
) LocalDateTime

NewLocalDateTime returns a new LocalDateTime

Copy
func (dt LocalDateTime) MarshalText() ([]byte, error)

MarshalText returns dt marshaled as text.

Copy
func (dt LocalDateTime) String() string
Copy
func (dt *LocalDateTime) UnmarshalText(b []byte) error

UnmarshalText unmarshals bytes into *dt.

LocalTime is a time without a time zone. https://www.edgedb.com/docs/stdlib/datetime#type::cal::local_time

Copy
type LocalTime struct {
    // contains filtered or unexported fields
}
Copy
func NewLocalTime(hour, minute, second, microsecond int) LocalTime

NewLocalTime returns a new LocalTime

Copy
func (t LocalTime) MarshalText() ([]byte, error)

MarshalText returns t marshaled as text.

Copy
func (t LocalTime) String() string
Copy
func (t *LocalTime) UnmarshalText(b []byte) error

UnmarshalText unmarshals bytes into *t.

Memory represents memory in bytes.

Copy
type Memory int64
Copy
func (m Memory) MarshalText() ([]byte, error)

MarshalText returns m marshaled as text.

Copy
func (m Memory) String() string
Copy
func (m *Memory) UnmarshalText(b []byte) error

UnmarshalText unmarshals bytes into *m.

Optional represents a shape field that is not required.

Copy
type Optional struct {
    // contains filtered or unexported fields
}
Copy
func (o *Optional) Missing() bool

Missing returns true if the value is missing.

Copy
func (o *Optional) SetMissing(missing bool)

SetMissing sets the structs missing status. true means missing and false means present.

Copy
func (o *Optional) Unset()

Unset marks the value as missing

OptionalBigInt is an optional *big.Int. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalBigInt struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalBigInt) Get() (*big.Int, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalBigInt) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalBigInt) Set(val *big.Int)

Set sets the value.

Copy
func (o *OptionalBigInt) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalBigInt) Unset()

Unset marks the value as missing.

OptionalBool is an optional bool. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalBool struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalBool) Get() (bool, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalBool) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalBool) Set(val bool)

Set sets the value.

Copy
func (o *OptionalBool) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalBool) Unset()

Unset marks the value as missing.

OptionalBytes is an optional []byte. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalBytes struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalBytes) Get() ([]byte, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalBytes) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalBytes) Set(val []byte)

Set sets the value.

Copy
func (o *OptionalBytes) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalBytes) Unset()

Unset marks the value as missing.

OptionalDateTime is an optional time.Time. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalDateTime struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalDateTime) Get() (time.Time, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalDateTime) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalDateTime) Set(val time.Time)

Set sets the value.

Copy
func (o *OptionalDateTime) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalDateTime) Unset()

Unset marks the value as missing.

OptionalDuration is an optional Duration. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalDuration struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalDuration) Get() (Duration, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalDuration) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalDuration) Set(val Duration)

Set sets the value.

Copy
func (o *OptionalDuration) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalDuration) Unset()

Unset marks the value as missing.

OptionalFloat32 is an optional float32. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalFloat32 struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalFloat32) Get() (float32, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalFloat32) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalFloat32) Set(val float32)

Set sets the value.

Copy
func (o *OptionalFloat32) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalFloat32) Unset()

Unset marks the value as missing.

OptionalFloat64 is an optional float64. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalFloat64 struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalFloat64) Get() (float64, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalFloat64) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalFloat64) Set(val float64)

Set sets the value.

Copy
func (o *OptionalFloat64) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalFloat64) Unset()

Unset marks the value as missing.

OptionalInt16 is an optional int16. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalInt16 struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalInt16) Get() (int16, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalInt16) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalInt16) Set(val int16)

Set sets the value.

Copy
func (o *OptionalInt16) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalInt16) Unset()

Unset marks the value as missing.

OptionalInt32 is an optional int32. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalInt32 struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalInt32) Get() (int32, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalInt32) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalInt32) Set(val int32)

Set sets the value.

Copy
func (o *OptionalInt32) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalInt32) Unset()

Unset marks the value as missing.

OptionalInt64 is an optional int64. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalInt64 struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalInt64) Get() (int64, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalInt64) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalInt64) Set(val int64) *OptionalInt64

Set sets the value.

Copy
func (o *OptionalInt64) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalInt64) Unset() *OptionalInt64

Unset marks the value as missing.

OptionalLocalDate is an optional LocalDate. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalLocalDate struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalLocalDate) Get() (LocalDate, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalLocalDate) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalLocalDate) Set(val LocalDate)

Set sets the value.

Copy
func (o *OptionalLocalDate) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalLocalDate) Unset()

Unset marks the value as missing.

OptionalLocalDateTime is an optional LocalDateTime. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalLocalDateTime struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalLocalDateTime) Get() (LocalDateTime, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalLocalDateTime) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalLocalDateTime) Set(val LocalDateTime)

Set sets the value.

Copy
func (o *OptionalLocalDateTime) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalLocalDateTime) Unset()

Unset marks the value as missing.

OptionalLocalTime is an optional LocalTime. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalLocalTime struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalLocalTime) Get() (LocalTime, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalLocalTime) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalLocalTime) Set(val LocalTime)

Set sets the value.

Copy
func (o *OptionalLocalTime) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalLocalTime) Unset()

Unset marks the value as missing.

OptionalMemory is an optional Memory. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalMemory struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalMemory) Get() (Memory, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalMemory) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalMemory) Set(val Memory)

Set sets the value.

Copy
func (o *OptionalMemory) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalMemory) Unset()

Unset marks the value as missing.

OptionalRelativeDuration is an optional RelativeDuration. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalRelativeDuration struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalRelativeDuration) Get() (RelativeDuration, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalRelativeDuration) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalRelativeDuration) Set(val RelativeDuration)

Set sets the value.

Copy
func (o *OptionalRelativeDuration) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalRelativeDuration) Unset()

Unset marks the value as missing.

OptionalStr is an optional string. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalStr struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalStr) Get() (string, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalStr) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalStr) Set(val string)

Set sets the value.

Copy
func (o *OptionalStr) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o.

Copy
func (o *OptionalStr) Unset()

Unset marks the value as missing.

OptionalUUID is an optional UUID. Optional types must be used for out parameters when a shape field is not required.

Copy
type OptionalUUID struct {
    // contains filtered or unexported fields
}
Copy
func (o *OptionalUUID) Get() (UUID, bool)

Get returns the value and a boolean indicating if the value is present.

Copy
func (o OptionalUUID) MarshalJSON() ([]byte, error)

MarshalJSON returns o marshaled as json.

Copy
func (o *OptionalUUID) Set(val UUID)

Set sets the value.

Copy
func (o *OptionalUUID) UnmarshalJSON(bytes []byte) error

UnmarshalJSON unmarshals bytes into *o

Copy
func (o *OptionalUUID) Unset()

Unset marks the value as missing.

RelativeDuration represents the elapsed time between two instants in a fuzzy human way.

Copy
type RelativeDuration struct {
    // contains filtered or unexported fields
}
Copy
func NewRelativeDuration(
    months, days int32,
    microseconds int64,
) RelativeDuration

NewRelativeDuration returns a new RelativeDuration

Copy
func (rd RelativeDuration) MarshalText() ([]byte, error)

MarshalText returns rd marshaled as text.

Copy
func (rd RelativeDuration) String() string
Copy
func (rd *RelativeDuration) UnmarshalText(b []byte) error

UnmarshalText unmarshals bytes into *rd.

UUID a universally unique identifier https://www.edgedb.com/docs/stdlib/uuid

Copy
type UUID [16]byte
Copy
func ParseUUID(s string) (UUID, error)

ParseUUID parses s into a UUID or returns an error.

Copy
func (id UUID) MarshalText() ([]byte, error)

MarshalText returns the id as a byte string.

Copy
func (id UUID) String() string
Copy
func (id *UUID) UnmarshalText(b []byte) error

UnmarshalText unmarshals the id from a string.

Light
Dark
System