makroud

package module

Go to main page

Versions in this module

v0

v0.8.0

Aug 14, 2020

Changes in this version

+ const LevelDefault

+ const LevelReadCommitted

+ const LevelReadUncommitted

+ const LevelRepeatableRead

+ const LevelSerializable

+ var ErrModelRequired = fmt.Errorf("a model is required")

+ func Select(ctx context.Context, driver Driver, dest interface{}, args ...interface{}) error

type Client

+ func (c *Client) Entropy() io.Reader

+ func (c *Client) GetCache() *DriverCache

+ func (c *Client) HasCache() bool

+ func (c *Client) HasLogger() bool

+ func (c *Client) HasObserver() bool

+ func (c *Client) Logger() Logger

+ func (c *Client) Observer() Observer

+ func (c *Client) SetCache(cache *DriverCache)

type ClientOptions

+ ApplicationName string

+ ConnectTimeout int

+ Database string

+ Entropy io.Reader

+ Node Node

+ Observer Observer

type Driver

+ Entropy func() io.Reader

+ GetCache func() *DriverCache

+ HasCache func() bool

+ HasLogger func() bool

+ HasObserver func() bool

+ Logger func() Logger

+ Observer func() Observer

+ SetCache func(cache *DriverCache)

+ type DriverCache struct

+ func NewDriverCache() *DriverCache

+ func (c *DriverCache) GetSchema(model Model) *Schema

+ func (c *DriverCache) GetSchemaless(value reflect.Type) *Schemaless

+ func (c *DriverCache) SetSchema(schema *Schema)

+ func (c *DriverCache) SetSchemaless(schemaless *Schemaless)

type Node

+ BeginTx func(ctx context.Context, opts *sql.TxOptions) (Node, error)

+ type Observer interface

+ OnClose func(err error, flags map[string]string)

+ OnRollback func(err error, flags map[string]string)

type Option

+ func ApplicationName(name string) Option

+ func ConnectTimeout(timeout int) Option

+ func WithEntropy(entropy io.Reader) Option

+ func WithNode(node Node) Option

+ func WithObserver(observer Observer) Option

type Schema

+ func (schema Schema) PrimaryKeyName() string

+ func (schema Schema) PrimaryKeyPath() string

type Schemaless

+ func (schema Schemaless) Name() string

+ type TxOptions = sql.TxOptions

v0.7.2

Aug 14, 2020

v0.7.1

Oct 7, 2019

v0.7.0

Aug 29, 2019

Changes in this version

+ var ErrCommitNotInTransaction = fmt.Errorf("cannot commit outside of a transaction")

+ var ErrSliceOfScalarMultipleColumns = fmt.Errorf("slice of scalar with multiple columns")

type Client

+ func (c *Client) PingContext(ctx context.Context) error

+ type Node interface

+ Begin func() (Node, error)

+ Close func() error

+ Commit func() error

+ DB func() *sql.DB

+ DriverName func() string

+ EnableSavepoint func(enabled bool)

+ Exec func(query string, args ...interface{}) (sql.Result, error)

