b2pweb / bdf-prime

src/Schema/Manager/DatabaseManagerInterface.php

<?php

namespace Bdf\Prime\Schema\Manager;

use Bdf\Prime\Connection\ConnectionInterface;
use Bdf\Prime\Exception\PrimeException;
use Bdf\Prime\Schema\TableInterface;

/**
 * Handle database operations, like load schema, check table existence,
 * manage database...
 *
 * The operations will be done one the remote connection (or simulate), so it will result to database queries
 *
 * @template C as ConnectionInterface
 */
interface DatabaseManagerInterface
{
    /**
     * Get the database connection instance.
     *
     * @return C

The type Bdf\Prime\Schema\Manager\C was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getConnection(): ConnectionInterface;

    /**
     * Determine if the given database exists.
     *
     * @param string $database
     *
     * @return bool
     * @throws PrimeException When list databases fail
     */
    public function hasDatabase(string $database): bool;

    /**
     * Get the databases listing.
     *
     * @return list<string>

The type Bdf\Prime\Schema\Manager\list was not found. Maybe you did not declare it correctly or list all dependencies?

     * @throws PrimeException When list databases fail
     */
    public function getDatabases(): array;

    /**
     * Creates a new database.
     *
     * @param string $database The name of the database to create.
     *
     * @return $this
     * @throws PrimeException When query fail
     */
    public function createDatabase(string $database);

    /**
     * Drops a database.
     *
     * NOTE: You can not drop the database this connection is currently connected to.
     *
     * @param string $database The name of the database to drop.
     *
     * @return $this
     * @throws PrimeException When query fail
     */
    public function dropDatabase(string $database);

    /**
     * Determine if the given table exists.
     *
     * @param string $tableName
     *
     * @return bool
     * @throws PrimeException When query fail
     */
    public function has(string $tableName): bool;

    /**
     * Determine if the given table exists.
     *
     * @param string $tableName
     *
     * @return bool
     * @throws PrimeException When query fail
     * @deprecated Since 2.0. Use DatabaseManagerInterface#has() instead
     */
    public function hasTable($tableName);

    /**
     * Determine load the table structure
     *
     * @param string $tableName
     *
     * @return TableInterface
     * @throws PrimeException When query fail
     * @deprecated Since 2.0. Use DatabaseStructureManagerInterface::load() instead
     */
    public function loadTable($tableName);

    /**
     * Drop a table from the schema.
     *
     * @param string $tableName
     *
     * @return $this
     * @throws PrimeException When query fail
     */
    public function drop(string $tableName);

    /**
     * Truncate a table
     *
     * @param string $tableName
     * @param bool $cascade
     *
     * @return $this
     * @throws PrimeException When query fail
     */
    public function truncate(string $tableName, bool $cascade = false);

    /**
     * Rename a table on the schema.
     *
     * @param string $from
     * @param string $to
     *
     * @return $this
     * @throws PrimeException When query fail
     */
    public function rename(string $from, string $to);
}