sql

Documentation

Index

• type SQL
  • func Init(dbType utils.DBType, connection string) (*SQL, error)
  • func (s *SQL) Aggregate(ctx context.Context, project, col string, req *model.AggregateRequest) (interface{}, error)
  • func (s *SQL) Batch(ctx context.Context, project string, txRequest *model.BatchRequest) error
  • func (s *SQL) Close() error
  • func (s *SQL) Create(ctx context.Context, project, col string, req *model.CreateRequest) error
  • func (s *SQL) Delete(ctx context.Context, project, col string, req *model.DeleteRequest) error
  • func (s *SQL) GetDBType() utils.DBType
  • func (s *SQL) Read(ctx context.Context, project, col string, req *model.ReadRequest) (interface{}, error)
  • func (s *SQL) Update(ctx context.Context, project, col string, req *model.UpdateRequest) error

Types

type SQL

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

SQL holds the sql db object

func Init

func Init(dbType utils.DBType, connection string) (*SQL, error)

Init initialises a new sql instance

func (*SQL) Aggregate

func (s *SQL) Aggregate(ctx context.Context, project, col string, req *model.AggregateRequest) (interface{}, error)

Aggregate performs a mongo db pipeline aggregation

func (*SQL) Batch

func (s *SQL) Batch(ctx context.Context, project string, txRequest *model.BatchRequest) error

Batch performs the provided operations in a single Batch

func (*SQL) Close

func (s *SQL) Close() error

Close gracefully the SQL client

func (*SQL) Create

func (s *SQL) Create(ctx context.Context, project, col string, req *model.CreateRequest) error

Create inserts a document (or multiple when op is "all") into the database

func (*SQL) Delete

func (s *SQL) Delete(ctx context.Context, project, col string, req *model.DeleteRequest) error

Delete removes the document(s) from the database which match the condition

func (*SQL) GetDBType

func (s *SQL) GetDBType() utils.DBType

GetDBType returns the dbType of the crud block

func (*SQL) Read

func (s *SQL) Read(ctx context.Context, project, col string, req *model.ReadRequest) (interface{}, error)

Read query document(s) from the database

func (*SQL) Update

func (s *SQL) Update(ctx context.Context, project, col string, req *model.UpdateRequest) error

Update updates the document(s) which match the condition provided.