Jelix 1.6.37

sqliteDbTools extends jDbTools
in package

tools to manage a sqlite database

Tags
subpackage

db_driver

Table of Contents

IBD_EMPTY_TABLE_BEFORE  = 1
IBD_IGNORE_IF_EXIST  = 3
IBD_INSERT_ONLY_IF_TABLE_IS_EMPTY  = 2
IBD_NO_CHECK  = 0
IBD_UPDATE_IF_EXIST  = 4
$falseValue  : mixed
$trueValue  : mixed
$_conn  : jDbConnection
the database connector
$dbmsStyle  : mixed
regular expression to detect comments and end of query
$functionNameCorrespondence  : mixed
$keywordNameCorrespondence  : mixed
$literalFilterToSubstitions  : mixed
$typesInfo  : mixed
$unifiedToPhp  : mixed
__construct()  : mixed
encloseName()  : string
Enclose the field name
escapeValue()  : string
execSQLScript()  : mixed
getBooleanValue()  : string
getFieldList()  : array<string|int, jDbFieldProperties>
retrieve the list of fields of a table
getNativeSQLFunction()  : string
Give the expression that works with the target database, corresponding to the given function name
getSQLColumnsList()  : string
getTableList()  : array<string|int, string>
returns the list of tables
getTypeInfo()  : array<string|int, mixed>
Get informations about the given SQL type
insertBulkData()  : int
Insert several records into a table
parseCREATETABLE()  : array<string|int, mixed>|bool
Parse a SQL CREATE TABLE statement and returns all of its components separately.
parseSQLFunctionAndConvert()  : mixed
parseSQLType()  : array<string|int, mixed>
Parse a SQL type and gives type, length.
stringToPhpValue()  : string
unifiedToPHPType()  : string
Return the PHP type corresponding to the given unified type
extractDateConverter()  : mixed

Constants

IBD_INSERT_ONLY_IF_TABLE_IS_EMPTY

public mixed IBD_INSERT_ONLY_IF_TABLE_IS_EMPTY = 2

Properties

$dbmsStyle

regular expression to detect comments and end of query

protected mixed $dbmsStyle = array('/^\s*#/', '/;\s*$/')

$functionNameCorrespondence

