mirror of
https://github.com/ent/ent.git
synced 2026-05-24 09:31:56 +03:00
61 lines
1.5 KiB
Go
61 lines
1.5 KiB
Go
// Copyright 2019-present Facebook Inc. All rights reserved.
|
|
// This source code is licensed under the Apache 2.0 license found
|
|
// in the LICENSE file in the root directory of this source tree.
|
|
|
|
package entsql
|
|
|
|
import "github.com/facebook/ent/schema"
|
|
|
|
// Annotation is a builtin schema annotation for attaching
|
|
// SQL metadata to schema objects for both codegen and runtime.
|
|
type Annotation struct {
|
|
// The Table option allows overriding the default table
|
|
// name that is generated by ent. For example:
|
|
//
|
|
// entsql.Annotation{
|
|
// Table: "Users",
|
|
// }
|
|
//
|
|
Table string `json:"table,omitempty"`
|
|
|
|
// Charset defines the character-set of the table. For example:
|
|
//
|
|
// entsql.Annotation{
|
|
// Charset: "utf8mb4",
|
|
// }
|
|
//
|
|
Charset string `json:"charset,omitempty"`
|
|
|
|
// Collation defines the collation of the table (a set of rules for comparing
|
|
// characters in a character set). For example:
|
|
//
|
|
// entsql.Annotation{
|
|
// Collation: "utf8mb4_bin",
|
|
// }
|
|
//
|
|
Collation string `json:"collation,omitempty"`
|
|
|
|
// Options defines the additional table options. For example:
|
|
//
|
|
// entsql.Annotation{
|
|
// Options: "ENGINE = INNODB",
|
|
// }
|
|
//
|
|
Options string `json:"options,omitempty"`
|
|
|
|
// Size defines the column size in the generated schema. For example:
|
|
//
|
|
// entsql.Annotation{
|
|
// Size: 128,
|
|
// }
|
|
//
|
|
Size int64 `json:"size,omitempty"`
|
|
}
|
|
|
|
// Name describes the annotation name.
|
|
func (Annotation) Name() string {
|
|
return "EntSQL"
|
|
}
|
|
|
|
var _ schema.Annotation = (*Annotation)(nil)
|