rkrx / php-mysql-query-builder

src/Database.php

<?php

namespace Kir\MySQL;

use JetBrains\PhpStorm\Language;
use Kir\MySQL\Builder\Internal\Types;
use Kir\MySQL\Builder\QueryStatement;
use Kir\MySQL\Database\DatabaseStatement;
use Kir\MySQL\Tools\AliasRegistry;
use Kir\MySQL\Tools\VirtualTables;
use Stringable;

/**
 * @phpstan-import-type DBParameterValueType from Types
 */
interface Database {
	/**
	 * @return AliasRegistry
	 */
	public function getAliasRegistry(): AliasRegistry;

	/**
	 * @return VirtualTables
	 */
	public function getVirtualTables(): VirtualTables;

	/**
	 * @param string $query
	 * @return DatabaseStatement
	 */
	public function query(
		#[Language('MySQL')]
		string $query,
	);

	/**
	 * @param string $query
	 * @return QueryStatement
	 */
	public function prepare(
		#[Language('MySQL')]
		string $query,
	);

	/**
	 * @param string $query
	 * @param array<string, null|scalar|Stringable|array<null|scalar>> $params
	 * @return int
	 */
	public function exec(
		#[Language('MySQL')]
		string $query,
		array $params = [],
	): int;

	/**
	 * @param string|null $name
	 * @return string|null
	 */
	public function getLastInsertId(?string $name = null): ?string;

	/**
	 * @param string $table
	 * @return array<int, string>
	 */
	public function getTableFields(string $table): array;

	/**
	 * @param string $expression
	 * @param list<DBParameterValueType> $arguments

The type Kir\MySQL\list was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @return string
	 */
	public function quoteExpression(string $expression, array $arguments = []): string;

	/**
	 * @param mixed $value
	 * @return string
	 */
	public function quote($value): string;

	/**
	 * @param string $field
	 * @return string
	 */
	public function quoteField(string $field): string;

	/**
	 * @param array<int|string, string>|null $fields
	 * @return Builder\RunnableSelect
	 */
	public function select(?array $fields = null);

	/**
	 * @param array<string, string>|null $fields
	 * @return Builder\RunnableInsert
	 */
	public function insert(?array $fields = null);

	/**
	 * @param array<string, string>|null $fields
	 * @return Builder\RunnableUpdate
	 */
	public function update(?array $fields = null);

	/**
	 * @return Builder\RunnableDelete
	 */
	public function delete(): Builder\RunnableDelete;

	/**
	 * @return $this
	 */
	public function transactionStart();

	/**
	 * @return $this
	 */
	public function transactionCommit();

	/**
	 * @return $this
	 */
	public function transactionRollback();

	/**
	 * @template T
	 * @param callable(self): T $callback
	 * @return T
	 */
	public function transaction(callable $callback);

	/**
	 * @template T
	 * @param callable(self): T $callback
	 * @return T
	 */
	public function dryRun(callable $callback);
}