bdf-prime/src/Schema/Manager/DatabaseManagerInterface.php at 2.1 · b2pweb/bdf-prime · 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?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
     */
    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>
     * @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);
}