nosql

Documentation

Index

• func IdOf(resource string, id uuid.UUID) string
• func Module() module.Module
• type Client
  • func NewClient(cfg *SurrealDBConfig) (*Client, error)
  • func (c *Client) Create(ctx context.Context, id string, data any) (any, error)
  • func (c *Client) OnStart(context.Context) error
  • func (c *Client) OnStop(context.Context) error
• type Entity
  • func EntityById[T any](resource string, id uuid.UUID, value T) Entity[T]
  • func (e *Entity[T]) Load(client *Client) error
  • func (e *Entity[T]) Save(client *Client) error
• type IEntity
• type SurrealDBConfig
  • func ConfigFromUrl(uri url.URL) (*SurrealDBConfig, error)
  • func (s SurrealDBConfig) ConnectionURI() string

Functions

func IdOf

func IdOf(resource string, id uuid.UUID) string

func Module

func Module() module.Module

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg *SurrealDBConfig) (*Client, error)

func (*Client) Create

func (c *Client) Create(ctx context.Context, id string, data any) (any, error)

func (*Client) OnStart

func (c *Client) OnStart(context.Context) error

func (*Client) OnStop

func (c *Client) OnStop(context.Context) error

type Entity

type Entity[T any] struct {
	Id    string `json:"id"`
	Value *T     `json:"value"`
	// contains filtered or unexported fields
}

func EntityById

func EntityById[T any](resource string, id uuid.UUID, value T) Entity[T]

func (*Entity[T]) Load

func (e *Entity[T]) Load(client *Client) error

func (*Entity[T]) Save

func (e *Entity[T]) Save(client *Client) error

type IEntity

type IEntity[T any] interface {
	AsEntity() Entity[T]
}

type SurrealDBConfig

type SurrealDBConfig struct {
	Username  string
	Password  string
	Host      string
	Port      uint16
	Secure    bool
	Namespace string
	Database  string
}

func ConfigFromUrl

func ConfigFromUrl(uri url.URL) (*SurrealDBConfig, error)

func (SurrealDBConfig) ConnectionURI

func (s SurrealDBConfig) ConnectionURI() string