mysql_handler/dd.rs
1// Copyright (C) 2026 ren-yamanashi
2//
3// This program is free software; you can redistribute it and/or modify
4// it under the terms of the GNU General Public License, version 2.0,
5// as published by the Free Software Foundation.
6//
7// This program is designed to work with certain software (including
8// but not limited to OpenSSL) that is licensed under separate terms,
9// as designated in a particular file or component or in included license
10// documentation. The authors of this program hereby grant you an additional
11// permission to link the program and your derivative works with the
12// separately licensed software that they have either included with
13// the program or referenced in the documentation.
14//
15// This program is distributed in the hope that it will be useful,
16// but WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18// GNU General Public License for more details.
19//
20// You should have received a copy of the GNU General Public License
21// along with this program; if not, see <https://www.gnu.org/licenses/>.
22
23//! Safe Rust view of the MySQL data-dictionary `dd::Table` tree.
24//!
25//! Engine implementations receive `Option<&sys::DdTable>` in `open` / `create`
26//! and walk it through the accessor methods on [`sys::DdTable`],
27//! [`sys::DdColumn`], [`sys::DdIndex`], and [`sys::DdIndexElement`] defined
28//! here. The opaque pointers are valid only for the originating callback;
29//! copy out anything that needs to outlive it.
30//!
31//! [`sys::DdTable`]: crate::sys::DdTable
32//! [`sys::DdColumn`]: crate::sys::DdColumn
33//! [`sys::DdIndex`]: crate::sys::DdIndex
34//! [`sys::DdIndexElement`]: crate::sys::DdIndexElement
35
36mod column;
37mod ffi;
38mod index;
39mod table;
40
41pub use column::ColumnType;
42pub use index::{IndexElementOrder, IndexType};