Skip to content

Latest commit

 

History

History
127 lines (100 loc) · 3 KB

README.md

File metadata and controls

127 lines (100 loc) · 3 KB

CORM

The awesome CouchDB ORM library for Golang, aims to be developer friendly.

GoDoc Go Report Card

Overview

  • Our goal is to adapt/implement the Domain-Classes Methods from grails and some of the CouchDB specific Api for CouchDb
  • Be careful when using. The api can changed. We are in early state.
  • If you have some suggestions or concerns please contact us or make a issue ticket.

Requirements

  • CouchDB >= 2.1
  • Golang >= 1.9

Installation

go get -u github.com/SerkanSipahi/corm

ORM methods (our goal for a Nosql-Database)

db methods

ctx := context.TODO()
db, err := corm.New(ctx, corm.Config{
    DBName: "myDatabase",
})
  • Save
  • Read
  • Update
  • Delete
  • First
  • Last
  • Count
  • CountBy
  • Exists
  • BelongsTo
  • DeleteMany
  • ExecuteQuery
  • UpdateAll
  • Find
  • FindAll
  • FindAllBy
  • FindAllWhere
  • FindBy
  • FindWhere
  • Get
  • GetAll
  • HasMany
  • HasOne
  • List
  • ListOrderBy
  • Refresh
  • SaveAll
  • SaveJson
  • Sync
  • Validate
  • Where
  • WhereAny

Basic usage

type Product struct {
	Id          string `json:"_id,omitempty"`  // required in this style
	Rev         string `json:"_rev,omitempty"` // required in this style
	Type        string `json:"type"`           // required: tag this but don´t touch it
	// additionals
	Name        string `json:"name"`
}

// init DB
ctx := context.TODO()
db, err := corm.New(ctx, corm.Config{
    DBName: "myDatabase",
})

// save document with custom Id
docId, rev, err := db.Save(ctx, Product{
    Id:   "111-222-333",
    Name: "Foo",
})

// save document with auto Id
docId, rev, err = db.Save(ctx, Product{
    Name: "Bar",
})

// update document
rev, err = db.Update(ctx, Product{
    Id:   docId,
    Rev:  rev,
    Name: "Baz",
})

// read document
var product Product
_, err = db.Read(ctx, docId, &product)
fmt.Println(product) // product{ Id: "asdfj334234f34asdfq34", Rev: "1-alsj34lkjij3lksife" ...

// delete document
rev, err = db.Delete(ctx, docId, rev)

Author

SerkanSipahi

Contributors

https://github.com/SerkanSipahi/corm/graphs/contributors

License

This software is released under the terms of the Apache 2.0 license. See LICENCE.md, or read the full license.