Query/apiDocumentation/files/src/Drivers/Sqlite/SQL.php.txt

171 lines
3.1 KiB
Plaintext
Raw Normal View History

2023-01-20 11:30:51 -05:00
<?php declare(strict_types=1);
/**
* Query
*
* SQL Query Builder / Database Abstraction Layer
*
* PHP version 8.1
*
* @package Query
* @author Timothy J. Warren <tim@timshome.page>
* @copyright 2012 - 2023 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link https://git.timshomepage.net/aviat/Query
* @version 4.0.0
*/
2023-03-17 16:28:07 -04:00
2023-01-20 11:30:51 -05:00
namespace Query\Drivers\Sqlite;
use Query\Drivers\AbstractSQL;
use Query\Exception\NotImplementedException;
/**
* SQLite Specific SQL
*/
2023-03-17 16:28:07 -04:00
class SQL extends AbstractSQL
{
2023-01-20 11:30:51 -05:00
/**
* Get the query plan for the sql query
*/
public function explain(string $sql): string
{
return "EXPLAIN QUERY PLAN {$sql}";
}
/**
* Random ordering keyword
*/
public function random(): string
{
return ' RANDOM()';
}
/**
* Returns sql to list other databases. Meaningless for SQLite, as this
* just returns the database(s) that we are currently connected to.
*/
public function dbList(): string
{
return '';
}
/**
* Returns sql to list tables
*/
public function tableList(): string
{
2023-03-17 16:28:07 -04:00
return <<<'SQL'
2023-01-20 11:30:51 -05:00
SELECT "name" FROM (
SELECT * FROM "sqlite_master" UNION ALL
SELECT * FROM "sqlite_temp_master"
)
WHERE "type"='table'
AND "name" NOT LIKE "sqlite_%"
ORDER BY "name"
SQL;
}
/**
* List the system tables
*
* @return string[]
*/
public function systemTableList(): array
{
return [
'sqlite_master',
'sqlite_temp_master',
2023-03-17 16:28:07 -04:00
'sqlite_sequence',
2023-01-20 11:30:51 -05:00
];
}
/**
* Returns sql to list views
*/
public function viewList(): string
{
2023-03-17 16:28:07 -04:00
return <<<'SQL'
2023-01-20 11:30:51 -05:00
SELECT "name" FROM "sqlite_master" WHERE "type" = 'view'
SQL;
}
/**
* Returns sql to list triggers
*/
public function triggerList(): string
{
2023-03-17 16:28:07 -04:00
return <<<'SQL'
2023-01-20 11:30:51 -05:00
SELECT "name" FROM "sqlite_master" WHERE "type"='trigger'
SQL;
}
/**
* Return sql to list functions
*
* @throws NotImplementedException
*/
public function functionList(): string
{
throw new NotImplementedException('Functionality does not exist in SQLite');
}
/**
* Return sql to list stored procedures
*
* @throws NotImplementedException
*/
public function procedureList(): string
{
throw new NotImplementedException('Functionality does not exist in SQLite');
}
/**
* Return sql to list sequences
*/
public function sequenceList(): string
{
return 'SELECT "name" FROM "sqlite_sequence"';
}
/**
* SQL to show list of field types
*
* @return string[]
*/
public function typeList(): array
{
return ['INTEGER', 'REAL', 'TEXT', 'BLOB', 'NULL'];
}
/**
* SQL to show information about columns in a table
*/
public function columnList(string $table): string
{
return <<<SQL
PRAGMA table_info("{$table}")
SQL;
}
/**
* Get the list of foreign keys for the current
* table
*/
public function fkList(string $table): string
{
return <<<SQL
PRAGMA foreign_key_list("{$table}")
SQL;
}
/**
* Get the list of indexes for the current table
*/
public function indexList(string $table): string
{
return <<<SQL
PRAGMA index_list("{$table}")
SQL;
}
2023-03-17 16:28:07 -04:00
}