https://github.com/zhihu/norm

An orm library support nGQL for Golang
https://github.com/zhihu/norm

golang nebula orm

Last synced: 18 days ago
JSON representation

An orm library support nGQL for Golang

• Host: GitHub
• URL: https://github.com/zhihu/norm
• Owner: zhihu
• License: mit
• Created: 2021-07-13T08:28:10.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-05T02:24:00.000Z (7 months ago)
• Last Synced: 2024-12-29T17:09:45.193Z (25 days ago)
• Topics: golang, nebula, orm
• Language: Go
• Homepage:
• Size: 63.5 KB
• Stars: 107
• Watchers: 9
• Forks: 22
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# norm

An ORM library support nGQL for Golang.

[![go report card](https://goreportcard.com/badge/github.com/zhihu/norm "go report card")](https://goreportcard.com/report/github.com/zhihu/norm)

[![Go](https://github.com/zhihu/norm/actions/workflows/go.yml/badge.svg)](https://github.com/zhihu/norm/actions/workflows/go.yml)

[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)

[![Go.Dev reference](https://img.shields.io/badge/go.dev-reference-blue?logo=go&logoColor=white)](https://pkg.go.dev/github.com/zhihu/norm)

## Overview

* Build insert nGQL by struct / map (Support vertex, edge).

* Parse Nebula execute result to struct / map.

* Easy to use.

* Easy mock for Unit Testing.

**Roadmap**

1. Session pool. For details, please see [dialector](/docs/dialector.adoc)

2. Support more types in insert/execute function.

    * Types: time.Time

3. Support batch insert, query list.

4. Chainable api. For detail please see [chainable api](/docs/chainable_api.adoc)

**Maybe Support**

- [ ] Statistic Hooks. Insert/Query count and latency.

- [ ] Fix fields Order when build insert nGQL. (now norm use map store keys, and in go range map is out-of-order.)

**Need improve**

- [ ] Benchmark.

- [ ] Unit Testing.

- [ ] Documents.

## Getting Started

Install:

```

go get github.com/zhihu/norm

```

use example: please go [use example](/examples/main.go)

## Contributing guidelines

* [code of conduct](/CODE_OF_CONDUCT.md)

* [行为规范 中文版](/CODE_OF_CONDUCT_CN.md)

## License

© Zhihu, 2021~time.Now

Released under the [MIT License](/LICENSE)

_copy and paste from gorm_