3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 * - MySQL imposes a 64 char limit.
18 * - All temp tables start with "civicrm_tmp".
19 * - Durable temp tables: "civicrm_tmp_d_{12}_{32}"
20 * - Ephemeral temp tables: "civicrm_tmp_e_{12}_{32}"
23 * - Begin by calling `CRM_Utils_SQL_TempTable::build()`.
24 * - Optionally, describe the table with `setDurable()`, `setCategory()`, `setId()`.
25 * - Finally, call `getName()` or `createWithQuery()` or `createWithColumns()`.
27 * Example 1: Just create a table name. You'll be responsible for CREATE/DROP actions.
29 * $name = CRM_Utils_SQL_TempTable::build()->getName();
30 * $name = CRM_Utils_SQL_TempTable::build()->setDurable()->getName();
31 * $name = CRM_Utils_SQL_TempTable::build()->setCategory('contactstats')->setId($contact['id'])->getName();
33 * Example 2: Create a temp table using the results of a SELECT query.
35 * $tmpTbl = CRM_Utils_SQL_TempTable::build()->createWithQuery('SELECT id, display_name FROM civicrm_contact');
36 * $tmpTbl = CRM_Utils_SQL_TempTable::build()->createWithQuery(CRM_Utils_SQL_Select::from('civicrm_contact')->select('display_name'));
38 * Example 3: Create an empty temp table with list of columns.
40 * $tmpTbl = CRM_Utils_SQL_TempTable::build()->setDurable()->createWithColumns('id int(10, name varchar(64)');
42 * Example 4: Drop a table that you previously created.
46 * Example 5: Auto-drop a temp table when $tmpTbl falls out of scope
48 * $tmpTbl->setAutodrop();
51 class CRM_Utils_SQL_TempTable
{
53 const UTF8
= 'DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci';
54 const CATEGORY_LENGTH
= 12;
55 const CATEGORY_REGEXP
= ';^[a-zA-Z0-9]+$;';
56 // MAX{64} - CATEGORY_LENGTH{12} - CONST_LENGHTH{15} = 37
58 const ID_REGEXP
= ';^[a-zA-Z0-9_]+$;';
59 const INNODB
= 'ENGINE=InnoDB';
60 const MEMORY
= 'ENGINE=MEMORY';
83 * @return CRM_Utils_SQL_TempTable
85 public static function build() {
86 $t = new CRM_Utils_SQL_TempTable();
88 $t->id
= md5(uniqid('', TRUE));
89 // The constant CIVICRM_TEMP_FORCE_DURABLE is for local debugging.
90 $t->durable
= CRM_Utils_Constant
::value('CIVICRM_TEMP_FORCE_DURABLE', FALSE);
97 public function __destruct() {
98 if ($this->autodrop
) {
104 * Determine the full table name.
107 * Ex: 'civicrm_tmp_d_foo_abcd1234abcd1234'
109 public function getName() {
110 $parts = ['civicrm', 'tmp'];
111 $parts[] = ($this->durable ?
'd' : 'e');
112 $parts[] = $this->category ?
$this->category
: 'dflt';
113 $parts[] = $this->id ?
$this->id
: 'dflt';
114 return implode('_', $parts);
118 * Create the table using results from a SELECT query.
120 * @param string|CRM_Utils_SQL_Select $selectQuery
121 * @return CRM_Utils_SQL_TempTable
123 public function createWithQuery($selectQuery) {
124 $sql = sprintf('%s %s %s AS %s',
125 $this->toSQL('CREATE'),
126 $this->memory ? self
::MEMORY
: self
::INNODB
,
127 $this->getUtf8String(),
128 ($selectQuery instanceof CRM_Utils_SQL_Select ?
$selectQuery->toSQL() : $selectQuery)
130 CRM_Core_DAO
::executeQuery($sql, [], TRUE, NULL, TRUE, FALSE);
131 $this->createSql
= $sql;
136 * Get the utf8 string for the table.
138 * If the db collation is already utf8 by default (either
139 * utf8 or utf84mb) then rely on that. Otherwise set to utf8.
141 * Respecting the DB collation supports utf8mb4 adopters, which is currently
142 * not the norm in civi installs.
146 public function getUtf8String() {
150 $dbUTF = CRM_Core_BAO_SchemaHandler
::getDBCollation();
151 if (strpos($dbUTF, 'utf8') !== FALSE) {
158 * Create the empty table.
160 * @parma string $columns
161 * SQL column listing.
162 * Ex: 'id int(10), name varchar(64)'.
163 * @return CRM_Utils_SQL_TempTable
165 public function createWithColumns($columns) {
166 $sql = sprintf('%s (%s) %s %s',
167 $this->toSQL('CREATE'),
169 $this->memory ? self
::MEMORY
: self
::INNODB
,
170 $this->getUtf8String()
172 CRM_Core_DAO
::executeQuery($sql, [], TRUE, NULL, TRUE, FALSE);
173 $this->createSql
= $sql;
180 * @return CRM_Utils_SQL_TempTable
182 public function drop() {
183 $sql = $this->toSQL('DROP', 'IF EXISTS');
184 CRM_Core_DAO
::executeQuery($sql, [], TRUE, NULL, TRUE, FALSE);
189 * @param string $action
190 * Ex: 'CREATE', 'DROP'
191 * @param string|NULL $ifne
192 * Ex: 'IF EXISTS', 'IF NOT EXISTS'.
194 * Ex: 'CREATE TEMPORARY TABLE `civicrm_tmp_e_foo_abcd1234`'
195 * Ex: 'CREATE TABLE IF NOT EXISTS `civicrm_tmp_d_foo_abcd1234`'
197 private function toSQL($action, $ifne = NULL) {
200 if (!$this->durable
) {
201 $parts[] = 'TEMPORARY';
207 $parts[] = '`' . $this->getName() . '`';
208 return implode(' ', $parts);
212 * @return string|NULL
214 public function getCategory() {
215 return $this->category
;
219 * @return string|NULL
221 public function getId() {
226 * @return string|NULL
228 public function getCreateSql() {
229 return $this->createSql
;
235 public function isAutodrop() {
236 return $this->autodrop
;
242 public function isDurable() {
243 return $this->durable
;
249 public function isMemory() {
250 return $this->memory
;
256 public function isUtf8() {
261 * @param bool $autodrop
262 * @return CRM_Utils_SQL_TempTable
264 public function setAutodrop($autodrop = TRUE) {
265 $this->autodrop
= $autodrop;
270 * @param string|NULL $category
272 * @return CRM_Utils_SQL_TempTable
274 public function setCategory($category) {
275 if ($category && !preg_match(self
::CATEGORY_REGEXP
, $category) ||
strlen($category) > self
::CATEGORY_LENGTH
) {
276 throw new \
RuntimeException("Malformed temp table category $category");
278 $this->category
= $category;
283 * Set whether the table should be durable.
285 * Durable tables are not TEMPORARY in the mysql sense.
287 * @param bool $durable
289 * @return CRM_Utils_SQL_TempTable
291 public function setDurable($durable = TRUE) {
292 $this->durable
= $durable;
301 * @return CRM_Utils_SQL_TempTable
303 public function setId($id) {
304 if ($id && !preg_match(self
::ID_REGEXP
, $id) ||
strlen($id) > self
::ID_LENGTH
) {
305 throw new \
RuntimeException("Malformed temp table id");
312 * Set table engine to MEMORY.
318 public function setMemory($value = TRUE) {
319 $this->memory
= $value;
324 * Set table collation to UTF8.
326 * @deprecated This method is deprecated as tables should be assumed to have
327 * UTF-8 as the default character set and collation; some other character set
328 * or collation may be specified in the column definition.
334 public function setUtf8($value = TRUE) {
335 $this->utf8
= $value;