README
¶
go-compose-sql
Transform Go structs into simple SQL queries.
This project uses github.com/kisielk/sqlstruct to map struct fields to database columns when executing queries.
Future plans
- Coalesce need a redesign
- Allow configure how the name to table translations (Take in account the posibilityfor define a interface with methods)
Documentation
¶
Index ¶
- func Exec(db *sql.DB, stmt SQLStatement, models ...any) (sql.Result, error)
- func ExecContext(ctx context.Context, db *sql.DB, stmt SQLStatement, models ...any) (sql.Result, error)
- func NewErrInvalidClause(clause string) error
- func NewErrInvalidCoalesceArgs(count int) error
- func NewErrMisplacedClause(clause string) error
- func QueryOne[T any](db *sql.DB, stmt SQLStatement) (T, error)
- func QueryOneContext[T any](ctx context.Context, db *sql.DB, stmt SQLStatement) (T, error)
- type ClauseType
- type ErrInvalidClause
- type ErrInvalidCoalesceArgs
- type ErrMisplacedClause
- type QueryRowIterator
- type SQLStatement
- func (s SQLStatement) Args() []any
- func (s SQLStatement) Asc() SQLStatement
- func (s SQLStatement) Coalesce(values ...any) SQLStatement
- func (s SQLStatement) Desc() SQLStatement
- func (s SQLStatement) Limit(n int) SQLStatement
- func (s SQLStatement) Offset(n int) SQLStatement
- func (s SQLStatement) OrderBy(columns ...string) SQLStatement
- func (s SQLStatement) Returning(columns ...string) SQLStatement
- func (s SQLStatement) Where(expr string, args ...any) SQLStatement
- func (s SQLStatement) Write() (string, error)
- type SqlClause
- type SqlOpts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Exec ¶
Exec executes the INSERT statement against the provided database using context.Background(). It delegates to ExecContext.
func ExecContext ¶
func ExecContext(ctx context.Context, db *sql.DB, stmt SQLStatement, models ...any) (sql.Result, error)
ExecContext executes the INSERT SQLStatement against the provided database using the supplied context. The models' exported fields are mapped to column names in the first clause and passed as arguments to the INSERT statement.
The first clause must be built using Insert[T] so that ModelType and ColumnNames match the fields in the model. ExecContext returns an error if the first clause is not an INSERT clause. It executes the statement once for each provided model and returns the result of the final execution.
func NewErrInvalidClause ¶ added in v0.0.16
NewErrInvalidClause constructs a new ErrInvalidClause for the given clause name.
func NewErrInvalidCoalesceArgs ¶ added in v0.0.19
NewErrInvalidCoalesceArgs constructs a new ErrInvalidCoalesceArgs with the provided argument count.
func NewErrMisplacedClause ¶ added in v0.0.16
NewErrMisplacedClause constructs a new ErrMisplacedClause for the given clause name.
func QueryOne ¶ added in v0.0.15
func QueryOne[T any](db *sql.DB, stmt SQLStatement) (T, error)
QueryOne executes the SELECT SQLStatement against the provided database using context.Background(). It delegates to QueryOneContext.
func QueryOneContext ¶ added in v0.0.15
QueryOneContext executes the SELECT SQLStatement against the provided database using the supplied context and returns exactly one row. If the query returns zero or more than one row, it returns an error.
Types ¶
type ClauseType ¶
type ClauseType string
ClauseType represents a SQL operation like INSERT or UPDATE.
const ( ClauseInsert ClauseType = "INSERT" ClauseSelect ClauseType = "SELECT" ClauseUpdate ClauseType = "UPDATE" ClauseDelete ClauseType = "DELETE" ClauseWhere ClauseType = "WHERE" ClauseOrderBy ClauseType = "ORDER BY" ClauseLimit ClauseType = "LIMIT" ClauseOffset ClauseType = "OFFSET" ClauseCoalesce ClauseType = "COALESCE" ClauseReturning ClauseType = "RETURNING" ClauseDesc ClauseType = "DESC" ClauseAsc ClauseType = "ASC" )
type ErrInvalidClause ¶ added in v0.0.16
type ErrInvalidClause struct {
Clause string
}
ErrInvalidClause is returned when a clause of an unknown type is encountered.
func (*ErrInvalidClause) Error ¶ added in v0.0.16
func (e *ErrInvalidClause) Error() string
type ErrInvalidCoalesceArgs ¶ added in v0.0.19
type ErrInvalidCoalesceArgs struct {
Count int
}
ErrInvalidCoalesceArgs is returned when COALESCE is called with insufficient arguments.
func (*ErrInvalidCoalesceArgs) Error ¶ added in v0.0.19
func (e *ErrInvalidCoalesceArgs) Error() string
type ErrMisplacedClause ¶ added in v0.0.16
type ErrMisplacedClause struct {
Clause string
}
ErrMisplacedClause is returned when a clause is used in an invalid position.
func (*ErrMisplacedClause) Error ¶ added in v0.0.16
func (e *ErrMisplacedClause) Error() string
type QueryRowIterator ¶ added in v0.0.9
type QueryRowIterator[T any] struct { // contains filtered or unexported fields }
QueryRowIterator allows for iterating over the results of a query one by one.
func Query ¶
func Query[T any](db *sql.DB, stmt SQLStatement) (*QueryRowIterator[T], error)
func QueryContext ¶ added in v0.0.5
func QueryContext[T any](ctx context.Context, db *sql.DB, stmt SQLStatement) (*QueryRowIterator[T], error)
QueryContext executes the SELECT SQLStatement against the provided database and returns a QueryRowIterator so the caller can iterate over the results.
func (*QueryRowIterator[T]) Close ¶ added in v0.0.9
func (iter *QueryRowIterator[T]) Close() error
Close closes the iterator, releasing any underlying resources.
func (*QueryRowIterator[T]) Err ¶ added in v0.0.10
func (iter *QueryRowIterator[T]) Err() error
Check if error happen
func (*QueryRowIterator[T]) Next ¶ added in v0.0.9
func (iter *QueryRowIterator[T]) Next() bool
Next prepares the next result row for reading.
func (*QueryRowIterator[T]) Scan ¶ added in v0.0.9
func (iter *QueryRowIterator[T]) Scan(dest *T) error
Scan scans the current row into the given destination.
type SQLStatement ¶ added in v0.0.6
type SQLStatement struct {
Clauses []SqlClause
}
SQLStatement represents a sequence of SQL clauses forming a statement.
func Delete ¶
func Delete[T any](opts *SqlOpts) SQLStatement
Delete builds a DELETE statement for type T.
The table name defaults to the struct type name converted to snake_case when opts.TableName is empty. The reflected type is stored in the resulting clause.
func Insert ¶
func Insert[T any](opts *SqlOpts) SQLStatement
Insert builds an INSERT statement for type T using the provided options.
Fields are mapped to column names using the `db` struct tag; if absent, the field name is converted to snake_case. The table name defaults to the struct type name converted to snake_case when opts.TableName is empty. The reflected type is stored in the resulting clause.
func Select ¶
func Select[T any](opts *SqlOpts) SQLStatement
Select builds a SELECT statement listing all exported fields of type T.
Column names and table name follow the same rules as Insert. The reflected type is stored in the resulting clause.
func (SQLStatement) Args ¶ added in v0.0.6
func (s SQLStatement) Args() []any
Args returns the collected arguments from all clauses in the statement.
func (SQLStatement) Asc ¶ added in v0.0.12
func (s SQLStatement) Asc() SQLStatement
Asc appends an ASC clause ensuring it follows an ORDER BY clause.
func (SQLStatement) Coalesce ¶ added in v0.0.19
func (s SQLStatement) Coalesce(values ...any) SQLStatement
Coalesce appends a COALESCE expression to the SELECT list.
func (SQLStatement) Desc ¶ added in v0.0.12
func (s SQLStatement) Desc() SQLStatement
Desc appends a DESC clause ensuring it follows an ORDER BY clause.
func (SQLStatement) Limit ¶ added in v0.0.12
func (s SQLStatement) Limit(n int) SQLStatement
Limit appends a LIMIT clause to the statement.
func (SQLStatement) Offset ¶ added in v0.0.17
func (s SQLStatement) Offset(n int) SQLStatement
Offset appends an OFFSET clause to the statement.
func (SQLStatement) OrderBy ¶ added in v0.0.12
func (s SQLStatement) OrderBy(columns ...string) SQLStatement
OrderBy appends an ORDER BY clause to the statement.
func (SQLStatement) Returning ¶ added in v0.0.20
func (s SQLStatement) Returning(columns ...string) SQLStatement
Returning appends a RETURNING clause to INSERT, UPDATE, or DELETE statements.
func (SQLStatement) Where ¶ added in v0.0.6
func (s SQLStatement) Where(expr string, args ...any) SQLStatement
Where appends a WHERE clause to the statement.
func (SQLStatement) Write ¶ added in v0.0.6
func (s SQLStatement) Write() (string, error)
Write renders the complete SQL statement by concatenating all clauses.
type SqlClause ¶
type SqlClause struct {
Type ClauseType
TableName string
ColumnNames []string
ModelType reflect.Type
Expr string
Args []any
}
SqlClause represents a SQL statement before rendering.
ModelType retains the generic type used when building the clause so that values can later be mapped to columns when executing the statement.
Source Files