Katrina ORM

Version

Katrina ORM is currently at version 2.x. To read documentation for previous versions choose one of the links below.

1.x

Getting Started

Katrina ORM is a component that brings the object-oriented application development paradigm closer to the relational database paradigm. It helps to carry out common routines, such as the famous CRUD (create, read, edit and delete), in addition to having a data paging system.

Katrina ORM uses the Active Record standard to manipulate the data in the database.

Requirements

  • PHP >= 8.3
  • PDO extension enabled

Installation

Katrina ORM is already installed by default in Solital. But if you are going to install in another project, use the command below to download via Composer.

composer require solital/katrina

Settings

In Solital:

# DATABASE CONFIG
DB_DRIVE=your_drive
DB_HOST=your_host
DB_NAME=your_database_name
DB_USER=your_user
DB_PASS=your_password

In another project:

define('DB_CONFIG', [
    'DRIVE' => 'your_drive',
    'HOST' => 'your_host',
    'DBNAME' => 'your_database_name',
    'USER' => 'your_user',
    'PASS' => 'your_password'
]);

For SQLite

Some differences exist for connecting to an SQLite database. First, add an additional index called SQLITE_DIR in the DB_CONFIG constant. This constant must have the absolute path where the SQLite database file will be located.

Then, assign the value sqlite in the index DRIVE.

define('DB_CONFIG', [
    'DRIVE' => 'sqlite',
    'DBNAME' => 'your_database_name.db',
    'SQLITE_DIR' => '/path/to/file/'
]);

In Solital:

# DATABASE CONFIG
DB_DRIVE=your_drive
DB_HOST=your_host
DB_NAME=your_database_name
DB_USER=your_user
DB_PASS=your_password
SQLITE_DIR=/path/to/file/

Initial structure

To initialize the Katrina ORM in your Model, just extend the Katrina class.

<?php

namespace Solital\Components\Model;
use Katrina\Katrina;

class User extends Katrina
{
}

Changing default fields

By default, your class table name is the class name itself, and the primary key name is id.

You can change these settings using the $table and $id properties.

<?php

namespace Solital\Components\Model;
use Katrina\Katrina;

class User extends Katrina
{
    /**
     *  @var null|string 
     */
    protected ?string $table = "tb_user";

    /**
     *  @var null|string 
     */
    protected ?string $id = "id_user";
}

Listing values from a table

SELECT query

To list all fields in the table, use all() as shown in the previous example.

User::all();

FIND

To list a single value, use find() method;

User::find(2);

Users::findFirst(); // Returns the first value in the table

Or, use the select method:

/** 
 * Fetch all
 */
User::select()->get();

/** 
 * Fetch only
 */
User::select()->where('id', 2)->getUnique();

/** 
 * Fetch all with column name
 */
User::select("name")->get();

If you need to raise an exception if no value is returned, use the findwithException method.

User::findwithException(2);

LATEST

You can return the latest values from the database in descending order using the latest method:

User::latest()->get();

By default, the latest method will sort using the created_at column. If this column does not exist in your table, you can pass the name of another column as a parameter.

User::latest('users')->get();

WHERE

The WHERE clause is used to filter records.

It is used to extract only those records that fulfill a specified condition.

/** 
 * Katrina will look for a record that has `foo` in the table.
*/
User::select()->where("name", "foo")->get();

/** 
 * Katrina will look for a record whose age is greater than 10.
*/
User::select()->where("age", 10, ">")->get();

/** 
 * Katrina will look for a record that is under the age of 10.
*/
User::select()->where("age", 10, "<")->get();

To save time and avoid using the and method, you can pass an array as a parameter in the where method with multiple conditions.

User::select()->where([
  'name', 'foo',
  'age', 10
])->get();

AND

The AND operator displays a record if all the conditions separated by AND are TRUE.

User::select()->where("brand", 'visa')->and("cvv", '502')->get();

OR

