> 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/column-types/primary-keys.md).

# Primary Keys

Clear needs your model to define a primary key column. By default, Clear can handle properly `int`, `bigint`, `string` and `uuid` primary keys.

{% hint style="warning" %}
As time of writing this manual, compound primary keys are not handled properly.
{% endhint %}

## `primary_key` helper

Clear offers a built-in `primary_key` helper which will define your primary key without hassle:

```ruby
class Product
  include Clear::Model

  self.table = "products"

  primary_key name: "product_id", type: :uuid
end
```

* `name` is the name of your column in your table. (Default: `id`)
* `type` is the type of the column in your table. Set to (Default: `bigserial`).
* By default, types can be of type `bigserial`, `serial`, `int`, `bigint`, `text` and `uuid`.

Note than primary\_key directive in the model class is just a fast way of writing:

```ruby
column id : Int64, primary: true, presence: false
```

The primary key name is ID, of type bigint and it won't check the presence on save because it has default value

{% hint style="info" %}
In case of `uuid`, Clear will generate a new `uuid` at every new object creation before inserting it into the database.
{% endhint %}


---

# 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/column-types/primary-keys.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.