api

Documentation

Index

• type API
  • func New(logger logger.Logger, config *frames.Config) (*API, error)
  • func (api *API) Create(request *frames.CreateRequest) error
  • func (api *API) Delete(request *frames.DeleteRequest) error
  • func (api *API) Exec(request *frames.ExecRequest) (frames.Frame, error)
  • func (api *API) Read(request *frames.ReadRequest, out chan frames.Frame) error
  • func (api *API) Write(request *frames.WriteRequest, in chan frames.Frame) (int, int, error)

Types

type API

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

API layer, implements common CRUD operations TODO: Call it DAL? (data access layer)

func New

func New(logger logger.Logger, config *frames.Config) (*API, error)

New returns a new API layer struct

func (*API) Create

func (api *API) Create(request *frames.CreateRequest) error

Create will create a new table

func (*API) Delete

func (api *API) Delete(request *frames.DeleteRequest) error

Delete deletes a table or part of it

func (*API) Exec

func (api *API) Exec(request *frames.ExecRequest) (frames.Frame, error)

Exec executes a command on the backend

func (*API) Read

func (api *API) Read(request *frames.ReadRequest, out chan frames.Frame) error

Read reads from database, emitting results to wf

func (*API) Write

func (api *API) Write(request *frames.WriteRequest, in chan frames.Frame) (int, int, error)

Write write data to backend, returns num_frames, num_rows, error