The OR operator displays a record if any of the conditions separated by OR is TRUE.

User::select()->where("brand", 'visa')->or("cvv", '502')->get();

LIKE

Used in a WHERE clause to search for a specified pattern in a column.

User::select()->where("name")->like("%foo%")->get();

BETWEEN

Selects values within a given range. The values can be numbers, text, or dates.

User::select()->where("age")->between(10, 22)->get();

LIMIT

Used to specify the number of records to return.

User::select()->limit(0, 3)->get();

ORDER BY

Used to sort the result-set in ascending or descending order.

User::select()->order("name")->get();

By default, the result will always return ascending. To return values descending, use false in the second parameter.

User::select()->order("name", false)->get();

GROUP BY

The GROUP BY statement groups rows that have the same values into summary rows, like "find the number of customers in each country".

The group by SQL command requires the use of a function. Use the group() method together with the Functions class (see here).

User::select("name, " . Functions::count('*', 'qtd'))->group("name")->get();

COUNT

The count method returns the total number of values in a table.

User::count();

If you want to specify the name of a column, use the first parameter. And to use the WHERE clause, use the second parameter.

// `Email` column
User::count("email");

// `Email` column with WHERE clause
User::count("email", "email='solital@gmail.com'");

INNER JOIN query

The innerJoin() method returns the values of two tables that have a foreign key.

The first parameter represents the table containing the foreign key. The second parameter represents the id of the foreign key.

User::select()
    ->innerJoin("table1", "id1")
    ->innerJoin("table2", "id2")
    ->get();

If you need to use the WHERE clause, use the where() method.

User::select()
    ->innerJoin("table1", "id1")
    ->innerJoin("table2", "id2")
    ->where("phone", 123123123)
    ->get();

NOTE: If you have two or more tables where the column names are the same, remember to specify the table names in the where() method:

User::select()
    ->innerJoin("table1", "id1")
    ->innerJoin("table2", "id2")
    ->where("table1.phone", 123123123)
    ->get();

SELECT inside SELECT

Some SQL queries need to have multiple SELECTs, and sometimes those SELECTs are inside other SELECTs. If you need such a query, follow the example:

$sql = User::select("name")->where("name", "solital")->rawQuery();
$result = User::select("name, age")->where("name", Functions::subquery($sql))->get();

var_dump($result);

The rawQuery() function will return an SQL string (you can use a var_dump() to parse the returned string). Then, to use that SQL string inside another query, use the subquery() function.

Creating and updating data

INSERT query

Katrina uses the ActiveRecord standard to insert and update database data. However, if you don't want to use the ActiveRecord pattern, you can use the insert() and update() methods.

With ActiveRecord

To insert data in the table, you must use the column name as a value. If your table has name, age and email columns, then the values should be used following that same sequence.

Note the code below:

$user = new User();
$user->name = "Harvey Specter";
$user->age = 40;
$user->email = "harvey@pearsonspecterlitt.com";
$user->save();

With the insert method

To save data, you must pass an array in which the keys will be the columns of the table. The values of these keys will be inserted into the database.

User::insert([
    'name' => 'Harvey Specter',
    'age' => 40,
    'email' => 'harvey@pearsonspecterlitt.com'
]);

If you want to retrieve the last ID entered, use the lastId() method.

$res = User::insert([
    'name' => 'Harvey Specter',
    'age' => 40,
    'email' => 'harvey@pearsonspecterlitt.com'
])->lastId();

var_dump($res);

UPDATE query

With ActiveRecord

The process for updating a record in the table is very similar to inserting a record. However, you need to specify the id of your table:

$user = new User();
$user->id = 1;
$user->name = "Harvey Specter";
$user->age = 42;
$user->email = "harvey@specterlitt.com";
$user->save();

With the update method

The process for updating a value in the database using the update method is similar to using the insert method. The difference is that you will use the where method to define the values that will be updated. And to save those changes, the saveUpdate method must be present.

