types

package

Go to main page

Versions in this module

v0

v0.6.0

Jul 26, 2025

Changes in this version

type DatabaseMigrator

+ IsSystemTable func(tableName string) bool

type DatabaseSpecificMigrator

+ IsPrimaryKeyIndex func(indexName string) bool

+ MapDatabaseTypeToFieldType func(dbType string) schema.FieldType

+ NormalizeDefaultToPrismaFunction func(value any, fieldType schema.FieldType) (string, bool)

+ ParseDefaultValue func(value any, fieldType schema.FieldType) any

type DriverCapabilities

+ SupportsForeignKeys func() bool

v0.5.0

Jul 19, 2025

v0.4.0

Jul 8, 2025

Changes in this version

type Database

+ GetLogger func() any

+ SetLogger func(logger any)

v0.3.0

Jul 7, 2025

v0.2.0

Jul 7, 2025

Changes in this version

+ func ModelNameToTableName(modelName string) string

+ type AggregationCondition struct

+ AggregationType string

+ FieldName string

+ Operator string

+ Value any

+ func NewAggregationCondition(aggType, fieldName, operator string, value any) *AggregationCondition

+ func (a *AggregationCondition) ToSQL(ctx *ConditionContext) (string, []any)

+ type AggregationQuery interface

+ Avg func(fieldName string, alias string) AggregationQuery

+ BuildSQL func() (string, []any, error)

+ Count func(fieldName string, alias string) AggregationQuery

+ CountAll func(alias string) AggregationQuery

+ Exec func(ctx context.Context, dest any) error

+ GetModelName func() string

+ GroupBy func(fieldNames ...string) AggregationQuery

+ Having func(condition Condition) AggregationQuery

+ Limit func(limit int) AggregationQuery

+ Max func(fieldName string, alias string) AggregationQuery

+ Min func(fieldName string, alias string) AggregationQuery

+ Offset func(offset int) AggregationQuery

+ OrderBy func(fieldName string, direction Order) AggregationQuery

+ OrderByAggregation func(aggregationType string, fieldName string, direction Order) AggregationQuery

+ Select func(fieldNames ...string) AggregationQuery

+ Sum func(fieldName string, alias string) AggregationQuery

+ Where func(fieldName string) FieldCondition

+ WhereCondition func(condition Condition) AggregationQuery

+ type AndCondition struct

+ Conditions []Condition

+ func NewAndCondition(conditions ...Condition) *AndCondition

+ func (c *AndCondition) And(condition Condition) Condition

+ func (c *AndCondition) Not() Condition

+ func (c *AndCondition) Or(condition Condition) Condition

+ func (c *AndCondition) ToSQL(ctx *ConditionContext) (string, []any)

+ type BaseCondition struct

+ Args []any

+ SQL string

+ func NewBaseCondition(sql string, args ...any) *BaseCondition

+ func (c BaseCondition) And(condition Condition) Condition

+ func (c BaseCondition) Not() Condition

+ func (c BaseCondition) Or(condition Condition) Condition

+ func (c BaseCondition) ToSQL(ctx *ConditionContext) (string, []any)

+ type ChangeType string

+ const ChangeTypeAddColumn

+ const ChangeTypeAddFK

+ const ChangeTypeAddIndex

+ const ChangeTypeAlterColumn

+ const ChangeTypeCreateTable

+ const ChangeTypeDropColumn

+ const ChangeTypeDropFK

+ const ChangeTypeDropIndex

+ const ChangeTypeDropTable

+ type ColumnChange struct

+ ColumnName string

+ NewColumn *ColumnInfo

+ OldColumn *ColumnInfo

+ TableName string

+ type ColumnInfo struct

+ AutoIncrement bool

+ Default any

+ Name string

+ Nullable bool

+ PrimaryKey bool

+ Type string

+ Unique bool

+ type Condition interface

+ And func(condition Condition) Condition

+ Not func() Condition

+ Or func(condition Condition) Condition

+ ToSQL func(ctx *ConditionContext) (string, []any)

+ func And(conditions ...Condition) Condition

+ func Not(condition Condition) Condition

+ func Or(conditions ...Condition) Condition

+ func Raw(sql string, args ...any) Condition

+ type ConditionContext struct

+ FieldMapper FieldMapper

