thing

---

description: globs: *.go alwaysApply: false

---

description: globs: *.go alwaysApply: false

Rule Name: Thing ORM Usage Guide

Description:

Quick reference for using the Thing ORM (github.com/burugo/thing).

Core Concept

• High-performance Go ORM focusing on CRUD and list operations.
• Built-in caching (Redis or in-memory) automatically handles single-entity and list query caching & invalidation.
• Uses Go generics for type safety and a cleaner API.
• Supports MySQL, PostgreSQL, SQLite.

Configuration

1. Create DB Adapter:

   import "github.com/burugo/thing/drivers/db/sqlite" // Or mysql, postgres
   dbAdapter, err := sqlite.NewSQLiteAdapter(":memory:")
   

2. Create Cache Client (Optional, defaults to in-memory):

   import (
       "github.com/redis/go-redis/v9"
       redisCache "github.com/burugo/thing/drivers/cache/redis"
       "github.com/burugo/thing"
   )
   // Use nil for default in-memory:
   // var cacheClient thing.CacheClient = nil
   // Or Redis:
   // rdb := redis.NewClient(...)
   // cacheClient = redisCache.NewClient(rdb)
   

3. Get ORM Instance per Model:

   import "github.com/burugo/thing"
   // import your models package
   
   // For a specific model typels.User)
   userThing, err := thing.New[*models.User](mdc:db)
   

   Alternative Global Config (less flexible): thing.Configure(dbAdapter, cacheClient) then thing.Use[*Model]().

Basic Usage

1. Model Definition: Embed thing.BaseModel and use db tags for columns.

   type User struct {
       thing.BaseModel // Includes ID, CreatedAt, UpdatedAt, DeletedAt
       Name string `db:"name"` // Explicitly maps Name field to 'name' column
       UserAge int // db tag omitted, defaults to 'user_age' column
   }
   // Optional: Define TableName() method if different from snake_case plural struct name.
   // func (u *User) TableName() string { return "custom_users_table" }
   

   Note: While using the db tag is recommended for clarity, it's technically optional. If omitted, Thing ORM defaults to converting the Go field name (CamelCase, e.g., UserAge) to its snake_case equivalent (user_age) as the database column name. Use db:"-" to explicitly ignore a field.