2017-07-15 16:52:34 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Pterodactyl\Contracts\Repository;
|
|
|
|
|
2018-01-05 04:49:50 +00:00
|
|
|
use Pterodactyl\Models\Database;
|
2017-10-19 03:32:19 +00:00
|
|
|
use Illuminate\Support\Collection;
|
2018-03-03 23:52:35 +00:00
|
|
|
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
|
2017-10-19 03:32:19 +00:00
|
|
|
|
2017-07-15 16:52:34 +00:00
|
|
|
interface DatabaseRepositoryInterface extends RepositoryInterface
|
|
|
|
{
|
2021-01-23 20:33:34 +00:00
|
|
|
public const DEFAULT_CONNECTION_NAME = 'dynamic';
|
2017-10-19 03:32:19 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the connection name to execute statements against.
|
|
|
|
*
|
|
|
|
* @return $this
|
|
|
|
*/
|
|
|
|
public function setConnection(string $connection);
|
|
|
|
|
|
|
|
/**
|
2018-05-13 14:50:56 +00:00
|
|
|
* Return the connection to execute statements against.
|
2017-10-19 03:32:19 +00:00
|
|
|
*/
|
|
|
|
public function getConnection(): string;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return all of the databases belonging to a server.
|
|
|
|
*/
|
|
|
|
public function getDatabasesForServer(int $server): Collection;
|
|
|
|
|
2018-03-03 23:52:35 +00:00
|
|
|
/**
|
|
|
|
* Return all of the databases for a given host with the server relationship loaded.
|
|
|
|
*/
|
|
|
|
public function getDatabasesForHost(int $host, int $count = 25): LengthAwarePaginator;
|
|
|
|
|
2017-07-15 16:52:34 +00:00
|
|
|
/**
|
|
|
|
* Create a new database on a given connection.
|
|
|
|
*/
|
2018-01-05 04:49:50 +00:00
|
|
|
public function createDatabase(string $database): bool;
|
2017-07-15 16:52:34 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a new database user on a given connection.
|
|
|
|
*
|
2020-04-23 14:45:44 +00:00
|
|
|
* @param $max_connections
|
2017-07-15 16:52:34 +00:00
|
|
|
*/
|
2020-04-22 10:00:04 +00:00
|
|
|
public function createUser(string $username, string $remote, string $password, string $max_connections): bool;
|
2017-07-15 16:52:34 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Give a specific user access to a given database.
|
|
|
|
*/
|
2018-01-05 04:49:50 +00:00
|
|
|
public function assignUserToDatabase(string $database, string $username, string $remote): bool;
|
2017-07-15 16:52:34 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Flush the privileges for a given connection.
|
|
|
|
*/
|
2018-01-05 04:49:50 +00:00
|
|
|
public function flush(): bool;
|
2017-07-15 16:52:34 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Drop a given database on a specific connection.
|
|
|
|
*/
|
2018-01-05 04:49:50 +00:00
|
|
|
public function dropDatabase(string $database): bool;
|
2017-07-15 16:52:34 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Drop a given user on a specific connection.
|
|
|
|
*
|
|
|
|
* @return mixed
|
|
|
|
*/
|
2018-01-05 04:49:50 +00:00
|
|
|
public function dropUser(string $username, string $remote): bool;
|
2017-07-15 16:52:34 +00:00
|
|
|
}
|