+ JoinedTables map[string]JoinInfo

+ ModelName string

+ QuoteIdentifier func(string) string

+ TableAlias string

+ func NewConditionContext(fieldMapper FieldMapper, modelName string, tableAlias string) *ConditionContext

+ func (ctx *ConditionContext) MapFieldToColumn(fieldName string) (string, error)

+ type ConflictAction int

+ const ConflictIgnore

+ const ConflictReplace

+ const ConflictUpdate

+ type Database interface

+ Begin func(ctx context.Context) (Transaction, error)

+ Close func() error

+ Connect func(ctx context.Context) error

+ CreateModel func(ctx context.Context, modelName string) error

+ DropModel func(ctx context.Context, modelName string) error

+ Exec func(query string, args ...any) (sql.Result, error)

+ GetCapabilities func() DriverCapabilities

+ GetDriverType func() string

+ GetMigrator func() DatabaseMigrator

+ GetModelSchema func(modelName string) (*schema.Schema, error)

+ GetModels func() []string

+ GetSchema func(modelName string) (*schema.Schema, error)

+ LoadSchema func(ctx context.Context, schemaContent string) error

+ LoadSchemaFrom func(ctx context.Context, filename string) error

+ Model func(modelName string) ModelQuery

+ Ping func(ctx context.Context) error

+ Query func(query string, args ...any) (*sql.Rows, error)

+ QueryRow func(query string, args ...any) *sql.Row

+ Raw func(sql string, args ...any) RawQuery

+ RegisterSchema func(modelName string, schema *schema.Schema) error

+ ResolveFieldName func(modelName, fieldName string) (string, error)

+ ResolveFieldNames func(modelName string, fieldNames []string) ([]string, error)

+ ResolveTableName func(modelName string) (string, error)

+ SyncSchemas func(ctx context.Context) error

+ Transaction func(ctx context.Context, fn func(tx Transaction) error) error

+ type DatabaseMigrator interface

+ ApplyMigration func(sql string) error

+ CompareSchema func(existingTable *TableInfo, desiredSchema any) (*MigrationPlan, error)

+ GenerateAddColumnSQL func(tableName string, field any) (string, error)

+ GenerateCreateIndexSQL func(tableName, indexName string, columns []string, unique bool) string

+ GenerateCreateTableSQL func(schema any) (string, error)

+ GenerateDropColumnSQL func(tableName, columnName string) ([]string, error)

+ GenerateDropIndexSQL func(indexName string) string

+ GenerateDropTableSQL func(tableName string) string

+ GenerateMigrationSQL func(plan *MigrationPlan) ([]string, error)

+ GenerateModifyColumnSQL func(change ColumnChange) ([]string, error)

+ GetDatabaseType func() string

+ GetTableInfo func(tableName string) (*TableInfo, error)

+ GetTables func() ([]string, error)

+ type DatabaseSpecificMigrator interface

+ ApplyMigration func(sql string) error

+ ConvertFieldToColumnInfo func(field schema.Field) *ColumnInfo

+ FormatDefaultValue func(value any) string

+ GenerateAddColumnSQL func(tableName string, field any) (string, error)

+ GenerateColumnDefinitionFromColumnInfo func(col ColumnInfo) string

+ GenerateCreateIndexSQL func(tableName, indexName string, columns []string, unique bool) string

+ GenerateCreateTableSQL func(s *schema.Schema) (string, error)

+ GenerateDropColumnSQL func(tableName, columnName string) ([]string, error)

+ GenerateDropIndexSQL func(indexName string) string

+ GenerateDropTableSQL func(tableName string) string

+ GenerateModifyColumnSQL func(change ColumnChange) ([]string, error)

+ GetDatabaseType func() string

+ GetTableInfo func(tableName string) (*TableInfo, error)

+ GetTables func() ([]string, error)

+ IsSystemIndex func(indexName string) bool

+ IsSystemTable func(tableName string) bool

+ MapFieldType func(field schema.Field) string

+ type DefaultFieldMapper struct

+ func NewDefaultFieldMapper() *DefaultFieldMapper

+ func (m *DefaultFieldMapper) ColumnFieldsToSchema(modelName string, columnNames []string) ([]string, error)

+ func (m *DefaultFieldMapper) ColumnToSchema(modelName, columnName string) (string, error)

