{"id":32750021,"url":"https://github.com/dobyte/mongo-dao-generator","last_synced_at":"2025-11-03T22:04:00.813Z","repository":{"id":63560203,"uuid":"567667524","full_name":"dobyte/mongo-dao-generator","owner":"dobyte","description":"A tool for generating dao files based on models","archived":false,"fork":false,"pushed_at":"2025-04-30T07:31:40.000Z","size":2873,"stargazers_count":13,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-30T08:41:18.036Z","etag":null,"topics":["dao-generator","mongo","mongo-dao","mongo-dao-generator"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dobyte.png","metadata":{"files":{"readme":"README-zh.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-18T09:48:00.000Z","updated_at":"2025-04-30T07:30:30.000Z","dependencies_parsed_at":"2024-05-07T13:49:39.034Z","dependency_job_id":null,"html_url":"https://github.com/dobyte/mongo-dao-generator","commit_stats":{"total_commits":15,"total_committers":1,"mean_commits":15.0,"dds":0.0,"last_synced_commit":"29dd74c8f91d50159e62447373a801e51d56de91"},"previous_names":["dobyte/gen-mongo-dao"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/dobyte/mongo-dao-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dobyte%2Fmongo-dao-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dobyte%2Fmongo-dao-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dobyte%2Fmongo-dao-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dobyte%2Fmongo-dao-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dobyte","download_url":"https://codeload.github.com/dobyte/mongo-dao-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dobyte%2Fmongo-dao-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":282536467,"owners_count":26685728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-03T02:00:05.676Z","response_time":108,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dao-generator","mongo","mongo-dao","mongo-dao-generator"],"created_at":"2025-11-03T22:02:01.244Z","updated_at":"2025-11-03T22:04:00.803Z","avatar_url":"https://github.com/dobyte.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mongo-dao-generator\n\n[English Document](README.md)\n\n### 1.介绍\n\nmongo-dao-generator是一个自动化生成MongoDB数据访问对象（Data Access Object）的工具。\n\n### 2.优势\n\n* 支持primitive.ObjectID、primitive.DateTime类型的自动填充。\n\n* 支持int、int8、int16、int32、int64、uint、uint8、uint16、uint32、uint64类型的自增长。\n\n* 提供了对数据库字段的统一生成方案，避免了业务代码中随处可见的数据库字段的问题。\n\n* 提供了包括InsertOne、InsertMany、UpdateOne、UpdateOneByID、UpdateMany、FindOne、FindOneByID、FindMany、DeleteOne、DeleteOneByID、DeleteMany、Count、Aggregate等多种数据库操作接口。\n\n* 提供了对数据库操作接口的扩展能力。\n\n* 提供了分包与不分包两种包解决方案。\n\n* 支持目录和文件名风格的自定义。\n\n### 3.安装\n\n```bash\ngo env -w GOSUMDB=off\ngo install github.com/dobyte/mongo-dao-generator@latest\ngo env -w GOSUMDB=on\n```\n\n### 4.用法\n\n```bash\nUsage of mongo-dao-generator:\n    mongo-dao-generator [flags] -model-dir=. -model-names=T,T -dao-dir=./dao\nFor more information, see:\n    https://github.com/dobyte/mongo-dao-generator\nFlags:\n  -counter-name string\n        specify the counter name; default is counter\n  -dao-dir string\n        specify the output directory of dao files; must be set\n  -dao-pkg-path string\n        specify the package path corresponding to the output directory of the dao files; automatically generated by default\n  -file-style string\n        specify the generation style for file; options: kebab | underscore | lower | camel | pascal; default is underscore (default \"underscore\")\n  -model-dir string\n        specify the model directory; must be set\n  -model-names string\n        specify the comma-separated list of model name; must be set\n  -model-pkg-alias string\n        specify a model package alias; default no alias\n  -model-pkg-path string\n        specify the package path corresponding to the model directory; automatically calculated by default\n  -sub-pkg-enable\n        specify whether to enable subpkg; default disable\n  -sub-pkg-style string\n        specify the generation style for subpkg; options: kebab | underscore | lower | camel | pascal; default is kebab (default \"kebab\")\n```\n\n### 5.标签\n\n在模型定义中支持对gen标签的解析，目前支持以下标签解析：\n\n| 标签名称     |                                                            | 示例                 | 说明                         |\n| -------- | ---------------------------------------------------------- | ------------------ | -------------------------- |\n| autoFill | primitive.ObjectID、primitive.DateTime                      | gen:\"autoFill\"     |                            |\n| autoIncr | int、int8、int16、int32、int64、uint、uint8、uint16、uint32、uint64 | gen:\"autoIncr:uid\" | 该自增为原子操作，会在生成代码时同步生成计数器代码。 |\n\n### 6.示例\n\n###### 6-1.创建模型\n\nmodel/mail.go\n\n```go\npackage model\n\nimport \"go.mongodb.org/mongo-driver/bson/primitive\"\n\n//go:generate mongo-dao-generator -model-dir=. -model-names=Mail -dao-dir=../dao/\ntype Mail struct {\n    ID       primitive.ObjectID `bson:\"_id\" gen:\"autoFill\"`       // 邮件ID\n    Title    string             `bson:\"title\"`                    // 邮件标题\n    Content  string             `bson:\"content\"`                  // 邮件内容\n    Sender   int64              `bson:\"sender\"`                   // 邮件发送者\n    Receiver int64              `bson:\"receiver\"`                 // 邮件接受者\n    Status   int                `bson:\"status\"`                   // 邮件状态\n    SendTime primitive.DateTime `bson:\"send_time\" gen:\"autoFill\"` // 发送时间\n}\n```\n\n###### 6-2.生成dao文件\n\n```bash\ngo generate ./...\n```\n\n###### 6-3.生成的dao文件示例\n\ndao/internal/mail.go\n\n```go\n// --------------------------------------------------------------------------------------------\n// The following code is automatically generated by the mongo-dao-generator tool.\n// Please do not modify this code manually to avoid being overwritten in the next generation.\n// For more tool details, please click the link to view https://github.com/dobyte/mongo-dao-generator\n// --------------------------------------------------------------------------------------------\n\npackage internal\n\nimport (\n    \"context\"\n    \"errors\"\n    models \"github.com/dobyte/mongo-dao-generator/example/model\"\n    \"go.mongodb.org/mongo-driver/bson\"\n    \"go.mongodb.org/mongo-driver/bson/primitive\"\n    \"go.mongodb.org/mongo-driver/mongo\"\n    \"go.mongodb.org/mongo-driver/mongo/options\"\n    \"time\"\n)\n\ntype MailFilterFunc func(cols *MailColumns) interface{}\ntype MailUpdateFunc func(cols *MailColumns) interface{}\ntype MailPipelineFunc func(cols *MailColumns) interface{}\ntype MailCountOptionsFunc func(cols *MailColumns) *options.CountOptions\ntype MailAggregateOptionsFunc func(cols *MailColumns) *options.AggregateOptions\ntype MailFindOneOptionsFunc func(cols *MailColumns) *options.FindOneOptions\ntype MailFindManyOptionsFunc func(cols *MailColumns) *options.FindOptions\ntype MailUpdateOptionsFunc func(cols *MailColumns) *options.UpdateOptions\ntype MailDeleteOptionsFunc func(cols *MailColumns) *options.DeleteOptions\ntype MailInsertOneOptionsFunc func(cols *MailColumns) *options.InsertOneOptions\ntype MailInsertManyOptionsFunc func(cols *MailColumns) *options.InsertManyOptions\n\ntype Mail struct {\n    Columns    *MailColumns\n    Database   *mongo.Database\n    Collection *mongo.Collection\n}\n\ntype MailColumns struct {\n    ID       string // 邮件ID\n    Title    string // 邮件标题\n    Content  string // 邮件内容\n    Sender   string // 邮件发送者\n    Receiver string // 邮件接受者\n    Status   string // 邮件状态\n    SendTime string // 发送时间\n}\n\nvar mailColumns = \u0026MailColumns{\n    ID:       \"_id\",       // 邮件ID\n    Title:    \"title\",     // 邮件标题\n    Content:  \"content\",   // 邮件内容\n    Sender:   \"sender\",    // 邮件发送者\n    Receiver: \"receiver\",  // 邮件接受者\n    Status:   \"status\",    // 邮件状态\n    SendTime: \"send_time\", // 发送时间\n}\n\nfunc NewMail(db *mongo.Database) *Mail {\n    return \u0026Mail{\n        Columns:    mailColumns,\n        Database:   db,\n        Collection: db.Collection(\"mail\"),\n    }\n}\n\n// Count returns the number of documents in the collection.\nfunc (dao *Mail) Count(ctx context.Context, filterFunc MailFilterFunc, optionsFunc ...MailCountOptionsFunc) (int64, error) {\n    var (\n        opts   *options.CountOptions\n        filter = filterFunc(dao.Columns)\n    )\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    return dao.Collection.CountDocuments(ctx, filter, opts)\n}\n\n// Aggregate executes an aggregate command against the collection and returns a cursor over the resulting documents.\nfunc (dao *Mail) Aggregate(ctx context.Context, pipelineFunc MailPipelineFunc, optionsFunc ...MailAggregateOptionsFunc) (*mongo.Cursor, error) {\n    var (\n        opts     *options.AggregateOptions\n        pipeline = pipelineFunc(dao.Columns)\n    )\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    return dao.Collection.Aggregate(ctx, pipeline, opts)\n}\n\n// InsertOne executes an insert command to insert a single document into the collection.\nfunc (dao *Mail) InsertOne(ctx context.Context, model *models.Mail, optionsFunc ...MailInsertOneOptionsFunc) (*mongo.InsertOneResult, error) {\n    if model == nil {\n        return nil, errors.New(\"model is nil\")\n    }\n\n    if err := dao.autofill(ctx, model); err != nil {\n        return nil, err\n    }\n\n    var opts *options.InsertOneOptions\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    return dao.Collection.InsertOne(ctx, model, opts)\n}\n\n// InsertMany executes an insert command to insert multiple documents into the collection.\nfunc (dao *Mail) InsertMany(ctx context.Context, models []*models.Mail, optionsFunc ...MailInsertManyOptionsFunc) (*mongo.InsertManyResult, error) {\n    if len(models) == 0 {\n        return nil, errors.New(\"models is empty\")\n    }\n\n    documents := make([]interface{}, 0, len(models))\n    for i := range models {\n        model := models[i]\n        if err := dao.autofill(ctx, model); err != nil {\n            return nil, err\n        }\n        documents = append(documents, model)\n    }\n\n    var opts *options.InsertManyOptions\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    return dao.Collection.InsertMany(ctx, documents, opts)\n}\n\n// UpdateOne executes an update command to update at most one document in the collection.\nfunc (dao *Mail) UpdateOne(ctx context.Context, filterFunc MailFilterFunc, updateFunc MailUpdateFunc, optionsFunc ...MailUpdateOptionsFunc) (*mongo.UpdateResult, error) {\n    var (\n        opts   *options.UpdateOptions\n        filter = filterFunc(dao.Columns)\n        update = updateFunc(dao.Columns)\n    )\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    return dao.Collection.UpdateOne(ctx, filter, update, opts)\n}\n\n// UpdateOneByID executes an update command to update at most one document in the collection.\nfunc (dao *Mail) UpdateOneByID(ctx context.Context, id string, updateFunc MailUpdateFunc, optionsFunc ...MailUpdateOptionsFunc) (*mongo.UpdateResult, error) {\n    objectID, err := primitive.ObjectIDFromHex(id)\n    if err != nil {\n        return nil, err\n    }\n\n    return dao.UpdateOne(ctx, func(cols *MailColumns) interface{} {\n        return bson.M{\"_id\": objectID}\n    }, updateFunc, optionsFunc...)\n}\n\n// UpdateMany executes an update command to update documents in the collection.\nfunc (dao *Mail) UpdateMany(ctx context.Context, filterFunc MailFilterFunc, updateFunc MailUpdateFunc, optionsFunc ...MailUpdateOptionsFunc) (*mongo.UpdateResult, error) {\n    var (\n        opts   *options.UpdateOptions\n        filter = filterFunc(dao.Columns)\n        update = updateFunc(dao.Columns)\n    )\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    return dao.Collection.UpdateMany(ctx, filter, update, opts)\n}\n\n// FindOne executes a find command and returns a model for one document in the collection.\nfunc (dao *Mail) FindOne(ctx context.Context, filterFunc MailFilterFunc, optionsFunc ...MailFindOneOptionsFunc) (*models.Mail, error) {\n    var (\n        opts   *options.FindOneOptions\n        model  = \u0026models.Mail{}\n        filter = filterFunc(dao.Columns)\n    )\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    err := dao.Collection.FindOne(ctx, filter, opts).Decode(model)\n    if err != nil {\n        if err == mongo.ErrNoDocuments {\n            return nil, nil\n        }\n        return nil, err\n    }\n\n    return model, nil\n}\n\n// FindOneByID executes a find command and returns a model for one document in the collection.\nfunc (dao *Mail) FindOneByID(ctx context.Context, id string, optionsFunc ...MailFindOneOptionsFunc) (*models.Mail, error) {\n    objectID, err := primitive.ObjectIDFromHex(id)\n    if err != nil {\n        return nil, err\n    }\n\n    return dao.FindOne(ctx, func(cols *MailColumns) interface{} {\n        return bson.M{\"_id\": objectID}\n    }, optionsFunc...)\n}\n\n// FindMany executes a find command and returns many models the matching documents in the collection.\nfunc (dao *Mail) FindMany(ctx context.Context, filterFunc MailFilterFunc, optionsFunc ...MailFindManyOptionsFunc) ([]*models.Mail, error) {\n    var (\n        opts   *options.FindOptions\n        filter = filterFunc(dao.Columns)\n    )\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    cur, err := dao.Collection.Find(ctx, filter, opts)\n    if err != nil {\n        return nil, err\n    }\n\n    models := make([]*models.Mail, 0)\n\n    if err = cur.All(ctx, \u0026models); err != nil {\n        return nil, err\n    }\n\n    return models, nil\n}\n\n// DeleteOne executes a delete command to delete at most one document from the collection.\nfunc (dao *Mail) DeleteOne(ctx context.Context, filterFunc MailFilterFunc, optionsFunc ...MailDeleteOptionsFunc) (*mongo.DeleteResult, error) {\n    var (\n        opts   *options.DeleteOptions\n        filter = filterFunc(dao.Columns)\n    )\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    return dao.Collection.DeleteOne(ctx, filter, opts)\n}\n\n// DeleteOneByID executes a delete command to delete at most one document from the collection.\nfunc (dao *Mail) DeleteOneByID(ctx context.Context, id string, optionsFunc ...MailDeleteOptionsFunc) (*mongo.DeleteResult, error) {\n    objectID, err := primitive.ObjectIDFromHex(id)\n    if err != nil {\n        return nil, err\n    }\n\n    return dao.DeleteOne(ctx, func(cols *MailColumns) interface{} {\n        return bson.M{\"_id\": objectID}\n    }, optionsFunc...)\n}\n\n// DeleteMany executes a delete command to delete documents from the collection.\nfunc (dao *Mail) DeleteMany(ctx context.Context, filterFunc MailFilterFunc, optionsFunc ...MailDeleteOptionsFunc) (*mongo.DeleteResult, error) {\n    var (\n        opts   *options.DeleteOptions\n        filter = filterFunc(dao.Columns)\n    )\n\n    if len(optionsFunc) \u003e 0 {\n        opts = optionsFunc[0](dao.Columns)\n    }\n\n    return dao.Collection.DeleteMany(ctx, filter, opts)\n}\n\n// autofill when inserting data\nfunc (dao *Mail) autofill(ctx context.Context, model *models.Mail) error {\n    if model.ID.IsZero() {\n        model.ID = primitive.NewObjectID()\n    }\n\n    if model.SendTime == 0 {\n        model.SendTime = primitive.NewDateTimeFromTime(time.Now())\n    }\n\n    return nil\n}\n```\n\ndao/mail.go\n\n```go\npackage dao\n\nimport (\n    \"github.com/dobyte/mongo-dao-generator/example/dao/internal\"\n    \"go.mongodb.org/mongo-driver/mongo\"\n)\n\ntype MailColumns = internal.MailColumns\n\ntype Mail struct {\n    *internal.Mail\n}\n\nfunc NewMail(db *mongo.Database) *Mail {\n    return \u0026Mail{Mail: internal.NewMail(db)}\n}\n```\n\n###### 6-4.使用生成的dao文件\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"github.com/dobyte/mongo-dao-generator/example/dao\"\n    \"github.com/dobyte/mongo-dao-generator/example/model\"\n    \"go.mongodb.org/mongo-driver/bson\"\n    \"go.mongodb.org/mongo-driver/mongo\"\n    \"go.mongodb.org/mongo-driver/mongo/options\"\n    \"go.mongodb.org/mongo-driver/mongo/readpref\"\n    \"log\"\n    \"time\"\n)\n\nfunc main() {\n    var (\n        uri     = \"mongodb://root:12345678@127.0.0.1:27017\"\n        opts    = options.Client().ApplyURI(uri)\n        baseCtx = context.Background()\n    )\n\n    ctx, cancel := context.WithTimeout(baseCtx, 5*time.Second)\n    client, err := mongo.Connect(ctx, opts)\n    cancel()\n    if err != nil {\n        log.Fatalf(\"connect mongo server failed: %v\", err)\n    }\n\n    ctx, cancel = context.WithTimeout(baseCtx, 5*time.Second)\n    defer cancel()\n    err = client.Ping(ctx, readpref.Primary())\n    cancel()\n    if err != nil {\n        log.Fatalf(\"ping mongo server failed: %v\", err)\n    }\n\n    db := client.Database(\"dao_test\")\n\n    mailDao := dao.NewMail(db)\n\n    _, err = mailDao.InsertOne(baseCtx, \u0026model.Mail{\n        Title:    \"mongo-dao-generator introduction\",\n        Content:  \"the mongo-dao-generator is a tool for automatically generating MongoDB Data Access Object.\",\n        Sender:   1,\n        Receiver: 2,\n        Status:   1,\n    })\n    if err != nil {\n        log.Fatalf(\"failed to insert into mongo database: %v\", err)\n    }\n\n    mail, err := mailDao.FindOne(baseCtx, func(cols *dao.MailColumns) interface{} {\n        return bson.M{cols.Receiver: 2}\n    })\n    if err != nil {\n        log.Fatalf(\"failed to find a row of data from mongo database: %v\", err)\n    }\n\n    log.Printf(\"%+v\", mail)\n}\n```\n\n运行结果:\n\n```bash\n2023/02/17 16:05:31 \u0026{ID:ObjectID(\"63ef354a4ddc485f0d9c5ea3\") Title:mongo-dao-generator introduction Content:the mongo-dao-generator is a tool for automatically generating MongoDB Data Access Object. Sender:1 Receiver:2 Status:1 SendTime:1676621130323}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdobyte%2Fmongo-dao-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdobyte%2Fmongo-dao-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdobyte%2Fmongo-dao-generator/lists"}