korm

带有总线的简单示例视频

---

隆重推出 Korm - 优雅、快如闪电的 ORM/框架，可满足您的所有需求，请参阅基准测试。受到非常流行的 Django 框架的启发，Korm 提供了类似的功能，并具有额外的性能优势

它也是可组合的，当您想要在多个 Korm 或 WithDashboard 之间同步数据以完整设置服务器总线和管理仪表板时，它允许使用 WithBus 与网络 websocket PubSub 集成。

当你可以拥有最好的东西时，为什么要满足于更少的东西呢？

• 当你需要并发和异步时，Django 变得很难使用，你将需要 django 通道和像 daphne 或 uvicorn 这样的服务器，Go 有完美的实现
• Django 每秒最多可以处理 300 个请求，Go 每秒处理 44,000 个请求（在我的机器上完成的基准测试）
• 该 API 也比 Django 更用户友好且更简洁
• 使用 Korm 部署可执行二进制文件，并使用自动 TLS Let's 加密、内置管理仪表板、交互式 Shell、Eventbus 在多个 Korm 应用程序之间进行通信，非常简洁
• 此外，它的缓存系统使用 goroutine 和通道在创建、更新、删除或删除行或表时有效地清理缓存

它有：

• 新增功能：使用 korm.WithDashboard 时，现在您可以在使用 lg pkg 登录时从管理仪表板实时访问所有日志（websockets）。默认情况下，仅将最后 10 条日志保留在内存中，您可以使用 lg.SaveLogs(50) 来增加它以保留最后 50 条日志

• 新增：根据数据库表自动检查结构（模式），提示您进行更改，因此它可以通过向结构添加或删除字段来添加或删除列，默认情况下禁用，使用korm.EnableCheck()启用它

• 新增内容：通过连接处理嵌套或嵌入结构以及结构切片，如 sqlx，但 sqlx 不处理结构切片

• 新功能： korm.QueryNamed、QueryNamedS、korm.ExecNamed、korm.ExecContextNamed 和WhereNamed(query string, args map[string]any) 类似：Where("email = :email",map[string]any{"email":" [email protected]"})

• 新功能： korm.LogsQueries()，记录 SQL 查询语句和所花费的时间

• 带有模型 API 和视频教程的 Auto Docs

• Swagger 文档和教程

• PPROF Go 分析工具和 Prometheus Metrics

• 日志中间件

• 管理仪表板具有离线且可安装的 PWA（使用 /static/sw.js 和 /static/manifest.webmanifest）。 sw.js中提到的所有静态信息都将由 Service Worker 缓存并提供服务，您可以检查浏览器中的“网络”选项卡来检查它

• 共享网络总线允许您在 ORM 之间使用 pubsub websockets 实时发送和接收数据，因此您可以决定如何在不同数据库之间分配数据，请参阅示例

• 使用korm.Auth 、 korm.Admin或korm.BasicAuth中间件进行内置身份验证，每当使用 Auth 和 Admin 中间件时，您都可以从任何模板 html 访问.User模型和变量.IsAuthenticated如本示例 admin_nav.html

• 交互式 Shell，要从命令行在数据库中进行 CRUD，请使用korm.WithShell()

• 直接从结构自动迁移

