Function DatabaseDriver->drop_index__sql
Definitions
sources/database.php
- Get SQL for deleting a table index.
- Visibility: public
- Is abstract?: Yes
- Is static?: No
- Is final?: No
- Returns: string
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $table_name | ID_TEXT | No | No | required parameter | N/A | N/A | The name of the table the index is on |
| $index_name | ID_TEXT | No | No | required parameter | N/A | N/A | The index name |
Returns
- SQL query to run (null: not supported)
- Type: ?string
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get SQL for deleting a table index.
*
* @param ID_TEXT $table_name The name of the table the index is on
* @param ID_TEXT $index_name The index name
* @return ?string SQL query to run (null: not supported)
*/
abstract public function drop_index__sql(string $table_name, string $index_name) : ?string
* Get SQL for deleting a table index.
*
* @param ID_TEXT $table_name The name of the table the index is on
* @param ID_TEXT $index_name The index name
* @return ?string SQL query to run (null: not supported)
*/
abstract public function drop_index__sql(string $table_name, string $index_name) : ?string