├── LICENSE ├── README.md ├── errors.go ├── go.mod ├── go.sum ├── repository.go └── types.go /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2021 Alexander Klinkert 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # go-gorm-repository 2 | 3 | This is a simple repository implementation for [GORM](https://gorm.io/) providing basic functions to CRUD and query 4 | entities as well as transactions and common error handling. 5 | 6 | ## Example 7 | 8 | For a complete list of supported methods, please see [types.go](types.go). 9 | 10 | ```go 11 | package main 12 | 13 | import ( 14 | "github.com/sirupsen/logrus" 15 | "github.com/aklinkert/go-gorm-repository" 16 | "gorm.io/gorm" 17 | ) 18 | 19 | func main() { 20 | logger := logrus.New() 21 | db, _ := gorm.Open(_, _) 22 | 23 | // third parameter is a list of related entities that should always preload 24 | repo := gormrepository.NewGormRepository(db, logger, "CreatorUser", "Organization") 25 | 26 | instance := &exampleModel{} 27 | 28 | if err := repo.Create(instance); err != nil { 29 | logger.Fatalf("failed to create cache instance: %v", err) 30 | } 31 | } 32 | ``` 33 | 34 | If you want to extend the repository with your own base or model repository just embed the interface into your implementation like so: 35 | 36 | ```go 37 | package base 38 | 39 | import "github.com/aklinkert/go-gorm-repository" 40 | 41 | type BaseRepository interface { 42 | gormrepository.TransactionRepository 43 | GetOneByName(target interface{}, name string, preloads ...string) error 44 | } 45 | 46 | type repository struct { 47 | gormrepository.TransactionRepository 48 | } 49 | 50 | func NewRepository(db *gorm.DB, logger logging.Logger) BaseRepository { 51 | return &repository{ 52 | TransactionRepository: gormrepository.NewGormRepository(db, logger, "Creator"), 53 | } 54 | } 55 | 56 | func (r *repository) GetOneByName(target interface{}, name string, preloads ...string) error { 57 | return r.TransactionRepository.GetOneByField(target, "name", name, preloads...) 58 | } 59 | ``` 60 | 61 | ## License 62 | 63 | Apache 2.0 License 64 | -------------------------------------------------------------------------------- /errors.go: -------------------------------------------------------------------------------- 1 | package gormrepository 2 | 3 | import ( 4 | "gorm.io/gorm" 5 | ) 6 | 7 | var ( 8 | // ErrNotFound is a convenience reference for the actual GORM error 9 | ErrNotFound = gorm.ErrRecordNotFound 10 | ) 11 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/aklinkert/go-gorm-repository 2 | 3 | go 1.15 4 | 5 | require ( 6 | github.com/aklinkert/go-logging v1.2.0 7 | gorm.io/gorm v1.20.9 8 | ) 9 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/aklinkert/go-logging v1.2.0 h1:Q5Mtw1BL84jfLz1HHyGSzQRYbzOL6GD+AnG8qSW7UNY= 2 | github.com/aklinkert/go-logging v1.2.0/go.mod h1:V0MxTepK3deGSzl8okalz1ZViHNK0e3Srn739jzKrjw= 3 | github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E= 4 | github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc= 5 | github.com/jinzhu/now v1.1.1 h1:g39TucaRWyV3dwDO++eEc6qf8TVIQ/Da48WmqjZ3i7E= 6 | github.com/jinzhu/now v1.1.1/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8= 7 | gorm.io/gorm v1.20.9 h1:M3aIZKXAC1PtPVu9t3WGwkBTE1le5c2telz3I/qjRNg= 8 | gorm.io/gorm v1.20.9/go.mod h1:0HFTzE/SqkGTzK6TlDPPQbAYCluiVvhzoA1+aVyzenw= 9 | -------------------------------------------------------------------------------- /repository.go: -------------------------------------------------------------------------------- 1 | package gormrepository 2 | 3 | import ( 4 | "fmt" 5 | 6 | "github.com/aklinkert/go-logging" 7 | "gorm.io/gorm" 8 | ) 9 | 10 | type gormRepository struct { 11 | logger logging.Logger 12 | db *gorm.DB 13 | defaultJoins []string 14 | } 15 | 16 | // NewGormRepository returns a new base repository that implements TransactionRepository 17 | func NewGormRepository(db *gorm.DB, logger logging.Logger, defaultJoins ...string) TransactionRepository { 18 | return &gormRepository{ 19 | defaultJoins: defaultJoins, 20 | logger: logger, 21 | db: db, 22 | } 23 | } 24 | 25 | func (r *gormRepository) DB() *gorm.DB { 26 | return r.DBWithPreloads(nil) 27 | } 28 | 29 | func (r *gormRepository) GetAll(target interface{}, preloads ...string) error { 30 | r.logger.Debugf("Executing GetAll on %T", target) 31 | 32 | res := r.DBWithPreloads(preloads). 33 | Unscoped(). 34 | Find(target) 35 | 36 | return r.HandleError(res) 37 | } 38 | 39 | func (r *gormRepository) GetBatch(target interface{}, limit, offset int, preloads ...string) error { 40 | r.logger.Debugf("Executing GetBatch on %T", target) 41 | 42 | res := r.DBWithPreloads(preloads). 43 | Unscoped(). 44 | Limit(limit). 45 | Offset(offset). 46 | Find(target) 47 | 48 | return r.HandleError(res) 49 | } 50 | 51 | func (r *gormRepository) GetWhere(target interface{}, condition string, preloads ...string) error { 52 | r.logger.Debugf("Executing GetWhere on %T with %v ", target, condition) 53 | 54 | res := r.DBWithPreloads(preloads). 55 | Where(condition). 56 | Find(target) 57 | 58 | return r.HandleError(res) 59 | } 60 | 61 | func (r *gormRepository) GetWhereBatch(target interface{}, condition string, limit, offset int, preloads ...string) error { 62 | r.logger.Debugf("Executing GetWhere on %T with %v ", target, condition) 63 | 64 | res := r.DBWithPreloads(preloads). 65 | Where(condition). 66 | Limit(limit). 67 | Offset(offset). 68 | Find(target) 69 | 70 | return r.HandleError(res) 71 | } 72 | 73 | func (r *gormRepository) GetByField(target interface{}, field string, value interface{}, preloads ...string) error { 74 | r.logger.Debugf("Executing GetByField on %T with %v = %v", target, field, value) 75 | 76 | res := r.DBWithPreloads(preloads). 77 | Where(fmt.Sprintf("%v = ?", field), value). 78 | Find(target) 79 | 80 | return r.HandleError(res) 81 | } 82 | 83 | func (r *gormRepository) GetByFields(target interface{}, filters map[string]interface{}, preloads ...string) error { 84 | r.logger.Debugf("Executing GetByField on %T with filters = %+v", target, filters) 85 | 86 | db := r.DBWithPreloads(preloads) 87 | for field, value := range filters { 88 | db = db.Where(fmt.Sprintf("%v = ?", field), value) 89 | } 90 | 91 | res := db.Find(target) 92 | 93 | return r.HandleError(res) 94 | } 95 | 96 | func (r *gormRepository) GetByFieldBatch(target interface{}, field string, value interface{}, limit, offset int, preloads ...string) error { 97 | r.logger.Debugf("Executing GetByField on %T with %v = %v", target, field, value) 98 | 99 | res := r.DBWithPreloads(preloads). 100 | Where(fmt.Sprintf("%v = ?", field), value). 101 | Limit(limit). 102 | Offset(offset). 103 | Find(target) 104 | 105 | return r.HandleError(res) 106 | } 107 | 108 | func (r *gormRepository) GetByFieldsBatch(target interface{}, filters map[string]interface{}, limit, offset int, preloads ...string) error { 109 | r.logger.Debugf("Executing GetByField on %T with filters = %+v", target, filters) 110 | 111 | db := r.DBWithPreloads(preloads) 112 | for field, value := range filters { 113 | db = db.Where(fmt.Sprintf("%v = ?", field), value) 114 | } 115 | 116 | res := db. 117 | Limit(limit). 118 | Offset(offset). 119 | Find(target) 120 | 121 | return r.HandleError(res) 122 | } 123 | 124 | func (r *gormRepository) GetOneByField(target interface{}, field string, value interface{}, preloads ...string) error { 125 | r.logger.Debugf("Executing GetOneByField on %T with %v = %v", target, field, value) 126 | 127 | res := r.DBWithPreloads(preloads). 128 | Where(fmt.Sprintf("%v = ?", field), value). 129 | First(target) 130 | 131 | return r.HandleOneError(res) 132 | } 133 | 134 | func (r *gormRepository) GetOneByFields(target interface{}, filters map[string]interface{}, preloads ...string) error { 135 | r.logger.Debugf("Executing FindOneByField on %T with filters = %+v", target, filters) 136 | 137 | db := r.DBWithPreloads(preloads) 138 | for field, value := range filters { 139 | db = db.Where(fmt.Sprintf("%v = ?", field), value) 140 | } 141 | 142 | res := db.First(target) 143 | return r.HandleOneError(res) 144 | } 145 | 146 | func (r *gormRepository) GetOneByID(target interface{}, id string, preloads ...string) error { 147 | r.logger.Debugf("Executing GetOneByID on %T with ID %v", target, id) 148 | 149 | res := r.DBWithPreloads(preloads). 150 | Where("id = ?", id). 151 | First(target) 152 | 153 | return r.HandleOneError(res) 154 | } 155 | 156 | func (r *gormRepository) Create(target interface{}) error { 157 | r.logger.Debugf("Executing Create on %T", target) 158 | 159 | res := r.db.Create(target) 160 | return r.HandleError(res) 161 | } 162 | 163 | func (r *gormRepository) CreateTx(target interface{}, tx *gorm.DB) error { 164 | r.logger.Debugf("Executing Create on %T", target) 165 | 166 | res := tx.Create(target) 167 | return r.HandleError(res) 168 | } 169 | 170 | func (r *gormRepository) Save(target interface{}) error { 171 | r.logger.Debugf("Executing Save on %T", target) 172 | 173 | res := r.db.Save(target) 174 | return r.HandleError(res) 175 | } 176 | 177 | func (r *gormRepository) SaveTx(target interface{}, tx *gorm.DB) error { 178 | r.logger.Debugf("Executing Save on %T", target) 179 | 180 | res := tx.Save(target) 181 | return r.HandleError(res) 182 | } 183 | 184 | func (r *gormRepository) Delete(target interface{}) error { 185 | r.logger.Debugf("Executing Delete on %T", target) 186 | 187 | res := r.db.Delete(target) 188 | return r.HandleError(res) 189 | } 190 | 191 | func (r *gormRepository) DeleteTx(target interface{}, tx *gorm.DB) error { 192 | r.logger.Debugf("Executing Delete on %T", target) 193 | 194 | res := tx.Delete(target) 195 | return r.HandleError(res) 196 | } 197 | 198 | func (r *gormRepository) HandleError(res *gorm.DB) error { 199 | if res.Error != nil && res.Error != gorm.ErrRecordNotFound { 200 | err := fmt.Errorf("Error: %w", res.Error) 201 | r.logger.Error(err) 202 | return err 203 | } 204 | 205 | return nil 206 | } 207 | 208 | func (r *gormRepository) HandleOneError(res *gorm.DB) error { 209 | if err := r.HandleError(res); err != nil { 210 | return err 211 | } 212 | 213 | if res.RowsAffected != 1 { 214 | return ErrNotFound 215 | } 216 | 217 | return nil 218 | } 219 | 220 | func (r *gormRepository) DBWithPreloads(preloads []string) *gorm.DB { 221 | dbConn := r.db 222 | 223 | for _, join := range r.defaultJoins { 224 | dbConn = dbConn.Joins(join) 225 | } 226 | 227 | for _, preload := range preloads { 228 | dbConn = dbConn.Preload(preload) 229 | } 230 | 231 | return dbConn 232 | } 233 | -------------------------------------------------------------------------------- /types.go: -------------------------------------------------------------------------------- 1 | package gormrepository 2 | 3 | import ( 4 | "gorm.io/gorm" 5 | ) 6 | 7 | // Repository is a generic DB handler that cares about default error handling 8 | type Repository interface { 9 | GetAll(target interface{}, preloads ...string) error 10 | GetBatch(target interface{}, limit, offset int, preloads ...string) error 11 | 12 | GetWhere(target interface{}, condition string, preloads ...string) error 13 | GetWhereBatch(target interface{}, condition string, limit, offset int, preloads ...string) error 14 | 15 | GetByField(target interface{}, field string, value interface{}, preloads ...string) error 16 | GetByFields(target interface{}, filters map[string]interface{}, preloads ...string) error 17 | GetByFieldBatch(target interface{}, field string, value interface{}, limit, offset int, preloads ...string) error 18 | GetByFieldsBatch(target interface{}, filters map[string]interface{}, limit, offset int, preloads ...string) error 19 | 20 | GetOneByField(target interface{}, field string, value interface{}, preloads ...string) error 21 | GetOneByFields(target interface{}, filters map[string]interface{}, preloads ...string) error 22 | 23 | // GetOneByID assumes you have a PK column "id" which is a UUID. If this is not the case just ignore the method 24 | // and add a custom struct with this Repository embedded. 25 | GetOneByID(target interface{}, id string, preloads ...string) error 26 | 27 | Create(target interface{}) error 28 | Save(target interface{}) error 29 | Delete(target interface{}) error 30 | 31 | DB() *gorm.DB 32 | DBWithPreloads(preloads []string) *gorm.DB 33 | HandleError(res *gorm.DB) error 34 | HandleOneError(res *gorm.DB) error 35 | } 36 | 37 | // TransactionRepository extends Repository with modifier functions that accept a transaction 38 | type TransactionRepository interface { 39 | Repository 40 | CreateTx(target interface{}, tx *gorm.DB) error 41 | SaveTx(target interface{}, tx *gorm.DB) error 42 | DeleteTx(target interface{}, tx *gorm.DB) error 43 | } 44 | --------------------------------------------------------------------------------