+ func (m *DefaultFieldMapper) GetSchema(modelName string) (*schema.Schema, error)

+ func (m *DefaultFieldMapper) MapColumnToSchemaData(modelName string, data map[string]any) (map[string]any, error)

+ func (m *DefaultFieldMapper) MapSchemaToColumnData(modelName string, data map[string]any) (map[string]any, error)

+ func (m *DefaultFieldMapper) ModelToTable(modelName string) (string, error)

+ func (m *DefaultFieldMapper) RegisterSchema(modelName string, s *schema.Schema)

+ func (m *DefaultFieldMapper) SchemaFieldsToColumns(modelName string, fieldNames []string) ([]string, error)

+ func (m *DefaultFieldMapper) SchemaToColumn(modelName, fieldName string) (string, error)

+ type DeleteQuery interface

+ BuildSQL func() (string, []any, error)

+ Exec func(ctx context.Context) (Result, error)

+ GetModelName func() string

+ Returning func(fieldNames ...string) DeleteQuery

+ Where func(fieldName string) FieldCondition

+ WhereCondition func(condition Condition) DeleteQuery

+ type DriverCapabilities interface

+ GetBooleanLiteral func(value bool) string

+ GetDriverType func() DriverType

+ GetNullsOrderingSQL func(direction Order, nullsFirst bool) string

+ GetPlaceholder func(index int) string

+ GetSupportedSchemes func() []string

+ IsNoSQL func() bool

+ IsSystemIndex func(indexName string) bool

+ IsSystemTable func(tableName string) bool

+ NeedsTypeConversion func() bool

+ QuoteIdentifier func(name string) string

+ RequiresLimitForOffset func() bool

+ SupportsAggregationPipeline func() bool

+ SupportsArrayFields func() bool

+ SupportsDefaultValues func() bool

+ SupportsDistinctOn func() bool

+ SupportsNestedDocuments func() bool

+ SupportsReturning func() bool

+ SupportsTransactions func() bool

+ type DriverType string

+ const DriverMongoDB

+ const DriverMySQL

+ const DriverPostgreSQL

+ const DriverSQLite

+ func ParseDriverType(s string) (DriverType, error)

+ func (d DriverType) String() string

+ type FieldCondition interface

+ Between func(min, max any) Condition

+ Contains func(value string) Condition

+ EndsWith func(value string) Condition

+ Equals func(value any) Condition

+ GetFieldName func() string

+ GetModelName func() string

+ GreaterThan func(value any) Condition

+ GreaterThanOrEqual func(value any) Condition

+ In func(values ...any) Condition

+ IsNotNull func() Condition

+ IsNull func() Condition

+ LessThan func(value any) Condition

+ LessThanOrEqual func(value any) Condition

+ Like func(pattern string) Condition

+ NotEquals func(value any) Condition

+ NotIn func(values ...any) Condition

+ StartsWith func(value string) Condition

+ type FieldConditionImpl struct

+ FieldName string

+ ModelName string

+ func NewFieldCondition(modelName, fieldName string) *FieldConditionImpl

+ func (f *FieldConditionImpl) Between(min, max any) Condition

+ func (f *FieldConditionImpl) Contains(value string) Condition

+ func (f *FieldConditionImpl) EndsWith(value string) Condition

+ func (f *FieldConditionImpl) Equals(value any) Condition

+ func (f *FieldConditionImpl) GetFieldName() string

+ func (f *FieldConditionImpl) GetModelName() string

+ func (f *FieldConditionImpl) GreaterThan(value any) Condition

+ func (f *FieldConditionImpl) GreaterThanOrEqual(value any) Condition

+ func (f *FieldConditionImpl) In(values ...any) Condition

+ func (f *FieldConditionImpl) IsNotNull() Condition

+ func (f *FieldConditionImpl) IsNull() Condition

+ func (f *FieldConditionImpl) LessThan(value any) Condition

+ func (f *FieldConditionImpl) LessThanOrEqual(value any) Condition

+ func (f *FieldConditionImpl) Like(pattern string) Condition

+ func (f *FieldConditionImpl) NotEquals(value any) Condition

+ func (f *FieldConditionImpl) NotIn(values ...any) Condition

+ func (f *FieldConditionImpl) StartsWith(value string) Condition

