[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/joomla/database/src/Sqlite/ -> SqliteDriver.php (summary)

Part of the Joomla Framework Database Package

Copyright: Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 551 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SqliteDriver:: (24 methods):
  __destruct()
  alterDbCharacterSet()
  connect()
  createDatabase()
  escape()
  getCollation()
  getConnectionCollation()
  getConnectionEncryption()
  isConnectionEncryptionSupported()
  getTableCreate()
  getTableColumns()
  getTableKeys()
  getTableList()
  getVersion()
  select()
  setUtf()
  lockTable()
  renameTable()
  truncateTable()
  unlockTables()
  isSupported()
  transactionCommit()
  transactionRollback()
  transactionStart()


Class: SqliteDriver  - X-Ref

SQLite database driver supporting PDO based connections

__destruct()   X-Ref
Destructor.


alterDbCharacterSet($dbName)   X-Ref
Alter database's character set.

param: string  $dbName  The database name that will be altered
return: boolean|resource

connect()   X-Ref
Connects to the database if needed.

return: void  Returns void if the database connected successfully.

createDatabase($options, $utf = true)   X-Ref
No description

escape($text, $extra = false)   X-Ref
Method to escape a string for usage in an SQLite statement.

Note: Using query objects with bound variables is preferable to the below.

param: string   $text   The string to be escaped.
param: boolean  $extra  Unused optional parameter to provide extra escaping.
return: string  The escaped string.

getCollation()   X-Ref
Method to get the database collation in use by sampling a text field of a table in the database.

return: string|boolean  The collation in use by the database or boolean false if not supported.

getConnectionCollation()   X-Ref
Method to get the database connection collation in use by sampling a text field of a table in the database.

return: string|boolean  The collation in use by the database connection (string) or boolean false if not supported.

getConnectionEncryption()   X-Ref
Method to get the database encryption details (cipher and protocol) in use.

return: string  The database encryption details.

isConnectionEncryptionSupported()   X-Ref
Method to test if the database TLS connections encryption are supported.

return: boolean  Whether the database supports TLS connections encryption.

getTableCreate($tables)   X-Ref
Shows the table CREATE statement that creates the given tables.

Note: Doesn't appear to have support in SQLite

param: mixed  $tables  A table name or a list of table names.
return: array  A list of the create SQL for the tables.

getTableColumns($table, $typeOnly = true)   X-Ref
Retrieves field information about a given table.

param: string   $table     The name of the database table.
param: boolean  $typeOnly  True to only return field types.
return: array  An array of fields for the database table.

getTableKeys($table)   X-Ref
Get the details list of keys for a table.

param: string  $table  The name of the table.
return: array  An array of the column specification for the table.

getTableList()   X-Ref
Method to get an array of all tables in the database (schema).

return: array   An array of all the tables in the database.

getVersion()   X-Ref
Get the version of the database connector.

return: string  The database connector version.

select($database)   X-Ref
Select a database for use.

param: string  $database  The name of the database to select for use.
return: boolean  True if the database was successfully selected.

setUtf()   X-Ref
Set the connection to use UTF-8 character encoding.

Returns false automatically for the Oracle driver since
you can only set the character set when the connection
is created.

return: boolean  True on success.

lockTable($table)   X-Ref
Locks a table in the database.

param: string  $table  The name of the table to unlock.
return: $this

renameTable($oldTable, $newTable, $backup = null, $prefix = null)   X-Ref
Renames a table in the database.

param: string  $oldTable  The name of the table to be renamed
param: string  $newTable  The new name for the table.
param: string  $backup    Not used by Sqlite.
param: string  $prefix    Not used by Sqlite.
return: $this

truncateTable($table)   X-Ref
Method to truncate a table.

param: string  $table  The table to truncate
return: void

unlockTables()   X-Ref
Unlocks tables in the database.

return: $this

isSupported()   X-Ref
Test to see if the PDO ODBC connector is available.

return: boolean  True on success, false otherwise.

transactionCommit($toSavepoint = false)   X-Ref
Method to commit a transaction.

param: boolean  $toSavepoint  If true, commit to the last savepoint.
return: void

transactionRollback($toSavepoint = false)   X-Ref
Method to roll back a transaction.

param: boolean  $toSavepoint  If true, rollback to the last savepoint.
return: void

transactionStart($asSavepoint = false)   X-Ref
Method to initialize a transaction.

param: boolean  $asSavepoint  If true and a transaction is already active, a savepoint will be created.
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer