backend

Documentation

Index

• type Column
• type QueryResult
• type Row
• type SimpleSQLClient
  • func NewSqlClient(ctx context.Context, tx *sql.Tx) SimpleSQLClient
• type SimpleSqlClientMock
  • func CreateSimpleSqlClientMock() *SimpleSqlClientMock
  • func (mock *SimpleSqlClientMock) Execute(query string, args ...any) (sql.Result, error)
  • func (mock *SimpleSqlClientMock) Query(query string, args ...any) (*QueryResult, error)
  • func (mock *SimpleSqlClientMock) SimulateExecuteError(err error, query string, args ...any)
  • func (mock *SimpleSqlClientMock) SimulateExecuteSuccess(query string, args ...any)
  • func (mock *SimpleSqlClientMock) SimulateQueryError(err error, query string, args ...any)
  • func (mock *SimpleSqlClientMock) SimulateQuerySuccess(result *QueryResult, query string, args ...any)

Types

type Column

type Column struct {
	Name     string `json:"name"`     // Column name
	TypeName string `json:"typeName"` // Column type
}

Column definition of a query result.

type QueryResult

type QueryResult struct {
	Columns []Column `json:"columns"` // Column definitions of the query result
	Rows    []Row    `json:"rows"`    // The result rows
}

Result of a database query.

type Row

type Row []any

Row of a database query result.

type SimpleSQLClient

type SimpleSQLClient interface {
	// Execute runs a query that does not return rows, e.g. INSERT or UPDATE.
	Execute(query string, args ...any) (sql.Result, error)

	// Query runs a query that returns rows, typically a SELECT.
	Query(query string, args ...any) (*QueryResult, error)
}

SimpleSQLClient allows extensions to execute statements and queries against the database.

func NewSqlClient

func NewSqlClient(ctx context.Context, tx *sql.Tx) SimpleSQLClient

NewSqlClient creates a new SimpleSQLClient.

type SimpleSqlClientMock

type SimpleSqlClientMock struct {
	mock.Mock
}

func CreateSimpleSqlClientMock

func CreateSimpleSqlClientMock() *SimpleSqlClientMock

func (*SimpleSqlClientMock) Execute

func (mock *SimpleSqlClientMock) Execute(query string, args ...any) (sql.Result, error)

func (*SimpleSqlClientMock) Query

func (mock *SimpleSqlClientMock) Query(query string, args ...any) (*QueryResult, error)

func (*SimpleSqlClientMock) SimulateExecuteError

func (mock *SimpleSqlClientMock) SimulateExecuteError(err error, query string, args ...any)

func (*SimpleSqlClientMock) SimulateExecuteSuccess

func (mock *SimpleSqlClientMock) SimulateExecuteSuccess(query string, args ...any)

func (*SimpleSqlClientMock) SimulateQueryError

func (mock *SimpleSqlClientMock) SimulateQueryError(err error, query string, args ...any)

func (*SimpleSqlClientMock) SimulateQuerySuccess

func (mock *SimpleSqlClientMock) SimulateQuerySuccess(result *QueryResult, query string, args ...any)