Back to home

Claix Retrieve · Data Map

Data Map: teach your agents what your database means

The Data Map is where Claix learns your database. It lists your tables, says what each one is for and maps how they relate to each other. One click drafts it for you, you review and correct it, and every route and agent builds on it.

Everything in it is a suggestion that you can change. A first draft in one click, and the last word is always yours.

Definition

What is the Data Map?

The Data Map is a description of the part of your database that your agents will work with. It has three parts.

  • Tables. The tables of your database. You choose the ones that will be used.
  • Descriptions. A short description of what each table is for.
  • Relationships. How the tables relate to each other. Claix reads them from your foreign keys and suggests others, and you can edit them, add new ones or delete the ones suggested.

Draft

One click, a first draft

You don't write the Data Map from scratch.

  1. 01

    Connect your database

    Claix knows the structure of your tables through your connection.

  2. 02

    Click to generate

    Claix drafts the Data Map for you.

  3. 03

    See the draft

    Your tables are listed, each with a suggested description, and the relationships between them are shown, including the ones found in your foreign keys and the ones suggested by AI.

  4. 04

    Review it

    Select the tables that will be used, correct any description, and edit, add or delete relationships.

  5. 05

    Use it

    The Data Map stays saved and visible in your dashboard.

Why it matters

Why the Data Map matters

An agent that doesn't understand your data can only guess. The Data Map gives it the two things it needs—and it also matters for you.

  • What each table is

    A description in plain language, so the agent doesn't have to guess from a table name.

  • How tables connect

    The relationships tell the agent how information in one table links to another, which is what a question across several tables needs.

  • You describe your data once

    Every route and every agent uses the same descriptions and relationships.

  • AI helps, you decide

    The AI suggests and you correct, so the map says what you mean.

  • It is visible

    The Data Map is saved in your dashboard, where you can read and change it at any time.

  • Better questions, safer joins

    A good Data Map makes better questions possible. Review the relationships with care: a wrong relationship can lead to a wrong answer without any error.

Stack

How routes use the Data Map

The Data Map is the first step, and routes and agents build on it. When an agent gets a question, it writes its query on the tables of a route, using the descriptions and relationships of the Data Map to understand them.

  1. 01

    Data Map

    Describes your tables and how they relate.

  2. 02

    Routes

    When you create a route, you choose its tables and columns from your tables. They already carry the descriptions and relationships from the Data Map.

  3. 03

    Agents

    Each agent uses the routes attached to it.

Roles

Data Map, route and agent

 Data MapRouteAgent
DescribesYour tables and how they relateWhat can be used for one purpose, and how to read itWho asks, and which routes it can use
You createOnce, with one clickOne for each purposeOne for each job
Used byRoutes and agentsAgentsYour application or AI agent

Example

What a Data Map looks like

This is an example of the information a Data Map holds. It is an illustration, not a customer's database.

TableDescription
customersOne row per customer
ordersOne row per customer order. Cancelled orders stay in this table

Relationships

Relationships in the same map

RelationshipMeaningOrigin
orders.customer_id → customers.idEach order belongs to one customerForeign key
reservations.table_id → tables.idEach reservation uses one tableSuggested by AI, reviewed by you

Descriptions

Writing good descriptions

The AI drafts the descriptions, and you can improve them.

customers — One row per customer
orders — One row per customer order. Cancelled orders stay in this table
  • Say what a row of the table represents.
  • Use the words your business uses.
  • Mention anything that is not obvious, for example that cancelled orders stay in the table.
  • Keep it short. One or two sentences are enough.

Limits

Good to know

  • Only the tables you include are used. You choose them in the Data Map.
  • The Data Map describes your data. It doesn't open access to it. What Claix can read is decided by the database role you connect with and by your routes. Use a read-only role.
  • Suggestions can be wrong. Review the descriptions and, above all, the relationships suggested by AI.
  • You can change it at any time. Edit descriptions, add relationships or delete the ones you don't want.

Frequently asked questions

What is the Data Map in Claix?
A description of your database: the tables you choose, what each one is for and how they relate to each other. Your routes and agents build on it.
Do I have to write it by hand?
No. With one click, Claix drafts it, and you review it and change what you want.
What does Claix suggest?
A description for each table and the relationships between them. It reads relationships from your foreign keys, and AI suggests others.
Can I change what the AI suggests?
Yes. You can edit the descriptions, edit relationships, add new ones and delete the ones suggested by AI.
Why do I need a Data Map before creating routes?
Because routes use your tables, and those tables already carry their descriptions and relationships from the Data Map.
My database has no foreign keys. Can I still use the Data Map?
Yes. You can add relationships yourself, and AI can suggest others.
Does the Data Map give agents access to my tables?
No. Agents can only use what your routes include, and Claix can only read what your database role allows.

Generate your Data Map

Connect your database, click, and review the first draft. Then create routes and agents on top of descriptions and relationships you trust.