b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (CVS HEAD) [ class tree: install ] [ index: install ] [ all elements ]

Procedural File: _functions_evoupgrade.php

Source Location: /blogs/install/_functions_evoupgrade.php

Page Details

This file implements upgrading of DB tables

b2evolution - http://b2evolution.net/ Released under GNU GPL License - http://b2evolution.net/about/license.html

Copyright:  

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

Filesource:  Source Code for this file
Functions
convert_lang_to_locale  [line 160]

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 124]

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 142]

void db_add_index( $table, $name, $def, [ $type = 'INDEX']  )

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

Parameters:
   $table: 
   $name: 
   $def: 
   $type: 


[ Top ]
db_cols_exist  [line 91]

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 108]

void db_drop_col( $table, $col_name  )

Drops a column, if it exists.

Parameters:
   $table: 
   $col_name: 


[ Top ]
db_index_exists  [line 67]

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 30]

void set_upgrade_checkpoint( string $version  )

Create a DB version checkpoint

This is useful when the next operation might timeout or fail! The checkpoint will allow to restart the script and continue where it stopped

Parameters:
string   $version:  version of DB at checkpoint


[ Top ]
upgrade_b2evo_tables  [line 223]

void upgrade_b2evo_tables( )

upgrade_b2evo_tables(-)



[ Top ]


Documentation generated on Sat, 06 Mar 2010 04:10:56 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).