+ ExecContext func(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

+ Ping func() error

+ PingContext func(ctx context.Context) error

+ Prepare func(query string) (*sql.Stmt, error)

+ PrepareContext func(ctx context.Context, query string) (*sql.Stmt, error)

+ Query func(query string, args ...interface{}) (*sql.Rows, error)

+ QueryContext func(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)

+ QueryRow func(query string, args ...interface{}) *sql.Row

+ QueryRowContext func(ctx context.Context, query string, args ...interface{}) *sql.Row

+ Rollback func() error

+ SetConnMaxLifetime func(duration time.Duration)

+ SetMaxIdleConns func(number int)

+ SetMaxOpenConns func(number int)

+ Stats func() sql.DBStats

+ Tx func() *sql.Tx

+ func Connect(driver string, dsn string) (Node, error)

+ type Schemaless struct

+ func GetSchemaless(driver Driver, value reflect.Type) (*Schemaless, error)

+ func (schema Schemaless) Columns() Columns

+ func (schema Schemaless) HasColumn(column string) bool

+ func (schema Schemaless) Key(column string) (SchemalessKey, bool)

+ func (schema Schemaless) ScanRow(row Row, val interface{}) error

+ func (schema Schemaless) ScanRows(rows Rows, val interface{}) error

+ func (schema Schemaless) Type() reflect.Type

+ type SchemalessKey struct

+ func (key SchemalessKey) ColumnName() string

+ func (key SchemalessKey) FieldIndex() []int

+ func (key SchemalessKey) FieldName() string

type TagsAnalyzerOption

+ func NewOnlyColumnTagsAnalyzerOption() TagsAnalyzerOption

v0.6.0

Jun 26, 2019

Changes in this version

+ func RawExecArgs(ctx context.Context, driver Driver, query string, args []interface{}, ...) error

v0.5.0

Jun 12, 2019

v0.4.0

May 28, 2019

Changes in this version

+ var ErrPointerOrSliceRequired = fmt.Errorf("a pointer or a slice is required")

+ var ErrUnknownPreloadRule = fmt.Errorf("unknown rule")

v0.3.0

May 27, 2019

v0.2.0

Mar 6, 2019

Changes in this version

+ const AssociationTypeMany

+ const AssociationTypeOne

+ const AssociationTypeUndefined

+ const ClientDriver

+ const DefaultSelector

+ const FKIntegerType

+ const FKOptionalIntegerType

+ const FKOptionalStringType

+ const FKStringType

+ const FKUnknownType

+ const MasterSelector

+ const PKIntegerType

+ const PKStringType

+ const PKUnknownType

+ const PrimaryKeyDBDefault

+ const PrimaryKeyULIDDefault

+ const PrimaryKeyUUIDV1Default

+ const PrimaryKeyUUIDV4Default

+ const SlaveSelector

+ const TagKeyColumn

+ const TagKeyColumnShort

+ const TagKeyDefault

+ const TagKeyForeignKey

+ const TagKeyIgnored

+ const TagKeyPrimaryKey

+ const TagKeyRelation

+ const TagKeyRelationShort

+ const TagKeyULID

+ const TagKeyUUIDV1

+ const TagKeyUUIDV4

+ const TagName

+ const TagNameAlt

+ const TagNameShort

+ var ErrInvalidDriver = fmt.Errorf("a makroud driver is required")

+ var ErrNoRows = fmt.Errorf("no rows in result set")

+ var ErrPointerRequired = fmt.Errorf("a pointer is required")

+ var ErrPreloadInvalidModel = fmt.Errorf("given model is invalid")

+ var ErrPreloadInvalidPath = fmt.Errorf("given path is invalid")

+ var ErrPreloadInvalidSchema = fmt.Errorf("given model has an invalid schema")

+ var ErrSchemaColumnRequired = fmt.Errorf("cannot find column in schema")

+ var ErrSchemaCreatedKey = fmt.Errorf("cannot find created key in schema")

+ var ErrSchemaDeletedKey = fmt.Errorf("cannot find deleted key in schema")

+ var ErrSchemaUpdatedKey = fmt.Errorf("cannot find updated key in schema")

+ var ErrSelectorMissingRetryConnection = fmt.Errorf("cannot find a healthy connection in selector")

+ var ErrSelectorNotFoundConnection = fmt.Errorf("cannot find connection in selector")

+ var ErrStructRequired = fmt.Errorf("a struct is required")

+ var TagsKeyMapper = map[string]string

+ var TagsList = []string

+ var TagsNameMapper = map[string]string

+ func Archive(ctx context.Context, driver Driver, model Model) error

+ func Count(ctx context.Context, driver Driver, stmt builder.Builder) (int64, error)

+ func DebugField(field Field) string

+ func DebugTag(tag Tag) string

+ func DebugTagProperty(prop TagProperty) string

+ func DebugTags(tags Tags) string

+ func Delete(ctx context.Context, driver Driver, model Model) error

+ func Exec(ctx context.Context, driver Driver, stmt builder.Builder, dest ...interface{}) error

+ func FloatCount(ctx context.Context, driver Driver, stmt builder.Builder) (float64, error)

+ func GenerateULID(driver Driver) string

+ func GenerateUUIDV1(driver Driver) string

+ func GenerateUUIDV4(driver Driver) string

+ func IsErrNoRows(err error) bool

+ func Log(driver Driver, queries Queries, duration time.Duration)

+ func Preload(ctx context.Context, driver Driver, out interface{}, ...) error

+ func RawExec(ctx context.Context, driver Driver, query string, dest ...interface{}) error

+ func Retry(handler func(Driver) error, drivers ...Driver) (err error)

+ func Save(ctx context.Context, driver Driver, model Model) error

+ func Transaction(driver Driver, handler func(driver Driver) error) error

+ type AssociationType uint8

+ func (e AssociationType) String() string

+ type Client struct

+ func New(options ...Option) (*Client, error)

+ func NewDebugClient(driver string, dsn string) (*Client, error)

+ func NewWithOptions(options *ClientOptions) (*Client, error)

+ func (c *Client) Begin() (Driver, error)

+ func (c *Client) Close() error

+ func (c *Client) Commit() error

+ func (c *Client) DriverName() string

+ func (c *Client) Exec(ctx context.Context, query string, args ...interface{}) error

+ func (c *Client) FindAll(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ func (c *Client) FindOne(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ func (c *Client) MustExec(ctx context.Context, query string, args ...interface{})

+ func (c *Client) MustQuery(ctx context.Context, query string, arg interface{}) Rows

+ func (c *Client) Ping() error

+ func (c *Client) Prepare(ctx context.Context, query string) (Statement, error)

+ func (c *Client) Query(ctx context.Context, query string, arg interface{}) (Rows, error)

+ func (c *Client) Rollback() error

+ type ClientOptions struct

+ DBName string

+ Host string

+ Logger Logger

+ MaxIdleConnections int

+ MaxOpenConnections int

+ Password string

+ Port int

+ SSLMode string

+ SavepointEnabled bool

+ Timezone string

+ User string

+ WithCache bool

+ func NewClientOptions() *ClientOptions

+ func (e ClientOptions) String() string

+ type Columns []string

+ func GetColumns(driver Driver, model Model) (Columns, error)

+ func (c Columns) List() []string

+ func (c Columns) String() string

+ type Driver interface

+ Begin func() (Driver, error)

+ Close func() error

+ Commit func() error

+ DriverName func() string

+ Exec func(ctx context.Context, query string, args ...interface{}) error

+ FindAll func(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ FindOne func(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ MustExec func(ctx context.Context, query string, args ...interface{})

+ MustQuery func(ctx context.Context, query string, arg interface{}) Rows

+ Ping func() error

+ Prepare func(ctx context.Context, query string) (Statement, error)

+ Query func(ctx context.Context, query string, arg interface{}) (Rows, error)

+ Rollback func() error

+ type FKType uint8

+ func (val FKType) IsCompatible(key PKType) bool

+ func (val FKType) IsOptional() bool

+ func (val FKType) String() string

+ type Field struct

+ func NewField(driver Driver, schema *Schema, model Model, name string, args ...ModelOpts) (*Field, error)

+ func (field Field) ColumnName() string

+ func (field Field) ColumnPath() string

+ func (field Field) FieldIndex() []int

+ func (field Field) FieldName() string

+ func (field Field) ForeignKey() string

+ func (field Field) HasDefault() bool

+ func (field Field) HasRelation() bool

+ func (field Field) HasULID() bool

+ func (field Field) HasUUIDV1() bool

+ func (field Field) HasUUIDV4() bool

+ func (field Field) IsAssociation() bool

+ func (field Field) IsAssociationType(kind AssociationType) bool

+ func (field Field) IsCreatedKey() bool

+ func (field Field) IsDeletedKey() bool

+ func (field Field) IsExcluded() bool

+ func (field Field) IsForeignKey() bool

+ func (field Field) IsPrimaryKey() bool

+ func (field Field) IsUpdatedKey() bool

+ func (field Field) ModelName() string

+ func (field Field) RelationName() string

+ func (field Field) String() string

+ func (field Field) TableName() string

+ func (field Field) Type() reflect.Type

+ type ForeignKey struct

+ func NewForeignKey(field *Field) (*ForeignKey, error)

+ func (key ForeignKey) Reference() string

+ func (key ForeignKey) Type() FKType

+ type Logger interface

+ Log func(query string, duration time.Duration)

+ type Mapper map[string]interface

+ type Model interface

+ TableName func() string

+ type ModelOpts struct

+ CreatedKey string

+ DeletedKey string

+ PrimaryKey string

+ UpdatedKey string

+ type Option func(*ClientOptions) error

+ func Cache(enabled bool) Option

+ func Database(dbname string) Option

+ func DisableSSL() Option

+ func EnableSSL() Option

+ func EnableSavepoint() Option

+ func Host(host string) Option

+ func MaxIdleConnections(maximum int) Option

+ func MaxOpenConnections(maximum int) Option

+ func Password(password string) Option

+ func Port(port int) Option

+ func SSLMode(mode string) Option

+ func Timezone(timezone string) Option

+ func User(user string) Option

+ func WithLogger(logger Logger) Option

+ type PKType uint8

+ func (val PKType) IsCompatible(key FKType) bool

+ func (val PKType) String() string

+ type PreloadHandler struct

+ func WithPreloadCallback(field string, callback func(query builder.Select) builder.Select) PreloadHandler

+ func WithPreloadField(field string) PreloadHandler

+ func WithUnscopedPreload(handler PreloadHandler) PreloadHandler

+ type PrimaryKey struct

+ func NewPrimaryKey(field *Field) (*PrimaryKey, error)

+ func (key PrimaryKey) Default() PrimaryKeyDefault

+ func (key PrimaryKey) Type() PKType

+ func (key PrimaryKey) Value(model Model) (interface{}, error)

+ func (key PrimaryKey) ValueOpt(model Model) (interface{}, bool)

+ type PrimaryKeyDefault uint8

+ func (e PrimaryKeyDefault) String() string

+ type Queries []Query

+ func (q Queries) String() string

+ type Query struct

+ Args map[string]interface{}

+ Query string

+ Raw string

+ func NewQuery(builder lkb.Builder) Query

+ func NewRawQuery(raw string) Query

+ func (q Query) String() string

+ type Reference struct

+ func NewReference(driver Driver, local *Schema, field *Field) (*Reference, error)

+ func (reference Reference) IsLocal() bool

+ func (reference Reference) Local() ReferenceObject

+ func (reference Reference) Remote() ReferenceObject

+ func (reference Reference) String() string

+ type ReferenceObject struct

+ func (object ReferenceObject) ColumnName() string

+ func (object ReferenceObject) ColumnPath() string

+ func (object ReferenceObject) Columns() []string

+ func (object ReferenceObject) DeletedKeyName() string

+ func (object ReferenceObject) DeletedKeyPath() string

+ func (object ReferenceObject) FieldName() string

+ func (object ReferenceObject) ForeignKeyType() FKType

+ func (object ReferenceObject) HasDeletedKey() bool

+ func (object ReferenceObject) IsForeignKey() bool

+ func (object ReferenceObject) IsPrimaryKey() bool

+ func (object ReferenceObject) Model() Model

+ func (object ReferenceObject) ModelName() string

+ func (object ReferenceObject) PrimaryKeyType() PKType

+ func (object ReferenceObject) Schema() *Schema

+ func (object ReferenceObject) TableName() string

+ type Row interface

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

+ Scan func(dest ...interface{}) error

+ Write func(dest map[string]interface{}) error

+ type Rows interface

+ Close func() error

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

+ Err func() error

+ Next func() bool

+ Scan func(dest ...interface{}) error

+ Write func(dest map[string]interface{}) error

+ type Schema struct

+ func GetSchema(driver Driver, model Model) (*Schema, error)

+ func (schema Schema) ColumnPaths() Columns

+ func (schema Schema) Columns() Columns

+ func (schema Schema) CreatedKeyName() string

+ func (schema Schema) CreatedKeyPath() string

+ func (schema Schema) DeletedKeyName() string

+ func (schema Schema) DeletedKeyPath() string

+ func (schema Schema) HasColumn(column string) bool

+ func (schema Schema) HasCreatedKey() bool

+ func (schema Schema) HasDeletedKey() bool

+ func (schema Schema) HasUpdatedKey() bool

+ func (schema Schema) Model() Model

+ func (schema Schema) ModelName() string

+ func (schema Schema) PrimaryKey() PrimaryKey

+ func (schema Schema) ScanRow(row Row, model Model) error

+ func (schema Schema) ScanRows(rows Rows, model Model) error

+ func (schema Schema) TableName() string

+ func (schema Schema) UpdatedKeyName() string

+ func (schema Schema) UpdatedKeyPath() string

+ type Selector struct

+ func NewSelector(configurations map[string]*ClientOptions) (*Selector, error)

+ func NewSelectorWithDriver(driver Driver) (*Selector, error)

+ func (selector *Selector) Close() error

+ func (selector *Selector) Ping() error

+ func (selector *Selector) RetryAliases(handler func(Driver) error, aliases ...string) error

+ func (selector *Selector) RetryMaster(handler func(Driver) error) error

+ func (selector *Selector) Using(alias string) (Driver, error)

+ type SelectorConfigurations map[string]*ClientOptions

+ type Statement interface

+ Close func() error

+ Exec func(ctx context.Context, args []interface{}) error

+ FindAll func(ctx context.Context, dest interface{}, args []interface{}) error

+ FindOne func(ctx context.Context, dest interface{}, args []interface{}) error

+ QueryRow func(ctx context.Context, args []interface{}) (Row, error)

+ QueryRows func(ctx context.Context, args []interface{}) (Rows, error)

+ type Tag struct

+ func (tag Tag) Get(key string) string

+ func (tag Tag) Name() string

+ func (tag Tag) Properties() []TagProperty

+ func (tag Tag) String() string

+ type TagProperty struct

+ func (prop TagProperty) Key() string

+ func (prop TagProperty) String() string

+ func (prop TagProperty) Value() string

+ type Tags []Tag

+ func GetTags(field reflect.StructField, args ...TagsAnalyzerOption) Tags

+ func (tags *Tags) Set(name string, property TagProperty)

+ func (tags Tags) Get(name string) *Tag

+ func (tags Tags) GetByKey(name string, key string) string

+ func (tags Tags) HasKey(name string, key string) bool

+ func (tags Tags) String() string

+ type TagsAnalyzerOption func(*TagsAnalyzerOptions)

+ type TagsAnalyzerOptions struct

+ Collector []string

+ KeyMapper map[string]string

+ Name string

+ NameMapper map[string]string

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