diff options
Diffstat (limited to 'storage/innobase/include/dict0load.h')
| -rw-r--r-- | storage/innobase/include/dict0load.h | 91 |
1 files changed, 53 insertions, 38 deletions
diff --git a/storage/innobase/include/dict0load.h b/storage/innobase/include/dict0load.h index 7e19c2eb3c0..60b8c1fb632 100644 --- a/storage/innobase/include/dict0load.h +++ b/storage/innobase/include/dict0load.h @@ -1,9 +1,26 @@ -/****************************************************** +/***************************************************************************** + +Copyright (c) 1996, 2009, Innobase Oy. All Rights Reserved. + +This program is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation; version 2 of the License. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program; if not, write to the Free Software Foundation, Inc., 59 Temple +Place, Suite 330, Boston, MA 02111-1307 USA + +*****************************************************************************/ + +/**************************************************//** +@file include/dict0load.h Loads to the memory cache database object definitions from dictionary tables -(c) 1996 Innobase Oy - Created 4/24/1996 Heikki Tuuri *******************************************************/ @@ -13,8 +30,9 @@ Created 4/24/1996 Heikki Tuuri #include "univ.i" #include "dict0types.h" #include "ut0byte.h" +#include "mem0mem.h" -/************************************************************************ +/********************************************************************//** In a crash recovery we already have all the tablespace objects created. This function compares the space id information in the InnoDB data dictionary to what we already read with fil_load_single_table_tablespaces(). @@ -22,72 +40,69 @@ to what we already read with fil_load_single_table_tablespaces(). In a normal startup, we create the tablespace objects for every table in InnoDB's data dictionary, if the corresponding .ibd file exists. We also scan the biggest space id, and store it to fil_system. */ - +UNIV_INTERN void dict_check_tablespaces_and_store_max_id( /*====================================*/ - ibool in_crash_recovery); /* in: are we doing a crash recovery */ -/************************************************************************ -Finds the first table name in the given database. */ - + ibool in_crash_recovery); /*!< in: are we doing a crash recovery */ +/********************************************************************//** +Finds the first table name in the given database. +@return own: table name, NULL if does not exist; the caller must free +the memory in the string! */ +UNIV_INTERN char* dict_get_first_table_name_in_db( /*============================*/ - /* out, own: table name, NULL if - does not exist; the caller must free - the memory in the string! */ - const char* name); /* in: database name which ends to '/' */ -/************************************************************************ + const char* name); /*!< in: database name which ends to '/' */ +/********************************************************************//** Loads a table definition and also all its index definitions, and also the cluster definition if the table is a member in a cluster. Also loads all foreign key constraints where the foreign key is in the table or where -a foreign key references columns in this table. */ - +a foreign key references columns in this table. +@return table, NULL if does not exist; if the table is stored in an +.ibd file, but the file does not exist, then we set the +ibd_file_missing flag TRUE in the table object we return */ +UNIV_INTERN dict_table_t* dict_load_table( /*============*/ - /* out: table, NULL if does not exist; - if the table is stored in an .ibd file, - but the file does not exist, - then we set the ibd_file_missing flag TRUE - in the table object we return */ - const char* name); /* in: table name in the + const char* name); /*!< in: table name in the databasename/tablename format */ -/*************************************************************************** -Loads a table object based on the table id. */ - +/***********************************************************************//** +Loads a table object based on the table id. +@return table; NULL if table does not exist */ +UNIV_INTERN dict_table_t* dict_load_table_on_id( /*==================*/ - /* out: table; NULL if table does not exist */ - dulint table_id); /* in: table id */ -/************************************************************************ + dulint table_id); /*!< in: table id */ +/********************************************************************//** This function is called when the database is booted. Loads system table index definitions except for the clustered index which is added to the dictionary cache at booting before calling this function. */ - +UNIV_INTERN void dict_load_sys_table( /*================*/ - dict_table_t* table); /* in: system table */ -/*************************************************************************** + dict_table_t* table); /*!< in: system table */ +/***********************************************************************//** Loads foreign key constraints where the table is either the foreign key holder or where the table is referenced by a foreign key. Adds these constraints to the data dictionary. Note that we know that the dictionary cache already contains all constraints where the other relevant table is -already in the dictionary cache. */ - +already in the dictionary cache. +@return DB_SUCCESS or error code */ +UNIV_INTERN ulint dict_load_foreigns( /*===============*/ - /* out: DB_SUCCESS or error code */ - const char* table_name, /* in: table name */ - ibool check_charsets);/* in: TRUE=check charsets + const char* table_name, /*!< in: table name */ + ibool check_charsets);/*!< in: TRUE=check charsets compatibility */ -/************************************************************************ +/********************************************************************//** Prints to the standard output information on all tables found in the data dictionary system table. */ - +UNIV_INTERN void dict_print(void); /*============*/ |