https://github.com/noeeekr/borm
Borm or Better Object Relational Mapper is a lightweight postgresql ORM that helps querying and building database migrations.
https://github.com/noeeekr/borm
compose database docker go golang open-source orm postgres sql
Last synced: about 2 months ago
JSON representation
Borm or Better Object Relational Mapper is a lightweight postgresql ORM that helps querying and building database migrations.
- Host: GitHub
- URL: https://github.com/noeeekr/borm
- Owner: Noeeekr
- Created: 2025-07-13T16:08:23.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-08-05T19:07:07.000Z (11 months ago)
- Last Synced: 2025-08-05T19:10:39.303Z (11 months ago)
- Topics: compose, database, docker, go, golang, open-source, orm, postgres, sql
- Language: Go
- Homepage:
- Size: 67.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Borm (Better Oriented Relational Mapper) is meant to be a safe and faster approach to simple database tasks. Managing boilerplate code for you as much as possible, without losing performance.
# TOPICS
___
## MIGRATIONS:
// Register user and database for migration. Migrating a database also migrate its user.
myDatabaseUser := borm.RegisterUser("my_database_user", "my_database_user_passwd")
myDatabase := borm.RegisterDatabase("my_databas_name", myDatabaseUser)
// Register tables and enums for migration.
enum := myDatabase.RegisterEnum("fruits", "banana", "apple", "pineapple")
table := myDatabase.RegisterTable(MyTableStruct{}).NeedRoles(enum)
// Needs to connect to postgres on first time
borm.Connect("postgres", "postgres-Host", "postgres-Password", "postgres-User")
borm.Settings().Migrations().Enable()
borm.Settings().Migrations().RecreateExisting()
// To migrate databases, users, etc.
borm.MigrateEnvironment()
// To migrate tables, types, etc.
borm.MigrateRelations()
___
## TAGS
```
Usage:
// Table name can be changed in the RegisterTable function
type MyDatabaseTable struct {
// Becomes a field of table MyDatabaseTable with name myPrivateField
myNonIgnoredPrivateField string
// Ignored
myIgnoredPrivateField string ``borm:"(IGNORE)"
// Becomes a field of table MyDatabaseTable with name my_public_field
MyPublicField string `borm:"(NAME, my_public_field) (CONSTRAINTS, NOT NULL)"`
}
```
```
(CONSTRAINTS, string) Defines the constraints of the field.
Ex: (CONSTRAINTS, PRIMARY KEY)
(NAME, string) Defines the name of the field. If not present name will be the field name to lowercase.
Ex: (NAME, my_field_name)
(TYPE, string) Defines the type of the field in case it is not implemented on reflection.
Ex: (TYPE, VARCHAR(555))
(FOREIGN KEY, primary_key_table_name, primary_key_field_name) Defines the field as a foreign key
Ex: (FOREIGN KEY, users, id)
(IGNORE) Ignores a field completely for all borm operations.
```
___
## Operations
```
myServiceDatabase := borm.RegisterDatabase("my_service_database_name", myServiceDatabaseOwnerUser)
TableProducts := myServiceDatabase.RegisterTable(Products{}).Name("products")
--
q := TableProducts.Select("product_name", "product_quantity")
q.Where(q.Field("product_quantity").Equals(10))
q.Scanner(scannerFunc)
```