-
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathDatabaseInterface.php
More file actions
198 lines (175 loc) · 4.54 KB
/
DatabaseInterface.php
File metadata and controls
198 lines (175 loc) · 4.54 KB
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<?php
/**
* Copyright 2021 Jeremy Presutti <Jeremy@Presutti.us>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
declare(strict_types=1);
namespace Feast\Interfaces;
use Exception;
use Feast\Database\Query;
use Feast\Database\TableDetails;
use Feast\Enums\DatabaseType;
use Feast\Date;
use PDO;
/**
* Manage the database connections.
* Direct access is frowned upon, let the factory manage it for you.
*
*/
interface DatabaseInterface
{
/**
* Return the database connection.
*
* @return PDO
*/
public function getConnection(): PDO;
/**
* Initialize a select query.
*
* @param string|null $table
* @return Query
*/
public function select(?string $table = null): Query;
/**
* Initialize a delete query.
*
* @param string|null $table
* @return Query
*/
public function delete(?string $table = null): Query;
/**
* Initialize an update query.
*
* @param string $table
* @param array $parameters
* @return Query
*/
public function update(string $table, array $parameters = []): Query;
/**
* Initialize an insert query.
*
* @param string $table
* @param array $parameters
* @return Query
*/
public function insert(string $table, array $parameters = []): Query;
/**
* Initialize a replace query.
*
* @param string $table
* @param array $parameters
* @return Query
* @throws Exception
*/
public function replace(string $table, array $parameters = []): Query;
/**
* Return true if transaction running, otherwise false.
*
* @return bool
*/
public function isInTransaction(): bool;
/**
* Begins transaction if not already running.
*
* Returns false if already running,
* True on success, false on failure.
*
* @return bool
*/
public function beginTransaction(): bool;
/**
* Commit current transaction.
*
* Returns false if not in a transaction or if commit fails.
*
* @return bool
*/
public function commit(): bool;
/**
* Rollback current transaction.
*
* Returns false if not in a transaction or if rollback fails.
*
* @return bool
*/
public function rollBack(): bool;
/**
* Get last insert id as string.
*
* @param string|null $name
* @return string
*/
public function lastInsertId(?string $name = null): string;
/**
* Start a describe query and return the Query object.
*
* @param string $table
* @return Query
* @throws Exception
*/
public function describe(string $table): Query;
/**
* Get TableDetails for a table.
*
* @param string $table
* @return TableDetails
* @throws Exception
*/
public function getDescribedTable(string $table): TableDetails;
/**
* Check if table exists.
*
* @param string $table
* @return bool
* @throws Exception
*/
public function tableExists(string $table): bool;
/**
* Check if a column exists.
*
* @param string $table
* @param string $column
* @return bool
* @throws Exception
*/
public function columnExists(string $table, string $column): bool;
/**
* Run a raw query (with optional bindings).
*
* @param string $query
* @param array<string|int|float|bool|Date|null> $bindings
* @param bool $forceEmulatePrepares
* @return bool
*/
public function rawQuery(string $query, array $bindings = [], bool $forceEmulatePrepares = false): bool;
/**
* Get Database type.
*
* @return DatabaseType
*/
public function getDatabaseType(): DatabaseType;
/**
* Get the escape character for identifiers.
* @return string
*/
public function getIdentifierEscapeCharacter(): string;
/**
* Get escaped identifier.
*
* @param string $field
* @return string
*/
public function getEscapedIdentifier(string $field): string;
}