dict0dict.h
上传用户:romrleung
上传日期:2022-05-23
资源大小:18897k
文件大小:33k
源码类别:

MySQL数据库

开发平台:

Visual C++

  1. /******************************************************
  2. Data dictionary system
  3. (c) 1996 Innobase Oy
  4. Created 1/8/1996 Heikki Tuuri
  5. *******************************************************/
  6. #ifndef dict0dict_h
  7. #define dict0dict_h
  8. #include "univ.i"
  9. #include "dict0types.h"
  10. #include "dict0mem.h"
  11. #include "data0type.h"
  12. #include "data0data.h"
  13. #include "sync0sync.h"
  14. #include "sync0rw.h"
  15. #include "mem0mem.h"
  16. #include "rem0types.h"
  17. #include "btr0types.h"
  18. #include "ut0mem.h"
  19. #include "ut0lst.h"
  20. #include "hash0hash.h"
  21. #include "ut0rnd.h"
  22. #include "ut0byte.h"
  23. #include "trx0types.h"
  24. /**********************************************************************
  25. Makes all characters in a NUL-terminated UTF-8 string lower case. */
  26. void
  27. dict_casedn_str(
  28. /*============*/
  29. char* a); /* in/out: string to put in lower case */
  30. /************************************************************************
  31. Get the database name length in a table name. */
  32. ulint
  33. dict_get_db_name_len(
  34. /*=================*/
  35. /* out: database name length */
  36. const char* name); /* in: table name in the form
  37. dbname '/' tablename */
  38. /*************************************************************************
  39. Accepts a specified string. Comparisons are case-insensitive. */
  40. const char*
  41. dict_accept(
  42. /*========*/
  43. /* out: if string was accepted, the pointer
  44. is moved after that, else ptr is returned */
  45. const char* ptr, /* in: scan from this */
  46. const char* string, /* in: accept only this string as the next
  47. non-whitespace string */
  48. ibool* success);/* out: TRUE if accepted */
  49. /************************************************************************
  50. Decrements the count of open MySQL handles to a table. */
  51. void
  52. dict_table_decrement_handle_count(
  53. /*==============================*/
  54. dict_table_t* table); /* in: table */
  55. /**************************************************************************
  56. Inits the data dictionary module. */
  57. void
  58. dict_init(void);
  59. /*===========*/
  60. /************************************************************************
  61. Gets the space id of every table of the data dictionary and makes a linear
  62. list and a hash table of them to the data dictionary cache. This function
  63. can be called at database startup if we did not need to do a crash recovery.
  64. In crash recovery we must scan the space id's from the .ibd files in MySQL
  65. database directories. */
  66. void
  67. dict_load_space_id_list(void);
  68. /*=========================*/
  69. /*************************************************************************
  70. Gets the column data type. */
  71. UNIV_INLINE
  72. dtype_t*
  73. dict_col_get_type(
  74. /*==============*/
  75. dict_col_t* col);
  76. /*************************************************************************
  77. Gets the column number. */
  78. UNIV_INLINE
  79. ulint
  80. dict_col_get_no(
  81. /*============*/
  82. dict_col_t* col);
  83. /*************************************************************************
  84. Gets the column position in the clustered index. */
  85. UNIV_INLINE
  86. ulint
  87. dict_col_get_clust_pos(
  88. /*===================*/
  89. dict_col_t* col);
  90. /************************************************************************
  91. Initializes the autoinc counter. It is not an error to initialize an already
  92. initialized counter. */
  93. void
  94. dict_table_autoinc_initialize(
  95. /*==========================*/
  96. dict_table_t* table, /* in: table */
  97. ib_longlong value); /* in: next value to assign to a row */
  98. /************************************************************************
  99. Gets the next autoinc value (== autoinc counter value), 0 if not yet
  100. initialized. If initialized, increments the counter by 1. */
  101. ib_longlong
  102. dict_table_autoinc_get(
  103. /*===================*/
  104. /* out: value for a new row, or 0 */
  105. dict_table_t* table); /* in: table */
  106. /************************************************************************
  107. Decrements the autoinc counter value by 1. */
  108. void
  109. dict_table_autoinc_decrement(
  110. /*=========================*/
  111. dict_table_t* table); /* in: table */
  112. /************************************************************************
  113. Reads the next autoinc value (== autoinc counter value), 0 if not yet
  114. initialized. */
  115. ib_longlong
  116. dict_table_autoinc_read(
  117. /*====================*/
  118. /* out: value for a new row, or 0 */
  119. dict_table_t* table); /* in: table */
  120. /************************************************************************
  121. Peeks the autoinc counter value, 0 if not yet initialized. Does not
  122. increment the counter. The read not protected by any mutex! */
  123. ib_longlong
  124. dict_table_autoinc_peek(
  125. /*====================*/
  126. /* out: value of the counter */
  127. dict_table_t* table); /* in: table */
  128. /************************************************************************
  129. Updates the autoinc counter if the value supplied is equal or bigger than the
  130. current value. If not inited, does nothing. */
  131. void
  132. dict_table_autoinc_update(
  133. /*======================*/
  134. dict_table_t* table, /* in: table */
  135. ib_longlong value); /* in: value which was assigned to a row */
  136. /**************************************************************************
  137. Adds a table object to the dictionary cache. */
  138. void
  139. dict_table_add_to_cache(
  140. /*====================*/
  141. dict_table_t* table); /* in: table */
  142. /**************************************************************************
  143. Removes a table object from the dictionary cache. */
  144. void
  145. dict_table_remove_from_cache(
  146. /*=========================*/
  147. dict_table_t* table); /* in, own: table */
  148. /**************************************************************************
  149. Renames a table object. */
  150. ibool
  151. dict_table_rename_in_cache(
  152. /*=======================*/
  153. /* out: TRUE if success */
  154. dict_table_t* table, /* in: table */
  155. const char* new_name, /* in: new name */
  156. ibool rename_also_foreigns);/* in: in ALTER TABLE we want
  157. to preserve the original table name
  158. in constraints which reference it */
  159. /**************************************************************************
  160. Change the id of a table object in the dictionary cache. This is used in
  161. DISCARD TABLESPACE. */
  162. void
  163. dict_table_change_id_in_cache(
  164. /*==========================*/
  165. dict_table_t* table, /* in: table object already in cache */
  166. dulint new_id);/* in: new id to set */
  167. /**************************************************************************
  168. Adds a foreign key constraint object to the dictionary cache. May free
  169. the object if there already is an object with the same identifier in.
  170. At least one of foreign table or referenced table must already be in
  171. the dictionary cache! */
  172. ulint
  173. dict_foreign_add_to_cache(
  174. /*======================*/
  175. /* out: DB_SUCCESS or error code */
  176. dict_foreign_t* foreign, /* in, own: foreign key constraint */
  177. ibool check_types); /* in: TRUE=check type compatibility */
  178. /*************************************************************************
  179. Checks if a table is referenced by foreign keys. */
  180. ibool
  181. dict_table_referenced_by_foreign_key(
  182. /*=================================*/
  183. /* out: TRUE if table is referenced by a
  184. foreign key */
  185. dict_table_t* table); /* in: InnoDB table */
  186. /*************************************************************************
  187. Scans a table create SQL string and adds to the data dictionary
  188. the foreign key constraints declared in the string. This function
  189. should be called after the indexes for a table have been created.
  190. Each foreign key constraint must be accompanied with indexes in
  191. bot participating tables. The indexes are allowed to contain more
  192. fields than mentioned in the constraint. */
  193. ulint
  194. dict_create_foreign_constraints(
  195. /*============================*/
  196. /* out: error code or DB_SUCCESS */
  197. trx_t* trx, /* in: transaction */
  198. const char* sql_string, /* in: table create statement where
  199. foreign keys are declared like:
  200. FOREIGN KEY (a, b) REFERENCES
  201. table2(c, d), table2 can be written
  202. also with the database
  203. name before it: test.table2; the
  204. default database id the database of
  205. parameter name */
  206. const char* name); /* in: table full name in the
  207. normalized form
  208. database_name/table_name */
  209. /**************************************************************************
  210. Parses the CONSTRAINT id's to be dropped in an ALTER TABLE statement. */
  211. ulint
  212. dict_foreign_parse_drop_constraints(
  213. /*================================*/
  214. /* out: DB_SUCCESS or
  215. DB_CANNOT_DROP_CONSTRAINT if
  216. syntax error or the constraint
  217. id does not match */
  218. mem_heap_t* heap, /* in: heap from which we can
  219. allocate memory */
  220. trx_t* trx, /* in: transaction */
  221. dict_table_t* table, /* in: table */
  222. ulint* n, /* out: number of constraints
  223. to drop */
  224. const char*** constraints_to_drop); /* out: id's of the
  225. constraints to drop */
  226. /**************************************************************************
  227. Returns a table object and memoryfixes it. NOTE! This is a high-level
  228. function to be used mainly from outside the 'dict' directory. Inside this
  229. directory dict_table_get_low is usually the appropriate function. */
  230. dict_table_t*
  231. dict_table_get(
  232. /*===========*/
  233. /* out: table, NULL if
  234. does not exist */
  235. const char* table_name, /* in: table name */
  236. trx_t* trx); /* in: transaction handle */
  237. /**************************************************************************
  238. Returns a table object and increments MySQL open handle count on the table.
  239. */
  240. dict_table_t*
  241. dict_table_get_and_increment_handle_count(
  242. /*======================================*/
  243. /* out: table, NULL if
  244. does not exist */
  245. const char* table_name, /* in: table name */
  246. trx_t* trx); /* in: transaction handle or NULL */
  247. /**************************************************************************
  248. Returns a table object, based on table id, and memoryfixes it. */
  249. dict_table_t*
  250. dict_table_get_on_id(
  251. /*=================*/
  252. /* out: table, NULL if does not exist */
  253. dulint table_id, /* in: table id */
  254. trx_t* trx); /* in: transaction handle */
  255. /**************************************************************************
  256. Returns a table object, based on table id, and memoryfixes it. */
  257. UNIV_INLINE
  258. dict_table_t*
  259. dict_table_get_on_id_low(
  260. /*=====================*/
  261. /* out: table, NULL if does not exist */
  262. dulint table_id, /* in: table id */
  263. trx_t* trx); /* in: transaction handle */
  264. /**************************************************************************
  265. Releases a table from being memoryfixed. Currently this has no relevance. */
  266. UNIV_INLINE
  267. void
  268. dict_table_release(
  269. /*===============*/
  270. dict_table_t* table); /* in: table to be released */
  271. /**************************************************************************
  272. Checks if a table is in the dictionary cache. */
  273. UNIV_INLINE
  274. dict_table_t*
  275. dict_table_check_if_in_cache_low(
  276. /*==============================*/
  277. /* out: table, NULL if not found */
  278. const char* table_name); /* in: table name */
  279. /**************************************************************************
  280. Gets a table; loads it to the dictionary cache if necessary. A low-level
  281. function. */
  282. UNIV_INLINE
  283. dict_table_t*
  284. dict_table_get_low(
  285. /*===============*/
  286. /* out: table, NULL if not found */
  287. const char* table_name); /* in: table name */
  288. /**************************************************************************
  289. Returns an index object. */
  290. UNIV_INLINE
  291. dict_index_t*
  292. dict_table_get_index(
  293. /*=================*/
  294. /* out: index, NULL if does not exist */
  295. dict_table_t* table, /* in: table */
  296. const char* name); /* in: index name */
  297. /**************************************************************************
  298. Returns an index object. */
  299. dict_index_t*
  300. dict_table_get_index_noninline(
  301. /*===========================*/
  302. /* out: index, NULL if does not exist */
  303. dict_table_t* table, /* in: table */
  304. const char* name); /* in: index name */
  305. /**************************************************************************
  306. Prints a table definition. */
  307. void
  308. dict_table_print(
  309. /*=============*/
  310. dict_table_t* table); /* in: table */
  311. /**************************************************************************
  312. Prints a table data. */
  313. void
  314. dict_table_print_low(
  315. /*=================*/
  316. dict_table_t* table); /* in: table */
  317. /**************************************************************************
  318. Prints a table data when we know the table name. */
  319. void
  320. dict_table_print_by_name(
  321. /*=====================*/
  322. const char* name);
  323. /**************************************************************************
  324. Outputs info on foreign keys of a table. */
  325. void
  326. dict_print_info_on_foreign_keys(
  327. /*============================*/
  328. ibool create_table_format, /* in: if TRUE then print in
  329. a format suitable to be inserted into
  330. a CREATE TABLE, otherwise in the format
  331. of SHOW TABLE STATUS */
  332. FILE* file, /* in: file where to print */
  333. trx_t* trx, /* in: transaction */
  334. dict_table_t* table); /* in: table */
  335. /**************************************************************************
  336. Outputs info on a foreign key of a table in a format suitable for
  337. CREATE TABLE. */
  338. void
  339. dict_print_info_on_foreign_key_in_create_format(
  340. /*============================================*/
  341. FILE* file, /* in: file where to print */
  342. trx_t* trx, /* in: transaction */
  343. dict_foreign_t* foreign);/* in: foreign key constraint */
  344. /************************************************************************
  345. Displays the names of the index and the table. */
  346. void
  347. dict_index_name_print(
  348. /*==================*/
  349. FILE* file, /* in: output stream */
  350. trx_t* trx, /* in: transaction */
  351. const dict_index_t* index); /* in: index to print */
  352. /************************************************************************
  353. Gets the first index on the table (the clustered index). */
  354. UNIV_INLINE
  355. dict_index_t*
  356. dict_table_get_first_index(
  357. /*=======================*/
  358. /* out: index, NULL if none exists */
  359. dict_table_t* table); /* in: table */
  360. /************************************************************************
  361. Gets the first index on the table (the clustered index). */
  362. dict_index_t*
  363. dict_table_get_first_index_noninline(
  364. /*=================================*/
  365. /* out: index, NULL if none exists */
  366. dict_table_t* table); /* in: table */
  367. /************************************************************************
  368. Gets the next index on the table. */
  369. UNIV_INLINE
  370. dict_index_t*
  371. dict_table_get_next_index(
  372. /*======================*/
  373. /* out: index, NULL if none left */
  374. dict_index_t* index); /* in: index */
  375. /************************************************************************
  376. Gets the next index on the table. */
  377. dict_index_t*
  378. dict_table_get_next_index_noninline(
  379. /*================================*/
  380. /* out: index, NULL if none left */
  381. dict_index_t* index); /* in: index */
  382. /************************************************************************
  383. Gets the number of user-defined columns in a table in the dictionary
  384. cache. */
  385. UNIV_INLINE
  386. ulint
  387. dict_table_get_n_user_cols(
  388. /*=======================*/
  389. /* out: number of user-defined (e.g., not
  390. ROW_ID) columns of a table */
  391. dict_table_t* table); /* in: table */
  392. /************************************************************************
  393. Gets the number of system columns in a table in the dictionary cache. */
  394. UNIV_INLINE
  395. ulint
  396. dict_table_get_n_sys_cols(
  397. /*======================*/
  398. /* out: number of system (e.g.,
  399. ROW_ID) columns of a table */
  400. dict_table_t* table); /* in: table */
  401. /************************************************************************
  402. Gets the number of all columns (also system) in a table in the dictionary
  403. cache. */
  404. UNIV_INLINE
  405. ulint
  406. dict_table_get_n_cols(
  407. /*==================*/
  408. /* out: number of columns of a table */
  409. dict_table_t* table); /* in: table */
  410. /************************************************************************
  411. Gets the nth column of a table. */
  412. UNIV_INLINE
  413. dict_col_t*
  414. dict_table_get_nth_col(
  415. /*===================*/
  416. /* out: pointer to column object */
  417. dict_table_t* table, /* in: table */
  418. ulint pos); /* in: position of column */
  419. /************************************************************************
  420. Gets the nth column of a table. */
  421. dict_col_t*
  422. dict_table_get_nth_col_noninline(
  423. /*=============================*/
  424. /* out: pointer to column object */
  425. dict_table_t* table, /* in: table */
  426. ulint pos); /* in: position of column */
  427. /************************************************************************
  428. Gets the given system column of a table. */
  429. UNIV_INLINE
  430. dict_col_t*
  431. dict_table_get_sys_col(
  432. /*===================*/
  433. /* out: pointer to column object */
  434. dict_table_t* table, /* in: table */
  435. ulint sys); /* in: DATA_ROW_ID, ... */
  436. /************************************************************************
  437. Gets the given system column number of a table. */
  438. UNIV_INLINE
  439. ulint
  440. dict_table_get_sys_col_no(
  441. /*======================*/
  442. /* out: column number */
  443. dict_table_t* table, /* in: table */
  444. ulint sys); /* in: DATA_ROW_ID, ... */
  445. /************************************************************************
  446. Checks if a column is in the ordering columns of the clustered index of a
  447. table. Column prefixes are treated like whole columns. */
  448. ibool
  449. dict_table_col_in_clustered_key(
  450. /*============================*/
  451. /* out: TRUE if the column, or its prefix, is
  452. in the clustered key */
  453. dict_table_t* table, /* in: table */
  454. ulint n); /* in: column number */
  455. /***********************************************************************
  456. Copies types of columns contained in table to tuple. */
  457. void
  458. dict_table_copy_types(
  459. /*==================*/
  460. dtuple_t* tuple, /* in: data tuple */
  461. dict_table_t* table); /* in: index */
  462. /**************************************************************************
  463. Looks for an index with the given id. NOTE that we do not reserve
  464. the dictionary mutex: this function is for emergency purposes like
  465. printing info of a corrupt database page! */
  466. dict_index_t*
  467. dict_index_find_on_id_low(
  468. /*======================*/
  469. /* out: index or NULL if not found from cache */
  470. dulint id); /* in: index id */
  471. /**************************************************************************
  472. Adds an index to dictionary cache. */
  473. ibool
  474. dict_index_add_to_cache(
  475. /*====================*/
  476. /* out: TRUE if success */
  477. dict_table_t* table, /* in: table on which the index is */
  478. dict_index_t* index); /* in, own: index; NOTE! The index memory
  479. object is freed in this function! */
  480. /************************************************************************
  481. Gets the number of fields in the internal representation of an index,
  482. including fields added by the dictionary system. */
  483. UNIV_INLINE
  484. ulint
  485. dict_index_get_n_fields(
  486. /*====================*/
  487. /* out: number of fields */
  488. dict_index_t* index); /* in: an internal representation of index
  489. (in the dictionary cache) */
  490. /************************************************************************
  491. Gets the number of fields in the internal representation of an index
  492. that uniquely determine the position of an index entry in the index, if
  493. we do not take multiversioning into account: in the B-tree use the value
  494. returned by dict_index_get_n_unique_in_tree. */
  495. UNIV_INLINE
  496. ulint
  497. dict_index_get_n_unique(
  498. /*====================*/
  499. /* out: number of fields */
  500. dict_index_t* index); /* in: an internal representation of index
  501. (in the dictionary cache) */
  502. /************************************************************************
  503. Gets the number of fields in the internal representation of an index
  504. which uniquely determine the position of an index entry in the index, if
  505. we also take multiversioning into account. */
  506. UNIV_INLINE
  507. ulint
  508. dict_index_get_n_unique_in_tree(
  509. /*============================*/
  510. /* out: number of fields */
  511. dict_index_t* index); /* in: an internal representation of index
  512. (in the dictionary cache) */
  513. /************************************************************************
  514. Gets the number of user-defined ordering fields in the index. In the internal
  515. representation we add the row id to the ordering fields to make all indexes
  516. unique, but this function returns the number of fields the user defined
  517. in the index as ordering fields. */
  518. UNIV_INLINE
  519. ulint
  520. dict_index_get_n_ordering_defined_by_user(
  521. /*======================================*/
  522. /* out: number of fields */
  523. dict_index_t* index); /* in: an internal representation of index
  524. (in the dictionary cache) */
  525. /************************************************************************
  526. Gets the nth field of an index. */
  527. UNIV_INLINE
  528. dict_field_t*
  529. dict_index_get_nth_field(
  530. /*=====================*/
  531. /* out: pointer to field object */
  532. dict_index_t* index, /* in: index */
  533. ulint pos); /* in: position of field */
  534. /************************************************************************
  535. Gets pointer to the nth field data type in an index. */
  536. UNIV_INLINE
  537. dtype_t*
  538. dict_index_get_nth_type(
  539. /*====================*/
  540. /* out: data type */
  541. dict_index_t* index, /* in: index */
  542. ulint pos); /* in: position of the field */
  543. /************************************************************************
  544. Gets the column number of the nth field in an index. */
  545. UNIV_INLINE
  546. ulint
  547. dict_index_get_nth_col_no(
  548. /*======================*/
  549. /* out: column number */
  550. dict_index_t* index, /* in: index */
  551. ulint pos); /* in: position of the field */
  552. /************************************************************************
  553. Looks for column n in an index. */
  554. ulint
  555. dict_index_get_nth_col_pos(
  556. /*=======================*/
  557. /* out: position in internal representation
  558. of the index; if not contained, returns
  559. ULINT_UNDEFINED */
  560. dict_index_t* index, /* in: index */
  561. ulint n); /* in: column number */
  562. /************************************************************************
  563. Returns TRUE if the index contains a column or a prefix of that column. */
  564. ibool
  565. dict_index_contains_col_or_prefix(
  566. /*==============================*/
  567. /* out: TRUE if contains the column or its
  568. prefix */
  569. dict_index_t* index, /* in: index */
  570. ulint n); /* in: column number */
  571. /************************************************************************
  572. Looks for a matching field in an index. The column has to be the same. The
  573. column in index must be complete, or must contain a prefix longer than the
  574. column in index2. That is, we must be able to construct the prefix in index2
  575. from the prefix in index. */
  576. ulint
  577. dict_index_get_nth_field_pos(
  578. /*=========================*/
  579. /* out: position in internal representation
  580. of the index; if not contained, returns
  581. ULINT_UNDEFINED */
  582. dict_index_t* index, /* in: index from which to search */
  583. dict_index_t* index2, /* in: index */
  584. ulint n); /* in: field number in index2 */
  585. /************************************************************************
  586. Looks for column n position in the clustered index. */
  587. ulint
  588. dict_table_get_nth_col_pos(
  589. /*=======================*/
  590. /* out: position in internal representation
  591. of the clustered index */
  592. dict_table_t* table, /* in: table */
  593. ulint n); /* in: column number */
  594. /************************************************************************
  595. Returns the position of a system column in an index. */
  596. UNIV_INLINE
  597. ulint
  598. dict_index_get_sys_col_pos(
  599. /*=======================*/
  600. /* out: position, ULINT_UNDEFINED if not
  601. contained */
  602. dict_index_t* index, /* in: index */
  603. ulint type); /* in: DATA_ROW_ID, ... */
  604. /***********************************************************************
  605. Copies types of fields contained in index to tuple. */
  606. void
  607. dict_index_copy_types(
  608. /*==================*/
  609. dtuple_t* tuple, /* in: data tuple */
  610. dict_index_t* index, /* in: index */
  611. ulint n_fields); /* in: number of field types to copy */
  612. /************************************************************************
  613. Gets the value of a system column in a clustered index record. The clustered
  614. index must contain the system column: if the index is unique, row id is
  615. not contained there! */
  616. UNIV_INLINE
  617. dulint
  618. dict_index_rec_get_sys_col(
  619. /*=======================*/
  620. /* out: system column value */
  621. dict_index_t* index, /* in: clustered index describing the record */
  622. ulint type, /* in: column type: DATA_ROLL_PTR, ... */
  623. rec_t* rec); /* in: record */
  624. /*************************************************************************
  625. Gets the index tree where the index is stored. */
  626. UNIV_INLINE
  627. dict_tree_t*
  628. dict_index_get_tree(
  629. /*================*/
  630. /* out: index tree */
  631. dict_index_t* index); /* in: index */
  632. /*************************************************************************
  633. Gets the field order criterion. */
  634. UNIV_INLINE
  635. ulint
  636. dict_field_get_order(
  637. /*=================*/
  638. dict_field_t* field);
  639. /*************************************************************************
  640. Gets the field column. */
  641. UNIV_INLINE
  642. dict_col_t*
  643. dict_field_get_col(
  644. /*===============*/
  645. dict_field_t* field);
  646. /**************************************************************************
  647. Creates an index tree struct. */
  648. dict_tree_t*
  649. dict_tree_create(
  650. /*=============*/
  651. /* out, own: created tree */
  652. dict_index_t* index); /* in: the index for which to create: in the
  653. case of a mixed tree, this should be the
  654. index of the cluster object */
  655. /**************************************************************************
  656. Frees an index tree struct. */
  657. void
  658. dict_tree_free(
  659. /*===========*/
  660. dict_tree_t* tree); /* in, own: index tree */
  661. /**************************************************************************
  662. In an index tree, finds the index corresponding to a record in the tree. */
  663. dict_index_t*
  664. dict_tree_find_index(
  665. /*=================*/
  666. /* out: index */
  667. dict_tree_t* tree, /* in: index tree */
  668. rec_t* rec); /* in: record for which to find correct index */
  669. /**************************************************************************
  670. In an index tree, finds the index corresponding to a dtuple which is used
  671. in a search to a tree. */
  672. dict_index_t*
  673. dict_tree_find_index_for_tuple(
  674. /*===========================*/
  675. /* out: index; NULL if the tuple does not
  676. contain the mix id field in a mixed tree */
  677. dict_tree_t* tree, /* in: index tree */
  678. dtuple_t* tuple); /* in: tuple for which to find index */
  679. /***********************************************************************
  680. Checks if a table which is a mixed cluster member owns a record. */
  681. UNIV_INLINE
  682. ibool
  683. dict_is_mixed_table_rec(
  684. /*====================*/
  685. /* out: TRUE if the record belongs to this
  686. table */
  687. dict_table_t* table, /* in: table in a mixed cluster */
  688. rec_t* rec); /* in: user record in the clustered index */
  689. /**************************************************************************
  690. Returns an index object if it is found in the dictionary cache. */
  691. dict_index_t*
  692. dict_index_get_if_in_cache(
  693. /*=======================*/
  694. /* out: index, NULL if not found */
  695. dulint index_id); /* in: index id */
  696. /**************************************************************************
  697. Checks that a tuple has n_fields_cmp value in a sensible range, so that
  698. no comparison can occur with the page number field in a node pointer. */
  699. ibool
  700. dict_tree_check_search_tuple(
  701. /*=========================*/
  702. /* out: TRUE if ok */
  703. dict_tree_t* tree, /* in: index tree */
  704. dtuple_t* tuple); /* in: tuple used in a search */
  705. /**************************************************************************
  706. Builds a node pointer out of a physical record and a page number. */
  707. dtuple_t*
  708. dict_tree_build_node_ptr(
  709. /*=====================*/
  710. /* out, own: node pointer */
  711. dict_tree_t* tree, /* in: index tree */
  712. rec_t* rec, /* in: record for which to build node
  713. pointer */
  714. ulint page_no,/* in: page number to put in node pointer */
  715. mem_heap_t* heap, /* in: memory heap where pointer created */
  716. ulint           level);  /* in: level of rec in tree: 0 means leaf
  717. level */
  718. /**************************************************************************
  719. Copies an initial segment of a physical record, long enough to specify an
  720. index entry uniquely. */
  721. rec_t*
  722. dict_tree_copy_rec_order_prefix(
  723. /*============================*/
  724. /* out: pointer to the prefix record */
  725. dict_tree_t* tree, /* in: index tree */
  726. rec_t* rec, /* in: record for which to copy prefix */
  727. byte** buf, /* in/out: memory buffer for the copied prefix,
  728. or NULL */
  729. ulint* buf_size);/* in/out: buffer size */
  730. /**************************************************************************
  731. Builds a typed data tuple out of a physical record. */
  732. dtuple_t*
  733. dict_tree_build_data_tuple(
  734. /*=======================*/
  735. /* out, own: data tuple */
  736. dict_tree_t* tree, /* in: index tree */
  737. rec_t* rec, /* in: record for which to build data tuple */
  738. mem_heap_t* heap); /* in: memory heap where tuple created */
  739. /*************************************************************************
  740. Gets the space id of the root of the index tree. */
  741. UNIV_INLINE
  742. ulint
  743. dict_tree_get_space(
  744. /*================*/
  745. /* out: space id */
  746. dict_tree_t* tree); /* in: tree */
  747. /*************************************************************************
  748. Sets the space id of the root of the index tree. */
  749. UNIV_INLINE
  750. void
  751. dict_tree_set_space(
  752. /*================*/
  753. dict_tree_t* tree, /* in: tree */
  754. ulint space); /* in: space id */
  755. /*************************************************************************
  756. Gets the page number of the root of the index tree. */
  757. UNIV_INLINE
  758. ulint
  759. dict_tree_get_page(
  760. /*===============*/
  761. /* out: page number */
  762. dict_tree_t* tree); /* in: tree */
  763. /*************************************************************************
  764. Sets the page number of the root of index tree. */
  765. UNIV_INLINE
  766. void
  767. dict_tree_set_page(
  768. /*===============*/
  769. dict_tree_t* tree, /* in: tree */
  770. ulint page); /* in: page number */
  771. /*************************************************************************
  772. Gets the type of the index tree. */
  773. UNIV_INLINE
  774. ulint
  775. dict_tree_get_type(
  776. /*===============*/
  777. /* out: type */
  778. dict_tree_t* tree); /* in: tree */
  779. /*************************************************************************
  780. Gets the read-write lock of the index tree. */
  781. UNIV_INLINE
  782. rw_lock_t*
  783. dict_tree_get_lock(
  784. /*===============*/
  785. /* out: read-write lock */
  786. dict_tree_t* tree); /* in: tree */
  787. /************************************************************************
  788. Returns free space reserved for future updates of records. This is
  789. relevant only in the case of many consecutive inserts, as updates
  790. which make the records bigger might fragment the index. */
  791. UNIV_INLINE
  792. ulint
  793. dict_tree_get_space_reserve(
  794. /*========================*/
  795. /* out: number of free bytes on page,
  796. reserved for updates */
  797. dict_tree_t* tree); /* in: a tree */
  798. /*************************************************************************
  799. Calculates the minimum record length in an index. */
  800. ulint
  801. dict_index_calc_min_rec_len(
  802. /*========================*/
  803. dict_index_t* index); /* in: index */
  804. /*************************************************************************
  805. Calculates new estimates for table and index statistics. The statistics
  806. are used in query optimization. */
  807. void
  808. dict_update_statistics_low(
  809. /*=======================*/
  810. dict_table_t* table, /* in: table */
  811. ibool has_dict_mutex);/* in: TRUE if the caller has the
  812. dictionary mutex */
  813. /*************************************************************************
  814. Calculates new estimates for table and index statistics. The statistics
  815. are used in query optimization. */
  816. void
  817. dict_update_statistics(
  818. /*===================*/
  819. dict_table_t* table); /* in: table */
  820. /************************************************************************
  821. Reserves the dictionary system mutex for MySQL. */
  822. void
  823. dict_mutex_enter_for_mysql(void);
  824. /*============================*/
  825. /************************************************************************
  826. Releases the dictionary system mutex for MySQL. */
  827. void
  828. dict_mutex_exit_for_mysql(void);
  829. /*===========================*/
  830. /************************************************************************
  831. Checks if the database name in two table names is the same. */
  832. ibool
  833. dict_tables_have_same_db(
  834. /*=====================*/
  835. /* out: TRUE if same db name */
  836. const char* name1, /* in: table name in the form
  837. dbname '/' tablename */
  838. const char* name2); /* in: table name in the form
  839. dbname '/' tablename */
  840. /*************************************************************************
  841. Scans from pointer onwards. Stops if is at the start of a copy of
  842. 'string' where characters are compared without case sensitivity. Stops
  843. also at ''. */
  844. const char*
  845. dict_scan_to(
  846. /*=========*/
  847. /* out: scanned up to this */
  848. const char* ptr, /* in: scan from */
  849. const char* string);/* in: look for this */
  850. /* Buffers for storing detailed information about the latest foreign key
  851. and unique key errors */
  852. extern FILE* dict_foreign_err_file;
  853. extern mutex_t dict_foreign_err_mutex; /* mutex protecting the buffers */
  854. extern dict_sys_t* dict_sys; /* the dictionary system */
  855. extern rw_lock_t dict_operation_lock;
  856. /* Dictionary system struct */
  857. struct dict_sys_struct{
  858. mutex_t mutex; /* mutex protecting the data
  859. dictionary; protects also the
  860. disk-based dictionary system tables;
  861. this mutex serializes CREATE TABLE
  862. and DROP TABLE, as well as reading
  863. the dictionary data for a table from
  864. system tables */
  865. dulint row_id; /* the next row id to assign;
  866. NOTE that at a checkpoint this
  867. must be written to the dict system
  868. header and flushed to a file; in
  869. recovery this must be derived from
  870. the log records */
  871. hash_table_t*  table_hash; /* hash table of the tables, based
  872. on name */
  873. hash_table_t*  table_id_hash; /* hash table of the tables, based
  874. on id */
  875. hash_table_t*  col_hash; /* hash table of the columns */
  876. UT_LIST_BASE_NODE_T(dict_table_t)
  877. table_LRU;  /* LRU list of tables */
  878. ulint size; /* varying space in bytes occupied
  879. by the data dictionary table and
  880. index objects */
  881. dict_table_t* sys_tables; /* SYS_TABLES table */
  882. dict_table_t* sys_columns; /* SYS_COLUMNS table */
  883. dict_table_t* sys_indexes; /* SYS_INDEXES table */
  884. dict_table_t* sys_fields; /* SYS_FIELDS table */
  885. };
  886. #ifndef UNIV_NONINL
  887. #include "dict0dict.ic"
  888. #endif
  889. #endif