• 与官方数据库/sql 兼容，因此您可以使用 sql.DB `korm.GetConnection()`` 自己进行查询，并且总体上使用数据库/sql 轻松集成现有代码库

• 调用korm.WithBus(...opts)或korm.WithDashboard(addr, ...opts)后可从 serverBus 访问 Router/Mux

• 钩子：OnInsert OnSet OnDelete 和 OnDrop

• 多对多关系

• 添加了 GENERATED ALWAYS AS 标签（所有方言）

• 对Where和标签的连接和长度支持： check和generated （所有方言）

• 支持外键、索引、检查... 查看全部

• Kenv 加载环境变量到结构体

• Python 总线客户端pip install ksbus

所有驱动并发安全读写

支持的数据库：

• sqlite
• mysql
• 玛丽亚
• Postgres
• 蟑螂

---

安装

go get -u github.com/kamalshkeir/korm@latest

驱动程序移出此包，以免将它们全部放入您的 go.mod 文件中

go get -u github.com/kamalshkeir/sqlitedriver@latest
go get -u github.com/kamalshkeir/pgdriver@latest
go get -u github.com/kamalshkeir/mysqldriver@latest

全局变量

 // Debug when true show extra useful logs for queries executed for migrations and queries statements
Debug = false
// FlushCacheEvery execute korm.FlushCache() every 10 min by default, you should not worry about it, but useful that you can change it
FlushCacheEvery = 10 * time . Minute
// SetCacheMaxMemory set max size of each cache cacheAllS AllM ...
korm . SetCacheMaxMemory ( megaByte int ) // default maximum of 50 Mb , cannot be lower
// Connection pool
MaxOpenConns = 20
MaxIdleConns = 20
MaxLifetime = 30 * time . Minute
MaxIdleTime = 15 * time . Minute

连接到数据库

 // sqlite
// go get github.com/kamalshkeir/sqlitedriver
err := korm . New ( korm . SQLITE , "dbName" , sqlitedriver . Use ()) // Connect
// postgres, cockroach
// go get github.com/kamalshkeir/pgdriver
err := korm . New ( korm . POSTGRES , "dbName" , pgdriver . Use (), "user:password@localhost:5432" ) // Connect
// mysql, maria
// go get github.com/kamalshkeir/mysqldriver
err := korm . New ( korm . MYSQL , "dbName" , mysqldriver . Use (), "user:password@localhost:3306" ) // Connect

korm . Shutdown ( databasesName ... string ) error

你好世界示例

 package main

import (
	"fmt"
	"time"

	"github.com/kamalshkeir/lg"
	"github.com/kamalshkeir/korm"
	"github.com/kamalshkeir/sqlitedriver"
)

type Class struct {
	Id       uint `korm:"pk"`
	Name     string
	Students [] Student
}

type Student struct {
	Id      uint `korm:"pk"`
	Name    string
	Class   uint `korm:"fk:classes.id:cascade:cascade"`
	Classes Class
}

func main () {
	err := korm . New ( korm . SQLITE , "db" , sqlitedriver . Use ())
	if lg . CheckError ( err ) {
		return
	}
	defer korm . Shutdown ()

	server := korm . WithDashboard ( ":9313" )
	korm . WithShell ()

	err = korm. AutoMigrate [ Class ]( "classes" )
	lg . CheckError ( err )

	err = korm. AutoMigrate [ Student ]( "students" )
	lg . CheckError ( err )

	// go run main.go shell to createsuperuser
	// connect to admin and create some data to query

	// nested structs with joins, scan the result to the channel directly after each row
	// so instead of receiving a slice, you will receive data on the channel[0] of the passed slice
	studentsChan := [] chan Student { make ( chan Student )}
	go func () {
		for s := range studentsChan [ 0 ] {
			fmt . Println ( "chan students:" , s )
		}
	}()
	err = korm . To ( & studentsChan ). Query ( "select students.*,classes.id as 'classes.id',classes.name as 'classes.name'  from students join classes where classes.id = students.class" )
	lg . CheckError ( err )
	fmt . Println ()

	// Named with nested (second argument of 'To') filled automatically from join, support nested slices and structs
	classes := [] Class {}
	query := "select classes.*, students.id as 'students.id',students.name as 'students.name' from classes join students on students.class = classes.id order by :order_here"
	err = korm . To ( & classes , true ). Named ( query , map [ string ] any {
		"order_here" : "classes.id" ,
	})
	lg . CheckError ( err )
	for _ , s := range classes {
		fmt . Println ( "class:" , s )
	}
	fmt . Println ()

	// // not nested, only remove second arg true from 'To' method
	students := [] Student {}
	err = korm . To ( & students , true ). Query ( "select students.*,classes.id as 'classes.id',classes.name as 'classes.name'  from students join classes where classes.id = students.class" )
	lg . CheckError ( err )
	for _ , s := range students {
		fmt . Println ( "student:" , s )
	}
	fmt . Println ()

	maps := [] map [ string ] any {}
	err = korm . To ( & maps ). Query ( "select * from students" )
	lg . CheckError ( err )
	fmt . Println ( "maps =" , maps )
	fmt . Println ()

	names := [] * string {}
	err = korm . To ( & names ). Query ( "select name from students" )
	lg . CheckError ( err )
	fmt . Println ( "names =" , names )
	fmt . Println ()

	ids := [] int {}
	err = korm . To ( & ids ). Query ( "select id from students" )
	lg . CheckError ( err )
	fmt . Println ( "ids =" , ids )
	fmt . Println ()

	bools := [] bool {}
	err = korm . To ( & bools ). Query ( "select is_admin from users" )
	lg . CheckError ( err )
	fmt . Println ( "bools =" , bools )
	fmt . Println ()

	times := []time. Time {}
	err = korm . To ( & times ). Query ( "select created_at from users" )
	lg . CheckError ( err )
	fmt . Println ( "times =" , times )

	server . Run ()
}

// OUTPUT
// chan students: {1 student-1 1 {1 Math []}}
// chan students: {2 student-2 2 {2 French []}}
// chan students: {3 student-3 1 {1 Math []}}
// chan students: {4 student-4 2 {2 French []}}

// class: {1 Math [{1 student-1 0 {0  []}} {3 student-3 0 {0  []}}]}
// class: {2 French [{2 student-2 0 {0  []}} {4 student-4 0 {0  []}}]}

// student: &{1 student-1 1 {1 Math []}}
// student: &{2 student-2 2 {2 French []}}
// student: &{3 student-3 1 {1 Math []}}
// student: &{4 student-4 2 {2 French []}}

// maps = [map[class:1 id:1 name:student-1] map[class:2 id:2 name:student-2] map[class:1 id:3 name:student-3] map[class:2 id:4 name:student-4]]

// names = [student-1 student-2 student-3 student-4]

// ids = [1 2 3 4]

// bools = [true]

// times = [2023-04-30 19:19:32 +0200 CEST]

自动迁移

可用标签 (SQL)

SQL：

korm. AutoMigrate [ T comparable ]( tableName string , dbName ... string ) error 

err := korm. AutoMigrate [ User ]( "users" )
err := korm. AutoMigrate [ Bookmark ]( "bookmarks" )

type User struct {
	Id        int       `korm:"pk"` // AUTO Increment ID primary key
	Uuid      string    `korm:"size:40"` // VARCHAR(50)
	Email     string    `korm:"size:50;iunique"` // insensitive unique
	Password  string    `korm:"size:150"` // VARCHAR(150)
	IsAdmin   bool      `korm:"default:false"` // DEFAULT 0
	Image     string    `korm:"size:100;default:''"`
	CreatedAt time. Time `korm:"now"` // auto now
    Ignored   string    `korm:"-"`
}

type Bookmark struct {
	Id      uint   `korm:"pk"`
	UserId  int    `korm:"fk:users.id:cascade:setnull"` // options cascade,donothing/noaction, setnull/null, setdefault/default
	IsDone	bool   
	ToCheck string `korm:"size:50; notnull; check: len(to_check) > 2 AND len(to_check) < 10; check: is_done=true"`  // column type will be VARCHAR(50)
	Content string `korm:"text"` // column type will be TEXT not VARCHAR
	UpdatedAt time. Time `korm:"update"` // will update when model updated, handled by triggers for sqlite, cockroach and postgres, and on migration for mysql
	CreatedAt time. Time `korm:"now"` // now is default to current timestamp and of type TEXT for sqlite
}

all , _ := korm . Model [ User ]()
                   . Where ( "id = ?" , id ) 
                   . Select ( "item1" , "item2" )
                   . OrderBy ( "created" )
				   . Limit ( 8 )
				   . Page ( 2 )
                   . All ()

应用程序编程接口

 korm . New ( dbType Dialect , dbName string , dbDriver driver . Driver , dbDSN ... string ) error
korm . LogQueries ()
korm . GetConnection ( dbName ... string ) * sql . DB
korm. To [ T any ]( dest * [] T , nestedSlice ... bool ) * Selector [ T ] // scan query to any type slice, even channels and slices with nested structs and joins
( sl * Selector [ T ]) Ctx ( ct context . Context ) * Selector [ T ]
( sl * Selector [ T ]) Query ( statement string , args ... any ) error
( sl * Selector [ T ]) Named ( statement string , args map [ string ] any , unsafe ... bool ) error
korm. WithBus ( ... opts ) * ksbus . Server // Usage: WithBus(...opts) or share an existing one
korm. WithDashboard ( address , ... opts ) * ksbus . Server
korm . WithShell ()
korm . WithDocs ( generateJsonDocs bool , outJsonDocs string , handlerMiddlewares ... func ( handler kmux . Handler ) kmux . Handler ) * ksbus . Server
korm . WithEmbededDocs ( embeded embed . FS , embededDirPath string , handlerMiddlewares ... func ( handler kmux. Handler ) kmux. Handler ) * ksbus . Server
korm . WithMetrics ( httpHandler http . Handler ) * ksbus . Server
korm . WithPprof ( path ... string ) * ksbus . Server
korm . Transaction ( dbName ... string ) ( * sql . Tx , error )
korm . Exec ( dbName , query string , args ... any ) error
korm . ExecContext ( ctx context . Context , dbName , query string , args ... any ) error
korm . ExecNamed ( query string , args map [ string ] any , dbName ... string ) error
korm . ExecContextNamed ( ctx context . Context , query string , args map [ string ] any , dbName ... string ) error
korm. BeforeServersData ( fn func ( data any , conn * ws. Conn ))
korm. BeforeDataWS ( fn func ( data map [ string ] any , conn * ws. Conn , originalRequest * http. Request ) bool )
korm . GetAllTables ( dbName ... string ) [] string
korm . GetAllColumnsTypes ( table string , dbName ... string ) map [ string ]string
korm . GetMemoryTable ( tbName string , dbName ... string ) ( TableEntity , error )
korm . GetMemoryTables ( dbName ... string ) ([] TableEntity , error )
korm . GetMemoryDatabases () [] DatabaseEntity
korm . GetMemoryDatabase ( dbName string ) ( * DatabaseEntity , error )
korm . Shutdown ( databasesName ... string ) error
korm . FlushCache ()
korm . DisableCache () 
korm . ManyToMany ( table1 , table2 string , dbName ... string ) error // add table relation m2m 

生成器Struct ：

 korm . Exec ( dbName , query string , args ... any ) error
korm . Transaction ( dbName ... string ) ( * sql . Tx , error )
// Model is a starter for Buider
func Model [ T comparable ]( tableName ... string ) * BuilderS [ T ]
// Database allow to choose database to execute query on
func ( b * BuilderS [ T ]) Database ( dbName string ) * BuilderS [ T ]
// Insert insert a row into a table and return inserted PK
func ( b * BuilderS [ T ]) Insert ( model * T ) ( int , error )
// InsertR add row to a table using input struct, and return the inserted row
func ( b * BuilderS [ T ]) InsertR ( model * T ) ( T , error )
// BulkInsert insert many row at the same time in one query
func ( b * BuilderS [ T ]) BulkInsert ( models ... * T ) ([] int , error )
// AddRelated used for many to many, and after korm.ManyToMany, to add a class to a student or a student to a class, class or student should exist in the database before adding them
func ( b * BuilderS [ T ]) AddRelated ( relatedTable string , whereRelatedTable string , whereRelatedArgs ... any ) ( int , error )
// DeleteRelated delete a relations many to many
func ( b * BuilderS [ T ]) DeleteRelated ( relatedTable string , whereRelatedTable string , whereRelatedArgs ... any ) ( int , error )
// GetRelated used for many to many to get related classes to a student or related students to a class
func ( b * BuilderS [ T ]) GetRelated ( relatedTable string , dest any ) error
// JoinRelated same as get, but it join data
func ( b * BuilderS [ T ]) JoinRelated ( relatedTable string , dest any ) error
// Set used to update, Set("email,is_admin","[email protected]",true) or Set("email = ? AND is_admin = ?","[email protected]",true)
func ( b * BuilderS [ T ]) Set ( query string , args ... any ) ( int , error )
// Delete data from database, can be multiple, depending on the where, return affected rows(Not every database or database driver may support affected rows)
func ( b * BuilderS [ T ]) Delete () ( int , error )
// Drop drop table from db
func ( b * BuilderS [ T ]) Drop () ( int , error )
// Select usage: Select("email","password")
func ( b * BuilderS [ T ]) Select ( columns ... string ) * BuilderS [ T ]
// Where can be like : Where("id > ?",1) or Where("id",1) = Where("id = ?",1)
func ( b * BuilderS [ T ]) Where ( query string , args ... any ) * BuilderS [ T ]
// Limit set limit
func ( b * BuilderS [ T ]) Limit ( limit int ) * BuilderS [ T ]
// Context allow to query or execute using ctx
func ( b * BuilderS [ T ]) Context ( ctx context. Context ) * BuilderS [ T ]
// Page return paginated elements using Limit for specific page
func ( b * BuilderS [ T ]) Page ( pageNumber int ) * BuilderS [ T ]
// OrderBy can be used like: OrderBy("-id","-email") OrderBy("id","-email") OrderBy("+id","email")
func ( b * BuilderS [ T ]) OrderBy ( fields ... string ) * BuilderS [ T ]
// Debug print prepared statement and values for this operation
func ( b * BuilderS [ T ]) Debug () * BuilderS [ T ]
// All get all data
func ( b * BuilderS [ T ]) All () ([] T , error )
// One get single row
func ( b * BuilderS [ T ]) One () ( T , error )

Examples:
korm . Model [models. User ](). Select ( "email" , "uuid" ). OrderBy ( "-id" ). Limit ( PAGINATION_PER ). Page ( 1 ). All ()

// INSERT
uuid , _ := korm . GenerateUUID ()
hashedPass , _ := argon . Hash ( password )
korm . Model [models. User ](). Insert ( & models. User {
	Uuid : uuid ,
	Email : "[email protected]" ,
	Password : hashedPass ,
	IsAdmin : false ,
	Image : "" ,
	CreatedAt : time . Now (),
})

//if using more than one db
korm. Database [models. User ]( "dbNameHere" ). Where ( "id = ? AND email = ?" , 1 , "[email protected]" ). All () 

// where
korm . Model [models. User ](). Where ( "id = ? AND email = ?" , 1 , "[email protected]" ). One () 

// delete
korm . Model [models. User ](). Where ( "id = ? AND email = ?" , 1 , "[email protected]" ). Delete ()

// drop table
korm . Model [models. User ](). Drop ()

// update
korm . Model [models. User ](). Where ( "id = ?" , 1 ). Set ( "email = ?" , "[email protected]" )

构建器map[string]any ：

 // BuilderM is query builder map string any
type BuilderM struct
// Table is a starter for BuiderM
func Table ( tableName string ) * BuilderM
// Database allow to choose database to execute query on
func ( b * BuilderM ) Database ( dbName string ) * BuilderM
// Select select table columns to return
func ( b * BuilderM ) Select ( columns ... string ) * BuilderM
// Where can be like: Where("id > ?",1) or Where("id",1) = Where("id = ?",1)
func ( b * BuilderM ) Where ( query string , args ... any ) * BuilderM
// Limit set limit
func ( b * BuilderM ) Limit ( limit int ) * BuilderM
// Page return paginated elements using Limit for specific page
func ( b * BuilderM ) Page ( pageNumber int ) * BuilderM
// OrderBy can be used like: OrderBy("-id","-email") OrderBy("id","-email") OrderBy("+id","email")
func ( b * BuilderM ) OrderBy ( fields ... string ) * BuilderM
// Context allow to query or execute using ctx
func ( b * BuilderM ) Context ( ctx context. Context ) * BuilderM
// Debug print prepared statement and values for this operation
func ( b * BuilderM ) Debug () * BuilderM
// All get all data
func ( b * BuilderM ) All () ([] map [ string ] any , error )
// One get single row
func ( b * BuilderM ) One () ( map [ string ] any , error )
// Insert add row to a table using input map, and return PK of the inserted row
func ( b * BuilderM ) Insert ( rowData map [ string ] any ) ( int , error )
// InsertR add row to a table using input map, and return the inserted row
func ( b * BuilderM ) InsertR ( rowData map [ string ] any ) ( map [ string ] any , error )
// BulkInsert insert many row at the same time in one query
func ( b * BuilderM ) BulkInsert ( rowsData ... map [ string ] any ) ([] int , error )
// Set used to update, Set("email,is_admin","[email protected]",true) or Set("email = ? AND is_admin = ?","[email protected]",true)
func ( b * BuilderM ) Set ( query string , args ... any ) ( int , error )
// Delete data from database, can be multiple, depending on the where, return affected rows(Not every database or database driver may support affected rows)
func ( b * BuilderM ) Delete () ( int , error )
// Drop drop table from db
func ( b * BuilderM ) Drop () ( int , error )
// AddRelated used for many to many, and after korm.ManyToMany, to add a class to a student or a student to a class, class or student should exist in the database before adding them
func ( b * BuilderM ) AddRelated ( relatedTable string , whereRelatedTable string , whereRelatedArgs ... any ) ( int , error )
// GetRelated used for many to many to get related classes to a student or related students to a class
func ( b * BuilderM ) GetRelated ( relatedTable string , dest * [] map [ string ] any ) error
// JoinRelated same as get, but it join data
func ( b * BuilderM ) JoinRelated ( relatedTable string , dest * [] map [ string ] any ) error
// DeleteRelated delete a relations many to many
func ( b * BuilderM ) DeleteRelated ( relatedTable string , whereRelatedTable string , whereRelatedArgs ... any ) ( int , error )


Examples:

sliceMapStringAny , err := korm . Table ( "users" )
							. Select ( "email" , "uuid" )
							. OrderBy ( "-id" )
							. Limit ( PAGINATION_PER )
							. Page ( 1 )
							. All ()

// INSERT
uuid , _ := korm . GenerateUUID ()
hashedPass , _ := argon . Hash ( "password" ) // github.com/kamalshkeir/argon

korm . Table ( "users" ). Insert ( map [ string ] any {
	"uuid" : uuid ,
	"email" : "[email protected]" ,
	 ...
})

//if using more than one db
korm . Database ( "dbNameHere" ). Table ( "tableName" ). Where ( "id = ? AND email = ?" , 1 , "[email protected]" ). All () 

// where
Where ( "id = ? AND email = ?" , 1 , "[email protected]" ) // this work
Where ( "id,email" , 1 , "[email protected]" ) // and this work

korm . Table ( "tableName" ). Where ( "id = ? AND email = ?" , 1 , "[email protected]" ). One () 

// delete
korm . Table ( "tableName" ). Where ( "id = ? AND email = ?" , 1 , "[email protected]" ). Delete () 

// drop table
korm . Table ( "tableName" ). Drop ()

// update
korm . Table ( "tableName" ). Where ( "id = ?" , 1 ). Set ( "email = ?" , "[email protected]" ) 
korm . Table ( "tableName" ). Where ( "id" , 1 ). Set ( "email" , "[email protected]" ) 

您可以设置仪表板默认值

 korm . PaginationPer      = 10
korm . DocsUrl           = "docs"
korm . EmbededDashboard   = false
korm . MediaDir           = "media"
korm . AssetsDir          = "assets"
korm . StaticDir          = path . Join ( AssetsDir , "/" , "static" )
korm . TemplatesDir       = path . Join ( AssetsDir , "/" , "templates" )
korm . RepoUser           = "kamalshkeir"
korm . RepoName           = "korm-dash"
korm . adminPathNameGroup = "/admin" // korm.SetAdminPath("/another")
// so you can create a custom dashboard, upload it to your repos and change like like above korm.RepoUser and korm.RepoName

使用 Dashboard 的示例（您不需要使用 korm.WithBus，因为 WithDashboard 已经调用它并为您返回服务器总线）

 package main

import (
	"github.com/kamalshkeir/lg"
	"github.com/kamalshkeir/ksmux"
	"github.com/kamalshkeir/korm"
	"github.com/kamalshkeir/sqlitedriver"
)

func main () {
	err := korm . New ( korm . SQLITE , "db" , sqlitedriver . Use ())
	lg . CheckError ( err )



	serverBus := korm . WithDashboard ( "localhost:9313" )
	korm . WithShell ()
	// you can overwrite Admin and Auth middleware used for dashboard (dash_middlewares.go) 
	//korm.Auth = func(handler ksmux.Handler) ksmux.Handler {}
	//korm.Admin = func(handler ksmux.Handler) ksmux.Handler {}

	// and also all handlers (dash_views.go)
	//korm.LoginView = func(c *ksmux.Context) {
	//	c.Html("admin/new_admin_login.html", nil)
	//}

	// add extra static directory if you want
	//serverBus.App.LocalStatics("assets/mystatic","myassets") // will be available at /myassets/*
	//serverBus.App.LocalTemplates("assets/templates") // will make them available to use with c.Html

	// serve HTML 
	// serverBus.App.Get("/",func(c *ksmux.Context) {
	// 	c.Html("index.html", map[string]any{
	// 		"data": data,
	// 	})
	// })
	serverBus . Run ()
	// OR run https if you have certificates
	serverBus . RunTLS ( cert string , certKey string )

	// OR generate certificates let's encrypt for a domain name, check https://github.com/kamalshkeir/ksbus for more infos
	serverBus . RunAutoTLS ( subDomains ... string )
}

然后创建管理员用户以连接到仪表板

go run main.go shell

createsuperuser

然后就可以访问/admin

Auth中间件示例

 func main () {
	err := korm . New ( korm . SQLITE , "db" , sqlitedriver . Use ())
	if lg . CheckError ( err ) {
		return
	}
	defer korm . Shutdown ()
	
	srv := korm . WithDashboard ( "localhost:9313" )
	korm . WithShell ()
	lg . Printfs ( "mgrunning on http://localhost:9313 n " )
	app := srv . App

	app . Get ( "/" , korm . Auth ( func ( c * ksmux. Context ) { // work with korm.Admin also
		// c.IsAuthenticated also return bool
		if v , ok := c . User (); ok {
			c . Json ( map [ string ] any {
				"msg" : "Authenticated" ,
				"v" :   v .(korm. User ). Email ,
			})
		} else {
			c . Json ( map [ string ] any {
				"error" : "not auth" ,
			})
		}
	}))

	srv . Run ()
}

示例管理员身份验证用户和 IsAuthenticated

{{define "admin_nav"}}
< header id =" admin-header " >
  < nav >
    < a href =" / " >
      < h1 > KORM </ h1 >
    </ a > 
    
    < ul >
        < li >
          < a {{if eq .Request.URL.Path "/" }}class=" active " {{end}} href =" / " > Home </ a >
        </ li >

        < li >
          < a {{if contains .Request.URL.Path .admin_path }}class =" active " {{end}} href =" {{.admin_path}} " > Admin </ a >
        </ li >

        {{if .IsAuthenticated}}
            < li >
              < a href =" {{.admin_path}}/logout " > Logout </ a >
            </ li >
            
            {{if .User.Email}}
              < li >
                < span > Hello {{.User.Email}} </ span >
              </ li >
            {{end}}
        {{end}}
    </ ul >
  </ nav >
</ header >
{{end}}

管理中间件

 // dash_middlewares.go
package korm

import (
	"context"
	"net/http"

	"github.com/kamalshkeir/aes"
	"github.com/kamalshkeir/ksmux"
)

var Auth = func ( handler ksmux. Handler ) ksmux. Handler {
	return func ( c * ksmux. Context ) {
		session , err := c . GetCookie ( "session" )
		if err != nil || session == "" {
			// NOT AUTHENTICATED
			c . DeleteCookie ( "session" )
			handler ( c )
			return
		}
		session , err = aes . Decrypt ( session )
		if err != nil {
			handler ( c )
			return
		}
		// Check session
		user , err := Model [ User ](). Where ( "uuid = ?" , session ). One ()
		if err != nil {
			// session fail
			handler ( c )
			return
		}

		// AUTHENTICATED AND FOUND IN DB
		c . SetKey ( "korm-user" , user )
		handler ( c )
	}
}

var Admin = func ( handler ksmux. Handler ) ksmux. Handler {
	return func ( c * ksmux. Context ) {
		session , err := c . GetCookie ( "session" )
		if err != nil || session == "" {
			// NOT AUTHENTICATED
			c . DeleteCookie ( "session" )
			c . Status ( http . StatusTemporaryRedirect ). Redirect ( adminPathNameGroup + "/login" )
			return
		}
		session , err = aes . Decrypt ( session )
		if err != nil {
			c . Status ( http . StatusTemporaryRedirect ). Redirect ( adminPathNameGroup + "/login" )
			return
		}
		user , err := Model [ User ](). Where ( "uuid = ?" , session ). One ()

		if err != nil {
			// AUTHENTICATED BUT NOT FOUND IN DB
			c . Status ( http . StatusTemporaryRedirect ). Redirect ( adminPathNameGroup + "/login" )
			return
		}

		// Not admin
		if ! user . IsAdmin {
			c . Status ( 403 ). Text ( "Middleware : Not allowed to access this page" )
			return
		}
		c . SetKey ( "korm-user" , user )
		handler ( c )
	}
}

var BasicAuth = func ( handler ksmux. Handler ) ksmux. Handler {
	return ksmux . BasicAuth ( handler , BASIC_AUTH_USER , BASIC_AUTH_PASS )
}

2 KORM 之间的巴士示例

科姆1：

 package main

import (
	"net/http"

	"github.com/kamalshkeir/lg"
	"github.com/kamalshkeir/ksmux"
	"github.com/kamalshkeir/ksmux/ws"
	"github.com/kamalshkeir/korm"
	"github.com/kamalshkeir/ksbus"
	"github.com/kamalshkeir/sqlitedriver"
)

func main () {
	err := korm . New ( korm . SQLITE , "db1" , sqlitedriver . Use ())
	if lg . CheckError ( err ) { return }

	korm . WithShell ()
	serverBus := korm . WithBus (ksbus. ServerOpts {
		ID              string
		Address         string
		Path            string
		OnWsClose       func ( connID string )
		OnDataWS        func ( data map [ string ] any , conn * ws. Conn , originalRequest * http. Request ) error
		OnServerData    func ( data any , conn * ws. Conn )
		OnId            func ( data map [ string ] any )
		OnUpgradeWs     func ( r * http. Request ) bool
		WithOtherRouter * ksmux. Router
		WithOtherBus    * Bus
	})
	// handler authentication	
	korm . BeforeDataWS ( func ( data map [ string ] any , conn * ws. Conn , originalRequest * http. Request ) bool {
		lg . Info ( "handle authentication here" )
		return true
	})
	// handler data from other KORM
	korm . BeforeServersData ( func ( data any , conn * ws. Conn ) {
		lg . Info ( "recv orm:" , "data" , data )
	})

	// built in router to the bus, check it at https://github.com/kamalshkeir/ksbus
	serverBus . App . Get ( "/" , func ( c * ksmux. Context ) {
		serverBus . SendToServer ( "localhost:9314" , map [ string ] any {
			"msg" : "hello from server 1" ,
		})
		c . Text ( "ok" )
	})

	
	serverBus . Run ( "localhost:9313" )
	// OR run https if you have certificates
	serverBus . RunTLS ( addr string , cert string , certKey string )
	// OR generate certificates let's encrypt for a domain name, check https://github.com/kamalshkeir/ksbus for more details
	serverBus . RunAutoTLS ( domainName string , subDomains ... string )
}

科尔姆2：

 package main

import (
	"net/http"

	"github.com/kamalshkeir/lg"
	"github.com/kamalshkeir/ksmux"
	"github.com/kamalshkeir/ksmux/ws"
	"github.com/kamalshkeir/korm"
	"github.com/kamalshkeir/sqlitedriver"
)

func main () {
	err := korm . New ( korm . SQLITE , "db2" , sqlitedriver . Use ())
	if lg . CheckError ( err ) { return }

	korm . WithShell () // if dashboard used, this line should be after it
	serverBus := korm . WithBus (ksbus. ServerOpts {
		ID              string
		Address         string
		Path            string
		OnWsClose       func ( connID string )
		OnDataWS        func ( data map [ string ] any , conn * ws. Conn , originalRequest * http. Request ) error
		OnServerData    func ( data any , conn * ws. Conn )
		OnId            func ( data map [ string ] any )
		OnUpgradeWs     func ( r * http. Request ) bool
		WithOtherRouter * ksmux. Router
		WithOtherBus    * Bus
	})

	korm . BeforeServersData ( func ( data any , conn * ws. Conn ) {
        lg . Info ( "recv" , "data" , data )
	})

	// built in router to the bus, check it at https://github.com/kamalshkeir/ksbus
	serverBus . App . GET ( "/" , func ( c * ksmux. Context ) {
		serverBus . SendToServer ( "localhost:9314" , map [ string ] any {
			"msg" : "hello from server 2" ,
		})
		c . Status ( 200 ). Text ( "ok" )
	})


    // Run Server Bus
	serverBus . Run ( "localhost:9314" )

	// OR run https if you have certificates
	serverBus . RunTLS ( addr string , cert string , certKey string )

	// OR generate certificates let's encrypt for a domain name, check https://github.com/kamalshkeir/ksbus for more infos
	serverBus . RunAutoTLS ( domainName string , subDomains ... string )
}

生成标签示例

 // generated example using concatination and length
type TestUser struct {
	Id        * uint   `korm:"pk"`
	Uuid      string  `korm:"size:40;iunique"`
	Email     * string `korm:"size:100;iunique"`
	Gen       string  `korm:"size:250;generated: concat(uuid,'working',len(password))"`
	Password  string
	IsAdmin   * bool
	CreatedAt time. Time `korm:"now"`
	UpdatedAt time. Time `korm:"update"`
}

func TestGeneratedAs ( t * testing. T ) {
	u , err := Model [ TestUser ](). Limit ( 3 ). All ()
	if err != nil {
		t . Error ( err )
	}
	if len ( u ) != 3 {
		t . Error ( "len not 20" )
	}
	if u [ 0 ]. Gen != u [ 0 ]. Uuid + "working" + fmt . Sprintf ( "%d" , len ( u [ 0 ]. Password )) {
		t . Error ( "generated not working:" , u [ 0 ]. Gen )
	}
}

来自 korm_test.go 的 concat 和 len 示例

 // Where example
func TestConcatANDLen ( t * testing. T ) {
	groupes , err := Model [ Group ](). Where ( "name = concat(?,'min') AND len(name) = ?" , "ad" , 5 ). Debug (). All ()
	// translated to select * from groups WHERE name = 'ad' || 'min'  AND  length(name) = 5 (sqlite)
	// translated to select * from groups WHERE name = concat('ad','min')  AND  char_length(name) = 5 (postgres, mysql)
	if err != nil {
		t . Error ( err )
	}
	if len ( groupes ) != 1 || groupes [ 0 ]. Name != "admin" {
		t . Error ( "len(groupes) != 1 , got: " , groupes )
	}
}

路由器/复用器

了解有关 Ksmux 的更多信息

 func main () {
	err := korm . New ( korm . SQLITE , "db" , sqlitedriver . Use ())
	if err != nil {
		log . Fatal ( err )
	}

	serverBus := korm . WithDashboard ( "localhost:9313" )
	korm . WithShell ()
	mux := serverBus . App
	// add global middlewares
	mux . Use (( midws ... func (http. Handler ) http. Handler ))
	...
}

普教授

 serverBus := korm . WithDashboard ( "localhost:9313" )
// or srv := korm.WithBus()
serverBus . WithPprof ( path ... string ) // path is 'debug' by default

will enable :
	- / debug / pprof
	- / debug / profile
	- / debug / heap
	- / debug / trace

执行 cpu 分析： go tool pprof -http=":8000" pprofbin http://localhost:9313/debug/profile?seconds=18执行内存分析： go tool pprof -http=":8000" pprofbin http://localhost:9313/debug/heap?seconds=18 :9313/debug/profile?seconds=18 go tool pprof -http=":8000" pprofbin http://localhost:9313/debug/heap?seconds=18要执行生成跟踪：从浏览器转到端点http://localhost:9313/debug/trace?seconds=18 ，这将下载18 秒的跟踪然后查看跟踪： go tool trace path/to/trace

普罗米修斯指标

 // or srv := korm.WithBus()
//srv.WithMetrics(httpHandler http.Handler, path ...string) path default to 'metrics'
srv . WithMetrics ( promhttp . Handler ())

will enable :
	- / metrics

日志中间件

 // or srv := korm.WithBus()
//srv.WithMetrics(httpHandler http.Handler, path ...string) path default to 'metrics'
srv . App . Use ( ksmux . Logs ()) // it take an optional callback executed on each request if you want to add log to a file or send
srv . App . Use ( ksmux . Logs ( func ( method , path , remote string , status int , took time. Duration ) {
	// save somewhere
}))

will enable :
	- / metrics

挂钩

 korm . OnInsert ( func ( database , table string , data map [ string ] any ) error {
	fmt . Println ( "inserting into" , database , table , data )
	// if error returned, it will not insert
	return nil
})

korm . OnSet ( func ( database , table string , data map [ string ] any ) error {
	fmt . Println ( "set into" , database , table , data )
	return nil
})

korm . OnDelete ( func ( database , table , query string , args ... any ) error {})

korm . OnDrop ( func ( database , table string ) error {})

Python 总线客户端示例

pip install ksbus==1.1.0
# if it doesn't work , execute it again 

 from ksbus import Bus


# onOpen callback that let you know when connection is ready, it take the bus as param
def OnOpen ( bus ):
    print ( "connected" )
    # bus.autorestart=True
    # Publish publish to topic
    bus . Publish ( "top" , {
        "data" : "hello from python"
    })
    # Subscribe, it also return the subscription
    bus . Subscribe ( "python" , pythonTopicHandler )
    # SendToNamed publish to named topic
    bus . SendToNamed ( "top:srv" , {
        "data" : "hello again from python"
    })
    # bus.Unsubscribe("python")
    print ( "finish everything" )


# pythonTopicHandler handle topic 'python'
def pythonTopicHandler ( data , subs ):
    print ( "recv on topic python:" , data )
    # Unsubscribe
    #subs.Unsubscribe()

if __name__ == "__main__" :
    Bus ( "localhost:9313" , onOpen = OnOpen ) # blocking
    print ( "prorgram exited" )

多对多关系示例

 type Class struct {
	Id          uint   `korm:"pk"`
	Name        string `korm:"size:100"`
	IsAvailable bool
	CreatedAt   time. Time `korm:"now"`
}

type Student struct {
	Id        uint      `korm:"pk"`
	Name      string    `korm:"size:100"`
	CreatedAt time. Time `korm:"now"`
}

// migrate
func migrate () {
	err := korm. AutoMigrate [ Class ]( "classes" )
	if lg . CheckError ( err ) {
		return
	}
	err = korm. AutoMigrate [ Student ]( "students" )
	if lg . CheckError ( err ) {
		return
	}
	err = korm . ManyToMany ( "classes" , "students" )
	if lg . CheckError ( err ) {
		return
	}
}

// korm.ManyToMany create relation table named m2m_classes_students

// then you can use it like so to get related data

// get related to map to struct
std := [] Student {}
err = korm . Model [ Class ](). Where ( "name = ?" , "Math" ). Select ( "name" ). OrderBy ( "-name" ). Limit ( 1 ). GetRelated ( "students" , & std )

// get related to map
std := [] map [ string ] any {}
err = korm . Table ( "classes" ). Where ( "name = ?" , "Math" ). Select ( "name" ). OrderBy ( "-name" ). Limit ( 1 ). GetRelated ( "students" , & std )

// join related to map
std := [] map [ string ] any {}
err = korm . Table ( "classes" ). Where ( "name = ?" , "Math" ). JoinRelated ( "students" , & std )

// join related to strcu
cu := [] JoinClassUser {}
err = korm . Model [ Class ](). Where ( "name = ?" , "Math" ). JoinRelated ( "students" , & cu )

// to add relation
_ , err = korm . Model [ Class ](). AddRelated ( "students" , "name = ?" , "hisName" )
_ , err = korm . Model [ Student ](). AddRelated ( "classes" , "name = ?" , "French" )
_ , err = korm . Table ( "students" ). AddRelated ( "classes" , "name = ?" , "French" )

// delete relation
_ , err = korm . Model [ Class ](). Where ( "name = ?" , "Math" ). DeleteRelated ( "students" , "name = ?" , "hisName" )
_ , err = korm . Table ( "classes" ). Where ( "name = ?" , "Math" ). DeleteRelated ( "students" , "name = ?" , "hisName" )

Swagger 文档