User::update([
    'name' => 'Harvey Specter',
    'age' => 42,
    'email' => 'harvey@specterlitt.com'
])->where('id', 1)->saveUpdate();

Deleting data

To delete a record from the table, use the delete() method.

User::delete('id', 2);

If you want to delete a row that has a foreign key in another table, the $safe_mode parameter must be changed to false:

User::delete('id', 2, false);

Functions

Katrina 2 supports SQL functions. You can use a function in an SQL query using the Function Method:

use Katrina\Functions\Functions;

User::select("name, " . Functions::count('*', 'qtd'))->group("name")->get();

When using a function, you can rename the table name when viewing the data using the $as parameter.

Functions::count(as: 'qtd');
Functions::concat(as: 'result');
Functions::trim(as: 'string');

//...

Below is a list of all the functions present in Katrina ORM:

Aggregate Functions Date Functions Math Functions String Functions
avg() now() abs() concat()
count() curdate() round() ltrim()
max() date() truncate() rtrim()
min() hour() - trim()
sum() day() - -
groupConcat() month() - -
- year() - -
- datediff() - -
- currentTimestamp() - -

Custom functions

If the function you want does not exist or has not yet been implemented in the Katrina ORM, you can use the custom() method.

In the first parameter, you must enter the name of the SQL function. In the second parameter, the value of this function. And in the third parameter, you can rename the table when returning the data.

Functions::custom('sum', '*', 'result');

Manipulating tables

Create a new table

The createTable() method starts opening the table. After inserting the fields and data types that the tables will have, use closeTable() to close the table. For a better understanding see the syntax below.

User::createTable("your_table_name")
    /* Fields and table type */
    ->int("id_user")->primary()->increment()
    ->varchar("name", 20)->unique()->notNull()->default("specter")
    ->int("age", 3)->unsigned()->notNull()
    ->varchar("email", 30)->default("harvey.specter@gmail.com")->notNull()
    ->varchar("profession", 40)
    ->constraint("dev_cons_fk")->foreign("type")->references("dev", "iddev")
    ->createdUpdatedAt()
    /* Close the command to create the table */
    ->closeTable();

For POSTGRESQL

Postgresql doesn't natively support the AUTO_INCREMENT command. An alternative is to use the SERIAL command. So, if you are going to create a table using Postgresql as a database, use the serial() method.

User::createTable("your_table_name")
    ->serial('id_user')->primary()
    # ...

UUIDs

On certain occasions it is necessary to generate a unique identifier for each record. These identifiers are called UUID (universally unique identifiers).

To create a field in a table that will receive a UUID, use the uuid() method. This method will generate a field of binary type.

User::createTable("your_table_name")
    ->uuid('id')->primary()
    # ...

When creating a field in the table that will receive a UUID and be defined as the primary key, you must enable increment in the class.

<?php

namespace Solital\Components\Model;
use Katrina\Katrina;

class User extends Katrina
{
    protected ?bool $uuid_increment = true;
}

If you use the insert() method instead of the standard Active Record to save the data in the table, you must pass the UUID manually. To do this, use the uuidToBin() method.

use Katrina\Functions\Functions;

User::insert([
    'id' => Functions::uuidToBin(),
    'name' => 'Harvey Specter',
    'age' => 40,
    'email' => 'harvey@pearsonspecterlitt.com'
]);

When using the uuidToBin method, the UUID is converted to binary. When returning data and converting back to UUID, use the binToUuid() method.

foreach(Users::all() as $user) {
    echo Functions::binToUuid($user->id) . PHP_EOL;
}

Remember that Katrina ORM uses UUID in version 4.

Timestamps

If you want to change the name of the created_at and updated_at columns, use the properties below:

<?php

namespace Solital\Components\Model;
use Katrina\Katrina;

class User extends Katrina
{
    protected string $created_at = 'created_date';
    protected string $updated_at = 'updated_date';
}

