代码拉取完成，页面将自动刷新
SqColumn 派生自 SqEntry。它定义数据库表中的列并与 SqType 一起使用。
SqEntry
│
└─── SqReentry
│
└─── SqColumn
SqColumn 必须与 SqTable and SqSchema 一起使用来创建表。
它使用 SqType 指定数据类型。
要获取更多信息和示例，您可以查看以下文档：
使用 C 语言
SqColumn *column;
// 使用 SqTable 的函数创建列（推荐）
column = sq_table_add_string(table, "column", offsetof(MyStruct, column), 191);
// 使用 sq_column_new() 创建列 （这里必须指定 SqType）
column = sq_column_new("id", SQ_TYPE_INT);
column->offset = offsetof(MyStruct, id);
sq_table_add_column(table, column, 1);
使用 C++ 语言
Sq::Column *column;
// 使用 Sq::Table 的方法创建列（推荐）
column = table->string("column", &MyStruct::column, 191);
// 使用 Sq::Column 的构造函数创建列 （这里必须指定 SqType）
column = new Sq::Column("id", SQ_TYPE_INT);
column->offset = offsetof(MyStruct, id);
table->addColumn(column);
在将列添加到表或将条目添加到结构时，您可以使用几个 "修饰符"。
大多数方法（函数）将 SqColumn::bit_field 的特定位设置为 1。
| C++ 方法 | C 函数 | 描述 |
|---|---|---|
| primary | sq_column_primary | 主键 |
| unique | sq_column_unique | 唯一索引 |
| autoIncrement | sq_column_auto_increment | 自动递增 |
| nullable | sq_column_nullable | 允许 NULL 值 |
| useCurrent | sq_column_use_current | 使用 CURRENT_TIMESTAMP 作为默认值。 |
| useCurrentOnUpdate | sq_column_use_current_on_update | 更新记录时使用 CURRENT_TIMESTAMP。 |
| queryOnly | sq_column_query_only | 列名仅适用于 SQL SELECT 查询。 |
| default_ | sq_column_default | 为该列指定一个 "默认" 值。 |
结构类型的特殊方法。
| C++ 方法 | C 函数 | 描述 |
|---|---|---|
| pointer | sq_column_pointer | 此数据成员是一个指针。 |
| hidden | sq_column_hidden | 不要将此数据成员输出到 JSON。 |
| hiddenNull | sq_column_hidden_null | 如果它的值为 NULL，则不要将此数据成员输出到 JSON。 |
示例1: 使列 "nullable"。
/* C++ 示例代码 */
table->string("name", &User::name)->nullable();
/* C 示例代码 */
column = sq_table_add_string(table, "name", offsetof(User, name), -1);
sq_column_nullable(column);
示例2: 使用仅查询列来获取指定列中值的长度。
它将特殊查询 'SELECT length(text), * FROM table' 的结果存储到 C 结构的成员（这里是 YourStruct.text_length）。
注意: 如果要使用此功能，请在 SqConfig.h 中启用 SQ_CONFIG_QUERY_ONLY_COLUMN。
/* C++ 示例代码 */
table->integer("length(text)", &YourStruct::text_length)->queryOnly();
/* C 示例代码 */
column = sq_table_add_integer(table, "length(text)", offsetof(YourStruct, text_length));
sq_column_query_only(column);
C 函数 sq_column_change()、C++ 方法 change() 允许您修改现有列的类型和属性。他们在迁移之前不会更改列。
使用 C 语言
// 更改表 "users"
table = sq_schema_alter(schema, "users", NULL);
// 更改表中的 "email" 列
column = sq_table_add_string(table, "email", offsetof(User, email), 100); // VARCHAR(100)
sq_column_change(column);
使用 C++ 语言
// 更改表 "users"
table = schema->alter("users");
// 更改表中的 "email" 列
table->string("email", &User::email, 100)->change(); // VARCHAR(100)
要定义常量 SqColumn，用户必须了解 SqColumn 结构定义：
struct SqColumn
{
// ------ SqEntry 成员 ------
const SqType *type; // 列的数据类型
const char *name; // 列的名称
size_t offset; // 结构中字段的偏移量
unsigned int bit_field; // 下面解释
// ------ SqReentry 成员 ------
const char *old_name; // 重命名或删除时使用这个
// ------ SqColumn 成员 ------
// sql_type: 将类型映射到 SQL 数据类型。如果该字段为 0，则不映射。
int32_t sql_type;
// size : 总位数以大小或字符串长度。
int32_t size;
// digits: 小数点后的位数，或 SQL 类型的第二个参数。
int32_t digits;
const char *default_value; // 默认值 DEFAULT
// 'foreign' 是以 NULL 结尾的数组，用于设置外键引用和操作。
char **foreign;
// 'composite' 是以 NULL 结尾的数组，用于设置复合约束的 列。
char **composite;
const char *reserve; // 保留
const char *raw; // 原始数据库列属性
};
定义 SqColumn 使用的 bit_field：
以下 SQB_XXXX 都必须使用按位操作来设置或清除 SqColumn::bit_field 中的位。
| 名称 | 描述 |
|---|---|
| SQB_PRIMARY | SQL 属性: PRIMARY KEY |
| SQB_FOREIGN | SQL 属性: FOREIGN KEY |
| SQB_UNIQUE | SQL 属性: UNIQUE |
| SQB_INCREMENT | SQL 属性: AUTOINCREMENT |
| SQB_AUTOINCREMENT | SQL 属性: 和 SQB_INCREMENT 一样 |
| SQB_NULLABLE | SQL 属性: 不要使用 "NOT NULL" |
| SQB_CURRENT | SQL 属性: DEFAULT CURRENT_TIMESTAMP |
| SQB_CURRENT_ON_UPDATE | SQL 属性: 更新记录时使用 CURRENT_TIMESTAMP |
| SQB_QUERY_ONLY | 列名仅适用于 SQL SELECT 查询。 |
| SQB_RENAMED | 列或表已重命名。 |
| SQB_CHANGED | 列或表已更改。 |
以下 bit_field 定义继承自 SqEntry：
| 名称 | 描述 |
|---|---|
| SQB_DYNAMIC | 列可以更改和释放 |
| SQB_POINTER | 列的实例是指针 |
| SQB_HIDDEN | JSON 转换器不会输出该列的值 |
| SQB_HIDDEN_NULL | 如果值为 NULL，JSON 转换器将不会输出 |
如果您的数据库表是固定的并且将来不会更改，这可以减少创架构时的运行时间。
static const SqColumn columnArray[2] = {
{SQ_TYPE_UINT, "id", offsetof(YourStruct, id), SQB_PRIMARY | SQB_HIDDEN},
{SQ_TYPE_STR, "name", offsetof(YourStruct, name), SQB_HIDDEN_NULL},
};
static const SqColumn *columnPointerArray[2] = {
& columnArray[0],
& columnArray[1],
};
/* 如果 'columnPointerArray' 未按名称排序，则将 0 传递给最后一个参数。
否则使用 SQB_TYPE_SORTED 替换最后一个参数中的 0。
*/
const SqType type = SQ_TYPE_INITIALIZER(YourStruct, columnPointerArray, 0);
使用 C 语言
SqType *type = sq_type_new(0, (SqDestroyFunc)sq_column_free);
// 从指针数组中添加 2 列
sq_type_add_entry_ptrs(type, (const SqEntry**)columnPointerArray, 2);
// 从数组中添加 2 列（不是指针数组）
// sq_type_add_entry(type, (const SqEntry*)columnArray, 2, sizeof(SqColumn));
使用 C++ 语言
Sq::Type *type = new Sq::Type(0, (SqDestroyFunc)sq_column_free);
// 从指针数组中添加 2 列
type->addEntry((const SqEntry**)columnPointerArray, 2);
// 从数组中添加 2 列（不是指针数组）
// type->addEntry((const SqEntry*)columnArray, 2, sizeof(SqColumn));
添加一个动态列来输入
使用 C 语言
SqColumn *column = sq_column_new("your_column_name", SQ_TYPE_STR);
column->offset = offsetof(YourStruct, FieldName);
sq_column_primary(column); // 设置主键 PRIMARY KEY
/* 将列添加到 SqType */
SqType *type = sq_type_new(0, (SqDestroyFunc)sq_column_free);
sq_type_add_entry(type, (const SqEntry*)column, 1, sizeof(SqColumn));
使用 C++ 语言
Sq::Column *column = new Sq::Column("your_column_name", SQ_TYPE_STR);
column->offset = offsetof(YourStruct, FieldName);
column->primary(); // 设置主键 PRIMARY KEY
/* 将列添加到 Sq::Type */
Sq::Type *type = new Sq::Type(0, (SqDestroyFunc)sq_column_free);
type->addEntry((const SqEntry*)column, 1, sizeof(SqColumn));
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
马建仓 AI 助手
