> For the complete documentation index, see [llms.txt](https://clear.gitbook.io/project/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://clear.gitbook.io/project/model/lifecycle/validations.md).

# Validations

Validation offers simple way to disable the updating and creation of invalid models to your database.

## Presence validator

The presence validation ensure than a column is not `NULL` inside the database. While we encourage to use the `NOT NULL` feature of PostgreSQL, the presence validator is automatically setup via the typing of the column:

* `column x : String` is assumed to be present
* `column x : String` can be nilable
* `column x : String, presence: false` will assume the value cannot be NULL in the database, while not performing any validation check. This is great for values which have default database set value (ex: serial, timestamp...)

## Custom validation

To create a custom validator, just override the `validate` method:

```ruby
class Article
  include Clear::Model

  column name : String
  column description : String

  def validate
    if description_column.present?
        if description.size < 100
          add_error("description", "must contains at least 100 characters")
        end
    end
  end
end
```

{% hint style="warning" %}
Ensure to check presence of your column while validation. In case of semi-fetching where the column would not have been fetched from the database or not setup, the validator will raise an exception otherwise.
{% endhint %}

## Helpers methods

To simplify the writing of validation code, you may want to use `on_presence(field, &block)` or `ensure_that(field, message, &block)` built-in helpers:

```ruby
class Article
  include Clear::Model

  column name : String
  column description : String

  def validate
    ensure_that :description, "must contains at least 100 characters", &.size.<(100)
  end
end
```

The code above will perform exactly like the previous one, while keeping a more compact syntax.

## Error object

Whenever a validation check is failing, an error is created and stored in the model. Error is simply a structure with two fields: `column : String?` and `reason : String`

The list of error can be accessed through `errors` method:

```ruby
a = Article.new
a.content = "Lorem ipsum"

unless a.valid?
  a.errors.each do |err|
    puts "Error on column: #{err.column} => #{err.reason}"
  end
end
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://clear.gitbook.io/project/model/lifecycle/validations.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.