+ type FieldMapper interface

+ ColumnFieldsToSchema func(modelName string, columnNames []string) ([]string, error)

+ ColumnToSchema func(modelName, columnName string) (string, error)

+ MapColumnToSchemaData func(modelName string, data map[string]any) (map[string]any, error)

+ MapSchemaToColumnData func(modelName string, data map[string]any) (map[string]any, error)

+ ModelToTable func(modelName string) (string, error)

+ SchemaFieldsToColumns func(modelName string, fieldNames []string) ([]string, error)

+ SchemaToColumn func(modelName, fieldName string) (string, error)

+ type ForeignKeyInfo struct

+ Column string

+ Name string

+ OnDelete string

+ OnUpdate string

+ ReferencedColumn string

+ ReferencedTable string

+ type IncludeOption struct

+ Limit *int

+ Offset *int

+ OrderBy []OrderByOption

+ Path string

+ Select []string

+ Where Condition

+ type IncludeOptions map[string]*IncludeOption

+ type IndexChange struct

+ IndexName string

+ NewIndex *IndexInfo

+ OldIndex *IndexInfo

+ TableName string

+ type IndexDefinition struct

+ Columns []string

+ Name string

+ Unique bool

+ type IndexInfo struct

+ Columns []string

+ Name string

+ Unique bool

+ type InsertQuery interface

+ BuildSQL func() (string, []any, error)

+ Exec func(ctx context.Context) (Result, error)

+ ExecAndReturn func(ctx context.Context, dest any) error

+ GetModelName func() string

+ OnConflict func(action ConflictAction) InsertQuery

+ Returning func(fieldNames ...string) InsertQuery

+ Values func(data ...any) InsertQuery

+ type JoinInfo struct

+ ModelName string

+ TableAlias string

+ type MappedFieldCondition struct

+ func (f *MappedFieldCondition) And(condition Condition) Condition

+ func (f *MappedFieldCondition) GetArgs() []any

+ func (f *MappedFieldCondition) GetFieldName() string

+ func (f *MappedFieldCondition) GetModelName() string

+ func (f *MappedFieldCondition) GetSQL() string

+ func (f *MappedFieldCondition) Not() Condition

+ func (f *MappedFieldCondition) Or(condition Condition) Condition

+ func (f *MappedFieldCondition) ToSQL(ctx *ConditionContext) (string, []any)

+ type Migration struct

+ AppliedAt time.Time

+ Checksum string

+ ID int

+ Name string

+ Version string

+ type MigrationFile struct

+ DownSQL string

+ Metadata MigrationMetadata

+ Name string

+ UpSQL string

+ Version string

+ type MigrationMetadata struct

+ Changes []SchemaChange

+ Checksum string

+ CreatedAt time.Time

+ Description string

+ Name string

+ Schemas map[string]string

+ Version string

+ type MigrationMode string

+ const MigrationModeAuto

+ const MigrationModeFile

+ type MigrationOptions struct

+ AutoMigrate bool

+ DryRun bool

+ Force bool

+ MigrationsDir string

+ Mode MigrationMode

+ type MigrationPlan struct

+ AddColumns []ColumnChange

+ AddIndexes []IndexChange

+ CreateTables []string

+ DropColumns []ColumnChange

+ DropIndexes []IndexChange

+ ModifyColumns []ColumnChange

+ type ModelQuery interface

+ Aggregate func() AggregationQuery

+ Avg func(ctx context.Context, fieldName string) (float64, error)

+ Count func(ctx context.Context) (int64, error)

+ Delete func() DeleteQuery

+ Exists func(ctx context.Context) (bool, error)

+ FindFirst func(ctx context.Context, dest any) error

+ FindMany func(ctx context.Context, dest any) error

+ FindUnique func(ctx context.Context, dest any) error

+ GetModelName func() string

+ GroupBy func(fieldNames ...string) ModelQuery

+ Having func(condition Condition) ModelQuery

+ Include func(relations ...string) ModelQuery

+ Insert func(data any) InsertQuery

+ Limit func(limit int) ModelQuery

+ Max func(ctx context.Context, fieldName string) (any, error)

+ Min func(ctx context.Context, fieldName string) (any, error)

+ Offset func(offset int) ModelQuery

+ OrderBy func(fieldName string, direction Order) ModelQuery

