panel/app/Contracts/Repository/DatabaseRepositoryInterface.php at e56f4cdd3362a6321aed042ca6202b8cd1aa491c · ghzhost/panel · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<?php
/**
 * Pterodactyl - Panel
 * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
 *
 * This software is licensed under the terms of the MIT license.
 * https://opensource.org/licenses/MIT
 */

namespace Pterodactyl\Contracts\Repository;

interface DatabaseRepositoryInterface extends RepositoryInterface
{
    /**
     * Create a new database if it does not already exist on the host with
     * the provided details.
     *
     * @param array $data
     * @return mixed
     *
     * @throws \Pterodactyl\Exceptions\DisplayException
     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
     */
    public function createIfNotExists(array $data);

    /**
     * Create a new database on a given connection.
     *
     * @param string      $database
     * @param null|string $connection
     * @return bool
     */
    public function createDatabase($database, $connection = null);

    /**
     * Create a new database user on a given connection.
     *
     * @param string      $username
     * @param string      $remote
     * @param string      $password
     * @param null|string $connection
     * @return bool
     */
    public function createUser($username, $remote, $password, $connection = null);

    /**
     * Give a specific user access to a given database.
     *
     * @param string      $database
     * @param string      $username
     * @param string      $remote
     * @param null|string $connection
     * @return bool
     */
    public function assignUserToDatabase($database, $username, $remote, $connection = null);

    /**
     * Flush the privileges for a given connection.
     *
     * @param null|string $connection
     * @return mixed
     */
    public function flush($connection = null);

    /**
     * Drop a given database on a specific connection.
     *
     * @param string      $database
     * @param null|string $connection
     * @return bool
     */
    public function dropDatabase($database, $connection = null);

    /**
     * Drop a given user on a specific connection.
     *
     * @param string      $username
     * @param string      $remote
     * @param null|string $connection
     * @return mixed
     */
    public function dropUser($username, $remote, $connection = null);
}