Gitee
\

\CI_DB_sqlite_forge

SQLite Forge Class

Summary

Methods
Properties
Constants
__construct()
create_database()
drop_database()
add_key()
add_field()
create_table()
drop_table()
rename_table()
add_column()
drop_column()
modify_column()
$fields
$keys
$primary_keys
$db_char_set
No constants found
_create_table()
_create_table_attr()
_drop_table()
_alter_table()
_process_fields()
_process_column()
_attr_type()
_attr_unsigned()
_attr_default()
_attr_unique()
_attr_auto_increment()
_process_primary_keys()
_process_indexes()
_reset()
$db
$_create_database
$_drop_database
$_create_table
$_create_table_if
$_create_table_keys
$_drop_table_if
$_rename_table
$_unsigned
$_null
$_default
N/A
No private methods found
No private properties found
N/A

Properties

$fields

$fields : array

Fields data

Type

array

$keys

$keys : array

Keys data

Type

array

$primary_keys

$primary_keys : array

Primary Keys data

Type

array

$db_char_set

$db_char_set : string

Database character set

Type

string

$db

$db : object

Database object

Type

object

$_create_database

$_create_database : string

CREATE DATABASE statement

Type

string

$_drop_database

$_drop_database : string

DROP DATABASE statement

Type

string

$_create_table

$_create_table : string

CREATE TABLE statement

Type

string

$_create_table_if

$_create_table_if : string

CREATE TABLE IF statement

Type

string

$_create_table_keys

$_create_table_keys : boolean

CREATE TABLE keys flag

Whether table keys are created from within the CREATE TABLE statement.

Type

boolean

$_drop_table_if

$_drop_table_if : string

DROP TABLE IF EXISTS statement

Type

string

$_rename_table

$_rename_table : string

RENAME TABLE statement

Type

string

$_unsigned

$_unsigned : boolean|array

UNSIGNED support

Type

boolean|array

$_null

$_null : string

NULL value representation in CREATE/ALTER TABLE statements

Type

string

$_default

$_default : string

DEFAULT value representation in CREATE/ALTER TABLE statements

Type

string

Methods

__construct()

__construct(  $db) : void

Class constructor

Parameters

$db

create_database()

create_database(string  $db_name) : boolean

Create database

Parameters

string $db_name

(ignored)

Returns

boolean

drop_database()

drop_database(string  $db_name) : boolean

Drop database

Parameters

string $db_name

(ignored)

Returns

boolean

add_key()

add_key(string  $key, boolean  $primary = FALSE) : \CI_DB_forge

Add Key

Parameters

string $key
boolean $primary

Returns

\CI_DB_forge

add_field()

add_field(array  $field) : \CI_DB_forge

Add Field

Parameters

array $field

Returns

\CI_DB_forge

create_table()

create_table(string  $table, boolean  $if_not_exists = FALSE, array  $attributes = array()) : boolean

Create Table

Parameters

string $table

Table name
boolean $if_not_exists

Whether to add IF NOT EXISTS condition
array $attributes

Associative array of table attributes

Returns

boolean

drop_table()

drop_table(string  $table_name, boolean  $if_exists = FALSE) : boolean

Drop Table

Parameters

string $table_name

Table name
boolean $if_exists

Whether to add an IF EXISTS condition

Returns

boolean

rename_table()

rename_table(string  $table_name, string  $new_table_name) : boolean

Rename Table

Parameters

string $table_name

Old table name
string $new_table_name

New table name

Returns

boolean

add_column()

add_column(string  $table, array  $field, string  $_after = NULL) : boolean

Column Add

Parameters

string $table

Table name
array $field

Column definition
string $_after

Column for AFTER clause (deprecated)

Returns

boolean

drop_column()

drop_column(string  $table, string  $column_name) : boolean

Column Drop

Parameters

string $table

Table name
string $column_name

Column name

Returns

boolean

modify_column()

modify_column(string  $table, string  $field) : boolean

Column Modify

Parameters

string $table

Table name
string $field

Column definition

Returns

boolean

_create_table()

_create_table(string  $table, boolean  $if_not_exists, array  $attributes) : mixed

Create Table

Parameters

string $table

Table name
boolean $if_not_exists

Whether to add 'IF NOT EXISTS' condition
array $attributes

Associative array of table attributes

Returns

mixed

_create_table_attr()

_create_table_attr(array  $attributes) : string

CREATE TABLE attributes

Parameters

array $attributes

Associative array of table attributes

Returns

string

_drop_table()

_drop_table(string  $table, boolean  $if_exists) : string

Drop Table

Generates a platform-specific DROP TABLE string

Parameters

string $table

Table name
boolean $if_exists

Whether to add an IF EXISTS condition

Returns

string

_alter_table()

_alter_table(string  $alter_type, string  $table, mixed  $field) : string|array<mixed,string>

ALTER TABLE

Parameters

string $alter_type

ALTER type
string $table

Table name
mixed $field

Column definition

Returns

string|array<mixed,string>

_process_fields()

_process_fields(boolean  $create_table = FALSE) : array

Process fields

Parameters

boolean $create_table

Returns

array

_process_column()

_process_column(array  $field) : string

Process column

Parameters

array $field

Returns

string

_attr_type()

_attr_type(  $attributes) : void

Field attribute TYPE

Performs a data type mapping between different databases.

Parameters

$attributes

_attr_unsigned()

_attr_unsigned(  $attributes,   $field) : void

Field attribute UNSIGNED

Depending on the _unsigned property value:

  • TRUE will always set $field['unsigned'] to 'UNSIGNED'
  • FALSE will always set $field['unsigned'] to ''
  • array(TYPE) will set $field['unsigned'] to 'UNSIGNED', if $attributes['TYPE'] is found in the array
  • array(TYPE => UTYPE) will change $field['type'], from TYPE to UTYPE in case of a match

Parameters

$attributes
$field

_attr_default()

_attr_default(  $attributes,   $field) : void

Field attribute DEFAULT

Parameters

$attributes
$field

_attr_unique()

_attr_unique(  $attributes,   $field) : void

Field attribute UNIQUE

Parameters

$attributes
$field

_attr_auto_increment()

_attr_auto_increment(  $attributes,   $field) : void

Field attribute AUTO_INCREMENT

Parameters

$attributes
$field

_process_primary_keys()

_process_primary_keys(string  $table) : string

Process primary keys

Parameters

string $table

Table name

Returns

string

_process_indexes()

_process_indexes(string  $table) : string

Process indexes

Parameters

string $table

Returns

string

_reset()

_reset() : void

Reset

Resets table creation vars