You can also rename columns when creating a table in the database using the createdUpdatedAt method.

// ...
->createdUpdatedAt('created_date', 'updated_date')
// ...

List tables

To have a list of all the tables in your database, use the listTables() method.

User::listTables();

List columns

To list the columns of a table, use the describeTable() method.

User::describeTable();

Drop table

If it is necessary to drop the table, use the dropTable() method.

User::dropTable();

Alter table

The alter() method performs the procedures of adding, changing and deleting a field from the database table.

Add new field

Use add() method together with the data type to add a new field.

User::alter()->varchar("username", 20)->add();

Drop column

Use the drop() method to delete a column from the table.

User::alter()->drop("username");

Modify column

Use the modify SQL with the modify() method.

User::alter()->varchar("name", 100)->modify();

Rename table

Use the rename() method to rename a database table.

User::alter()->rename("new_table_name");

Adding foreign key

To add a foreign key to an already created table, use the constraint() method to add a constraint; foreign() to inform the column and references() to refer to the table.

User::alter()->constraint("dev_cons_fk")->foreign("type")->references("dev", "iddev");

Truncate table

To use the sql truncate command, use the truncate() method.

User::truncate();

By default, the database checks the table's foreign key and locks the truncate command. To disable foreign key verification, enter true as a parameter.

User::truncate(true);

Procedure

To call a database procedure, use the call() method.

User::call('procedure_name');

To use procedure parameters, pass the values in array format.

User::call('procedure_name' , ['param_1, param_2, param_3']);

Transactions

Transactions are typically implemented by "saving-up" your batch of changes to be applied all at once; this has the nice side effect of drastically improving the efficiency of those updates. In other words, transactions can make your scripts faster and potentially more robust (you still need to use them correctly to reap that benefit).

public static function transaction()
{
  try {
    $pdo = Connection::getInstance();
    $pdo->beginTransaction();

    // code...

    $pdo->commit();
  } catch (\PDOException $e) {
    $pdo->rollback();
    echo $e->getMessage();
  }
}

// Using transactions

User::transaction();

Pagination

The pagination() method creates a system for paging results. To initialize, the first parameter must be the table you want to use to start paging. The second parameter will list the amount of values that will be returned from the table as shown in the example below.

$users = new User();
$values = $users->pagination('your_table', 3);

To retrieve the table values from the database, you can use the getRows() method. And to use pagination, use the getArrows() method.

/** Returns table data */
$values->getRows();

/** Returns commands to advance or return */
$values->getArrows()

To use pagination with relationship in another table, in the third parameter pass an array containing the name of the table that has a relationship with the current table, the column name of the current table that has the foreign key and the column name of the primary key of the another table.

$users = new User();
$values = $users->pagination('your_table', 3, ['foreign_table', 'column_foreign_key', 'column_primary_key']);

Pagination with other table (INNER JOIN)

If you want to use pagination with a table that has a foreign key, pass an array in the third parameter.

In the first index, insert the name of the table that is linked to the current table, in the second index the name of the column that contains the foreign key and in the third index the column name of the primary key of the table that references the current table

$values = (new User)->pagination('your_table', 3, ['foreign_table', 'column_foreign_key', 'column_primary_key'], "status=true");

WHERE clause

To use the WHERE clause, use the fourth parameter as shown below.

$values = (new User)->pagination('your_table', 3, null, "status=true");

Wolf Template

Data pagination is widely used in project templates. You can integrate pagination into Wolf Template as follows:

$values = (new User)->pagination('your_table', 3);

return view('home', [
    'values' => $values
]);

In your template, retrieve the data like this:

<table>
    <thead>
        <tr>
            <th>Name</th>
            <th>Age</th>
            <th>Gender</th>
        </tr>
    </thead>

    <tbody>
        {% foreach ($values->getRows() as $result): %}
            <tr>
                <td>{{ $result['name'] }}</td>
                <td>{{ $result['age'] }}</td>
                <td>{{ $result['gender'] }}</td>
            </tr>
        {% endforeach; %}
    </tbody>
