2 Star 6 Fork 0

yanshikun / tcode

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

tcode

介绍

Go语言轻量ORM,极简封装,尽可能少使用反射进行封装,支持多库,支持基本类型,结构体,切片,分页结果映射,原始表数据映射(行,列),批量新增,事务

新增,更新数据表时采用go语言类型默认值进行补充,不允许数据表中包含null列,

代码生成器,使用函数WriteStruct进行结构体的输出,生成出的结构体不建议手动修改,如需修改,可以copy至其他目录进行修改

安装教程

go get gitee.com/yan-shi-kun/tcode

支持数据库

目前仅支持Mysql,后续新增支持(PostgreSQL,SQLite,Oracle,DB2...等)

使用说明

初始化代码生成器和数据库链接

// 初始化代码生成器和数据库链接
var (
    conf = &Config{
        Dsn:                   "root:root@tcp(127.0.0.1:3306)/test?charset=utf8mb4&parseTime=true&loc=Local",
        DriverName:            "mysql",
        Dialect:               "mysql",
        MaxOpenConns:          50,
        MaxIdleConns:          50,
        ConnMaxLifetimeSecond: 600,
    }
    _, codeConstructor, _ = New(conf)
    ctx                   = context.Background()
)

生成当前库所有表

// TestGenAll 生成当前库所有表
func TestGenAll(t *testing.T) {
	info, err := codeConstructor.ToAllStructInfo(ctx)
	if err != nil {
		panic(err)
	}
	for i := range info {
		err = WriteStruct(ctx, info[i])
		if err != nil {
			panic(err)
		}
	}
	time.Sleep(time.Second)
}

新增,未设置的值将使用类型默认值补充

// TestInsert 新增,未设置的值将使用类型默认值补充
func TestInsert(t *testing.T) {
	var tb tables.TbTest
	tb.UserId = 199999
	tb.CategoryId = 123
	tb.ArticleCover = "Ar't''icl\\'\\\\'\\'eCover"
	tb.ArticleTitle = "ArticleTitle"
	tb.ArticleContent = "ArticleContent"
	tb.Type = 4
	tb.OriginalUrl = "OriginalUrl"
	tb.IsTop = 1
	tb.IsDelete = 0
	tb.Status = 1
	tb.Sortno = 99
	tb.UpdateTime = time.Now()
	insert, pkid, err := tcode.Insert(ctx, &tb)
	fmt.Println(insert, pkid, err)
	fmt.Println(tb)
}

批量新增

// TestInsertBatch 批量新增
func TestInsertBatch(t *testing.T) {
	var tbs []tcode.Table
	for i := 0; i < 1000; i++ {
		var tb tables.TbTest
		tb.UserId = int32(i)
		tb.UpdateTime = time.Now()
		tb.ArticleTitle = "测试批量新增123"
		tbs = append(tbs, &tb)
	}
	insert, pkid, err := tcode.InsertBatch(ctx, &tbs)
	fmt.Println(insert, pkid, err)
}

更新;忽略每一个空列(类型默认值进行忽略)

// TestUpdate 更新;忽略每一个空列(类型默认值进行忽略)
func TestUpdate(t *testing.T) {
	var tb tables.TbTest
	tb.Id = 201434
	tb.ArticleTitle = "测试\\'1234"
	update, id, err := tcode.UpdateByPk(ctx, &tb)
	fmt.Println(update, id, err)
}

更新:不忽略任何一列

// TestUpdateNotIgnoredEveryColumn 更新:不忽略任何一列
func TestUpdateNotIgnoredEveryColumn(t *testing.T) {
	var tb tables.TbTest
	tb.Id = pkid
	tb.ArticleTitle = "测试1234"
	update, id, err := tcode.UpdateNotIgnoredEveryColumnByPk(ctx, &tb)
	fmt.Println(update, id, err)
}

删除

// TestDelete 删除
func TestDelete(t *testing.T) {
	var tb tables.TbTest
	tb.Id = pkid
	affected, id, err := tcode.DeleteByPk(ctx, &tb)
	if err != nil {
		panic(err)
	}
	fmt.Println(affected, id, err)
}

查询结果映射变量

// TestSelectToVar 查询结果映射变量
func TestSelectToVar(t *testing.T) {
	var id int
	err := tcode.NewSqlInfo(ctx, "SELECT id FROM tb_test WHERE id=?", pkid).ToVar(&id)
	if err != nil {
		panic(err)
	}
	fmt.Println(id)
}

查询结果映射结构体ToStruct

