forked from SemanticMediaWiki/SemanticMediaWiki
/
TableBuilder.php
134 lines (117 loc) · 3.35 KB
/
TableBuilder.php
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
<?php
namespace SMW\SQLStore;
use SMW\SQLStore\TableBuilder\Table;
/**
* @private
*
* Provides generic creation and updating function for database tables. A builder
* that implements this interface is expected to define Database specific
* operations and allowing it to be executed on a specific RDBMS back-end.
*
* @license GNU GPL v2+
* @since 2.5
*
* @author mwjames
*/
interface TableBuilder {
/**
* Common prefix used by all Semantic MediaWiki tables
*/
const TABLE_PREFIX = 'smw_';
/**
* Processing field activity status
*/
const PROC_FIELD_NEW = 'field.new';
/**
* Processing field activity status
*/
const PROC_FIELD_UPD = 'field.update';
/**
* Processing field activity status
*/
const PROC_FIELD_DROP = 'field.drop';
/**
* On before the creation of tables and indices
*/
const PRE_CREATION = 'pre.creation';
/**
* On after creation of all tables
*/
const POST_CREATION = 'post.creation';
/**
* On after dropping all tables
*/
const POST_DESTRUCTION = 'post.destruction';
/**
* Generic creation and updating function for database tables. Ideally, it
* would be able to modify a table's signature in arbitrary ways, but it will
* fail for some changes. Its string-based interface is somewhat too
* impoverished for a permanent solution. It would be possible to go for update
* scripts (specific to each change) in the style of MediaWiki instead.
*
* Make sure the table of the given name has the given fields, provided
* as an array with entries fieldname => typeparams. typeparams should be
* in a normalised form and order to match to existing values.
*
* The function returns an array that includes all columns that have been
* changed. For each such column, the array contains an entry
* columnname => action, where action is one of 'up', 'new', or 'del'
*
* @note The function partly ignores the order in which fields are set up.
* Only if the type of some field changes will its order be adjusted explicitly.
*
* @since 2.5
*
* @param Table $table
*/
public function create( Table $table );
/**
* Removes a table from the RDBMS backend.
*
* @since 2.5
*
* @param Table $table
*/
public function drop( Table $table );
/**
* Performs analysis on a key distribution and stores the distribution so
* that the query planner can use these statistics to help determine the
* most efficient execution plans for queries.
*
* @since 3.0
*
* @param Table $table
*/
public function optimize( Table $table );
/**
* Database backends often have different types that need to be used
* repeatedly in (Semantic) MediaWiki. This function provides the
* preferred type (as a string) for various common kinds of columns.
* The input is one of the following strings: 'id' (page id numbers or
* similar), 'title' (title strings or similar), 'namespace' (namespace
* numbers), 'blob' (longer text blobs), 'iw' (interwiki prefixes).
*
* @since 2.5
*
* @param string|FieldType $fieldType
*
* @return string|false SQL type declaration
*/
public function getStandardFieldType( $fieldType );
/**
* Returns a list of process activities
*
* @since 3.0
*
* @param array
*/
public function getLog();
/**
* Allows to check and validate the build on specific events
*
* @since 2.5
*
* @param string $event
*/
public function checkOn( $event );
}