diff options
Diffstat (limited to 'sql/mysql_priv.h')
| -rw-r--r-- | sql/mysql_priv.h | 90 |
1 files changed, 44 insertions, 46 deletions
diff --git a/sql/mysql_priv.h b/sql/mysql_priv.h index cafb7487e35..15f76c4577b 100644 --- a/sql/mysql_priv.h +++ b/sql/mysql_priv.h @@ -13,10 +13,13 @@ along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -/* +/** + @file + + @details Mostly this file is used in the server. But a little part of it is used in mysqlbinlog too (definition of SELECT_DISTINCT and others). - The consequence is that 90% of the file is wrapped in #ifndef MYSQL_CLIENT, + The consequence is that 90% of the file is wrapped in \#ifndef MYSQL_CLIENT, except the part which must be in the server and in the client. */ @@ -253,12 +256,12 @@ protected: Feel free to raise this by the smallest amount you can to get the "execution_constants" test to pass. */ -#define STACK_MIN_SIZE 12000 // Abort if less stack during eval. +#define STACK_MIN_SIZE 12000 ///< Abort if less stack during eval. #define STACK_MIN_SIZE_FOR_OPEN 1024*80 -#define STACK_BUFF_ALLOC 352 // For stack overrun checks +#define STACK_BUFF_ALLOC 352 ///< For stack overrun checks #ifndef MYSQLD_NET_RETRY_COUNT -#define MYSQLD_NET_RETRY_COUNT 10 // Abort read after this many int. +#define MYSQLD_NET_RETRY_COUNT 10 ///< Abort read after this many int. #endif #define TEMP_POOL_SIZE 128 @@ -282,14 +285,14 @@ protected: #define MIN_ROWS_TO_USE_TABLE_CACHE 100 #define MIN_ROWS_TO_USE_BULK_INSERT 100 -/* +/** The following is used to decide if MySQL should use table scanning instead of reading with keys. The number says how many evaluation of the WHERE clause is comparable to reading one extra row from a table. */ #define TIME_FOR_COMPARE 5 // 5 compares == one read -/* +/** Number of comparisons of table rowids equivalent to reading one row from a table. */ @@ -309,17 +312,17 @@ protected: #define DISK_SEEK_PROP_COST ((double)0.5/BLOCKS_IN_AVG_SEEK) -/* +/** Number of rows in a reference table when refereed through a not unique key. This value is only used when we don't know anything about the key distribution. */ #define MATCHING_ROWS_IN_OTHER_TABLE 10 -/* Don't pack string keys shorter than this (if PACK_KEYS=1 isn't used) */ +/** Don't pack string keys shorter than this (if PACK_KEYS=1 isn't used). */ #define KEY_DEFAULT_PACK_LENGTH 8 -/* Characters shown for the command in 'show processlist' */ +/** Characters shown for the command in 'show processlist'. */ #define PROCESS_LIST_WIDTH 100 /* Characters shown for the command in 'information_schema.processlist' */ #define PROCESS_LIST_INFO_WIDTH 65535 @@ -335,11 +338,11 @@ protected: /* The following can also be changed from the command line */ #define DEFAULT_CONCURRENCY 10 -#define DELAYED_LIMIT 100 /* pause after xxx inserts */ +#define DELAYED_LIMIT 100 /**< pause after xxx inserts */ #define DELAYED_QUEUE_SIZE 1000 -#define DELAYED_WAIT_TIMEOUT 5*60 /* Wait for delayed insert */ -#define FLUSH_TIME 0 /* Don't flush tables */ -#define MAX_CONNECT_ERRORS 10 // errors before disabling host +#define DELAYED_WAIT_TIMEOUT 5*60 /**< Wait for delayed insert */ +#define FLUSH_TIME 0 /**< Don't flush tables */ +#define MAX_CONNECT_ERRORS 10 ///< errors before disabling host #ifdef __NETWARE__ #define IF_NETWARE(A,B) A @@ -349,7 +352,7 @@ protected: #if defined(__WIN__) #undef FLUSH_TIME -#define FLUSH_TIME 1800 /* Flush every half hour */ +#define FLUSH_TIME 1800 /**< Flush every half hour */ #define INTERRUPT_PRIOR -2 #define CONNECT_PRIOR -1 @@ -368,12 +371,12 @@ protected: #define TEST_MIT_THREAD 4 #define TEST_BLOCKING 8 #define TEST_KEEP_TMP_TABLES 16 -#define TEST_READCHECK 64 /* Force use of readcheck */ +#define TEST_READCHECK 64 /**< Force use of readcheck */ #define TEST_NO_EXTRA 128 -#define TEST_CORE_ON_SIGNAL 256 /* Give core if signal */ +#define TEST_CORE_ON_SIGNAL 256 /**< Give core if signal */ #define TEST_NO_STACKTRACE 512 -#define TEST_SIGINT 1024 /* Allow sigint on threads */ -#define TEST_SYNCHRONIZATION 2048 /* get server to do sleep in +#define TEST_SIGINT 1024 /**< Allow sigint on threads */ +#define TEST_SYNCHRONIZATION 2048 /**< get server to do sleep in some places */ #endif @@ -423,26 +426,26 @@ protected: /* The following is used to detect a conflict with DISTINCT */ #define SELECT_ALL (ULL(1) << 24) // SELECT, user, parser -/* The following can be set when importing tables in a 'wrong order' +/** The following can be set when importing tables in a 'wrong order' to suppress foreign key checks */ #define OPTION_NO_FOREIGN_KEY_CHECKS (ULL(1) << 26) // THD, user, binlog -/* The following speeds up inserts to InnoDB tables by suppressing unique +/** The following speeds up inserts to InnoDB tables by suppressing unique key checks in some cases */ #define OPTION_RELAXED_UNIQUE_CHECKS (ULL(1) << 27) // THD, user, binlog #define SELECT_NO_UNLOCK (ULL(1) << 28) // SELECT, intern #define OPTION_SCHEMA_TABLE (ULL(1) << 29) // SELECT, intern -/* Flag set if setup_tables already done */ +/** Flag set if setup_tables already done */ #define OPTION_SETUP_TABLES_DONE (ULL(1) << 30) // intern -/* If not set then the thread will ignore all warnings with level notes. */ +/** If not set then the thread will ignore all warnings with level notes. */ #define OPTION_SQL_NOTES (ULL(1) << 31) // THD, user -/* +/** Force the used temporary table to be a MyISAM table (because we will use fulltext functions when reading from it. */ #define TMP_TABLE_FORCE_MYISAM (ULL(1) << 32) -/* +/** Maximum length of time zone name that we support (Time zone name is char(64) in db). mysqlbinlog needs it. */ @@ -505,9 +508,9 @@ protected: #define UNCACHEABLE_DEPENDENT 1 #define UNCACHEABLE_RAND 2 #define UNCACHEABLE_SIDEEFFECT 4 -// forcing to save JOIN for explain +/// forcing to save JOIN for explain #define UNCACHEABLE_EXPLAIN 8 -/* Don't evaluate subqueries in prepare even if they're not correlated */ +/** Don't evaluate subqueries in prepare even if they're not correlated */ #define UNCACHEABLE_PREPARE 16 /* For uncorrelated SELECT in an UNION with some correlated SELECTs */ #define UNCACHEABLE_UNITED 32 @@ -515,7 +518,7 @@ protected: /* Used to check GROUP BY list in the MODE_ONLY_FULL_GROUP_BY mode */ #define UNDEF_POS (-1) #ifdef EXTRA_DEBUG -/* +/** Sync points allow us to force the server to reach a certain line of code and block there until the client tells the server it is ok to go on. The client tells the server to block with SELECT GET_LOCK() @@ -551,7 +554,7 @@ void view_store_options(THD *thd, TABLE_LIST *table, String *buff); #define portable_sizeof_char_ptr 8 -#define tmp_file_prefix "#sql" /* Prefix for tmp tables */ +#define tmp_file_prefix "#sql" /**< Prefix for tmp tables */ #define tmp_file_prefix_length 4 /* Flags for calc_week() function. */ @@ -586,9 +589,9 @@ enum enum_check_fields CHECK_FIELD_WARN, CHECK_FIELD_ERROR_FOR_NULL }; - -/* Struct to handle simple linked lists */ + +/** Struct to handle simple linked lists. */ typedef struct st_sql_list { uint elements; uchar *first; @@ -2209,16 +2212,15 @@ Item * all_any_subquery_creator(Item *left_expr, bool all, SELECT_LEX *select_lex); -/* - clean/setup table fields and map +/** + clean/setup table fields and map. - SYNOPSYS - setup_table_map() - table - TABLE structure pointer (which should be setup) - table_list TABLE_LIST structure pointer (owner of TABLE) - tablenr - table number + @param table TABLE structure pointer (which should be setup) + @param table_list TABLE_LIST structure pointer (owner of TABLE) + @param tablenr table number */ + inline void setup_table_map(TABLE *table, TABLE_LIST *table_list, uint tablenr) { table->used_fields= 0; @@ -2240,10 +2242,8 @@ inline void setup_table_map(TABLE *table, TABLE_LIST *table_list, uint tablenr) } -/* - SYNOPSYS - hexchar_to_int() - convert a hex digit into number +/** + convert a hex digit into number. */ inline int hexchar_to_int(char c) @@ -2256,11 +2256,9 @@ inline int hexchar_to_int(char c) return -1; } -/* - is_user_table() - return true if the table was created explicitly +/** + return true if the table was created explicitly. */ - inline bool is_user_table(TABLE * table) { const char *name= table->s->table_name.str; |