3 Star 51 Fork 2

yunyouzi / sorm

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

sorm-logo

china-logo

Security Status

SORM 操作框架,是一款适配国产化数据库操作的golang orm 框架,内部适配分库分表策略,提供类似于GORM的操作形式。内部包含所有数据库驱动,直接使用原生的驱动构建而成,提供一站式数据托管的数据操作能力。 欢迎对数据库感兴趣的小伙伴一起来改进这个库,毕竟以我自己一个人的力量还是微小,很多不足之处,欢迎给我留言。 [TOC]

目前支持的数据库驱动如下:

  • dm 达梦
  • gobase
  • kingbase
  • mysql
  • opengauss
  • oracle
  • postgres
  • shentong
  • sqlite
  • yxres 优炫
  • odbc 驱动

后期改进

  1. 神通和达梦的数据库 大小写还是很反人类,设置大小写敏感,使用小写自动转成大写了,如果想使用小写需要使用"" 括起来处理,但是sql 又比较灵活,还有很多聚合和统计的函数不能一一实现,索性就让这两个数据库都使用大写的表名和字段去处理
  2. 关于数据库的自增,目前只支持字段自增,不能使用sequence,因为要同时兼容很多数据库,需要适配,这是也是一个坑。
  3. 还有一些数据库方言类的数据格式需要适配,可能需要一些细微的调整

数据库分库分表功能:

表指定数据库

// 单独给一个表存放一个数据库:
// cofnig 是数据库的配置文件
engine.AddDB("user", &conf)

分表策略

// TableName:表名
// TableShardType 分表策略
// TableSegName 表中分表的字段
engine.AddSpliter( spliter.Split{TableName: tableName, TableShardType: shardType, TableSegName: segName})
取模
%5:按照取模来分表,user_0、user_1,user_2、user_3,user_4
按照分表字段的对应的值 取模上面的数字,例如表名,user,分表的字段是age,按照分表策略%2,生成的表名就是user_0、user_1
时间:
m:按照月来分表 对应的表名为user_202001,user_202002,user_202003...
d:按照天来分表 对应的表名为,user_20200101,user_20200102,user_20200103...      
w:按照周来分表 对应的表名为user_202028,user_202029,user_202030,...
h:按照小时来分表 对应的表为user_2020010101 
y:按照年来分表 对应的表名为user_2020,user_2021,user_2022,user_2023,...

数据库操作

初始化数据库引擎

conf := server.Config{ // 初始化一个engine
		Type:     "dm",
		Host:     "192.168.81.36",
		Port:     5236,
		Username: "test",
		Password: "123456",
		Database: "test",
	}

	engine, err := NewEngineWithConfig(&conf)
	if err != nil {
		t.Fatal("failed to connect", err)
	}

定义数据表结构

type User struct {
	Name       string    `column:"name" sorm:"PRIMARY KEY"`
	Age        int       `json:"age" form:"age" column:"age"`
	CreateTime time.Time `json:"create_time" form:"create_time"  column:"create_time"`
	Num        *int      `json:"num"  form:"num"  column:"num"`
}

func (u *User) GetTableName() string {
	return "user"
}
上述代码定义了一个名为 User 的结构体,它对应数据库中的 user 表。结构体字段使用 column 标签指定了对应的数据库列名。
目前仅支持自增主键,使用 sorm:"PRIMARY KEY" 来表示,还未启用各个数据库的sequence,这个功能还没想好怎么加。

事务

事务框架会自动代理所有的数据库,提供整体的事务处理    
使用数据库引擎的 Transaction 方法可以进行数据库事务操作。示例如下:
engine.Transaction(func(s *session.Session) (result interface{}, err error) {
	s.Where("name =?", "John").First(&User{}) // find a user with name "John"") 
	
}

创建数据:

使用数据库引擎的 Create 方法可以向数据库中插入数据。示例如下:

func create(t *testing.T) {
	engine := OpenDB(t)
	defer engine.Close()

	u1 := User{Name: "Tom", CreateTime: time.Now()}
	us := []User{
		{Name: "Tom", Age: 18, CreateTime: t1, Num: n1},
		{Name: "liu", Age: 19, CreateTime: t1, Num: n1},
		{Name: "lao", Age: 20, CreateTime: time.Now()},
		{Name: "ban", Age: 21, CreateTime: time.Now()},
	}

	s := engine.NewSession()

	_, err := s.Create(&us)
	if err != nil {
		log.Infof("err:%+v\n", err)
		return
	}

	_, err = s.Create(&u1)
	if err != nil {
		log.Infof("err:%+v\n", err)
		return
	}

	_, err = s.Select("name", "age").Create(&u1)
	if err != nil {
		log.Infof("err:%+v\n", err)
		return
	}

	_, err = s.Select("name", "age").Create(&us)
	if err != nil {
		log.Infof("err:%+v\n", err)
		return
	}
}
上述代码通过调用 engine.NewSession 创建一个数据库会话,然后使用会话的 Create 方法插入数据。可以一次插入多个数据,传入的参数为对应的结构体和切片。

查询数据

查询数据可选的方法就就比较多了

Select("name", "age")  // 选择指定的字段
Omit("name") // 选择不显示指定的字段
Join(LEFT, "a", "a.id=b.id") // join 类型/表/连接条件
Limit(10)
Offset(10)
OrderBy("name desc") // order by
GroupBy("name") // group by
Having  


var ps []Point

err := s.Model(&Point{}).Select("t19").Find(&ps)
if err != nil {
    panic(err)
}

fmt.Println("ps:", ps)

更新数据

func UpdatePoint(t *testing.T) {
	engine := OpenDB(t)
	defer engine.Close()
	//engine.AddUserSplitter()
	s := engine.NewSession()

	_, err := s.Model(&Point{}).Where("num = ?", 1).Update("t19 = ?", time.Now())
	if err != nil {
		panic(err)
	}

}

删除数据


func deletePointTran(t *testing.T) {

	engine := OpenDB(t)
	defer engine.Close()
	engine.AddUserSplitter()

	engine.Transaction(func(s *session.Session) (interface{}, error) {
		_, err := s.Model(&Point{}).Where("num = ? and name = ?", 4, "liu").Delete()

		if err != nil {
			panic(err)
		}
		return nil, nil
	})

}
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.

简介

sorm golang 基于原生驱动适配了国产化数据库的orm 框架 展开 收起
Go 等 4 种语言
Apache-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/zhendliu/sorm.git
git@gitee.com:zhendliu/sorm.git
zhendliu
sorm
sorm
master

搜索帮助