/usr/share/php/Horde/Db/Adapter/Base/Schema.php is in php-horde-db 2.4.0-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 | <?php
/**
* Copyright 2007 Maintainable Software, LLC
* Copyright 2008-2017 Horde LLC (http://www.horde.org/)
*
* @author Mike Naberezny <mike@maintainable.com>
* @author Derek DeVries <derek@maintainable.com>
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Jan Schneider <jan@horde.org>
* @license http://www.horde.org/licenses/bsd
* @category Horde
* @package Db
* @subpackage Adapter
*/
/**
* Base class for managing database schemes and handling database-specific SQL
* dialects and quoting.
*
* @author Mike Naberezny <mike@maintainable.com>
* @author Derek DeVries <derek@maintainable.com>
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Jan Schneider <jan@horde.org>
* @license http://www.horde.org/licenses/bsd
* @category Horde
* @package Db
* @subpackage Adapter
*/
abstract class Horde_Db_Adapter_Base_Schema
{
/**
* A Horde_Db_Adapter instance.
*
* @var Horde_Db_Adapter_Base
*/
protected $_adapter = null;
/**
* List of public methods supported by the attached adapter.
*
* Method names are in the keys.
*
* @var array
*/
protected $_adapterMethods = array();
/*##########################################################################
# Construct/Destruct
##########################################################################*/
/**
* Constructor.
*
* @param Horde_Db_Adapter_Base $adapter A Horde_Db_Adapter instance.
*/
public function __construct(Horde_Db_Adapter $adapter)
{
$this->setAdapter($adapter);
}
/**
* Setter for a Horde_Db_Adapter instance.
*
* @param Horde_Db_Adapter $adapter A Horde_Db_Adapter instance.
*/
public function setAdapter(Horde_Db_Adapter $adapter)
{
$this->_adapter = $adapter;
$this->_adapterMethods = array_flip(get_class_methods($adapter));
}
/*##########################################################################
# Object factories
##########################################################################*/
/**
* Factory for Column objects.
*
* @param string $name The column's name, such as "supplier_id" in
* "supplier_id int(11)".
* @param string $default The type-casted default value, such as "new" in
* "sales_stage varchar(20) default 'new'".
* @param string $sqlType Used to extract the column's type, length and
* signed status, if necessary. For example
* "varchar" and "60" in "company_name varchar(60)"
* or "unsigned => true" in "int(10) UNSIGNED".
* @param boolean $null Whether this column allows NULL values.
*
* @return Horde_Db_Adapter_Base_Column A column object.
*/
public function makeColumn($name, $default, $sqlType = null, $null = true)
{
return new Horde_Db_Adapter_Base_Column($name, $default, $sqlType, $null);
}
/**
* Factory for ColumnDefinition objects.
*
* @return Horde_Db_Adapter_Base_ColumnDefinition A column definition
* object.
*/
public function makeColumnDefinition(
$base, $name, $type, $limit = null, $precision = null, $scale = null,
$unsigned = null, $default = null, $null = null, $autoincrement = null)
{
return new Horde_Db_Adapter_Base_ColumnDefinition(
$base, $name, $type, $limit, $precision, $scale, $unsigned,
$default, $null, $autoincrement);
}
/**
* Factory for Index objects.
*
* @param string $table The table the index is on.
* @param string $name The index's name.
* @param boolean $primary Is this a primary key?
* @param boolean $unique Is this a unique index?
* @param array $columns The columns this index covers.
*
* @return Horde_Db_Adapter_Base_Index An index object.
*/
public function makeIndex($table, $name, $primary, $unique, $columns)
{
return new Horde_Db_Adapter_Base_Index($table, $name, $primary, $unique, $columns);
}
/**
* Factory for Table objects.
*
* @return Horde_Db_Adapter_Base_Table A table object.
*/
public function makeTable($name, $primaryKey, $columns, $indexes)
{
return new Horde_Db_Adapter_Base_Table($name, $primaryKey, $columns, $indexes);
}
/**
* Factory for TableDefinition objects.
*
* @return Horde_Db_Adapter_Base_TableDefinition A table definition object.
*/
public function makeTableDefinition($name, $base, $options = array())
{
return new Horde_Db_Adapter_Base_TableDefinition($name, $base, $options);
}
/*##########################################################################
# Object composition
##########################################################################*/
/**
* Delegates calls to the adapter object.
*
* @param string $method A method name.
* @param array $args Method parameters.
*
* @return mixed The method call result.
* @throws BadMethodCallException if method doesn't exist in the adapter.
*/
public function __call($method, $args)
{
if (isset($this->_adapterMethods[$method])) {
return call_user_func_array(array($this->_adapter, $method), $args);
}
throw new BadMethodCallException('Call to undeclared method "' . $method . '"');
}
/**
* Delegates access to $_cache and $_logger to the adapter object.
*
* @param string $key Property name. Only '_cache' and '_logger' are
* supported.
*
* @return object The request property object.
*/
public function __get($key)
{
if ($key == '_cache' || $key == '_logger') {
$getter = 'get' . Horde_String::ucfirst(substr($key, 1));
return $this->_adapter->$getter();
}
}
/*##########################################################################
# Quoting
##########################################################################*/
/**
* Quotes the column value to help prevent SQL injection attacks.
*
* This method makes educated guesses on the scalar type based on the
* passed value. Make sure to correctly cast the value and/or pass the
* $column parameter to get the best results.
*
* @param mixed $value The scalar value to quote, a Horde_Db_Value,
* Horde_Date, or DateTime instance, or an object
* implementing quotedId().
* @param object $column An object implementing getType().
*
* @return string The correctly quoted value.
*/
public function quote($value, $column = null)
{
if (is_object($value) && is_callable(array($value, 'quotedId'))) {
return $value->quotedId();
}
if ($value instanceof Horde_Db_Value) {
return $value->quote($this->_adapter);
}
$type = isset($column) ? $column->getType() : null;
if (is_null($value)) {
return 'NULL';
} elseif ($value === true) {
return $type == 'integer' ? '1' : $this->quoteTrue();
} elseif ($value === false) {
return $type == 'integer' ? '0' : $this->quoteFalse();
} elseif (is_float($value)) {
return sprintf('%F', $value);
} elseif (is_int($value)) {
return $value;
} elseif ($value instanceof DateTime || $value instanceof Horde_Date) {
return $this->_adapter->quoteString($type == 'integer'
? $value->format('U')
: $value->format('Y-m-d H:i:s'));
} elseif ($type == 'integer') {
return (int)$value;
} elseif ($type == 'float') {
return sprintf('%F', $value);
} else {
return $this->_adapter->quoteString($value);
}
}
/**
* Quotes a string, escaping any ' (single quote) and \ (backslash)
* characters.
*
* @param string $string A string to escape.
*
* @return string The escaped and quoted string.
*/
public function quoteString($string)
{
return "'" . str_replace(array('\\', '\''), array('\\\\', '\\\''), $string) . "'";
}
/**
* Returns a quoted form of the column name.
*
* @param string $name A column name.
*
* @return string The quoted column name.
*/
public function quoteColumnName($name)
{
return '"' . str_replace('"', '""', $name) . '"';
}
/**
* Returns a quoted form of the table name.
*
* Defaults to column name quoting.
*
* @param string $name A table name.
*
* @return string The quoted table name.
*/
public function quoteTableName($name)
{
return $this->quoteColumnName($name);
}
/**
* Returns a quoted boolean true.
*
* @return string The quoted boolean true.
*/
public function quoteTrue()
{
return '1';
}
/**
* Returns a quoted boolean false.
*
* @return string The quoted boolean false.
*/
public function quoteFalse()
{
return '0';
}
/**
* Returns a quoted date value.
*
* @param mixed A date value that can be casted to string.
*
* @return string The quoted date value.
*/
public function quoteDate($value)
{
return $this->quoteString((string)$value);
}
/**
* Returns a quoted binary value.
*
* @param mixed A binary value.
*
* @return string The quoted binary value.
*/
public function quoteBinary($value)
{
return $this->quoteString($value);
}
/*##########################################################################
# Schema Statements
##########################################################################*/
/**
* Returns a hash of mappings from the abstract data types to the native
* database types.
*
* See TableDefinition::column() for details on the recognized abstract
* data types.
*
* @see TableDefinition::column()
*
* @return array A database type map.
*/
abstract public function nativeDatabaseTypes();
/**
* Returns the maximum length a table alias can have.
*
* @return integer The maximum table alias length.
*/
public function tableAliasLength()
{
return 255;
}
/**
* Converts a table name into a suitable table alias.
*
* @param string $tableName A table name.
*
* @return string A possible alias name for the table.
*/
public function tableAliasFor($tableName)
{
$alias = substr($tableName, 0, $this->tableAliasLength());
return str_replace('.', '_', $alias);
}
/**
* Returns a list of all tables of the current database.
*
* @return array A table list.
*/
abstract public function tables();
/**
* Returns a Horde_Db_Adapter_Base_Table object for a table.
*
* @param string $tableName A table name.
* @param string $name (can be removed?)
*
* @return Horde_Db_Adapter_Base_Table A table object.
*/
public function table($tableName, $name = null)
{
return $this->makeTable(
$tableName,
$this->primaryKey($tableName),
$this->columns($tableName, $name),
$this->indexes($tableName, $name)
);
}
/**
* Returns a table's primary key.
*
* @param string $tableName A table name.
* @param string $name (can be removed?)
*
* @return Horde_Db_Adapter_Base_Index The primary key index object.
*/
abstract public function primaryKey($tableName, $name = null);
/**
* Returns a list of tables indexes.
*
* @param string $tableName A table name.
* @param string $name (can be removed?)
*
* @return array A list of Horde_Db_Adapter_Base_Index objects.
*/
abstract public function indexes($tableName, $name = null);
/**
* Returns a list of table columns.
*
* @param string $tableName A table name.
* @param string $name (can be removed?)
*
* @return array A list of Horde_Db_Adapter_Base_Column objects.
*/
abstract public function columns($tableName, $name = null);
/**
* Returns a table column.
*
* @since Horde_Db 2.1.0
*
* @param string $tableName A table name.
* @param string $columnName A column name.
*
* @throws Horde_Db_Exception if column not found.
* @return Horde_Db_Adapter_Base_Column A column object.
*/
public function column($tableName, $columnName)
{
foreach ($this->columns($tableName) as $column) {
if ($column->getName() == $columnName) {
return $column;
}
}
throw new Horde_Db_Exception("$tableName does not have a column '$columnName'");
}
/**
* Creates a new table.
*
* The $options hash can include the following keys:
* - autoincrementKey (string|array):
* The name of the autoincrementing primary key, if one is to be added
* automatically. Defaults to "id".
* - options (array):
* Any extra options you want appended to the table definition.
* - temporary (boolean):
* Make a temporary table.
* - force (boolean):
* Set to true or false to drop the table before creating it.
* Defaults to false.
*
* Examples:
* <code>
* // Add a backend specific option to the generated SQL (MySQL)
* $schema->createTable('suppliers', array('options' => 'ENGINE=InnoDB DEFAULT CHARSET=utf8')));
* </code>
* generates:
* <pre>
* CREATE TABLE suppliers (
* id int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY
* ) ENGINE=InnoDB DEFAULT CHARSET=utf8
* </pre>
*
* <code>
* // Rename the primary key column
* $table = $schema->createTable('objects', array('autoincrementKey' => 'guid'));
* $table->column('name', 'string', array('limit' => 80));
* $table->end();
* </code>
* generates:
* <pre>
* CREATE TABLE objects (
* guid int(10) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
* name varchar(80)
* )
* </pre>
*
* <code>
* // Do not add a primary key column, use fluent interface, use type
* // method.
* $schema->createTable('categories_suppliers', array('autoincrementKey' => false))
* ->column('category_id', 'integer')
* ->integer('supplier_id')
* ->end();
* </code>
* generates:
* <pre>
* CREATE TABLE categories_suppliers (
* category_id int(11),
* supplier_id int(11)
* )
* </pre>
*
* See also Horde_Db_Adapter_Base_TableDefinition::column() for details on
* how to create columns.
*
* @param string $name A table name.
* @param array $options A list of table options, see the method
* description.
*
* @return Horde_Db_Adapter_Base_TableDefinition The definition of the
* created table.
*/
public function createTable($name, $options = array())
{
$tableDefinition = $this->makeTableDefinition($name, $this, $options);
if (isset($options['autoincrementKey'])) {
if ($options['autoincrementKey'] === true ||
$options['autoincrementKey'] === 'true' ||
$options['autoincrementKey'] === 't' ||
$options['autoincrementKey'] === 1 ||
$options['autoincrementKey'] === '1') {
$pk = 'id';
} elseif ($options['autoincrementKey'] === false ||
$options['autoincrementKey'] === 'false' ||
$options['autoincrementKey'] === 'f' ||
$options['autoincrementKey'] === 0 ||
$options['autoincrementKey'] === '0') {
$pk = false;
} else {
$pk = $options['autoincrementKey'];
}
} else {
$pk = 'id';
}
if ($pk != false) {
$tableDefinition->primaryKey($pk);
}
return $tableDefinition;
}
/**
* Finishes and executes table creation.
*
* @param string|Horde_Db_Adapter_Base_TableDefinition $name
* A table name or object.
* @param array $options
* A list of options. See createTable().
*/
public function endTable($name, $options = array())
{
if ($name instanceof Horde_Db_Adapter_Base_TableDefinition) {
$tableDefinition = $name;
$options = array_merge($tableDefinition->getOptions(), $options);
} else {
$tableDefinition = $this->createTable($name, $options);
}
// Drop previous table.
if (isset($options['force'])) {
$this->dropTable($tableDefinition->getName(), $options);
}
$temp = !empty($options['temporary']) ? 'TEMPORARY' : null;
$opts = !empty($options['options']) ? $options['options'] : null;
$sql = sprintf("CREATE %s TABLE %s (\n%s\n) %s",
$temp,
$this->quoteTableName($tableDefinition->getName()),
$tableDefinition->toSql(),
$opts);
$this->execute($sql);
}
/**
* Renames a table.
*
* @param string $name A table name.
* @param string $newName The new table name.
*/
abstract public function renameTable($name, $newName);
/**
* Drops a table from the database.
*
* @param string $name A table name.
*/
public function dropTable($name)
{
$this->_clearTableCache($name);
return $this->execute('DROP TABLE ' . $this->quoteTableName($name));
}
/**
* Adds a new column to a table.
*
* @param string $tableName A table name.
* @param string $columnName A column name.
* @param string $type A data type.
* @param array $options Column options. See
* Horde_Db_Adapter_Base_TableDefinition#column()
* for details.
*/
public function addColumn($tableName, $columnName, $type,
$options = array())
{
$this->_clearTableCache($tableName);
$options = array_merge(
array('limit' => null,
'precision' => null,
'scale' => null,
'unsigned' => null),
$options);
$sql = sprintf('ALTER TABLE %s ADD %s %s',
$this->quoteTableName($tableName),
$this->quoteColumnName($columnName),
$this->typeToSql($type,
$options['limit'],
$options['precision'],
$options['scale'],
$options['unsigned']));
$sql = $this->addColumnOptions($sql, $options);
return $this->execute($sql);
}
/**
* Removes a column from a table.
*
* @param string $tableName A table name.
* @param string $columnName A column name.
*/
public function removeColumn($tableName, $columnName)
{
$this->_clearTableCache($tableName);
$sql = sprintf('ALTER TABLE %s DROP %s',
$this->quoteTableName($tableName),
$this->quoteColumnName($columnName));
return $this->execute($sql);
}
/**
* Changes an existing column's definition.
*
* @param string $tableName A table name.
* @param string $columnName A column name.
* @param string $type A data type.
* @param array $options Column options. See
* Horde_Db_Adapter_Base_TableDefinition#column()
* for details.
*/
abstract public function changeColumn($tableName, $columnName, $type, $options = array());
/**
* Sets a new default value for a column.
*
* If you want to set the default value to NULL, you are out of luck. You
* need to execute the apppropriate SQL statement yourself.
*
* @param string $tableName A table name.
* @param string $columnName A column name.
* @param mixed $default The new default value.
*/
abstract public function changeColumnDefault($tableName, $columnName, $default);
/**
* Renames a column.
*
* @param string $tableName A table name.
* @param string $columnName A column name.
* @param string $newColumnName The new column name.
*/
abstract public function renameColumn($tableName, $columnName, $newColumnName);
/**
* Adds a primary key to a table.
*
* @param string $tableName A table name.
* @param string|array $columnName One or more column names.
*
* @throws Horde_Db_Exception
*/
public function addPrimaryKey($tableName, $columns)
{
$this->_clearTableCache($tableName);
$columns = (array)$columns;
$sql = sprintf('ALTER TABLE %s ADD PRIMARY KEY (%s)',
$this->quoteTableName($tableName),
implode(', ', $columns));
return $this->execute($sql);
}
/**
* Removes a primary key from a table.
*
* @param string $tableName A table name.
*
* @throws Horde_Db_Exception
*/
abstract public function removePrimaryKey($tableName);
/**
* Adds a new index to a table.
*
* The index will be named after the table and the first column names,
* unless you pass 'name' as an option.
*
* When creating an index on multiple columns, the first column is used as
* a name for the index. For example, when you specify an index on two
* columns 'first' and 'last', the DBMS creates an index for both columns
* as well as an index for the first colum 'first'. Using just the first
* name for this index makes sense, because you will never have to create a
* singular index with this name.
*
* Examples:
*
* Creating a simple index
* <code>
* $schema->addIndex('suppliers', 'name');
* </code>
* generates
* <code>
* CREATE INDEX suppliers_name_index ON suppliers(name)
* </code>
*
* Creating a unique index
* <code>
* $schema->addIndex('accounts',
* array('branch_id', 'party_id'),
* array('unique' => true));
* </code>
* generates
* <code>
* CREATE UNIQUE INDEX accounts_branch_id_index ON accounts(branch_id, party_id)
* </code>
*
* Creating a named index
* <code>
* $schema->addIndex('accounts',
* array('branch_id', 'party_id'),
* array('unique' => true, 'name' => 'by_branch_party'));
* </code>
* generates
* <code>
* CREATE UNIQUE INDEX by_branch_party ON accounts(branch_id, party_id)
* </code>
*
* @param string $tableName A table name.
* @param string|array $columnName One or more column names.
* @param array $options Index options:
* - name: (string) the index name.
* - unique: (boolean) create a unique
* index?
*
* @return string The index name. @since Horde_Db 2.1.0
*/
public function addIndex($tableName, $columnName, $options = array())
{
$this->_clearTableCache($tableName);
$columnNames = (array)$columnName;
$indexName = empty($options['name'])
? $this->indexName($tableName, array('column' => $columnNames))
: $this->indexName($tableName, $options);
foreach ($columnNames as &$colName) {
$colName = $this->quoteColumnName($colName);
}
$sql = sprintf('CREATE %s INDEX %s ON %s (%s)',
empty($options['unique']) ? null : 'UNIQUE',
$this->quoteColumnName($indexName),
$this->quoteTableName($tableName),
implode(', ', $columnNames));
$this->execute($sql);
return $indexName;
}
/**
* Removes an index from a table.
*
* Examples:
*
* Remove the suppliers_name_index in the suppliers table:
* <code>
* $schema->removeIndex('suppliers', 'name');
* </code>
*
* Remove the index named accounts_branch_id in the accounts table:
* <code>
* $schema->removeIndex('accounts', array('column' => 'branch_id'));
* </code>
*
* Remove the index named by_branch_party in the accounts table:
* <code>
* $schema->removeIndex('accounts', array('name' => 'by_branch_party'));
* </code>
*
* You can remove an index on multiple columns by specifying the first
* column:
* <code>
* $schema->addIndex('accounts', array('username', 'password'))
* $schema->removeIndex('accounts', 'username');
* </code>
*
* @param string $tableName A table name.
* @param string|array $options Either a column name or index options:
* - name: (string) the index name.
* - column: (string|array) column name(s).
*/
public function removeIndex($tableName, $options = array())
{
$this->_clearTableCache($tableName);
$index = $this->indexName($tableName, $options);
$sql = sprintf('DROP INDEX %s ON %s',
$this->quoteColumnName($index),
$this->quoteTableName($tableName));
return $this->execute($sql);
}
/**
* Builds the name for an index.
*
* @param string $tableName A table name.
* @param string|array $options Either a column name or index options:
* - column: (string|array) column name(s).
* - name: (string) the index name to fall
* back to if no column names specified.
*/
public function indexName($tableName, $options = array())
{
if (!is_array($options)) {
$options = array('column' => $options);
}
if (isset($options['column'])) {
$columns = (array)$options['column'];
return "index_{$tableName}_on_" . implode('_and_', $columns);
}
if (isset($options['name'])) {
return $options['name'];
}
throw new Horde_Db_Exception('You must specify the index name');
}
/**
* Recreates, i.e. drops then creates a database.
*
* @param string $name A database name.
*/
public function recreateDatabase($name)
{
$this->dropDatabase($name);
return $this->createDatabase($name);
}
/**
* Creates a database.
*
* @param string $name A database name.
* @param array $options Database options.
*/
abstract public function createDatabase($name, $options = array());
/**
* Drops a database.
*
* @param string $name A database name.
*/
abstract public function dropDatabase($name);
/**
* Returns the name of the currently selected database.
*
* @return string The database name.
*/
abstract public function currentDatabase();
/**
* Generates the SQL definition for a column type.
*
* @param string $type A column type.
* @param integer $limit Maximum column length (non decimal type only)
* @param integer $precision The number precision (decimal type only).
* @param integer $scale The number scaling (decimal columns only).
* @param boolean $unsigned Whether the column is an unsigned number
* (non decimal columns only).
*
* @return string The SQL definition. If $type is not one of the
* internally supported types, $type is returned unchanged.
*/
public function typeToSql($type, $limit = null, $precision = null,
$scale = null, $unsigned = null)
{
$natives = $this->nativeDatabaseTypes();
$native = isset($natives[$type]) ? $natives[$type] : null;
if (empty($native)) {
return $type;
}
$sql = is_array($native) ? $native['name'] : $native;
if ($type == 'decimal' ||
is_array($native) && (isset($native['precision']) || isset($native['scale'])) ||
isset($precision) || isset($scale)) {
$nativePrec = isset($native['precision']) ? $native['precision'] : null;
$nativeScale = isset($native['scale']) ? $native['scale'] : null;
$precision = !empty($precision) ? $precision : $nativePrec;
$scale = !empty($scale) ? $scale : $nativeScale;
if ($precision) {
$sql .= $scale ? "($precision, $scale)" : "($precision)";
}
} else {
$nativeLimit = is_array($native) ? $native['limit'] : null;
// If there is no explicit limit, adjust $nativeLimit for unsigned
// integers.
if (!empty($unsigned) && empty($limit) && is_integer($nativeLimit)) {
$nativeLimit--;
}
if ($limit = !empty($limit) ? $limit : $nativeLimit) {
$sql .= "($limit)";
}
}
return $sql;
}
/**
* Adds default/null options to column SQL definitions.
*
* @param string $sql Existing SQL definition for a column.
* @param array $options Column options:
* - column: (Horde_Db_Adapter_Base_ColumnDefinition
* The column definition class.
* - null: (boolean) Whether to allow NULL values.
* - default: (mixed) Default column value.
* - autoincrement: (boolean) Whether the column is
* an autoincrement column. Driver depedendent.
*
* @return string The manipulated SQL definition.
*/
public function addColumnOptions($sql, $options)
{
/* 'autoincrement' is not handled here - it varies too much between
* DBs. Do autoincrement-specific handling in the driver. */
if (isset($options['null']) && $options['null'] === false) {
$sql .= ' NOT NULL';
}
if (isset($options['default'])) {
$default = $options['default'];
$column = isset($options['column']) ? $options['column'] : null;
$sql .= ' DEFAULT ' . $this->quote($default, $column);
}
return $sql;
}
/**
* Generates a DISTINCT clause for SELECT queries.
*
* <code>
* $connection->distinct('posts.id', 'posts.created_at DESC')
* </code>
*
* @param string $columns A column list.
* @param string $orderBy An ORDER clause.
*
* @return string The generated DISTINCT clause.
*/
public function distinct($columns, $orderBy = null)
{
return 'DISTINCT ' . $columns;
}
/**
* Adds an ORDER BY clause to an existing query.
*
* @param string $sql An SQL query to manipulate.
* @param array $options Options:
* - order: Order column an direction.
*
* @return string The manipulated SQL query.
*/
public function addOrderByForAssocLimiting($sql, $options)
{
return $sql . 'ORDER BY ' . $options['order'];
}
/**
* Generates an INTERVAL clause for SELECT queries.
*
* @deprecated since version 1.2.0. This function does not work with SQLite
* as a backend so you should avoid using it. Use "modifyDate()" instead.
*
* @param string $interval The interval.
* @param string $precision The precision.
*
* @return string The generated INTERVAL clause.
*/
public function interval($interval, $precision)
{
return 'INTERVAL ' . $precision . ' ' . $interval;
}
/**
* Generates a modified date for SELECT queries.
*
* @param string $reference The reference date - this is a column
* referenced in the SELECT.
* @param string $operator Add or subtract time? (+/-)
* @param integer $amount The shift amount (number of days if $interval
* is DAY, etc).
* @param string $interval The interval (SECOND, MINUTE, HOUR, DAY,
* MONTH, YEAR).
*
* @return string The generated INTERVAL clause.
*/
public function modifyDate($reference, $operator, $amount, $interval)
{
if (!is_int($amount)) {
throw new InvalidArgumentException('$amount parameter must be an integer');
}
return sprintf('%s %s INTERVAL \'%s\' %s',
$reference,
$operator,
$amount,
$interval);
}
/**
* Returns an expression using the specified operator.
*
* @param string $lhs The column or expression to test.
* @param string $op The operator.
* @param string $rhs The comparison value.
* @param boolean $bind If true, the method returns the query and a list
* of values suitable for binding as an array.
* @param array $params Any additional parameters for the operator.
*
* @return string|array The SQL test fragment, or an array containing the
* query and a list of values if $bind is true.
*/
public function buildClause($lhs, $op, $rhs, $bind = false,
$params = array())
{
$lhs = $this->_escapePrepare($lhs);
switch ($op) {
case '|':
case '&':
if ($bind) {
return array($lhs . ' ' . $op . ' ?',
array((int)$rhs));
}
return $lhs . ' ' . $op . ' ' . (int)$rhs;
case '~':
if ($bind) {
return array($lhs . ' ' . $op . ' ?', array($rhs));
}
return $lhs . ' ' . $op . ' ' . $rhs;
case 'IN':
if ($bind) {
if (is_array($rhs)) {
return array($lhs . ' IN (?' . str_repeat(', ?', count($rhs) - 1) . ')', $rhs);
}
/* We need to bind each member of the IN clause separately to
* ensure proper quoting. */
if (substr($rhs, 0, 1) == '(') {
$rhs = substr($rhs, 1);
}
if (substr($rhs, -1) == ')') {
$rhs = substr($rhs, 0, -1);
}
$ids = preg_split('/\s*,\s*/', $rhs);
return array($lhs . ' IN (?' . str_repeat(', ?', count($ids) - 1) . ')', $ids);
}
if (is_array($rhs)) {
return $lhs . ' IN ' . implode(', ', $rhs);
}
return $lhs . ' IN ' . $rhs;
case 'LIKE':
$query = 'LOWER(%s) LIKE LOWER(%s)';
if ($bind) {
if (empty($params['begin'])) {
return array(sprintf($query, $lhs, '?'),
array('%' . $rhs . '%'));
}
return array(sprintf('(' . $query . ' OR ' . $query . ')',
$lhs, '?', $lhs, '?'),
array($rhs . '%', '% ' . $rhs . '%'));
}
if (empty($params['begin'])) {
return sprintf($query,
$lhs,
$this->_escapePrepare($this->quote('%' . $rhs . '%')));
}
return sprintf('(' . $query . ' OR ' . $query . ')',
$lhs,
$this->_escapePrepare($this->quote($rhs . '%')),
$lhs,
$this->_escapePrepare($this->quote('% ' . $rhs . '%')));
default:
if ($bind) {
return array($lhs . ' ' . $this->_escapePrepare($op) . ' ?', array($rhs));
}
return $lhs . ' ' . $this->_escapePrepare($op . ' ' . $this->quote($rhs));
}
}
/**
* Escapes all characters in a string that are placeholders for
* prepare/execute methods.
*
* @param string $query A string to escape.
*
* @return string The correctly escaped string.
*/
protected function _escapePrepare($query)
{
return preg_replace('/[?!&]/', '\\\\$0', $query);
}
/*##########################################################################
# Protected
##########################################################################*/
/**
* Clears the cache for tables when altering them.
*
* @param string $tableName A table name.
*/
protected function _clearTableCache($tableName)
{
$this->cacheWrite('tables/columns/' . $tableName, '');
$this->cacheWrite('tables/indexes/' . $tableName, '');
}
}
|