phpDocumentor pond
[ class tree: pond ] [ index: pond ] [ all elements ]

Procedural File: _functions_dbupgrade.php

Source Location: /qp_install/_functions_dbupgrade.php

Page Details

This file implements upgrading of DB tables

Quam Plures - http://quamplures.net/ Released under GNU GPL License - http://quamplures.net/license.html

Copyright:  

(c)2003-2009 by Francois PLANQUE - http://fplanque.net/

Copyright:  (c) 2009 - 2011 by the Quam Plures developers - http://quamplures.net/
Filesource:  Source Code for this file
Functions
convert_lang_to_locale  [line 29]

void convert_lang_to_locale( string $table, string $columnlang, string $columnID  )

Converts languages in a given table into according locales

Parameters:
string   $table:  name of the table
string   $columnlang:  name of the column where lang is stored
string   $columnID:  name of the table's ID column


[ Top ]
db_add_col  [line 95]

boolean db_add_col( $table, $col_name, $col_desc  )

Add a column, if it does not already exist.

If it exists already, a "ALTER TABLE" statement will get executed instead.

Parameters:
   $table: 
   $col_name: 
   $col_desc: 

API Tags:
Return:  True if the column has been added, False if not.


[ Top ]
db_add_index  [line 113]

void db_add_index( $table, $name, $def  )

Add an INDEX. If another index with the same name already exists, it will get dropped before.

Parameters:
   $table: 
   $name: 
   $def: 


[ Top ]
db_cols_exist  [line 129]

boolean db_cols_exist( string $table, array $col_names  )
Parameters:
string   $table:  Table name
array   $col_names:  Column names

API Tags:
Return:  Does a list of given column names exist in DB?


[ Top ]
db_drop_col  [line 146]

void db_drop_col( $table, $col_name  )

Drops a column, if it exists.

Parameters:
   $table: 
   $col_name: 


[ Top ]
db_index_exists  [line 160]

boolean db_index_exists( $table, $index_name  )
Parameters:
   $table: 
   $index_name: 

API Tags:
Return:  Does a given index key name exist in DB?


[ Top ]
set_upgrade_checkpoint  [line 187]

void set_upgrade_checkpoint( string $version  )

Create a DB version checkpoint

This increments table.db_upgrade during an upgrade cycle. It starts matching table.db_version and end matching $app_db_version. If the upgrader crashes this value lets us pick up exactly where we left off :)

Parameters:
string   $version:  version of DB at checkpoint


[ Top ]
upgrade_dbase_tables  [line 212]

void upgrade_dbase_tables( )

Upgrade database tables

This is a process. Life is a process. Therefore this is life.



[ Top ]