Query builder

Table of contents

1. Query builder
   1. Introduction
   2. Running queries
   3. Available clauses
   4. Safety

Introduction

The database query builder provides a convenient, fluent interface for running queries against tables that have no model. It is the Go counterpart of Laravel’s DB::table() and Knex. Rows come back as map[string]any. Builders are mutable: each method changes and returns the same *Builder.

Running queries

users := func() *query.Builder { return query.Table(db, "users") }

rows, err := users().Where("age > ?", 18).OrderBy("name", "asc").Limit(20).Get(ctx) // []map[string]any
row, err := users().Where("id = ?", 1).First(ctx)       // errors.Is(err, migro.ErrNotFound) if missing
n, err := users().WhereIn("id", []int{1, 2, 3}).Count(ctx)
err = users().Insert(ctx, query.Row{"name": "Ada"}, query.Row{"name": "Alan"})
affected, err := users().Where("id = ?", 1).Update(ctx, query.Row{"name": "Ada L"})
affected, err = users().Where("id = ?", 2).Delete(ctx)
page, err := users().OrderBy("id", "asc").Paginate(ctx, 1, 25) // Data, Total, PerPage, CurrentPage, LastPage

Available clauses

Also available: Select, OrWhere, Not, WhereNull, WhereNotNull, WhereBetween, Join("JOIN posts ON …"), GroupBy, Having, Offset, Pluck.

Safety

Values are always bound as parameters. Update and Delete without a Where return an error rather than touching every row. OrderBy only accepts asc or desc.