Database Connection

This class allows you to initiate a database connection, Comprehensive Guide to Using the Database Connection Class for Efficient Data Management to get started, see Database Example.

• Class namespace: \Luminova\Database\Connection

Properties

Database connection instance

protected \Luminova\Interface\DriversInterface|null $db

Methods

constructor

Initializes the Connection class constructor based on configuration in the .env file.

new Connection()

• The constructor method is final.

Throws:

• \Luminova\Exceptions\DatabaseException - If all retry attempts fail or an error occurs during connection.
• \Luminova\Exceptions\DatabaseLimitException - When the maximum connection limit is reached.
• \Luminova\Exceptions\InvalidArgumentException - If an invalid connection configuration or driver is passed.

database

Retrieves the database connection instance.

public database(): \Luminova\Interface\DriversInterface|null

Return Value:

DriversInterface|null - The database driver connection instance if connected; otherwise, returns null.

To get the raw database connection instance of PDO or mysqli.

<?php 
$conn->database()->raw()

getInstance

Retrieves the shared singleton instance of the Connection class.

public static getInstance(): self

Return Value:

self - Connection class instance.

Throws:

• \Luminova\Exceptions\DatabaseException - If all retry attempts fail or an error occurs during connection.
• \Luminova\Exceptions\DatabaseLimitException - When the maximum connection limit is reached.
• \Luminova\Exceptions\InvalidArgumentException - If an invalid connection configuration or driver is passed.

newInstance

Retrieves a new database driver instance based on the provided configuration.

If no configuration is provided, the default configuration will be used.

public static newInstance(\Luminova\Base\BaseDatabase|null $config = null): \Luminova\Interface\DriversInterface|null

Parameters:

Return Value:

DriversInterface|null - Database driver instance.

Throws:

• \Luminova\Exceptions\DatabaseException - If all retry attempts fail, an error occurs during connection, or an invalid driver interface is detected.
• \Luminova\Exceptions\DatabaseLimitException - When the maximum connection limit is reached.
• \Luminova\Exceptions\InvalidArgumentException - If an invalid database driver is provided.

connect

Connects to the database, either returning a connection instance or reusing a previous connection from the pool if available.

public connect(): \Luminova\Interface\DriversInterface|null

Return Value:

DriversInterface|nul - Database driver instance (either MySqliDriver or PdoDriver).

Throws:

• \Luminova\Exceptions\DatabaseException - If all retry attempts fail or an error occurs during connection.
• \Luminova\Exceptions\DatabaseLimitException - When the maximum connection limit is reached.
• \Luminova\Exceptions\InvalidArgumentException - If an invalid connection configuration or driver is passed.

Optionally retries failed connections based on the retry attempt value set in the .env file (database.connection.retry).

retry

Retries the database connection with optional backup server fallback.

public retry(int|null $retry = 1): \Luminova\Interface\DriversInterface|null

Parameters:

Return Value:

DriversInterface|null - Connection instance or null if all retry attempts fail.

Throws:

• \Luminova\Exceptions\DatabaseException - If all retry attempts fail or an error occurs during connection.
• \Luminova\Exceptions\DatabaseLimitException - When the maximum connection limit is reached.
• \Luminova\Exceptions\InvalidArgumentException - If an invalid connection configuration or driver is passed.

If the retry parameter is set to null, retries the connection with backup servers if available.

release

Releases a connection back to the connection pool.

public release(\Luminova\Interface\DriversInterface|null $connection): void

Parameters:

If the connection pool is not full, adds the provided connection to the pool else closes the provided connection.

purge

Purges all stacked pool connections and optionally closes the database connection.

public purge(bool $conn = false): void

Parameters:

If the conn parameter is true, the database connection will be closed; otherwise, only the pool connections will be closed.