MDB2
[ class tree: MDB2 ] [ index: MDB2 ] [ all elements ]

Class: MDB2_Driver_Manager_sqlite

Source Location: /MDB2-2.0.0beta2/MDB2/Driver/Manager/sqlite.php

Class Overview

MDB2_Driver_Manager_Common
   |
   --MDB2_Driver_Manager_sqlite

MDB2 SQLite driver for the management modules


Author(s):

Methods


Inherited Variables

Inherited Methods

Class: MDB2_Driver_Manager_Common

MDB2_Driver_Manager_Common::MDB2_Driver_Manager_Common()
Constructor
MDB2_Driver_Manager_Common::alterTable()
alter an existing table
MDB2_Driver_Manager_Common::createDatabase()
create a new database
MDB2_Driver_Manager_Common::createIndex()
get the stucture of a field into an array
MDB2_Driver_Manager_Common::createSequence()
create sequence
MDB2_Driver_Manager_Common::createTable()
create a new table
MDB2_Driver_Manager_Common::dropDatabase()
drop an existing database
MDB2_Driver_Manager_Common::dropIndex()
drop existing index
MDB2_Driver_Manager_Common::dropSequence()
drop existing sequence
MDB2_Driver_Manager_Common::dropTable()
drop an existing table
MDB2_Driver_Manager_Common::getFieldDeclarationList()
get declaration of a number of field in bulk
MDB2_Driver_Manager_Common::getTableFieldDefinition()
get the stucture of a field into an array
MDB2_Driver_Manager_Common::getTableIndexDefinition()
get the stucture of an index into an array
MDB2_Driver_Manager_Common::listDatabases()
list all databases
MDB2_Driver_Manager_Common::listFunctions()
list all functions in the current database
MDB2_Driver_Manager_Common::listSequences()
list all sequences in the current database
MDB2_Driver_Manager_Common::listTableFields()
list all fields in a tables in the current database
MDB2_Driver_Manager_Common::listTableIndexes()
list all indexes in a table
MDB2_Driver_Manager_Common::listTables()
list all tables in the current database
MDB2_Driver_Manager_Common::listUsers()
list all users
MDB2_Driver_Manager_Common::listViews()
list all views in the current database

Class Details

[line 57]
MDB2 SQLite driver for the management modules


[ Top ]


Method Detail

MDB2_Driver_Manager_sqlite (Constructor)   [line 65]

MDB2_Driver_Manager_sqlite MDB2_Driver_Manager_sqlite( $db_index)

Constructor

Parameters:

   $db_index   — 

[ Top ]

createDatabase   [line 80]

mixed createDatabase( string $name)

create a new database
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::createDatabase() (create a new database)

Parameters:

string   $name   —  name of the database that should be created

[ Top ]

createIndex   [line 348]

mixed createIndex( string $table, string $name, array $definition)

get the stucture of a field into an array
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::createIndex() (get the stucture of a field into an array)

Parameters:

string   $table   —  name of the table on which the index is to be created
string   $name   —  name of the index to be created
array   $definition   — 

associative array that defines properties of the index to be created. Currently, only one property named FIELDS is supported. This property is also an associative with the names of the index fields as array indexes. Each entry of this array is set to another type of associative array that specifies properties of the index that are specific to each field.

Currently, only the sorting property is supported. It should be used to define the sorting direction of the index. It may be set to either ascending or descending.

Not all DBMS support index sorting direction configuration. The DBMS drivers of those that do not support it ignore this property. Use the function support() to determine whether the DBMS driver can manage indexes. Example array( 'fields' => array( 'user_name' => array( 'sorting' => 'ascending' ), 'last_login' => array() ) )


[ Top ]

createSequence   [line 424]

mixed createSequence( string $seq_name, [string $start = 1])

create sequence
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::createSequence() (create sequence)

Parameters:

string   $seq_name   —  name of the sequence to be created
string   $start   —  start value of the sequence; default is 1

[ Top ]

createTable   [line 157]

mixed createTable( string $name, array $fields)

create a new table
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::createTable() (create a new table)

Parameters:

string   $name   —  Name of the database that should be created
array   $fields   — 

Associative array that contains the definition of each field of the new table The indexes of the array entries are the names of the fields of the table an the array entry values are associative arrays like those that are meant to be passed with the field definitions to get[Type]Declaration() functions.

Example array(

'id' => array( 'type' => 'integer', 'unsigned' => 1 'notnull' => 1 'default' => 0 ), 'name' => array( 'type' => 'text', 'length' => 12 ), 'password' => array( 'type' => 'text', 'length' => 12 ) );


[ Top ]

dropDatabase   [line 108]

mixed dropDatabase( string $name)

drop an existing database
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::dropDatabase() (drop an existing database)

Parameters:

string   $name   —  name of the database that should be dropped

[ Top ]

dropIndex   [line 376]

mixed dropIndex( string $table, string $name)

drop existing index
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::dropIndex() (drop existing index)

Parameters:

string   $table   —  name of table that should be used in method
string   $name   —  name of the index to be dropped

[ Top ]

dropSequence   [line 463]

mixed dropSequence( string $seq_name)

drop existing sequence
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::dropSequence() (drop existing sequence)

Parameters:

string   $seq_name   —  name of the sequence to be dropped

[ Top ]

listDatabases   [line 185]

mixed listDatabases( )

list all databases
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::listDatabases() (list all databases)
[ Top ]

listSequences   [line 479]

mixed listSequences( )

list all sequences in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::listSequences() (list all sequences in the current database)
[ Top ]

listTableFields   [line 296]

mixed listTableFields( string $table)

list all fields in a tables in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::listTableFields() (list all fields in a tables in the current database)

Parameters:

string   $table   —  name of table that should be used in method

[ Top ]

listTableIndexes   [line 392]

mixed listTableIndexes( string $table)

list all indexes in a table
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::listTableIndexes() (list all indexes in a table)

Parameters:

string   $table   —  name of table that should be used in method

[ Top ]

listTables   [line 215]

mixed listTables( )

list all tables in the current database
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::listTables() (list all tables in the current database)
[ Top ]

listUsers   [line 200]

mixed listUsers( )

list all users
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Driver_Manager_Common::listUsers() (list all users)
[ Top ]


Documentation generated on Mon, 11 Mar 2019 10:15:56 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.