</table>

{{ $values->getArrows(); }}

The result will be as follows:

Name Age Gender
Sam 47 Male
Dean 49 Male
Marry 52 Female

<< 1 2 3 >>

To change the arrows (<< and >>), use the parameters of the getArrows() method. The result will be:

{{ $values->getArrows('First', 'Last'); }}
Name Age Gender
Sam 47 Male
Dean 49 Male
Marry 52 Female

First 2 3 Last

Custom Pagination

The pagination() method uses a basic SELECT statement. If you need to use a much more complex SELECT, consider using the customPagination() method.

$values = (new User)->customPagination("SELECT created_at, order_status, idSession, SUM(idOrder) AS idOrder FROM `tb_order` 
GROUP BY created_at, order_status, idSession", 3);

Customizing arrows CSS

You can customize the look of the arrows through the classes pagination_first_item, pagination_atual_item, pagination_others_itens and pagination_last_item.

Below is a customization to serve as an example:

.pagination_atual_item {
    background-color: #B5B5B5;
    padding: 10px;
    margin: 5px;
    border-radius: 5px;
    margin-top: 30px;
    transition: 0.2s;
}

.pagination_first_item, .pagination_others_itens, .pagination_last_item {
    background-color: #4682B4;
    color: #FFF;
    padding: 10px;
    margin: 5px;
    border-radius: 5px;
    margin-top: 30px;
    transition: 0.2s;
    text-decoration: none;
}

.pagination_first_item:hover, .pagination_others_itens:hover, .pagination_last_item:hover {
    background-color: #0071E3;
    color: #FFF !important;
    transition: 0.2s;
}

Cache

To enable Katrina ORM caching in Solital, you must change the cache_database variable to true in the cache.yaml file.

# Enable cache on Katrina ORM
cache_database: true

To configure caching in Solital, see the documentation here.

If you are NOT using Katrina ORM together with Solital, you must configure the constants manually:

define('DB_CACHE', [
    'CACHE_TYPE' => 'memcached',
    'CACHE_HOST' => '127.0.0.1',
    'CACHE_PORT' => 11211,
    'CACHE_TTL' => 600
]);

Katrina ORM supports the following drivers

  • Memcached
  • Memcache
  • APCu
  • Yac

In your Model, you will need to enable caching. To do this, add the following property:

<?php

namespace Solital\Components\Model;
use Katrina\Katrina;

class User extends Katrina
{
    /**
     * @var bool|null
     */
    protected ?bool $cache = true;
}

Multiple connections

In specific cases it is necessary to use two different databases. Katrina ORM supports you to use a second database.

To do this, you must add the following variables to your .env file:

DB_HOST_SECONDARY=localhost
DB_NAME_SECONDARY=second_database
DB_USER_SECONDARY=root
DB_PASS_SECONDARY=""
SQLITE_DIR_SECONDARY=""

If you are NOT using Solital, you must create the following constants:

define('DB_CONFIG_SECONDARY', [
    'HOST' => 'localhost',
    'DBNAME' => 'second_database',
    'USER' => 'root',
    'PASS' => '',
    'SQLITE_DIR' => ''
]);

So, to use the second connection to the other database, use the connection method:

# Main database
User::select()->get();

# Second database
User::connection('pgsql')::select()->get();

Types of data

Below is listed the attributes and data supported by Katrina ORM:

String data Numerical data Date and time
varchar() tinyint() date()
char() smallint() year()
tinytext() mediumint() time()
mediumtext() bigint() datetime()
longtext() int() timestamp()
text() decimal() -
Attributes Boolean
boolean() default()
unique() -
unsigned() -
incremet() (MYSQL) -
notNull() -
primary() -
after() -
first() -
serial() (POSTGRESQL) -

What to see next?

  1. ← Dump
  2. Deploy →
Built with MkDocs.