Documentation
¶
Overview ¶
Package models defines model types for example testing +genx:doc
Code generated by genx:model@devel DO NOT EDIT.
Code generated by genx:model@devel DO NOT EDIT.
Code generated by genx:model@devel DO NOT EDIT.
Code generated by genx:model@devel DO NOT EDIT.
Code generated by genx:model@devel DO NOT EDIT.
Code generated by genx:doc@devel DO NOT EDIT.
Index ¶
- Variables
- type Order
- func (m Order) ColumnRel() map[string][]string
- func (m *Order) Count(ctx context.Context, cond builder.SqlCondition) (int64, error)
- func (m *Order) Create(ctx context.Context) error
- func (m *Order) DeleteByID(ctx context.Context) error
- func (m *Order) DeleteByOrderID(ctx context.Context) error
- func (v *Order) DocOf(names ...string) ([]string, bool)
- func (m *Order) FetchByID(ctx context.Context) error
- func (m *Order) FetchByOrderID(ctx context.Context) error
- func (m Order) Indexes() map[string][]string
- func (m *Order) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, ...) ([]Order, error)
- func (m Order) PrimaryKey() []string
- func (m Order) TableDesc() []string
- func (m Order) TableName() string
- func (m Order) UniqueIndexes() map[string][]string
- func (m *Order) UpdateAndFetchByID(ctx context.Context, targets ...builder.Col) error
- func (m *Order) UpdateAndFetchByOrderID(ctx context.Context, targets ...builder.Col) error
- func (m *Order) UpdateByID(ctx context.Context, expects ...builder.Col) error
- func (m *Order) UpdateByOrderID(ctx context.Context, expects ...builder.Col) error
- type OrderID
- type OrderMeta
- type OrderSnapshot
- func (m OrderSnapshot) ColumnRel() map[string][]string
- func (m *OrderSnapshot) Count(ctx context.Context, cond builder.SqlCondition) (int64, error)
- func (m *OrderSnapshot) Create(ctx context.Context) error
- func (m *OrderSnapshot) DeleteByID(ctx context.Context) error
- func (m *OrderSnapshot) DeleteByOrderID(ctx context.Context) error
- func (v *OrderSnapshot) DocOf(names ...string) ([]string, bool)
- func (m *OrderSnapshot) FetchByID(ctx context.Context) error
- func (m *OrderSnapshot) FetchByOrderID(ctx context.Context) error
- func (m OrderSnapshot) Indexes() map[string][]string
- func (m *OrderSnapshot) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, ...) ([]OrderSnapshot, error)
- func (m OrderSnapshot) PrimaryKey() []string
- func (m OrderSnapshot) TableDesc() []string
- func (m OrderSnapshot) TableName() string
- func (m OrderSnapshot) UniqueIndexes() map[string][]string
- func (m *OrderSnapshot) UpdateAndFetchByID(ctx context.Context, targets ...builder.Col) error
- func (m *OrderSnapshot) UpdateAndFetchByOrderID(ctx context.Context, targets ...builder.Col) error
- func (m *OrderSnapshot) UpdateByID(ctx context.Context, expects ...builder.Col) error
- func (m *OrderSnapshot) UpdateByOrderID(ctx context.Context, expects ...builder.Col) error
- type OrderSnapshotData
- type OrderState
- type Product
- func (m Product) ColumnRel() map[string][]string
- func (m *Product) Count(ctx context.Context, cond builder.SqlCondition) (int64, error)
- func (m *Product) Create(ctx context.Context) error
- func (m *Product) DeleteByID(ctx context.Context) error
- func (m *Product) DeleteByProductIDAndDeletedAt(ctx context.Context) error
- func (v *Product) DocOf(names ...string) ([]string, bool)
- func (m *Product) FetchByID(ctx context.Context) error
- func (m *Product) FetchByProductIDAndDeletedAt(ctx context.Context) error
- func (m Product) Indexes() map[string][]string
- func (m *Product) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, ...) ([]Product, error)
- func (m *Product) MarkDeletionByID(ctx context.Context) error
- func (m *Product) MarkDeletionByProductIDAndDeletedAt(ctx context.Context) error
- func (m Product) PrimaryKey() []string
- func (m Product) TableDesc() []string
- func (m Product) TableName() string
- func (m Product) UniqueIndexes() map[string][]string
- func (m *Product) UpdateAndFetchByID(ctx context.Context, targets ...builder.Col) error
- func (m *Product) UpdateAndFetchByProductIDAndDeletedAt(ctx context.Context, targets ...builder.Col) error
- func (m *Product) UpdateByID(ctx context.Context, expects ...builder.Col) error
- func (m *Product) UpdateByProductIDAndDeletedAt(ctx context.Context, expects ...builder.Col) error
- type ProductID
- type ProductMeta
- type ProductState
- type RelOrder
- type RelOrderNo
- type RelProduct
- type RelShipmentNo
- type RelUser
- type Shipment
- func (m Shipment) ColumnRel() map[string][]string
- func (m *Shipment) Count(ctx context.Context, cond builder.SqlCondition) (int64, error)
- func (m *Shipment) Create(ctx context.Context) error
- func (m *Shipment) DeleteByID(ctx context.Context) error
- func (m *Shipment) DeleteByOrderID(ctx context.Context) error
- func (m *Shipment) DeleteByTrackingNo(ctx context.Context) error
- func (v *Shipment) DocOf(names ...string) ([]string, bool)
- func (m *Shipment) FetchByID(ctx context.Context) error
- func (m *Shipment) FetchByOrderID(ctx context.Context) error
- func (m *Shipment) FetchByTrackingNo(ctx context.Context) error
- func (m Shipment) Indexes() map[string][]string
- func (m *Shipment) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, ...) ([]Shipment, error)
- func (m Shipment) PrimaryKey() []string
- func (m Shipment) TableDesc() []string
- func (m Shipment) TableName() string
- func (m Shipment) UniqueIndexes() map[string][]string
- func (m *Shipment) UpdateAndFetchByID(ctx context.Context, targets ...builder.Col) error
- func (m *Shipment) UpdateAndFetchByOrderID(ctx context.Context, targets ...builder.Col) error
- func (m *Shipment) UpdateAndFetchByTrackingNo(ctx context.Context, targets ...builder.Col) error
- func (m *Shipment) UpdateByID(ctx context.Context, expects ...builder.Col) error
- func (m *Shipment) UpdateByOrderID(ctx context.Context, expects ...builder.Col) error
- func (m *Shipment) UpdateByTrackingNo(ctx context.Context, expects ...builder.Col) error
- type ShipmentMeta
- type ShipmentState
- type User
- func (m User) ColumnRel() map[string][]string
- func (m *User) Count(ctx context.Context, cond builder.SqlCondition) (int64, error)
- func (m *User) Create(ctx context.Context) error
- func (m *User) DeleteByID(ctx context.Context) error
- func (m *User) DeleteByUserID(ctx context.Context) error
- func (v *User) DocOf(names ...string) ([]string, bool)
- func (m *User) FetchByID(ctx context.Context) error
- func (m *User) FetchByUserID(ctx context.Context) error
- func (m User) Indexes() map[string][]string
- func (m *User) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, ...) ([]User, error)
- func (m *User) MarkDeletionByID(ctx context.Context) error
- func (m *User) MarkDeletionByUserID(ctx context.Context) error
- func (m User) PrimaryKey() []string
- func (m User) TableDesc() []string
- func (m User) TableName() string
- func (m User) UniqueIndexes() map[string][]string
- func (m *User) UpdateAndFetchByID(ctx context.Context, targets ...builder.Col) error
- func (m *User) UpdateAndFetchByUserID(ctx context.Context, targets ...builder.Col) error
- func (m *User) UpdateByID(ctx context.Context, expects ...builder.Col) error
- func (m *User) UpdateByUserID(ctx context.Context, expects ...builder.Col) error
- type UserID
- type UserMeta
- type UserState
Constants ¶
This section is empty.
Variables ¶
var Catalog = builder.NewCatalog()
var TOrder *tOrder
var TOrderSnapshot *tOrderSnapshot
var TProduct *tProduct
var TShipment *tShipment
var TUser *tUser
var TagsOrder = map[string]string{
"f_id": "f_id",
"user_id": "user_id",
"order_id": "order_id",
"order_no": "order_no",
"orderNO": "order_no",
"amount": "amount",
"currency": "currency",
"paid_at": "paid_at",
"paidAt": "paid_at",
"canceled_at": "canceled_at",
"canceledAt": "canceled_at",
"status": "status",
"f_created_at": "f_created_at",
"createdAt": "f_created_at",
"f_updated_at": "f_updated_at",
"updatedAt": "f_updated_at",
}
var TagsOrderSnapshot = map[string]string{
"f_id": "f_id",
"order_id": "order_id",
"product_id": "product_id",
"product_sku": "product_sku",
"product_name": "product_name",
"price": "price",
"quantity": "quantity",
"subtotal": "subtotal",
"f_created_at": "f_created_at",
"createdAt": "f_created_at",
}
var TagsProduct = map[string]string{
"f_id": "f_id",
"product_id": "product_id",
"sku": "sku",
"name": "name",
"description": "description",
"price": "price",
"currency": "currency",
"status": "status",
"f_created_at": "f_created_at",
"createdAt": "f_created_at",
"f_updated_at": "f_updated_at",
"updatedAt": "f_updated_at",
"f_deleted_at": "f_deleted_at",
"deletedAt": "f_deleted_at",
}
var TagsShipment = map[string]string{
"f_id": "f_id",
"order_id": "order_id",
"tracking_no": "tracking_no",
"carrier": "carrier",
"status": "status",
"shipped_at": "shipped_at",
"delivered_at": "delivered_at",
"f_created_at": "f_created_at",
"createdAt": "f_created_at",
"f_updated_at": "f_updated_at",
"updatedAt": "f_updated_at",
}
var TagsUser = map[string]string{
"f_id": "f_id",
"user_id": "user_id",
"username": "username",
"email": "email",
"phone": "phone",
"status": "status",
"f_created_at": "f_created_at",
"createdAt": "f_created_at",
"f_updated_at": "f_updated_at",
"updatedAt": "f_updated_at",
"f_deleted_at": "f_deleted_at",
"deletedAt": "f_deleted_at",
}
Functions ¶
This section is empty.
Types ¶
type Order ¶
type Order struct {
types.Serial
RelUser
RelOrder
RelOrderNo
OrderMeta
OrderState
types.CreationModificationTime
}
Order 订单 +genx:model @model TableName=t_order @model Register=Catalog @model pk=ID @model uidx=ui_order_id;OrderID @model idx=i_status;Status @model idx=i_created_at;CreatedAt @model idx=i_updated_at;UpdatedAt
func (*Order) DeleteByID ¶
DeleteByID delete Order recode by Order.ID
func (*Order) DeleteByOrderID ¶
DeleteByOrderID delete Order recode by Order.OrderID
func (*Order) FetchByOrderID ¶
FetchByOrderID fetch Order by Order.OrderID
func (*Order) List ¶
func (m *Order) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, expects ...builder.Col) ([]Order, error)
List fetch Order datalist with condition and additions
func (Order) PrimaryKey ¶
PrimaryKey returns column list of Order's primary key
func (Order) UniqueIndexes ¶
UniqueIndexes returns unique index list of Order
func (*Order) UpdateAndFetchByID ¶
UpdateAndFetchByID update Order by Order.ID and retrieve record
func (*Order) UpdateAndFetchByOrderID ¶
UpdateAndFetchByOrderID update Order by Order.OrderID and retrieve record
func (*Order) UpdateByID ¶
UpdateByID update Order by Order.ID
type OrderMeta ¶ added in v0.3.7
type OrderSnapshot ¶
type OrderSnapshot struct {
types.Serial
RelOrder
RelProduct
OrderSnapshotData
types.CreationTime
}
OrderSnapshot 订单快照 +genx:model @model TableName=t_order_snapshot @model Register=Catalog @model pk=ID @model uidx=ui_order_id;OrderID @model idx=i_product_name;ProductName @model idx=i_created_at;CreatedAt
func (OrderSnapshot) ColumnRel ¶ added in v0.3.1
func (m OrderSnapshot) ColumnRel() map[string][]string
ColumnRel presents soft foreign key of columns
func (*OrderSnapshot) Count ¶ added in v0.2.8
func (m *OrderSnapshot) Count(ctx context.Context, cond builder.SqlCondition) (int64, error)
Count record count of OrderSnapshot match condition
func (*OrderSnapshot) Create ¶
func (m *OrderSnapshot) Create(ctx context.Context) error
Create inserts OrderSnapshot to database
func (*OrderSnapshot) DeleteByID ¶
func (m *OrderSnapshot) DeleteByID(ctx context.Context) error
DeleteByID delete OrderSnapshot recode by OrderSnapshot.ID
func (*OrderSnapshot) DeleteByOrderID ¶
func (m *OrderSnapshot) DeleteByOrderID(ctx context.Context) error
DeleteByOrderID delete OrderSnapshot recode by OrderSnapshot.OrderID
func (*OrderSnapshot) DocOf ¶ added in v0.2.3
func (v *OrderSnapshot) DocOf(names ...string) ([]string, bool)
func (*OrderSnapshot) FetchByID ¶
func (m *OrderSnapshot) FetchByID(ctx context.Context) error
FetchByID fetch OrderSnapshot by OrderSnapshot.ID
func (*OrderSnapshot) FetchByOrderID ¶
func (m *OrderSnapshot) FetchByOrderID(ctx context.Context) error
FetchByOrderID fetch OrderSnapshot by OrderSnapshot.OrderID
func (OrderSnapshot) Indexes ¶
func (m OrderSnapshot) Indexes() map[string][]string
Indexes returns index list of OrderSnapshot
func (*OrderSnapshot) List ¶
func (m *OrderSnapshot) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, expects ...builder.Col) ([]OrderSnapshot, error)
List fetch OrderSnapshot datalist with condition and additions
func (OrderSnapshot) PrimaryKey ¶
func (m OrderSnapshot) PrimaryKey() []string
PrimaryKey returns column list of OrderSnapshot's primary key
func (OrderSnapshot) TableDesc ¶
func (m OrderSnapshot) TableDesc() []string
TableDesc returns descriptions of OrderSnapshot
func (OrderSnapshot) TableName ¶
func (m OrderSnapshot) TableName() string
TableName returns database table name of OrderSnapshot
func (OrderSnapshot) UniqueIndexes ¶
func (m OrderSnapshot) UniqueIndexes() map[string][]string
UniqueIndexes returns unique index list of OrderSnapshot
func (*OrderSnapshot) UpdateAndFetchByID ¶
UpdateAndFetchByID update OrderSnapshot by OrderSnapshot.ID and retrieve record
func (*OrderSnapshot) UpdateAndFetchByOrderID ¶
UpdateAndFetchByOrderID update OrderSnapshot by OrderSnapshot.OrderID and retrieve record
func (*OrderSnapshot) UpdateByID ¶
UpdateByID update OrderSnapshot by OrderSnapshot.ID
func (*OrderSnapshot) UpdateByOrderID ¶
UpdateByOrderID update OrderSnapshot by OrderSnapshot.OrderID
type OrderSnapshotData ¶
type OrderSnapshotData struct {
// ProductSKU 产品SKU
ProductSKU string `db:"product_sku,width=64"`
// ProductName 产品名称 Product.Name
ProductName string `db:"product_name,width=256"`
// Price 产品单价 Product.Price
Price types.Decimal `db:"price,width=22,precision=4"`
// Quantity 订单产品数量
Quantity int64 `db:"quantity"`
// Subtotal 订单金额
Subtotal types.Decimal `db:"subtotal,width=22,precision=4"`
}
type OrderState ¶ added in v0.3.7
type Product ¶
type Product struct {
types.Serial
RelProduct
ProductMeta
ProductState
types.CreationModificationDeletionTime
}
Product 商品 +genx:model @model TableName=t_product @model Register=Catalog @model pk=ID @model uidx=ui_product_id;ProductID;DeletedAt @model idx=i_product_name;Name @model idx=i_status;Status @model idx=i_updated_at;UpdatedAt
func (*Product) DeleteByID ¶
DeleteByID delete Product recode by Product.ID
func (*Product) DeleteByProductIDAndDeletedAt ¶ added in v0.3.7
DeleteByProductIDAndDeletedAt delete Product recode by Product.ProductID and Product.DeletedAt
func (*Product) FetchByProductIDAndDeletedAt ¶ added in v0.3.7
FetchByProductIDAndDeletedAt fetch Product by Product.ProductID and Product.DeletedAt
func (*Product) List ¶
func (m *Product) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, expects ...builder.Col) ([]Product, error)
List fetch Product datalist with condition and additions
func (*Product) MarkDeletionByID ¶
MarkDeletionByID marks Product as deleted
func (*Product) MarkDeletionByProductIDAndDeletedAt ¶ added in v0.3.7
MarkDeletionByProductIDAndDeletedAt marks Product as deleted
func (Product) PrimaryKey ¶
PrimaryKey returns column list of Product's primary key
func (Product) UniqueIndexes ¶
UniqueIndexes returns unique index list of Product
func (*Product) UpdateAndFetchByID ¶
UpdateAndFetchByID update Product by Product.ID and retrieve record
func (*Product) UpdateAndFetchByProductIDAndDeletedAt ¶ added in v0.3.7
func (m *Product) UpdateAndFetchByProductIDAndDeletedAt(ctx context.Context, targets ...builder.Col) error
UpdateAndFetchByProductIDAndDeletedAt update Product by Product.ProductID and Product.DeletedAt and retrieve record
func (*Product) UpdateByID ¶
UpdateByID update Product by Product.ID
type ProductMeta ¶ added in v0.3.7
type ProductState ¶ added in v0.3.7
type RelOrder ¶
type RelOrder struct {
// @model rel=Order.OrderID
OrderID OrderID `db:"order_id"`
}
type RelOrderNo ¶ added in v0.3.7
type RelOrderNo struct {
// OrderNo 订单编号
// @model rel=Order.OrderNo
OrderNo string `db:"order_no,width=64" json:"orderNO"`
}
type RelProduct ¶
type RelProduct struct {
// @model rel=Product.ProductID
ProductID ProductID `db:"product_id"`
}
type RelShipmentNo ¶ added in v0.3.7
type RelShipmentNo struct {
// TrackingNo 物流单号
// @model rel=Shipment.TrackingNo
TrackingNo string `db:"tracking_no,width=128"`
}
type Shipment ¶
type Shipment struct {
types.Serial
RelOrder
RelShipmentNo
ShipmentMeta
ShipmentState
types.CreationModificationTime
}
Shipment 物流 +genx:model @model TableName=t_shipment @model Register=Catalog @model pk=ID @model uidx=ui_order_id;OrderID @model uidx=ui_tracking_no;TrackingNo @model idx=i_carrier;Carrier @model idx=i_status;Status @model idx=i_shipped_at;ShippedAt @model idx=i_delivered_at;DeliveredAt
func (*Shipment) DeleteByID ¶
DeleteByID delete Shipment recode by Shipment.ID
func (*Shipment) DeleteByOrderID ¶
DeleteByOrderID delete Shipment recode by Shipment.OrderID
func (*Shipment) DeleteByTrackingNo ¶
DeleteByTrackingNo delete Shipment recode by Shipment.TrackingNo
func (*Shipment) FetchByOrderID ¶
FetchByOrderID fetch Shipment by Shipment.OrderID
func (*Shipment) FetchByTrackingNo ¶
FetchByTrackingNo fetch Shipment by Shipment.TrackingNo
func (*Shipment) List ¶
func (m *Shipment) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, expects ...builder.Col) ([]Shipment, error)
List fetch Shipment datalist with condition and additions
func (Shipment) PrimaryKey ¶
PrimaryKey returns column list of Shipment's primary key
func (Shipment) UniqueIndexes ¶
UniqueIndexes returns unique index list of Shipment
func (*Shipment) UpdateAndFetchByID ¶
UpdateAndFetchByID update Shipment by Shipment.ID and retrieve record
func (*Shipment) UpdateAndFetchByOrderID ¶
UpdateAndFetchByOrderID update Shipment by Shipment.OrderID and retrieve record
func (*Shipment) UpdateAndFetchByTrackingNo ¶
UpdateAndFetchByTrackingNo update Shipment by Shipment.TrackingNo and retrieve record
func (*Shipment) UpdateByID ¶
UpdateByID update Shipment by Shipment.ID
func (*Shipment) UpdateByOrderID ¶
UpdateByOrderID update Shipment by Shipment.OrderID
type ShipmentMeta ¶ added in v0.3.7
type ShipmentMeta struct {
// Carrier 物流运营商
Carrier string `db:"carrier,width=64"`
}
type ShipmentState ¶ added in v0.3.7
type User ¶
User 用户 +genx:model @model TableName=t_user @model Register=Catalog @model pk=ID @model uidx=ui_user_id;UserID @model idx=ui_username,BTREE;Username @model idx=i_status;Status,NULLS,FIRST @model idx=i_created_at;CreatedAt
func (*User) DeleteByID ¶
DeleteByID delete User recode by User.ID
func (*User) DeleteByUserID ¶
DeleteByUserID delete User recode by User.UserID
func (*User) FetchByUserID ¶
FetchByUserID fetch User by User.UserID
func (*User) List ¶
func (m *User) List(ctx context.Context, cond builder.SqlCondition, adds builder.Additions, expects ...builder.Col) ([]User, error)
List fetch User datalist with condition and additions
func (*User) MarkDeletionByID ¶
MarkDeletionByID marks User as deleted
func (*User) MarkDeletionByUserID ¶
MarkDeletionByUserID marks User as deleted
func (User) PrimaryKey ¶
PrimaryKey returns column list of User's primary key
func (User) UniqueIndexes ¶
UniqueIndexes returns unique index list of User
func (*User) UpdateAndFetchByID ¶
UpdateAndFetchByID update User by User.ID and retrieve record
func (*User) UpdateAndFetchByUserID ¶
UpdateAndFetchByUserID update User by User.UserID and retrieve record
func (*User) UpdateByID ¶
UpdateByID update User by User.ID