+ Select func(fields ...string) SelectQuery

+ Sum func(ctx context.Context, fieldName string) (float64, error)

+ Update func(data any) UpdateQuery

+ Where func(fieldName string) FieldCondition

+ WhereCondition func(condition Condition) ModelQuery

+ WhereRaw func(sql string, args ...any) ModelQuery

+ With func(relations ...string) ModelQuery

+ type NotCondition struct

+ Condition Condition

+ func NewNotCondition(condition Condition) *NotCondition

+ func (c *NotCondition) And(condition Condition) Condition

+ func (c *NotCondition) Not() Condition

+ func (c *NotCondition) Or(condition Condition) Condition

+ func (c *NotCondition) ToSQL(ctx *ConditionContext) (string, []any)

+ type OrCondition struct

+ Conditions []Condition

+ func NewOrCondition(conditions ...Condition) *OrCondition

+ func (c *OrCondition) And(condition Condition) Condition

+ func (c *OrCondition) Not() Condition

+ func (c *OrCondition) Or(condition Condition) Condition

+ func (c *OrCondition) ToSQL(ctx *ConditionContext) (string, []any)

+ type Order int

+ const ASC

+ const DESC

+ type OrderByClause struct

+ Direction Order

+ Field string

+ type OrderByOption struct

+ Direction Order

+ Field string

+ type RawCondition struct

+ func NewRawCondition(sql string, args ...any) *RawCondition

+ type RawQuery interface

+ Exec func(ctx context.Context) (Result, error)

+ Find func(ctx context.Context, dest any) error

+ FindOne func(ctx context.Context, dest any) error

+ type Result struct

+ LastInsertID int64

+ RowsAffected int64

+ type SchemaChange struct

+ ColumnName string

+ IndexDef *IndexDefinition

+ IndexName string

+ SQL string

+ TableName string

+ Type ChangeType

+ type SelectQuery interface

+ BuildSQL func() (string, []any, error)

+ Count func(ctx context.Context) (int64, error)

+ Distinct func() SelectQuery

+ DistinctOn func(fieldNames ...string) SelectQuery

+ FindFirst func(ctx context.Context, dest any) error

+ FindMany func(ctx context.Context, dest any) error

+ GetModelName func() string

+ GroupBy func(fieldNames ...string) SelectQuery

+ Having func(condition Condition) SelectQuery

+ Include func(relations ...string) SelectQuery

+ IncludeWithOptions func(path string, opt *IncludeOption) SelectQuery

+ Limit func(limit int) SelectQuery

+ Offset func(offset int) SelectQuery

+ OrderBy func(fieldName string, direction Order) SelectQuery

+ Where func(fieldName string) FieldCondition

+ WhereCondition func(condition Condition) SelectQuery

+ type TableInfo struct

+ Columns []ColumnInfo

+ ForeignKeys []ForeignKeyInfo

+ Indexes []IndexInfo

+ Name string

+ type Transaction interface

+ Commit func(ctx context.Context) error

+ CreateMany func(ctx context.Context, modelName string, data []any) (Result, error)

+ DeleteMany func(ctx context.Context, modelName string, condition Condition) (Result, error)

+ Model func(modelName string) ModelQuery

+ Raw func(sql string, args ...any) RawQuery

+ Rollback func(ctx context.Context) error

+ RollbackTo func(ctx context.Context, name string) error

+ Savepoint func(ctx context.Context, name string) error

+ UpdateMany func(ctx context.Context, modelName string, condition Condition, data any) (Result, error)

+ type URIParser interface

+ GetDriverType func() string

+ GetSupportedSchemes func() []string

+ ParseURI func(uri string) (string, error)

+ type UpdateQuery interface

+ BuildSQL func() (string, []any, error)

+ Decrement func(fieldName string, value int64) UpdateQuery

+ Exec func(ctx context.Context) (Result, error)

+ ExecAndReturn func(ctx context.Context, dest any) error

+ GetModelName func() string

+ Increment func(fieldName string, value int64) UpdateQuery

+ Returning func(fieldNames ...string) UpdateQuery

+ Set func(data any) UpdateQuery

+ Where func(fieldName string) FieldCondition

+ WhereCondition func(condition Condition) UpdateQuery

v0.1.0

Jul 4, 2025

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL