> For the complete documentation index, see [llms.txt](https://jls-organization-3.gitbook.io/projecthyper/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jls-organization-3.gitbook.io/projecthyper/features/quickstart/relationships.md).
# Relationships
Relationships are the connections between different tables in a database. These relationships allow you to efficiently store and retrieve related data. PHP is often used to interact with MySQL databases and manage these relationships.
**Common Types of Relationships**
1. **One-to-One:**
* A single record in one table corresponds to exactly one record in another table.
* **Example:** A `users` table and a `profile` table, where each user has one profile.
2. **One-to-Many:**
* A single record in one table can be associated with multiple records in another table.
* **Example:** An `authors` table and a `books` table, where one author can write many books.
3. **Many-to-Many:**
* Multiple records in one table can be associated with multiple records in another table.
* **Example:** A `students` table and a `courses` table, where one student can take many courses, and one course can be taken by many students.
**Example:**
For example, we have 3 tables
| Table | Fields |
|---|
| news | id, name, status |
| news_details | id, news_id, content |
| news_attachments | id, news_details_id, url |
Each table is referenced to another table where news -> news\_details -> news\_attachments.
**Usage:**
$news = $db->news->findOne(1);
// This only returns
{
"id": "1",
"name": "Test News",
"status": "ACTIVE",
"created_at": "2024-11-03 21:07:37",
"updated_at": null,
"deleted_at": null
}
However, if we transform the options into
```php
$news = $db->news->findOne(
array(
'where' => array('id' => 1),
'include' => array('news_details' => true)
)
);
// This will return the news and the news_details
{
"id": "1",
"name": "Test News",
"status": "ACTIVE",
"created_at": "2024-11-03 21:07:37",
"updated_at": null,
"deleted_at": null,
"news_details": [....]
}
```
What if the requirement is to return only a single record? Just pass `single` attribute to the object
```php
$news = $db->news->findOne(
array(
'where' => array('id' => 1),
'include' => array(
'news_details' => array(
'single' => true // ADD THIS
)
)
)
);
// This will return the news and the news_details (1 row)
{
"id": "1",
"name": "Test News",
"status": "ACTIVE",
"created_at": "2024-11-03 21:07:37",
"updated_at": null,
"deleted_at": null,
"news_details": {
"id": "1",
"news_id": "1",
"content": "Test",
"created_at": "2024-11-03 21:07:37",
"updated_at": null,
"deleted_at": null,
}
}
```
{% hint style="info" %}
The include option can also be added inside the relation to create a hierarchy of data
{% endhint %}
```php
$news = $db->news->findOne(
array(
'where' => array('id' => 1),
'include' => array(
'news_details' => array(
'single' => true,
'include' => array(
'news_attachments' => true
)
)
)
)
);
// This will return the news and the news_details (1 row) and attachments
{
"id": "1",
"name": "Test News",
"status": "ACTIVE",
"created_at": "2024-11-03 21:07:37",
"updated_at": null,
"deleted_at": null,
"news_details": {
"id": "1",
"news_id": "1",
"content": "Test",
"created_at": "2024-11-03 21:07:37",
"updated_at": null,
"deleted_at": null,
"news_attachments": [...]
}
}
```
The `include` method is flexible as well to the `where`, `order`, `group` , `limit`, `offset` etc.
$condition = array(
'where' => array('id' => 1),
'include' => array(
'news_details' => array(
'single' => true,
'where' => array(
'created_at' => array(
'between' => array('2024-01-01', '2025-01-01')
)
),
'include' => array(
'news_attachments' => array(
'order' => array(
'created_at' => 'DESC'
),
'where' => array(
'url' => array('not_null' => true)
),
'limit' => 10,
'offset' => 0
),
)
)
)
);
$news = $db->news->find($condition);
---
# 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://jls-organization-3.gitbook.io/projecthyper/features/quickstart/relationships.md?ask=&goal=
```
`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.