Adapter
2 years ago
Schema
2 years ago
Adapter.php
2 years ago
AdapterInterface.php
2 years ago
BatchInsert.php
2 years ago
Schema.php
2 years ago
SchemaInterface.php
2 years ago
Settings.php
2 years ago
TransactionLevel.php
2 years ago
SchemaInterface.php
96 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | * |
| 9 | */ |
| 10 | namespace Piwik\Db; |
| 11 | |
| 12 | /** |
| 13 | * Database schema interface |
| 14 | */ |
| 15 | interface SchemaInterface |
| 16 | { |
| 17 | /** |
| 18 | * Get the SQL to create a specific Piwik table |
| 19 | * |
| 20 | * @param string $tableName |
| 21 | * @return string SQL |
| 22 | */ |
| 23 | public function getTableCreateSql($tableName); |
| 24 | /** |
| 25 | * Get the SQL to create Piwik tables |
| 26 | * |
| 27 | * @return array array of strings containing SQL |
| 28 | */ |
| 29 | public function getTablesCreateSql(); |
| 30 | /** |
| 31 | * Creates a new table in the database. |
| 32 | * |
| 33 | * @param string $nameWithoutPrefix The name of the table without any piwik prefix. |
| 34 | * @param string $createDefinition The table create definition |
| 35 | */ |
| 36 | public function createTable($nameWithoutPrefix, $createDefinition); |
| 37 | /** |
| 38 | * Create database |
| 39 | * |
| 40 | * @param string $dbName Name of the database to create |
| 41 | */ |
| 42 | public function createDatabase($dbName = null); |
| 43 | /** |
| 44 | * Drop database |
| 45 | */ |
| 46 | public function dropDatabase(); |
| 47 | /** |
| 48 | * Create all tables |
| 49 | */ |
| 50 | public function createTables(); |
| 51 | /** |
| 52 | * Creates an entry in the User table for the "anonymous" user. |
| 53 | */ |
| 54 | public function createAnonymousUser(); |
| 55 | /** |
| 56 | * Records the Matomo version a user used when installing this Matomo for the first time |
| 57 | */ |
| 58 | public function recordInstallVersion(); |
| 59 | /** |
| 60 | * Returns which Matomo version was used to install this Matomo for the first time. |
| 61 | */ |
| 62 | public function getInstallVersion(); |
| 63 | /** |
| 64 | * Truncate all tables |
| 65 | */ |
| 66 | public function truncateAllTables(); |
| 67 | /** |
| 68 | * Names of all the prefixed tables in piwik |
| 69 | * Doesn't use the DB |
| 70 | * |
| 71 | * @return array Table names |
| 72 | */ |
| 73 | public function getTablesNames(); |
| 74 | /** |
| 75 | * Get list of tables installed |
| 76 | * |
| 77 | * @param bool $forceReload Invalidate cache |
| 78 | * @return array installed Tables |
| 79 | */ |
| 80 | public function getTablesInstalled($forceReload = true); |
| 81 | /** |
| 82 | * Get list of installed columns in a table |
| 83 | * |
| 84 | * @param string $tableName The name of a table. |
| 85 | * |
| 86 | * @return array Installed columns indexed by the column name. |
| 87 | */ |
| 88 | public function getTableColumns($tableName); |
| 89 | /** |
| 90 | * Checks whether any table exists |
| 91 | * |
| 92 | * @return bool True if tables exist; false otherwise |
| 93 | */ |
| 94 | public function hasTables(); |
| 95 | } |
| 96 |