# 5. Full-text search

Source: https://docs.anetos.dev/main/getting-started/tutorial/05-search/

You add a search box that finds issues by the words in their title and
description, best matches first, from a full-text index in the database.

## The index

```sh
go tool anetos make:migration add_search_to_issues_table
```

Fill in its two functions:

```go
func(s *migrate.Schema) error {
	return s.Alter("issues", func(t *migrate.Table) {
		t.SearchIndex("title", "body") // titles weigh more
	})
},
func(s *migrate.Schema) error {
	return s.Alter("issues", func(t *migrate.Table) {
		t.DropSearchIndex()
	})
},
```

(Copied from [`examples/tutorial/database/migrations/2026_10_06_142847_add_search_to_issues_table.go`](https://github.com/anetos-dev/anetos/blob/main/examples/tutorial/database/migrations/2026_10_06_142847_add_search_to_issues_table.go), region `migration`.)

```sh
go run . migrate
```

`SearchIndex` builds what each database has: an FTS5 table on SQLite, a
`tsvector` column on PostgreSQL, a `FULLTEXT` index on MySQL. The index
follows the table's changes by itself.

## The page

Create `app/handlers/search.go`, in package `handlers`:

```go
import (
	"anetos.dev/anetos/db"
	"anetos.dev/anetos/web"

	"tracker/app/models"
	"tracker/views"
)
```

(Copied from [`examples/tutorial/app/handlers/search.go`](https://github.com/anetos-dev/anetos/blob/main/examples/tutorial/app/handlers/search.go), region `imports`.)

```go
// SearchInput is the search box: GET /search?q=words.
type SearchInput struct {
	Q string `query:"q" validate:"max:200"`
}

// Search finds the issues whose title or description has the words,
// best matches first.
func (Issues) Search(c *web.Ctx, in SearchInput) (web.Responder, error) {
	var found []models.Issue
	if in.Q != "" {
		var err error
		found, err = db.Query[models.Issue](c).With(models.IssueRels.Author).Search(in.Q).Limit(50).Get()
		if err != nil {
			return nil, err
		}
	}
	return web.Render(views.SearchPage(in.Q, found)), nil
}
```

(Copied from [`examples/tutorial/app/handlers/search.go`](https://github.com/anetos-dev/anetos/blob/main/examples/tutorial/app/handlers/search.go), region `search`.)

`Search` keeps the rows that have every word (as a word or the start of
one: `pay` finds `payment`), and orders them by how well they match.

And `views/search.templ`, in package `views`:

```templ
import (
	"fmt"

	"anetos.dev/anetos/web"

	"tracker/app/models"
	"tracker/views/ui"
)
```

(Copied from [`examples/tutorial/views/search.templ`](https://github.com/anetos-dev/anetos/blob/main/examples/tutorial/views/search.templ), region `imports`.)

```templ
// SearchPage shows the issues that match q.
templ SearchPage(q string, found []models.Issue) {
	@Layout("Search") {
		<h1>Search</h1>
		@ui.Form(web.MustURL(ctx, "search"), "GET", templ.Attributes{"role": "search"}) {
			@ui.Cluster() {
				@ui.Input("q", "search", q, templ.Attributes{"aria-label": "Search issues"})
				@ui.Button(ui.Primary, nil) {
					Search
				}
			}
		}
		if q != "" && len(found) == 0 {
			@ui.Empty("No issues match “" + q + "”.")
		}
		if len(found) > 0 {
			@ui.Table() {
				<tbody>
					for _, issue := range found {
						<tr>
							<td>
								@statusBadge(issue.Status)
							</td>
							<td><a href={ templ.URL(fmt.Sprintf("/issues/%d", issue.ID)) }>{ issue.Title }</a></td>
							<td><small>#{ issue.ID } by { issue.Author.Name }</small></td>
						</tr>
					}
				</tbody>
			}
		}
	}
}
```

(Copied from [`examples/tutorial/views/search.templ`](https://github.com/anetos-dev/anetos/blob/main/examples/tutorial/views/search.templ), region `page`.)

The route, in `routes/auth.go` below the others:

```go
loggedIn.Get("/search", web.H(issues.Search)).Name("search")
```

(Copied from [`examples/tutorial/routes/auth.go`](https://github.com/anetos-dev/anetos/blob/main/examples/tutorial/routes/auth.go), region `routes-search`.)

Last, a search box on every page. In `views/layout.templ`, add it to
the header, below the `@ui.Nav` block (before `@AccountMenu()`):

```templ
<form method="get" action={ web.URL(ctx, "search") } role="search">
	<input type="search" name="q" placeholder="Search issues" aria-label="Search issues"/>
</form>
```

(Copied from [`examples/tutorial/views/layout.templ`](https://github.com/anetos-dev/anetos/blob/main/examples/tutorial/views/layout.templ), region `nav-search`.)

## Test it

`search_test.go`, in package `main`:

```go
import (
	"testing"

	"anetos.dev/anetos/anetostest"

	"tracker/app/models"
	"tracker/database/factories"
)
```

(Copied from [`examples/tutorial/search_test.go`](https://github.com/anetos-dev/anetos/blob/main/examples/tutorial/search_test.go), region `imports`.)

```go
func TestSearch(t *testing.T) {
	app := anetostest.New(t, setup)
	ada := anetostest.Create(app, factories.Users)
	issues := factories.Issues.With(func(i *models.Issue) { i.AuthorID = ada.ID })
	anetostest.Create(app, issues.With(func(i *models.Issue) { i.Title, i.Body = "Checkout fails", "The payment form spins." }))
	anetostest.Create(app, issues.With(func(i *models.Issue) { i.Title = "Typo in the footer" }))
	anetostest.ActingAs(app, &ada)

	app.Get("/search?q=payment").AssertOK().AssertSee("Checkout fails").AssertDontSee("Typo in the footer")
	app.Get("/search?q=zebra").AssertSee("No issues match “zebra”.")
}
```

(Copied from [`examples/tutorial/search_test.go`](https://github.com/anetos-dev/anetos/blob/main/examples/tutorial/search_test.go), region `test`.)

> **Note:** On MySQL and MariaDB, full-text indexes only see committed
> rows, and each test runs in a transaction: a search test there needs
> `anetostest.WithoutTransaction()`. The tutorial's SQLite has no such
> limit.

The [search guide](https://docs.anetos.dev/main/guides/search/index.md) covers languages, ranking and
the other databases.

Next: [6. Email the author](https://docs.anetos.dev/main/getting-started/tutorial/06-email-the-author.md).