// TestSelect 查询结果映射结构体ToStruct
func TestSelect(t *testing.T) {
	toStruct, err := tcode.Select[*tables.TbTest](ctx).AppendSQL(" WHERE id=?", pkid).ToStruct()
	if err != nil {
		panic(err)
	}
	fmt.Println(toStruct, err)
}

查询结果映射为切片

// TestSelect1 查询结果映射为切片
func TestSelect1(t *testing.T) {
	//PossibleQueryEmptyColumn 查询的列可能有空数据(nil)
	//toSlice, err := tcode.Select[*tables.TbTest](ctx).PossibleQueryEmptyColumn().ToSlice(nil)
	toSlice, err := tcode.Select[*tables.TbTest](ctx).ToSlice(nil)
	if err != nil {
		panic(err)
	}
	slice := *toSlice
	for i := range slice {
		fmt.Println(slice[i])
	}
}

没有结构体的情况下,将查询结果映射为原始表

// TestSelectToRawTable 没有结构体的情况下,将查询结果映射为原始表
func TestSelectToRawTable(t *testing.T) {
	table, err := tcode.NewSqlInfo(ctx, "select * FROM tb_test").ToRawTable(nil)
	if err != nil {
		panic(err)
	}
	//获取行
	row := table.GetRow(1)
	fmt.Println(row["id"])

	//获取列
	col := table.GetColumnByIndex(2)
	//col := table.GetColumnByName("列明")
	for i := range col {
		fmt.Println(col[i])
	}
}

分页查询

// TestPage 分页查询
func TestPage(t *testing.T) {
	newPage := tcode.NewPage()
	newPage.PageSize = 2
	newPage.NextPage = 1
	page, err := tcode.Select[*tables.TbTest](ctx, "id,article_title").PossibleQueryEmptyColumn().ToPage(newPage)
	if err != nil {
		panic(err)
	}
	p := *page
	for i := range p {
		fmt.Println(p[i].Id)
		fmt.Println(p[i].ArticleTitle)
	}
	fmt.Println(newPage)
}

自定义分页查询总记录数函数

// TestPage2 分页查询;自定义查询总记录数函数
func TestPage2(t *testing.T) {
	newPage := tcode.NewPage()
	newPage.PageSize = 2
	newPage.NextPage = 1
	newPage.FuncCustomTotal = func(total *int) error {
		err := tcode.NewSqlInfo(ctx, "SELECT COUNT(*) FROM tb_test").ToVar(total)
		if err != nil {
			return err
		}
		return nil
	}
	page, err := tcode.Select[*tables.TbTest](ctx, "id,article_title").PossibleQueryEmptyColumn().ToSlice(newPage)
	if err != nil {
		panic(err)
	}
	p := *page
	for i := range p {
		fmt.Println(p[i].Id)
		fmt.Println(p[i].ArticleTitle)
	}
	fmt.Println(newPage)
}

查询条件,in,like

// TestSelect4 查询条件,in,like
func TestSelect4(t *testing.T) {
	ids := []int32{pkid}
	cids := []int{186}
	slice, err := tcode.Select[*tables.TbTest](ctx).AppendSQL("WHERE id in (?) AND category_id IN (?) and  article_title like ?", ids, cids, "%测试%").ToSlice(nil)
	if err != nil {
		panic(err)
	}
	s := *slice
	for i := range s {
		fmt.Println(s[i])
	}
}

使用事务

// TestTransaction 使用事务
func TestTransaction(t *testing.T) {
	err := tcode.Transaction(ctx, func(ctx context.Context) error {
		var tb tables.TbTest
		tb.UserId = 199999
		tb.CategoryId = 123
		tb.ArticleCover = "rollback"
		tb.ArticleTitle = "ArticleTitle"
		tb.ArticleContent = "ArticleContent"
		tb.Type = 4
		tb.OriginalUrl = "OriginalUrl"
		tb.IsTop = 1
		tb.IsDelete = 0
		tb.Status = 1
		tb.Sortno = 99
		tb.UpdateTime = time.Now()
		insert, id, err := tcode.Insert(ctx, &tb)
		fmt.Println(insert, id, err)

		err2 := tcode.Transaction(ctx, func(ctx context.Context) error {
			var tb tables.TbTest
			tb.UserId = 199999
			tb.CategoryId = 123
			tb.ArticleCover = "commit"
			tb.ArticleTitle = "ArticleTitle"
			tb.ArticleContent = "ArticleContent"
			tb.Type = 4
			tb.OriginalUrl = "OriginalUrl"
			tb.IsTop = 1
			tb.IsDelete = 0
			tb.Status = 1
			tb.Sortno = 99
			tb.UpdateTime = time.Now()
			insert, id, err := tcode.Insert(ctx, &tb)
			fmt.Println(insert, id, err)
			return nil
		})
		fmt.Println(err2)

		insert, id, err = tcode.Insert(ctx, &tb)
		fmt.Println(insert, id, err)

		return errors.New("rollback")
	})
	fmt.Println(err)
}