protected mixed $functionNameCorrespondence = array( // sqlsrv, -> date+time 'sysdatetime' => 'datetime('now', 'localtime')', // sqlsrv, -> date+time+offset 'sysdatetimeoffset' => 'datetime('now', 'localtime')', // sqlsrv, -> date+time at utc 'sysutcdatetime' => 'datetime('now')', // sqlsrv -> date+time 'getdate' => 'datetime('now', 'localtime')', // sqlsrv -> date+time at utc 'getutcdate' => 'strftime('%d', 'now')', // sqlsrv,mysql (datetime)-> integer 'day' => 'strftime('%d', %!p, 'localtime')', // sqlsrv,mysql (datetime)-> integer 'month' => 'strftime('%m', %!p, 'localtime')', // sqlsrv, mysql (datetime)-> integer 'year' => 'strftime('%Y', %!p, 'localtime')', // mysql -> date 'curdate' => 'date('now', 'localtime')', // mysql -> date 'current_date' => 'date('now', 'localtime')', // mysql -> time 'curtime' => 'time('now', 'localtime')', // mysql -> time 'current_time' => 'time('now', 'localtime')', // mysql,pgsql -> date+time 'now' => 'datetime('now', 'localtime')', // mysql date+time 'current_timestamp' => 'date('now', 'localtime')', // mysql (datetime)->date, sqlite (timestring, modifier)->date //'date' => '!dateConverter', // mysql = day() 'dayofmonth' => 'strftime('%d', %!p, 'localtime')', // mysql -> date+time 'localtime' => 'datetime('now', 'localtime')', // mysql -> date+time 'localtimestamp' => 'datetime('now', 'localtime')', // mysql utc current date 'utc_date' => 'date('now')', // mysql utc current time 'utc_time' => 'time('now')', // mysql utc current date+time 'utc_timestamp' => 'datetime('now')', // mysql (datetime)->time, , sqlite (timestring, modifier)->time //'time' => '!timeConverter', // mysql (datetime/time)-> hour 'hour' => 'strftime('%H', %!p, 'localtime')', // mysql (datetime/time)-> minute 'minute' => 'strftime('%M', %!p, 'localtime')', // mysql (datetime/time)-> second 'second' => 'strftime('%S', %!p, 'localtime')', // sqlite (timestring, modifier)->datetime //'datetime' => '', // oci, mysql (year|month|day|hour|minute|second FROM <datetime>)->value , // pgsql (year|month|day|hour|minute|second <datetime>)->value 'extract' => '!extractDateConverter', // pgsql ('year'|'month'|'day'|'hour'|'minute'|'second', <datetime>)->value 'date_part' => '!extractDateConverter', // sqlsrv (year||month|day|hour|minute|second, <datetime>)->value 'datepart' => '!extractDateConverter', )

$keywordNameCorrespondence

protected mixed $keywordNameCorrespondence = array( // sqlsrv,mysql,oci -> date+time, pgsql -> date+time (+tz) 'current_timestamp' => 'datetime('now', 'localtime')', // mysql,oci,pgsql -> date 'current_date' => 'date('now', 'localtime')', // mysql -> time, pgsql -> time+timezone 'current_time' => 'time('now', 'localtime')', // oci -> date+fractional secon + timezone //'systimestamp' => '', // oci -> date+time 'sysdate' => 'datetime('now', 'localtime')', // pgsql -> time 'localtime' => 'time('now', 'localtime')', // pgsql -> date+time 'localtimestamp' => 'datetime('now', 'localtime')', )

$literalFilterToSubstitions

protected mixed $literalFilterToSubstitions = array('year' => '%Y', 'month' => '%m', 'day' => '%d', 'hour' => '%H', 'minute' => '%M', 'seconde' => '%S')

$typesInfo

protected mixed $typesInfo = array( // type native type unified type minvalue maxvalue minlength maxlength 'bool' => array('integer', 'boolean', 0, 1, ull, ull), 'boolean' => array('integer', 'boolean', 0, 1, ull, ull), 'bit' => array('integer', 'integer', 0, 1, ull, ull), 'tinyint' => array('integer', 'integer', -128, 127, ull, ull), 'smallint' => array('integer', 'integer', -32768, 32767, ull, ull), 'mediumint' => array('integer', 'integer', -8388608, 8388607, ull, ull), 'integer' => array('integer', 'integer', -2147483648, 2147483647, ull, ull), 'int' => array('integer', 'integer', -2147483648, 2147483647, ull, ull), 'bigint' => array('numeric', 'numeric', '-9223372036854775808', '9223372036854775807', ull, ull), 'serial' => array('numeric', 'numeric', '-9223372036854775808', '9223372036854775807', ull, ull), 'bigserial' => array('numeric', 'numeric', '-9223372036854775808', '9223372036854775807', ull, ull), 'autoincrement' => array('integer', 'integer', -2147483648, 2147483647, ull, ull), // for old dao files 'bigautoincrement' => array('numeric', 'numeric', '-9223372036854775808', '9223372036854775807', ull, ull), // for old dao files 'float' => array('float', 'float', ull, ull, ull, ull), //4bytes 'money' => array('real', 'float', ull, ull, ull, ull), //4bytes 'smallmoney' => array('float', 'float', ull, ull, ull, ull), //4bytes 'double precision' => array('double', 'decimal', ull, ull, ull, ull), //8bytes 'double' => array('double', 'decimal', ull, ull, ull, ull), //8bytes 'real' => array('real', 'decimal', ull, ull, ull, ull), //8bytes 'number' => array('real', 'decimal', ull, ull, ull, ull), //8bytes 'binary_float' => array('double', 'float', ull, ull, ull, ull), //4bytes 'binary_double' => array('double', 'decimal', ull, ull, ull, ull), //8bytes 'numeric' => array('numeric', 'numeric', ull, ull, ull, ull), 'decimal' => array('real', 'decimal', ull, ull, ull, ull), 'dec' => array('real', 'decimal', ull, ull, ull, ull), 'date' => array('date', 'date', ull, ull, 10, 10), 'time' => array('time', 'time', ull, ull, 8, 8), 'datetime' => array('datetime', 'datetime', ull, ull, 19, 19), 'datetime2' => array('datetime', 'datetime', ull, ull, 19, 27), // sqlsrv / 9999-12-31 23:59:59.9999999 'datetimeoffset' => array('datetime', 'datetime', ull, ull, 19, 34), // sqlsrv / 9999-12-31 23:59:59.9999999 +14:00 'smalldatetime' => array('datetime', 'datetime', ull, ull, 19, 19), // sqlsrv / 2079-06-06 23:59 'timestamp' => array('datetime', 'datetime', ull, ull, 19, 19), // oracle/pgsql timestamp 'utimestamp' => array('integer', 'integer', 0, 2147483647, ull, ull), // mysql timestamp 'year' => array('integer', 'year', ull, ull, 2, 4), 'interval' => array('datetime', 'datetime', ull, ull, 19, 19), 'char' => array('char', 'char', ull, ull, 0, 255), 'nchar' => array('char', 'char', ull, ull, 0, 255), 'varchar' => array('varchar', 'varchar', ull, ull, 0, 65535), 'varchar2' => array('varchar', 'varchar', ull, ull, 0, 4000), 'nvarchar2' => array('varchar', 'varchar', ull, ull, 0, 4000), 'character' => array('varchar', 'varchar', ull, ull, 0, 65535), 'character varying' => array('varchar', 'varchar', ull, ull, 0, 65535), 'name' => array('varchar', 'varchar', ull, ull, 0, 64), 'longvarchar' => array('varchar', 'varchar', ull, ull, 0, 65535), 'string' => array('varchar', 'varchar', ull, ull, 0, 65535), // for old dao files 'tinytext' => array('text', 'text', ull, ull, 0, 255), 'text' => array('text', 'text', ull, ull, 0, 65535), 'ntext' => array('text', 'text', ull, ull, 0, 0), 'mediumtext' => array('text', 'text', ull, ull, 0, 16777215), 'longtext' => array('text', 'text', ull, ull, 0, 0), 'long' => array('text', 'text', ull, ull, 0, 0), 'clob' => array('text', 'text', ull, ull, 0, 0), 'nclob' => array('text', 'text', ull, ull, 0, 0), 'tinyblob' => array('blob', 'blob', ull, ull, 0, 255), 'blob' => array('blob', 'blob', ull, ull, 0, 65535), 'mediumblob' => array('blob', 'blob', ull, ull, 0, 16777215), 'longblob' => array('blob', 'blob', ull, ull, 0, 0), 'bfile' => array('blob', 'blob', ull, ull, 0, 0), 'bytea' => array('blob', 'varbinary', ull, ull, 0, 0), 'binary' => array('blob', 'binary', ull, ull, 0, 255), 'varbinary' => array('blob', 'varbinary', ull, ull, 0, 255), 'raw' => array('blob', 'varbinary', ull, ull, 0, 2000), 'long raw' => array('blob', 'varbinary', ull, ull, 0, 0), 'image' => array('blob', 'varbinary', ull, ull, 0, 0), 'enum' => array('varchar', 'varchar', ull, ull, 0, 65535), 'set' => array('varchar', 'varchar', ull, ull, 0, 65535), 'xmltype' => array('varchar', 'varchar', ull, ull, 0, 65535), 'xml' => array('text', 'text', ull, ull, 0, 0), 'point' => array('varchar', 'varchar', ull, ull, 0, 16), 'line' => array('varchar', 'varchar', ull, ull, 0, 32), 'lsed' => array('varchar', 'varchar', ull, ull, 0, 32), 'box' => array('varchar', 'varchar', ull, ull, 0, 32), 'path' => array('varchar', 'varchar', ull, ull, 0, 65535), 'polygon' => array('varchar', 'varchar', ull, ull, 0, 65535), 'circle' => array('varchar', 'varchar', ull, ull, 0, 24), 'cidr' => array('varchar', 'varchar', ull, ull, 0, 24), 'inet' => array('varchar', 'varchar', ull, ull, 0, 24), 'macaddr' => array('integer', 'integer', 0, 0xffffffffffff, ull, ull), 'bit varying' => array('varchar', 'varchar', ull, ull, 0, 65535), 'arrays' => array('varchar', 'varchar', ull, ull, 0, 65535), 'complex types' => array('varchar', 'varchar', ull, ull, 0, 65535), )

$unifiedToPhp

protected mixed $unifiedToPhp = array('boolean' => 'boolean', 'integer' => 'integer', 'float' => 'float', 'double' => 'float', 'numeric' => 'numeric', 'decimal' => 'decimal', 'date' => 'string', 'time' => 'string', 'datetime' => 'string', 'year' => 'string', 'char' => 'string', 'varchar' => 'string', 'text' => 'string', 'blob' => 'string', 'binary' => 'string', 'varbinary' => 'string')

Methods

encloseName()

Enclose the field name

public encloseName(string $fieldName) : string
Parameters
$fieldName : string

the field name

Tags
since
1.2
Return values
string

the enclosed field name

escapeValue()

public escapeValue(string $unifiedType, mixed $value[, mixed $checkNull = false ][, mixed $toPhpSource = false ]) : string
Parameters
$unifiedType : string

the unified type name

$value : mixed

the value

$checkNull : mixed = false
$toPhpSource : mixed = false
Tags
since
1.2
Return values
string

the value which is ready to include a SQL query string

execSQLScript()

public execSQLScript(mixed $file) : mixed
Parameters
$file : mixed
Return values
mixed

getBooleanValue()

public getBooleanValue(string|bool $value) : string
Parameters
$value : string|bool

a value which is a boolean

Tags
since
1.2
Return values
string

the string value representing a boolean in SQL

getFieldList()

retrieve the list of fields of a table

public getFieldList(string $tableName[, string $sequence = '' ][, string $schemaName = '' ]) : array<string|int, jDbFieldProperties>
Parameters
$tableName : string

the name of the table

$sequence : string = ''

the sequence used to auto increment the primary key (not supported here)

$schemaName : string = ''

the name of the schema (only for PostgreSQL, not supported here)

Return values
array<string|int, jDbFieldProperties>

keys are field names and values are jDbFieldProperties objects

getNativeSQLFunction()

Give the expression that works with the target database, corresponding to the given function name

public getNativeSQLFunction(string $name[, string|null $parametersString = null ]) : string
Parameters
$name : string

a SQL function, maybe a SQL function of another database type

$parametersString : string|null = null

parameters given to the function. Null if no parenthesis

Return values
string

the SQL expression, possibly with a native SQL function corresponding to the given foreign SQL function

getSQLColumnsList()

public getSQLColumnsList(array<string|int, string> $columns) : string
Parameters
$columns : array<string|int, string>

list of column names

Tags
since
1.6.16
Return values
string

the list in SQL

getTableList()

returns the list of tables

public getTableList() : array<string|int, string>
Tags
throws
jException
Return values
array<string|int, string>

list of table names

getTypeInfo()

Get informations about the given SQL type

public getTypeInfo(string $nativeType) : array<string|int, mixed>
Parameters
$nativeType : string

the SQL type

Tags
since
1.2
Return values
array<string|int, mixed>

an array which contains characteristics of the type array ( 'nativetype', 'corresponding unifiedtype', minvalue, maxvalue, minlength, maxlength, autoincrement) minvalue, maxvalue, minlength, maxlength can be null.

insertBulkData()

Insert several records into a table

public insertBulkData(string $tableName, array<string|int, string> $columns, array<string|int, array<string|int, mixed>> $data[, string|array<string|int, string>|null $primaryKey = null ], int $options) : int
Parameters
$tableName : string
$columns : array<string|int, string>

the column names in which data will be inserted

$data : array<string|int, array<string|int, mixed>>

the data. each row is an array of values. Values are in the same order as $columns

$primaryKey : string|array<string|int, string>|null = null

the column names that are the primary key. Don't give the primary key if it is an autoincrement field, or if option is not IBD_*_IF_EXIST

$options : int

one of IDB_* const

Tags
since
1.6.16
Return values
int

number of records inserted/updated

parseCREATETABLE()

Parse a SQL CREATE TABLE statement and returns all of its components separately.

public parseCREATETABLE( $createTableStatement) : array<string|int, mixed>|bool
Parameters
$createTableStatement :
Tags
since
1.6.16
Return values
array<string|int, mixed>|bool

false if parsing has failed. Else an array : 'name' => the schema/table name, 'temporary'=> true if there is the temporary keywork , 'ifnotexists' => true if there is the IF NOT EXISTS statement, 'columns' => list of columns definitions, 'constraints' => list of table constraints definitions, 'options' => all options at the end of the CREATE TABLE statement.

parseSQLFunctionAndConvert()

public parseSQLFunctionAndConvert(mixed $expression) : mixed
Parameters
$expression : mixed
Return values
mixed

parseSQLType()

Parse a SQL type and gives type, length.

public parseSQLType(string $type) : array<string|int, mixed>

..

Parameters
$type : string
Return values
array<string|int, mixed>

[$realtype, $length, $precision, $scale, $otherTypeDef]

stringToPhpValue()

public stringToPhpValue(string $unifiedType, string $value[, mixed $checkNull = false ]) : string
Parameters
$unifiedType : string

the unified type name

$value : string

the value

$checkNull : mixed = false
Tags
since
1.2
Return values
string

the php value corresponding to the type

unifiedToPHPType()

Return the PHP type corresponding to the given unified type

public unifiedToPHPType(string $unifiedType) : string
Parameters
$unifiedType : string
Tags
throws
Exception
since
1.2
Return values
string

the php type

extractDateConverter()

protected extractDateConverter(mixed $parametersString) : mixed
Parameters
$parametersString : mixed
Return values
mixed

Search results