->> Database & Redis <<-

Amidst the digital realm, the Database module emerges as the keeper of the sacred data, a realm where information is curated and stored in structured sanctuaries. In the journey through code, a developer seeks the knowledge ensconced within these database halls, and with C::Database()->... as the key, the gateways to these knowledge realms are unlocked. The module stands as a bridge, where structured queries turn into a stream of knowledge flowing into the application's veins. It's not merely a module but a conjurer, casting spells of SQL to commune with the data deities enshrined within your database.

Database actions are mostly handled by the popular Eloquent ORM by Laravel.

Supported databases:

  • MariaDB 10.10+
  • MySQL 5.7+
  • PostgreSQL 11.0+
  • SQLite 3.8.8+
  • SQL Server 2017+

->> Methodology

Section header image

-> Unveiling the Database Connection:


With this invocation, the Eloquent instance is revealed, unlocking the full arsenal of features. For instance:

C::Database()->getDatabaseConnection()->select('SHOW DATABASES');

-> Discovering the Databases:


Embark on a quest to unveil all the databases dwelling within your realm:

$all_databases = C::Database()->getAllDatabases();

-> Uncovering the Tables:


Seek the tables harbored within your database realms:

$all_tables = C::Database()->getAllTables();

-> Revealing the Table Structure:

getTableStructure(string $table_name)

Delve deeper to understand the anatomy of a table:

$table_structure = C::Database()->getTableStructure('heroes');

-> ORM - The Chariot of Interaction:

The charm of ORM (Object-Relational Mapping) simplifies the voyage through the data realms, where models act as the chariots, ferrying developers across the river of queries.

->> Configuring The Database Connection

Section header image

Single Database:

The connections.yaml is the scroll where the details of your database realm are inscribed. Here’s a glimpse into the configuration for a single database:

# SQL Database
# ---------------------------------------------
  # Should the database connection be enabled?
  enabled:   true
  # Type of database
  driver:    mysql
  # Authentication
  host:      'localhost'
  username:  'dukenukem'
  password:  'LAm3ltd0wn!'
  # Database
  database:  'DatabaseName'
  prefix:    dn_
  charset:   utf8mb4
  collation: utf8mb4_unicode_ci

Multiple Databases:

For those seeking to converse with multiple data realms, a slight alteration in the connections.yaml scroll unveils the path:

# SQL Databases
# ---------------------------------------------
    enabled:   true
    driver:    mysql
    host:      'localhost'
    username:  'dukenukem'
    password:  'LAm3ltd0wn!'
    database:  'DatabaseName'
    prefix:    dn_
    charset:   utf8mb4
    collation: utf8mb4_unicode_ci
    enabled:   true
    driver:    mysql
    host:      'localhost'
    username:  'dukenukem'
    password:  'LAm3ltd0wn!'
    database:  'OtherStuffDatabase'
    prefix:    osdb_
    charset:   utf8mb4
    collation: utf8mb4_unicode_ci

Make sure you provide a default connection!

If you use multiple databases, one connection must always have the name default.

->> Database Dumping

A ritual to encapsulate the essence of your database into a dump, preserving it for the epochs to come. Invoke the createDump() method to commence the ritual:

             ->excludeTables(['foo', 'bar'])
             ->dumpToFile(PathFinder::getDataPath() . DS . 'dump.sql');

->> Redis: The Swift Messenger of Data

Section header image

Redis, the in-memory data structure store, operates as a swift messenger, delivering data at lightning speed. Access the realm of Redis via C::Redis()->..., a doorway to a universe where data traverses in real-time.

Access to redis is possible via phpredis and predis. PHP's native package will be prefered, if it is available.


Inscribe the connection runes in the connections.yaml scroll:

# Redis
# ---------------------------------------------
  # Should redis be enabled?
  enabled: true
  # Driver to use: phpredis (only used if available), predis
  driver: phpredis
  scheme: tcp
  # Authentication
  host: ''
  port: 6379
  password: ''
  # Prefix for all stored keys
  prefix: myapp_
  # Persistent connection
  persistent: true

Engaging with Redis:

Engage with Redis directly, retrieving the ancient scripts:

$value = C::Redis()->get('mykey');

or delve deeper into the native client to unveil more powers:


All common methods are available both ways.

Redis, the swift courier in the data realms, stands ready to heed your call, transcribing your commands into the ether of rapid data exchange.

->> Conclusion

The Database module, your compass in the wilderness of data, is more than a mere library. It's a sage guiding you through the structured yet complex labyrinths of databases. With every method invocation, a path in the enigmatic forest of data clears, leading you to the sanctum of knowledge. As you venture deeper into the Charm framework, let the Database module be your lodestar, illuminating the way through the dark woods of queries, towards the enlightenment that the structured data beholds.