开启调试sql

// TestDebugSQL 开启调试sql,会将参数值拼接好的完整sql打印至控制台,用户开发阶段调试复杂sql,可直接在sql控制台执行的sql
func TestDebugSQL(t *testing.T) {
    conf = &tcode.Config{
        Dsn:                   "root:root@tcp(127.0.0.1:3306)/test?charset=utf8mb4&parseTime=true&loc=Local",
        DriverName:            "mysql",
        Dialect:               "mysql",
        MaxOpenConns:          50,
        MaxIdleConns:          50,
        ConnMaxLifetimeSecond: 600,
        PrimaryKeyColumnName:  "id",
        DebugSQL:              true,
    }
    _, _, _ = tcode.New(conf)
    ids := []int32{pkid}
    cids := []int{186}
    slice, err := tcode.Select[*tables.TbTest](context.Background()).AppendSQL("WHERE id in (?) AND category_id IN (?) and  article_title like ?", ids, cids, "%测试%").ToSlice(nil)
    if err != nil {
        panic(err)
    }
    s := *slice
    for i := range s {
        fmt.Println(s[i])
    }
}

日志重写

tcode.FuncLog = func(arbitrarily ...interface{}) {
    // 日志重写
}
tcode.FuncSQLLog = func(ms float64, sql string, params []any) {
    // sql日志重写
}

不实现Table接口进行表和结构体进行转换

// Test_rawTable_ConvertStruct 转换结构体
func Test_rawTable_ConvertStruct(t *testing.T) {
	test1 := struct {
		Id           int32
		ArticleTitle string
		CreateTime   time.Time
		UpdateTime   time.Time
		Sortno       int32
	}{}
	table, err := NewSqlInfo(ctx, "select * FROM tb_test where id=?", 1014).ToRawTable(nil)
	if err != nil {
		fmt.Println(err)
	}
	err = Convert(table,&test1)
	fmt.Println(err, test1)
}

// Test_rawTable_Convert_Slice 转换结构体切片
func Test_rawTable_Convert_Slice(t *testing.T) {
	var test1 []struct {
		Id           int32
		ArticleTitle string
		CreateTime   time.Time
		UpdateTime   time.Time
		Sortno       int32
	}
	table, err := NewSqlInfo(ctx, "select * FROM tb_test where id=?", 1014).ToRawTable(nil)
	if err != nil {
		fmt.Println(err)
	}
	err = Convert(table,&test1)
	fmt.Println(err, test1)
}

rawTable 转换基本类型切片

// Test_rawTable_ConvertColIndex_Var_Slice 转换基本类型切片
func Test_rawTable_ConvertColIndex_Var_Slice(t *testing.T) {
	var test1 []int
	table, err := NewSqlInfo(ctx, "select id,user_id FROM tb_test where id=?", 1014).ToRawTable(nil)
	if err != nil {
		fmt.Println(err)
	}
	err = ConvertColIndex(table, 1, &test1)
	fmt.Println(err, test1)
}

rawTable分页查询

// Test_rawTable_Convert_Slice rawTable分页查询
func Test_rawTable_Convert_Slice_QueryPage(t *testing.T) {
	var test1 []struct {
		Id           int32
		ArticleTitle string
		CreateTime   time.Time
		UpdateTime   time.Time
		Sortno       int32
	}
	newPage := NewPage()
	table, err := NewSqlInfo(ctx, "select * FROM tb_test").ToRawTable(newPage)
	if err != nil {
		fmt.Println(err)
	}
	err = Convert(table, &test1)
	fmt.Println(newPage, err, test1)
}

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_master 分支
  3. 提交代码
  4. 新建 Pull Request
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Go语言轻量ORM,极简封装,支持基本类型,结构体,切片,分页结果映射,原始表数据映射(行,列) 展开 收起
Go
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/yan-shi-kun/tcode.git
git@gitee.com:yan-shi-kun/tcode.git
yan-shi-kun
tcode
tcode
master

搜索帮助