CommandInterface.php

<?php

namespace Bdf\Prime\Query;

use Bdf\Prime\Connection\ConnectionInterface;
use Bdf\Prime\Connection\Result\ResultSetInterface;
use Bdf\Prime\Exception\PrimeException;
use Bdf\Prime\Query\Compiler\CompilerInterface;
use Bdf\Prime\Query\Contract\SelfExecutable;

/**
 * Base type for perform an SGBD command
 *
 * @template C as ConnectionInterface
 */
interface CommandInterface extends CompilableClauseInterface, SelfExecutable
{
    /**
     * Gets the query language compiler
     *
     * @return object
     */
    public function compiler(): object;

    /**
     * Gets the associated DBAL Connection for this command
     *
     * @return C
     */
    public function connection(): ConnectionInterface;

    /**
     * Set connection
     *
     * @param C $connection
     *
     * @return $this
     */
    public function on(ConnectionInterface $connection);

    /**
     * {@inheritdoc}
     *
     * @param string|array $columns Filter result columns
     *
     * @return ResultSetInterface<array<string, mixed>>
     * @throws PrimeException When execute fail
     */
    public function execute($columns = null): ResultSetInterface;

    /**
     * Creates and adds a query root corresponding to the table identified by the
     * given alias, forming a cartesian product with any existing query roots.
     *
     * <code>
     *     $query
     *         ->select('u.id')
     *         ->from('users', 'u')
     *         ->from('customers', 'c');
     * </code>
     *
     * @param string $from The table.
     * @param string|null $alias The alias of the table.
     *
     * @return $this This Query instance.
     */
    public function from(string $from, ?string $alias = null);
}