ent

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 13, 2022 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Operation types.
	OpCreate    = ent.OpCreate
	OpDelete    = ent.OpDelete
	OpDeleteOne = ent.OpDeleteOne
	OpUpdate    = ent.OpUpdate
	OpUpdateOne = ent.OpUpdateOne

	// Node types.
	TypeUser = "User"
)

Variables

This section is empty.

Functions

func IsConstraintError 

func IsConstraintError(err error) bool

IsConstraintError returns a boolean indicating whether the error is a constraint failure.

func IsNotFound 

func IsNotFound(err error) bool

IsNotFound returns a boolean indicating whether the error is a not found error.

func IsNotLoaded 

func IsNotLoaded(err error) bool

IsNotLoaded returns a boolean indicating whether the error is a not loaded error.

func IsNotSingular 

func IsNotSingular(err error) bool

IsNotSingular returns a boolean indicating whether the error is a not singular error.

func IsValidationError 

func IsValidationError(err error) bool

IsValidationError returns a boolean indicating whether the error is a validation error.

func MaskNotFound 

func MaskNotFound(err error) error

MaskNotFound masks not found error.

func NewContext 

func NewContext(parent context.Context, c *Client) context.Context

NewContext returns a new context with the given Client attached.

func NewTxContext 

func NewTxContext(parent context.Context, tx *Tx) context.Context

NewTxContext returns a new context with the given Tx attached.

Types

type AggregateFunc 

type AggregateFunc func(*sql.Selector) string

AggregateFunc applies an aggregation step on the group-by traversal/selector.

func As 

func As(fn AggregateFunc, end string) AggregateFunc

As is a pseudo aggregation function for renaming another other functions with custom names. For example: 

GroupBy(field1, field2).
Aggregate(ent.As(ent.Sum(field1), "sum_field1"), (ent.As(ent.Sum(field2), "sum_field2")).
Scan(ctx, &v)

func Count 

func Count() AggregateFunc

Count applies the "count" aggregation function on each group.

func Max 

func Max(field string) AggregateFunc

Max applies the "max" aggregation function on the given field of each group.

func Mean 

func Mean(field string) AggregateFunc

Mean applies the "mean" aggregation function on the given field of each group.

func Min 

func Min(field string) AggregateFunc

Min applies the "min" aggregation function on the given field of each group.

func Sum 

func Sum(field string) AggregateFunc

Sum applies the "sum" aggregation function on the given field of each group.

type Client 

type Client struct {

	// Schema is the client for creating, migrating and dropping schema.
	Schema *migrate.Schema
	// User is the client for interacting with the User builders.
	User *UserClient
	// contains filtered or unexported fields
}

Client is the client that holds all ent builders.

func FromContext 

func FromContext(ctx context.Context) *Client

FromContext returns a Client stored inside a context, or nil if there isn't one.

func NewClient 

func NewClient(opts ...Option) *Client

NewClient creates a new client configured with the given options.

func Open 

func Open(driverName, dataSourceName string, options ...Option) (*Client, error)

Open opens a database/sql.DB specified by the driver name and the data source name, and returns a new client attached to it. Optional parameters can be added for configuring the client.

func (*Client) BeginTx 

func (c *Client) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error)

BeginTx returns a transactional client with specified options.

func (*Client) Close 

func (c *Client) Close() error

Close closes the database connection and prevents new queries from starting.

func (*Client) Debug 

func (c *Client) Debug() *Client

Debug returns a new debug-client. It's used to get verbose logging on specific operations. 

client.Debug().
	User.
	Query().
	Count(ctx)

func (*Client) Tx 

func (c *Client) Tx(ctx context.Context) (*Tx, error)

Tx returns a new transactional client. The provided context is used until the transaction is committed or rolled back.

func (*Client) Use 

func (c *Client) Use(hooks ...Hook)

Use adds the mutation hooks to all the entity clients. In order to add hooks to a specific client, call: `client.Node.Use(...)`.

type CommitFunc 

type CommitFunc func(context.Context, *Tx) error

The CommitFunc type is an adapter to allow the use of ordinary function as a Committer. If f is a function with the appropriate signature, CommitFunc(f) is a Committer that calls f.

func (CommitFunc) Commit 

func (f CommitFunc) Commit(ctx context.Context, tx *Tx) error

Commit calls f(ctx, m).

type CommitHook 

type CommitHook func(Committer) Committer

CommitHook defines the "commit middleware". A function that gets a Committer and returns a Committer. For example: 

hook := func(next ent.Committer) ent.Committer {
	return ent.CommitFunc(func(ctx context.Context, tx *ent.Tx) error {
		// Do some stuff before.
		if err := next.Commit(ctx, tx); err != nil {
			return err
		}
		// Do some stuff after.
		return nil
	})
}

type Committer 

type Committer interface {
	Commit(context.Context, *Tx) error
}

Committer is the interface that wraps the Commit method.

type ConstraintError 

type ConstraintError struct {
	// contains filtered or unexported fields
}

ConstraintError returns when trying to create/update one or more entities and one or more of their constraints failed. For example, violation of edge or field uniqueness.

func (ConstraintError) Error 

func (e ConstraintError) Error() string

Error implements the error interface.

func (*ConstraintError) Unwrap 

func (e *ConstraintError) Unwrap() error

Unwrap implements the errors.Wrapper interface.

type Hook 

type Hook = ent.Hook

ent aliases to avoid import conflicts in user's code.

type MutateFunc 

type MutateFunc = ent.MutateFunc

ent aliases to avoid import conflicts in user's code.

type Mutation 

type Mutation = ent.Mutation

ent aliases to avoid import conflicts in user's code.

type Mutator 

type Mutator = ent.Mutator

ent aliases to avoid import conflicts in user's code.

type NotFoundError 

type NotFoundError struct {
	// contains filtered or unexported fields
}

NotFoundError returns when trying to fetch a specific entity and it was not found in the database.

func (*NotFoundError) Error 

func (e *NotFoundError) Error() string

Error implements the error interface.

type NotLoadedError 

type NotLoadedError struct {
	// contains filtered or unexported fields
}

NotLoadedError returns when trying to get a node that was not loaded by the query.

func (*NotLoadedError) Error 

func (e *NotLoadedError) Error() string

Error implements the error interface.

type NotSingularError 

type NotSingularError struct {
	// contains filtered or unexported fields
}

NotSingularError returns when trying to fetch a singular entity and more then one was found in the database.

func (*NotSingularError) Error 

func (e *NotSingularError) Error() string

Error implements the error interface.

type Op 

type Op = ent.Op

ent aliases to avoid import conflicts in user's code.

type Option 

type Option func(*config)

Option function to configure the client.

func Debug 

func Debug() Option

Debug enables debug logging on the ent.Driver.

func Driver 

func Driver(driver dialect.Driver) Option

Driver configures the client driver.

func Log 

func Log(fn func(...interface{})) Option

Log sets the logging function for debug mode.

type OrderFunc 

type OrderFunc func(*sql.Selector)

OrderFunc applies an ordering on the sql selector.

func Asc 

func Asc(fields ...string) OrderFunc

Asc applies the given fields in ASC order.

func Desc 

func Desc(fields ...string) OrderFunc

Desc applies the given fields in DESC order.

type Policy 

type Policy = ent.Policy

ent aliases to avoid import conflicts in user's code.

type Query 

type Query = ent.Query

ent aliases to avoid import conflicts in user's code.

type RollbackFunc 

type RollbackFunc func(context.Context, *Tx) error

The RollbackFunc type is an adapter to allow the use of ordinary function as a Rollbacker. If f is a function with the appropriate signature, RollbackFunc(f) is a Rollbacker that calls f.

func (RollbackFunc) Rollback 

func (f RollbackFunc) Rollback(ctx context.Context, tx *Tx) error

Rollback calls f(ctx, m).

type RollbackHook 

type RollbackHook func(Rollbacker) Rollbacker

RollbackHook defines the "rollback middleware". A function that gets a Rollbacker and returns a Rollbacker. For example: 

hook := func(next ent.Rollbacker) ent.Rollbacker {
	return ent.RollbackFunc(func(ctx context.Context, tx *ent.Tx) error {
		// Do some stuff before.
		if err := next.Rollback(ctx, tx); err != nil {
			return err
		}
		// Do some stuff after.
		return nil
	})
}

type Rollbacker 

type Rollbacker interface {
	Rollback(context.Context, *Tx) error
}

Rollbacker is the interface that wraps the Rollback method.

type Tx 

type Tx struct {

	// User is the client for interacting with the User builders.
	User *UserClient
	// contains filtered or unexported fields
}

Tx is a transactional client that is created by calling Client.Tx().

func TxFromContext 

func TxFromContext(ctx context.Context) *Tx

TxFromContext returns a Tx stored inside a context, or nil if there isn't one.

func (*Tx) Client 

func (tx *Tx) Client() *Client

Client returns a Client that binds to current transaction.

func (*Tx) Commit 

func (tx *Tx) Commit() error

Commit commits the transaction.

func (*Tx) OnCommit 

func (tx *Tx) OnCommit(f CommitHook)

OnCommit adds a hook to call on commit.

func (*Tx) OnRollback 

func (tx *Tx) OnRollback(f RollbackHook)

OnRollback adds a hook to call on rollback.

func (*Tx) Rollback 

func (tx *Tx) Rollback() error

Rollback rollbacks the transaction.

type User 

type User struct {

	// ID of the ent.
	ID uint64 `json:"id,omitempty"`
	// Name holds the value of the "name" field.
	Name string `json:"name,omitempty"`
	// Edges holds the relations/edges for other nodes in the graph.
	// The values are being populated by the UserQuery when eager-loading is set.
	Edges UserEdges `json:"edges"`
	// contains filtered or unexported fields
}

User is the model entity for the User schema.

func (*User) QueryFollowers 

func (u *User) QueryFollowers() *UserQuery

QueryFollowers queries the "followers" edge of the User entity.

func (*User) QueryFollowing 

func (u *User) QueryFollowing() *UserQuery

QueryFollowing queries the "following" edge of the User entity.

func (*User) QuerySpouse 

func (u *User) QuerySpouse() *UserQuery

QuerySpouse queries the "spouse" edge of the User entity.

func (*User) String 

func (u *User) String() string

String implements the fmt.Stringer.

func (*User) Unwrap 

func (u *User) Unwrap() *User

Unwrap unwraps the User entity that was returned from a transaction after it was closed, so that all future queries will be executed through the driver which created the transaction.

func (*User) Update 

func (u *User) Update() *UserUpdateOne

Update returns a builder for updating this User. Note that you need to call User.Unwrap() before calling this method if this User was returned from a transaction, and the transaction was committed or rolled back.

type UserClient 

type UserClient struct {
	// contains filtered or unexported fields
}

UserClient is a client for the User schema.

func NewUserClient 

func NewUserClient(c config) *UserClient

NewUserClient returns a client for the User from the given config.

func (*UserClient) Create 

func (c *UserClient) Create() *UserCreate

Create returns a builder for creating a User entity.

func (*UserClient) CreateBulk 

func (c *UserClient) CreateBulk(builders ...*UserCreate) *UserCreateBulk

CreateBulk returns a builder for creating a bulk of User entities.

func (*UserClient) Delete 

func (c *UserClient) Delete() *UserDelete

Delete returns a delete builder for User.

func (*UserClient) DeleteOne 

func (c *UserClient) DeleteOne(u *User) *UserDeleteOne

DeleteOne returns a builder for deleting the given entity.

func (*UserClient) DeleteOneID 

func (c *UserClient) DeleteOneID(id uint64) *UserDeleteOne

DeleteOne returns a builder for deleting the given entity by its id.

func (*UserClient) Get 

func (c *UserClient) Get(ctx context.Context, id uint64) (*User, error)

Get returns a User entity by its id.

func (*UserClient) GetX 

func (c *UserClient) GetX(ctx context.Context, id uint64) *User

GetX is like Get, but panics if an error occurs.

func (*UserClient) Hooks 

func (c *UserClient) Hooks() []Hook

Hooks returns the client hooks.

func (*UserClient) Query 

func (c *UserClient) Query() *UserQuery

Query returns a query builder for User.

func (*UserClient) QueryFollowers 

func (c *UserClient) QueryFollowers(u *User) *UserQuery

QueryFollowers queries the followers edge of a User.

func (*UserClient) QueryFollowing 

func (c *UserClient) QueryFollowing(u *User) *UserQuery

QueryFollowing queries the following edge of a User.

func (*UserClient) QuerySpouse 

func (c *UserClient) QuerySpouse(u *User) *UserQuery

QuerySpouse queries the spouse edge of a User.

func (*UserClient) Update 

func (c *UserClient) Update() *UserUpdate

Update returns an update builder for User.

func (*UserClient) UpdateOne 

func (c *UserClient) UpdateOne(u *User) *UserUpdateOne

UpdateOne returns an update builder for the given entity.

func (*UserClient) UpdateOneID 

func (c *UserClient) UpdateOneID(id uint64) *UserUpdateOne

UpdateOneID returns an update builder for the given id.

func (*UserClient) Use 

func (c *UserClient) Use(hooks ...Hook)

Use adds a list of mutation hooks to the hooks stack. A call to `Use(f, g, h)` equals to `user.Hooks(f(g(h())))`.

type UserCreate 

type UserCreate struct {
	// contains filtered or unexported fields
}

UserCreate is the builder for creating a User entity.

func (*UserCreate) AddFollowerIDs 

func (uc *UserCreate) AddFollowerIDs(ids ...uint64) *UserCreate

AddFollowerIDs adds the "followers" edge to the User entity by IDs.

func (*UserCreate) AddFollowers 

func (uc *UserCreate) AddFollowers(u ...*User) *UserCreate

AddFollowers adds the "followers" edges to the User entity.

func (*UserCreate) AddFollowing 

func (uc *UserCreate) AddFollowing(u ...*User) *UserCreate

AddFollowing adds the "following" edges to the User entity.

func (*UserCreate) AddFollowingIDs 

func (uc *UserCreate) AddFollowingIDs(ids ...uint64) *UserCreate

AddFollowingIDs adds the "following" edge to the User entity by IDs.

func (*UserCreate) Exec added in v0.9.0 

func (uc *UserCreate) Exec(ctx context.Context) error

Exec executes the query.

func (*UserCreate) ExecX added in v0.9.0 

func (uc *UserCreate) ExecX(ctx context.Context)

ExecX is like Exec, but panics if an error occurs.

func (*UserCreate) Mutation 

func (uc *UserCreate) Mutation() *UserMutation

Mutation returns the UserMutation object of the builder.

func (*UserCreate) Save 

func (uc *UserCreate) Save(ctx context.Context) (*User, error)

Save creates the User in the database.

func (*UserCreate) SaveX 

func (uc *UserCreate) SaveX(ctx context.Context) *User

SaveX calls Save and panics if Save returns an error.

func (*UserCreate) SetName 

func (uc *UserCreate) SetName(s string) *UserCreate

SetName sets the "name" field.

func (*UserCreate) SetNillableSpouseID 

func (uc *UserCreate) SetNillableSpouseID(id *uint64) *UserCreate

SetNillableSpouseID sets the "spouse" edge to the User entity by ID if the given value is not nil.

func (*UserCreate) SetSpouse 

func (uc *UserCreate) SetSpouse(u *User) *UserCreate

SetSpouse sets the "spouse" edge to the User entity.

func (*UserCreate) SetSpouseID 

func (uc *UserCreate) SetSpouseID(id uint64) *UserCreate

SetSpouseID sets the "spouse" edge to the User entity by ID.

type UserCreateBulk 

type UserCreateBulk struct {
	// contains filtered or unexported fields
}

UserCreateBulk is the builder for creating many User entities in bulk.

func (*UserCreateBulk) Exec added in v0.9.0 

func (ucb *UserCreateBulk) Exec(ctx context.Context) error

Exec executes the query.

func (*UserCreateBulk) ExecX added in v0.9.0 

func (ucb *UserCreateBulk) ExecX(ctx context.Context)

ExecX is like Exec, but panics if an error occurs.

func (*UserCreateBulk) Save 

func (ucb *UserCreateBulk) Save(ctx context.Context) ([]*User, error)

Save creates the User entities in the database.

func (*UserCreateBulk) SaveX 

func (ucb *UserCreateBulk) SaveX(ctx context.Context) []*User

SaveX is like Save, but panics if an error occurs.

type UserDelete 

type UserDelete struct {
	// contains filtered or unexported fields
}

UserDelete is the builder for deleting a User entity.

func (*UserDelete) Exec 

func (ud *UserDelete) Exec(ctx context.Context) (int, error)

Exec executes the deletion query and returns how many vertices were deleted.

func (*UserDelete) ExecX 

func (ud *UserDelete) ExecX(ctx context.Context) int

ExecX is like Exec, but panics if an error occurs.

func (*UserDelete) Where 

func (ud *UserDelete) Where(ps ...predicate.User) *UserDelete

Where appends a list predicates to the UserDelete builder.

type UserDeleteOne 

type UserDeleteOne struct {
	// contains filtered or unexported fields
}

UserDeleteOne is the builder for deleting a single User entity.

func (*UserDeleteOne) Exec 

func (udo *UserDeleteOne) Exec(ctx context.Context) error

Exec executes the deletion query.

func (*UserDeleteOne) ExecX 

func (udo *UserDeleteOne) ExecX(ctx context.Context)

ExecX is like Exec, but panics if an error occurs.

type UserEdges 

type UserEdges struct {
	// Spouse holds the value of the spouse edge.
	Spouse *User `json:"spouse,omitempty"`
	// Followers holds the value of the followers edge.
	Followers []*User `json:"followers,omitempty"`
	// Following holds the value of the following edge.
	Following []*User `json:"following,omitempty"`
	// contains filtered or unexported fields
}

UserEdges holds the relations/edges for other nodes in the graph.

func (UserEdges) FollowersOrErr 

func (e UserEdges) FollowersOrErr() ([]*User, error)

FollowersOrErr returns the Followers value or an error if the edge was not loaded in eager-loading.

func (UserEdges) FollowingOrErr 

func (e UserEdges) FollowingOrErr() ([]*User, error)

FollowingOrErr returns the Following value or an error if the edge was not loaded in eager-loading.

func (UserEdges) SpouseOrErr 

func (e UserEdges) SpouseOrErr() (*User, error)

SpouseOrErr returns the Spouse value or an error if the edge was not loaded in eager-loading, or loaded but was not found.

type UserGroupBy 

type UserGroupBy struct {
	// contains filtered or unexported fields
}

UserGroupBy is the group-by builder for User entities.

func (*UserGroupBy) Aggregate 

func (ugb *UserGroupBy) Aggregate(fns ...AggregateFunc) *UserGroupBy

Aggregate adds the given aggregation functions to the group-by query.

func (*UserGroupBy) Bool 

func (s *UserGroupBy) Bool(ctx context.Context) (_ bool, err error)

Bool returns a single bool from a selector. It is only allowed when selecting one field.

func (*UserGroupBy) BoolX 

func (s *UserGroupBy) BoolX(ctx context.Context) bool

BoolX is like Bool, but panics if an error occurs.

func (*UserGroupBy) Bools 

func (s *UserGroupBy) Bools(ctx context.Context) ([]bool, error)

Bools returns list of bools from a selector. It is only allowed when selecting one field.

func (*UserGroupBy) BoolsX 

func (s *UserGroupBy) BoolsX(ctx context.Context) []bool

BoolsX is like Bools, but panics if an error occurs.

func (*UserGroupBy) Float64 

func (s *UserGroupBy) Float64(ctx context.Context) (_ float64, err error)

Float64 returns a single float64 from a selector. It is only allowed when selecting one field.

func (*UserGroupBy) Float64X 

func (s *UserGroupBy) Float64X(ctx context.Context) float64

Float64X is like Float64, but panics if an error occurs.

func (*UserGroupBy) Float64s 

func (s *UserGroupBy) Float64s(ctx context.Context) ([]float64, error)

Float64s returns list of float64s from a selector. It is only allowed when selecting one field.

func (*UserGroupBy) Float64sX 

func (s *UserGroupBy) Float64sX(ctx context.Context) []float64

Float64sX is like Float64s, but panics if an error occurs.

func (*UserGroupBy) Int 

func (s *UserGroupBy) Int(ctx context.Context) (_ int, err error)

Int returns a single int from a selector. It is only allowed when selecting one field.

func (*UserGroupBy) IntX 

func (s *UserGroupBy) IntX(ctx context.Context) int

IntX is like Int, but panics if an error occurs.

func (*UserGroupBy) Ints 

func (s *UserGroupBy) Ints(ctx context.Context) ([]int, error)

Ints returns list of ints from a selector. It is only allowed when selecting one field.

func (*UserGroupBy) IntsX 

func (s *UserGroupBy) IntsX(ctx context.Context) []int

IntsX is like Ints, but panics if an error occurs.

func (*UserGroupBy) Scan 

func (ugb *UserGroupBy) Scan(ctx context.Context, v interface{}) error

Scan applies the group-by query and scans the result into the given value.

func (*UserGroupBy) ScanX 

func (s *UserGroupBy) ScanX(ctx context.Context, v interface{})

ScanX is like Scan, but panics if an error occurs.

func (*UserGroupBy) String 

func (s *UserGroupBy) String(ctx context.Context) (_ string, err error)

String returns a single string from a selector. It is only allowed when selecting one field.

func (*UserGroupBy) StringX 

func (s *UserGroupBy) StringX(ctx context.Context) string

StringX is like String, but panics if an error occurs.

func (*UserGroupBy) Strings 

func (s *UserGroupBy) Strings(ctx context.Context) ([]string, error)

Strings returns list of strings from a selector. It is only allowed when selecting one field.

func (*UserGroupBy) StringsX 

func (s *UserGroupBy) StringsX(ctx context.Context) []string

StringsX is like Strings, but panics if an error occurs.

type UserMutation 

type UserMutation struct {
	// contains filtered or unexported fields
}

UserMutation represents an operation that mutates the User nodes in the graph.

func (*UserMutation) AddField 

func (m *UserMutation) AddField(name string, value ent.Value) error

AddField adds the value to the field with the given name. It returns an error if the field is not defined in the schema, or if the type mismatched the field type.

func (*UserMutation) AddFollowerIDs 

func (m *UserMutation) AddFollowerIDs(ids ...uint64)

AddFollowerIDs adds the "followers" edge to the User entity by ids.

func (*UserMutation) AddFollowingIDs 

func (m *UserMutation) AddFollowingIDs(ids ...uint64)

AddFollowingIDs adds the "following" edge to the User entity by ids.

func (*UserMutation) AddedEdges 

func (m *UserMutation) AddedEdges() []string

AddedEdges returns all edge names that were set/added in this mutation.

func (*UserMutation) AddedField 

func (m *UserMutation) AddedField(name string) (ent.Value, bool)

AddedField returns the numeric value that was incremented/decremented on a field with the given name. The second boolean return value indicates that this field was not set, or was not defined in the schema.

func (*UserMutation) AddedFields 

func (m *UserMutation) AddedFields() []string

AddedFields returns all numeric fields that were incremented/decremented during this mutation.

func (*UserMutation) AddedIDs 

func (m *UserMutation) AddedIDs(name string) []ent.Value

AddedIDs returns all IDs (to other nodes) that were added for the given edge name in this mutation.

func (*UserMutation) ClearEdge 

func (m *UserMutation) ClearEdge(name string) error

ClearEdge clears the value of the edge with the given name. It returns an error if that edge is not defined in the schema.

func (*UserMutation) ClearField 

func (m *UserMutation) ClearField(name string) error

ClearField clears the value of the field with the given name. It returns an error if the field is not defined in the schema.

func (*UserMutation) ClearFollowers 

func (m *UserMutation) ClearFollowers()

ClearFollowers clears the "followers" edge to the User entity.

func (*UserMutation) ClearFollowing 

func (m *UserMutation) ClearFollowing()

ClearFollowing clears the "following" edge to the User entity.

func (*UserMutation) ClearSpouse 

func (m *UserMutation) ClearSpouse()

ClearSpouse clears the "spouse" edge to the User entity.

func (*UserMutation) ClearedEdges 

func (m *UserMutation) ClearedEdges() []string

ClearedEdges returns all edge names that were cleared in this mutation.

func (*UserMutation) ClearedFields 

func (m *UserMutation) ClearedFields() []string

ClearedFields returns all nullable fields that were cleared during this mutation.

func (UserMutation) Client 

func (m UserMutation) Client() *Client

Client returns a new `ent.Client` from the mutation. If the mutation was executed in a transaction (ent.Tx), a transactional client is returned.

func (*UserMutation) EdgeCleared 

func (m *UserMutation) EdgeCleared(name string) bool

EdgeCleared returns a boolean which indicates if the edge with the given name was cleared in this mutation.

func (*UserMutation) Field 

func (m *UserMutation) Field(name string) (ent.Value, bool)

Field returns the value of a field with the given name. The second boolean return value indicates that this field was not set, or was not defined in the schema.

func (*UserMutation) FieldCleared 

func (m *UserMutation) FieldCleared(name string) bool

FieldCleared returns a boolean indicating if a field with the given name was cleared in this mutation.

func (*UserMutation) Fields 

func (m *UserMutation) Fields() []string

Fields returns all fields that were changed during this mutation. Note that in order to get all numeric fields that were incremented/decremented, call AddedFields().

func (*UserMutation) FollowersCleared 

func (m *UserMutation) FollowersCleared() bool

FollowersCleared reports if the "followers" edge to the User entity was cleared.

func (*UserMutation) FollowersIDs 

func (m *UserMutation) FollowersIDs() (ids []uint64)

FollowersIDs returns the "followers" edge IDs in the mutation.

func (*UserMutation) FollowingCleared 

func (m *UserMutation) FollowingCleared() bool

FollowingCleared reports if the "following" edge to the User entity was cleared.

func (*UserMutation) FollowingIDs 

func (m *UserMutation) FollowingIDs() (ids []uint64)

FollowingIDs returns the "following" edge IDs in the mutation.

func (*UserMutation) ID 

func (m *UserMutation) ID() (id uint64, exists bool)

ID returns the ID value in the mutation. Note that the ID is only available if it was provided to the builder or after it was returned from the database.

func (*UserMutation) IDs added in v0.10.0 

func (m *UserMutation) IDs(ctx context.Context) ([]uint64, error)

IDs queries the database and returns the entity ids that match the mutation's predicate. That means, if the mutation is applied within a transaction with an isolation level such as sql.LevelSerializable, the returned ids match the ids of the rows that will be updated or updated by the mutation.

func (*UserMutation) Name 

func (m *UserMutation) Name() (r string, exists bool)

Name returns the value of the "name" field in the mutation.

func (*UserMutation) OldField 

func (m *UserMutation) OldField(ctx context.Context, name string) (ent.Value, error)

OldField returns the old value of the field from the database. An error is returned if the mutation operation is not UpdateOne, or the query to the database failed.

func (*UserMutation) OldName 

func (m *UserMutation) OldName(ctx context.Context) (v string, err error)

OldName returns the old "name" field's value of the User entity. If the User object wasn't provided to the builder, the object is fetched from the database. An error is returned if the mutation operation is not UpdateOne, or the database query fails.

func (*UserMutation) Op 

func (m *UserMutation) Op() Op

Op returns the operation name.

func (*UserMutation) RemoveFollowerIDs 

func (m *UserMutation) RemoveFollowerIDs(ids ...uint64)

RemoveFollowerIDs removes the "followers" edge to the User entity by IDs.

func (*UserMutation) RemoveFollowingIDs 

func (m *UserMutation) RemoveFollowingIDs(ids ...uint64)

RemoveFollowingIDs removes the "following" edge to the User entity by IDs.

func (*UserMutation) RemovedEdges 

func (m *UserMutation) RemovedEdges() []string

RemovedEdges returns all edge names that were removed in this mutation.

func (*UserMutation) RemovedFollowersIDs 

func (m *UserMutation) RemovedFollowersIDs() (ids []uint64)

RemovedFollowers returns the removed IDs of the "followers" edge to the User entity.

func (*UserMutation) RemovedFollowingIDs 

func (m *UserMutation) RemovedFollowingIDs() (ids []uint64)

RemovedFollowing returns the removed IDs of the "following" edge to the User entity.

func (*UserMutation) RemovedIDs 

func (m *UserMutation) RemovedIDs(name string) []ent.Value

RemovedIDs returns all IDs (to other nodes) that were removed for the edge with the given name in this mutation.

func (*UserMutation) ResetEdge 

func (m *UserMutation) ResetEdge(name string) error

ResetEdge resets all changes to the edge with the given name in this mutation. It returns an error if the edge is not defined in the schema.

func (*UserMutation) ResetField 

func (m *UserMutation) ResetField(name string) error

ResetField resets all changes in the mutation for the field with the given name. It returns an error if the field is not defined in the schema.

func (*UserMutation) ResetFollowers 

func (m *UserMutation) ResetFollowers()

ResetFollowers resets all changes to the "followers" edge.

func (*UserMutation) ResetFollowing 

func (m *UserMutation) ResetFollowing()

ResetFollowing resets all changes to the "following" edge.

func (*UserMutation) ResetName 

func (m *UserMutation) ResetName()

ResetName resets all changes to the "name" field.

func (*UserMutation) ResetSpouse 

func (m *UserMutation) ResetSpouse()

ResetSpouse resets all changes to the "spouse" edge.

func (*UserMutation) SetField 

func (m *UserMutation) SetField(name string, value ent.Value) error

SetField sets the value of a field with the given name. It returns an error if the field is not defined in the schema, or if the type mismatched the field type.

func (*UserMutation) SetName 

func (m *UserMutation) SetName(s string)

SetName sets the "name" field.

func (*UserMutation) SetSpouseID 

func (m *UserMutation) SetSpouseID(id uint64)

SetSpouseID sets the "spouse" edge to the User entity by id.

func (*UserMutation) SpouseCleared 

func (m *UserMutation) SpouseCleared() bool

SpouseCleared reports if the "spouse" edge to the User entity was cleared.

func (*UserMutation) SpouseID 

func (m *UserMutation) SpouseID() (id uint64, exists bool)

SpouseID returns the "spouse" edge ID in the mutation.

func (*UserMutation) SpouseIDs 

func (m *UserMutation) SpouseIDs() (ids []uint64)

SpouseIDs returns the "spouse" edge IDs in the mutation. Note that IDs always returns len(IDs) <= 1 for unique edges, and you should use SpouseID instead. It exists only for internal usage by the builders.

func (UserMutation) Tx 

func (m UserMutation) Tx() (*Tx, error)

Tx returns an `ent.Tx` for mutations that were executed in transactions; it returns an error otherwise.

func (*UserMutation) Type 

func (m *UserMutation) Type() string

Type returns the node type of this mutation (User).

func (*UserMutation) Where added in v0.9.0 

func (m *UserMutation) Where(ps ...predicate.User)

Where appends a list predicates to the UserMutation builder.

type UserQuery 

type UserQuery struct {
	// contains filtered or unexported fields
}

UserQuery is the builder for querying User entities.

func (*UserQuery) All 

func (uq *UserQuery) All(ctx context.Context) ([]*User, error)

All executes the query and returns a list of Users.

func (*UserQuery) AllX 

func (uq *UserQuery) AllX(ctx context.Context) []*User

AllX is like All, but panics if an error occurs.

func (*UserQuery) Clone 

func (uq *UserQuery) Clone() *UserQuery

Clone returns a duplicate of the UserQuery builder, including all associated steps. It can be used to prepare common query builders and use them differently after the clone is made.

func (*UserQuery) Count 

func (uq *UserQuery) Count(ctx context.Context) (int, error)

Count returns the count of the given query.

func (*UserQuery) CountX 

func (uq *UserQuery) CountX(ctx context.Context) int

CountX is like Count, but panics if an error occurs.

func (*UserQuery) Exist 

func (uq *UserQuery) Exist(ctx context.Context) (bool, error)

Exist returns true if the query has elements in the graph.

func (*UserQuery) ExistX 

func (uq *UserQuery) ExistX(ctx context.Context) bool

ExistX is like Exist, but panics if an error occurs.

func (*UserQuery) First 

func (uq *UserQuery) First(ctx context.Context) (*User, error)

First returns the first User entity from the query. Returns a *NotFoundError when no User was found.

func (*UserQuery) FirstID 

func (uq *UserQuery) FirstID(ctx context.Context) (id uint64, err error)

FirstID returns the first User ID from the query. Returns a *NotFoundError when no User ID was found.

func (*UserQuery) FirstIDX 

func (uq *UserQuery) FirstIDX(ctx context.Context) uint64

FirstIDX is like FirstID, but panics if an error occurs.

func (*UserQuery) FirstX 

func (uq *UserQuery) FirstX(ctx context.Context) *User

FirstX is like First, but panics if an error occurs.

func (*UserQuery) GroupBy 

func (uq *UserQuery) GroupBy(field string, fields ...string) *UserGroupBy

GroupBy is used to group vertices by one or more fields/columns. It is often used with aggregate functions, like: count, max, mean, min, sum.

Example: 

var v []struct {
	Name string `json:"name,omitempty"`
	Count int `json:"count,omitempty"`
}

client.User.Query().
	GroupBy(user.FieldName).
	Aggregate(ent.Count()).
	Scan(ctx, &v)

func (*UserQuery) IDs 

func (uq *UserQuery) IDs(ctx context.Context) ([]uint64, error)

IDs executes the query and returns a list of User IDs.

func (*UserQuery) IDsX 

func (uq *UserQuery) IDsX(ctx context.Context) []uint64

IDsX is like IDs, but panics if an error occurs.

func (*UserQuery) Limit 

func (uq *UserQuery) Limit(limit int) *UserQuery

Limit adds a limit step to the query.

func (*UserQuery) Offset 

func (uq *UserQuery) Offset(offset int) *UserQuery

Offset adds an offset step to the query.

func (*UserQuery) Only 

func (uq *UserQuery) Only(ctx context.Context) (*User, error)

Only returns a single User entity found by the query, ensuring it only returns one. Returns a *NotSingularError when more than one User entity is found. Returns a *NotFoundError when no User entities are found.

func (*UserQuery) OnlyID 

func (uq *UserQuery) OnlyID(ctx context.Context) (id uint64, err error)

OnlyID is like Only, but returns the only User ID in the query. Returns a *NotSingularError when more than one User ID is found. Returns a *NotFoundError when no entities are found.

func (*UserQuery) OnlyIDX 

func (uq *UserQuery) OnlyIDX(ctx context.Context) uint64

OnlyIDX is like OnlyID, but panics if an error occurs.

func (*UserQuery) OnlyX 

func (uq *UserQuery) OnlyX(ctx context.Context) *User

OnlyX is like Only, but panics if an error occurs.

func (*UserQuery) Order 

func (uq *UserQuery) Order(o ...OrderFunc) *UserQuery

Order adds an order step to the query.

func (*UserQuery) QueryFollowers 

func (uq *UserQuery) QueryFollowers() *UserQuery

QueryFollowers chains the current query on the "followers" edge.

func (*UserQuery) QueryFollowing 

func (uq *UserQuery) QueryFollowing() *UserQuery

QueryFollowing chains the current query on the "following" edge.

func (*UserQuery) QuerySpouse 

func (uq *UserQuery) QuerySpouse() *UserQuery

QuerySpouse chains the current query on the "spouse" edge.

func (*UserQuery) Select 

func (uq *UserQuery) Select(fields ...string) *UserSelect

Select allows the selection one or more fields/columns for the given query, instead of selecting all fields in the entity.

Example: 

var v []struct {
	Name string `json:"name,omitempty"`
}

client.User.Query().
	Select(user.FieldName).
	Scan(ctx, &v)

func (*UserQuery) Unique added in v0.8.0 

func (uq *UserQuery) Unique(unique bool) *UserQuery

Unique configures the query builder to filter duplicate records on query. By default, unique is set to true, and can be disabled using this method.

func (*UserQuery) Where 

func (uq *UserQuery) Where(ps ...predicate.User) *UserQuery

Where adds a new predicate for the UserQuery builder.

func (*UserQuery) WithFollowers 

func (uq *UserQuery) WithFollowers(opts ...func(*UserQuery)) *UserQuery

WithFollowers tells the query-builder to eager-load the nodes that are connected to the "followers" edge. The optional arguments are used to configure the query builder of the edge.

func (*UserQuery) WithFollowing 

func (uq *UserQuery) WithFollowing(opts ...func(*UserQuery)) *UserQuery

WithFollowing tells the query-builder to eager-load the nodes that are connected to the "following" edge. The optional arguments are used to configure the query builder of the edge.

func (*UserQuery) WithSpouse 

func (uq *UserQuery) WithSpouse(opts ...func(*UserQuery)) *UserQuery

WithSpouse tells the query-builder to eager-load the nodes that are connected to the "spouse" edge. The optional arguments are used to configure the query builder of the edge.

type UserSelect 

type UserSelect struct {
	*UserQuery
	// contains filtered or unexported fields
}

UserSelect is the builder for selecting fields of User entities.

func (*UserSelect) Bool 

func (s *UserSelect) Bool(ctx context.Context) (_ bool, err error)

Bool returns a single bool from a selector. It is only allowed when selecting one field.

func (*UserSelect) BoolX 

func (s *UserSelect) BoolX(ctx context.Context) bool

BoolX is like Bool, but panics if an error occurs.

func (*UserSelect) Bools 

func (s *UserSelect) Bools(ctx context.Context) ([]bool, error)

Bools returns list of bools from a selector. It is only allowed when selecting one field.

func (*UserSelect) BoolsX 

func (s *UserSelect) BoolsX(ctx context.Context) []bool

BoolsX is like Bools, but panics if an error occurs.

func (*UserSelect) Float64 

func (s *UserSelect) Float64(ctx context.Context) (_ float64, err error)

Float64 returns a single float64 from a selector. It is only allowed when selecting one field.

func (*UserSelect) Float64X 

func (s *UserSelect) Float64X(ctx context.Context) float64

Float64X is like Float64, but panics if an error occurs.

func (*UserSelect) Float64s 

func (s *UserSelect) Float64s(ctx context.Context) ([]float64, error)

Float64s returns list of float64s from a selector. It is only allowed when selecting one field.

func (*UserSelect) Float64sX 

func (s *UserSelect) Float64sX(ctx context.Context) []float64

Float64sX is like Float64s, but panics if an error occurs.

func (*UserSelect) Int 

func (s *UserSelect) Int(ctx context.Context) (_ int, err error)

Int returns a single int from a selector. It is only allowed when selecting one field.

func (*UserSelect) IntX 

func (s *UserSelect) IntX(ctx context.Context) int

IntX is like Int, but panics if an error occurs.

func (*UserSelect) Ints 

func (s *UserSelect) Ints(ctx context.Context) ([]int, error)

Ints returns list of ints from a selector. It is only allowed when selecting one field.

func (*UserSelect) IntsX 

func (s *UserSelect) IntsX(ctx context.Context) []int

IntsX is like Ints, but panics if an error occurs.

func (*UserSelect) Scan 

func (us *UserSelect) Scan(ctx context.Context, v interface{}) error

Scan applies the selector query and scans the result into the given value.

func (*UserSelect) ScanX 

func (s *UserSelect) ScanX(ctx context.Context, v interface{})

ScanX is like Scan, but panics if an error occurs.

func (*UserSelect) String 

func (s *UserSelect) String(ctx context.Context) (_ string, err error)

String returns a single string from a selector. It is only allowed when selecting one field.

func (*UserSelect) StringX 

func (s *UserSelect) StringX(ctx context.Context) string

StringX is like String, but panics if an error occurs.

func (*UserSelect) Strings 

func (s *UserSelect) Strings(ctx context.Context) ([]string, error)

Strings returns list of strings from a selector. It is only allowed when selecting one field.

func (*UserSelect) StringsX 

func (s *UserSelect) StringsX(ctx context.Context) []string

StringsX is like Strings, but panics if an error occurs.

type UserUpdate 

type UserUpdate struct {
	// contains filtered or unexported fields
}

UserUpdate is the builder for updating User entities.

func (*UserUpdate) AddFollowerIDs 

func (uu *UserUpdate) AddFollowerIDs(ids ...uint64) *UserUpdate

AddFollowerIDs adds the "followers" edge to the User entity by IDs.

func (*UserUpdate) AddFollowers 

func (uu *UserUpdate) AddFollowers(u ...*User) *UserUpdate

AddFollowers adds the "followers" edges to the User entity.

func (*UserUpdate) AddFollowing 

func (uu *UserUpdate) AddFollowing(u ...*User) *UserUpdate

AddFollowing adds the "following" edges to the User entity.

func (*UserUpdate) AddFollowingIDs 

func (uu *UserUpdate) AddFollowingIDs(ids ...uint64) *UserUpdate

AddFollowingIDs adds the "following" edge to the User entity by IDs.

func (*UserUpdate) ClearFollowers 

func (uu *UserUpdate) ClearFollowers() *UserUpdate

ClearFollowers clears all "followers" edges to the User entity.

func (*UserUpdate) ClearFollowing 

func (uu *UserUpdate) ClearFollowing() *UserUpdate

ClearFollowing clears all "following" edges to the User entity.

func (*UserUpdate) ClearSpouse 

func (uu *UserUpdate) ClearSpouse() *UserUpdate

ClearSpouse clears the "spouse" edge to the User entity.

func (*UserUpdate) Exec 

func (uu *UserUpdate) Exec(ctx context.Context) error

Exec executes the query.

func (*UserUpdate) ExecX 

func (uu *UserUpdate) ExecX(ctx context.Context)

ExecX is like Exec, but panics if an error occurs.

func (*UserUpdate) Mutation 

func (uu *UserUpdate) Mutation() *UserMutation

Mutation returns the UserMutation object of the builder.

func (*UserUpdate) RemoveFollowerIDs 

func (uu *UserUpdate) RemoveFollowerIDs(ids ...uint64) *UserUpdate

RemoveFollowerIDs removes the "followers" edge to User entities by IDs.

func (*UserUpdate) RemoveFollowers 

func (uu *UserUpdate) RemoveFollowers(u ...*User) *UserUpdate

RemoveFollowers removes "followers" edges to User entities.

func (*UserUpdate) RemoveFollowing 

func (uu *UserUpdate) RemoveFollowing(u ...*User) *UserUpdate

RemoveFollowing removes "following" edges to User entities.

func (*UserUpdate) RemoveFollowingIDs 

func (uu *UserUpdate) RemoveFollowingIDs(ids ...uint64) *UserUpdate

RemoveFollowingIDs removes the "following" edge to User entities by IDs.

func (*UserUpdate) Save 

func (uu *UserUpdate) Save(ctx context.Context) (int, error)

Save executes the query and returns the number of nodes affected by the update operation.

func (*UserUpdate) SaveX 

func (uu *UserUpdate) SaveX(ctx context.Context) int

SaveX is like Save, but panics if an error occurs.

func (*UserUpdate) SetName 

func (uu *UserUpdate) SetName(s string) *UserUpdate

SetName sets the "name" field.

func (*UserUpdate) SetNillableSpouseID 

func (uu *UserUpdate) SetNillableSpouseID(id *uint64) *UserUpdate

SetNillableSpouseID sets the "spouse" edge to the User entity by ID if the given value is not nil.

func (*UserUpdate) SetSpouse 

func (uu *UserUpdate) SetSpouse(u *User) *UserUpdate

SetSpouse sets the "spouse" edge to the User entity.

func (*UserUpdate) SetSpouseID 

func (uu *UserUpdate) SetSpouseID(id uint64) *UserUpdate

SetSpouseID sets the "spouse" edge to the User entity by ID.

func (*UserUpdate) Where 

func (uu *UserUpdate) Where(ps ...predicate.User) *UserUpdate

Where appends a list predicates to the UserUpdate builder.

type UserUpdateOne 

type UserUpdateOne struct {
	// contains filtered or unexported fields
}

UserUpdateOne is the builder for updating a single User entity.

func (*UserUpdateOne) AddFollowerIDs 

func (uuo *UserUpdateOne) AddFollowerIDs(ids ...uint64) *UserUpdateOne

AddFollowerIDs adds the "followers" edge to the User entity by IDs.

func (*UserUpdateOne) AddFollowers 

func (uuo *UserUpdateOne) AddFollowers(u ...*User) *UserUpdateOne

AddFollowers adds the "followers" edges to the User entity.

func (*UserUpdateOne) AddFollowing 

func (uuo *UserUpdateOne) AddFollowing(u ...*User) *UserUpdateOne

AddFollowing adds the "following" edges to the User entity.

func (*UserUpdateOne) AddFollowingIDs 

func (uuo *UserUpdateOne) AddFollowingIDs(ids ...uint64) *UserUpdateOne

AddFollowingIDs adds the "following" edge to the User entity by IDs.

func (*UserUpdateOne) ClearFollowers 

func (uuo *UserUpdateOne) ClearFollowers() *UserUpdateOne

ClearFollowers clears all "followers" edges to the User entity.

func (*UserUpdateOne) ClearFollowing 

func (uuo *UserUpdateOne) ClearFollowing() *UserUpdateOne

ClearFollowing clears all "following" edges to the User entity.

func (*UserUpdateOne) ClearSpouse 

func (uuo *UserUpdateOne) ClearSpouse() *UserUpdateOne

ClearSpouse clears the "spouse" edge to the User entity.

func (*UserUpdateOne) Exec 

func (uuo *UserUpdateOne) Exec(ctx context.Context) error

Exec executes the query on the entity.

func (*UserUpdateOne) ExecX 

func (uuo *UserUpdateOne) ExecX(ctx context.Context)

ExecX is like Exec, but panics if an error occurs.

func (*UserUpdateOne) Mutation 

func (uuo *UserUpdateOne) Mutation() *UserMutation

Mutation returns the UserMutation object of the builder.

func (*UserUpdateOne) RemoveFollowerIDs 

func (uuo *UserUpdateOne) RemoveFollowerIDs(ids ...uint64) *UserUpdateOne

RemoveFollowerIDs removes the "followers" edge to User entities by IDs.

func (*UserUpdateOne) RemoveFollowers 

func (uuo *UserUpdateOne) RemoveFollowers(u ...*User) *UserUpdateOne

RemoveFollowers removes "followers" edges to User entities.

func (*UserUpdateOne) RemoveFollowing 

func (uuo *UserUpdateOne) RemoveFollowing(u ...*User) *UserUpdateOne

RemoveFollowing removes "following" edges to User entities.

func (*UserUpdateOne) RemoveFollowingIDs 

func (uuo *UserUpdateOne) RemoveFollowingIDs(ids ...uint64) *UserUpdateOne

RemoveFollowingIDs removes the "following" edge to User entities by IDs.

func (*UserUpdateOne) Save 

func (uuo *UserUpdateOne) Save(ctx context.Context) (*User, error)

Save executes the query and returns the updated User entity.

func (*UserUpdateOne) SaveX 

func (uuo *UserUpdateOne) SaveX(ctx context.Context) *User

SaveX is like Save, but panics if an error occurs.

func (*UserUpdateOne) Select added in v0.8.0 

func (uuo *UserUpdateOne) Select(field string, fields ...string) *UserUpdateOne

Select allows selecting one or more fields (columns) of the returned entity. The default is selecting all fields defined in the entity schema.

func (*UserUpdateOne) SetName 

func (uuo *UserUpdateOne) SetName(s string) *UserUpdateOne

SetName sets the "name" field.

func (*UserUpdateOne) SetNillableSpouseID 

func (uuo *UserUpdateOne) SetNillableSpouseID(id *uint64) *UserUpdateOne

SetNillableSpouseID sets the "spouse" edge to the User entity by ID if the given value is not nil.

func (*UserUpdateOne) SetSpouse 

func (uuo *UserUpdateOne) SetSpouse(u *User) *UserUpdateOne

SetSpouse sets the "spouse" edge to the User entity.

func (*UserUpdateOne) SetSpouseID 

func (uuo *UserUpdateOne) SetSpouseID(id uint64) *UserUpdateOne

SetSpouseID sets the "spouse" edge to the User entity by ID.

type Users 

type Users []*User

Users is a parsable slice of User.

type ValidationError 

type ValidationError struct {
	Name string // Field or edge name.
	// contains filtered or unexported fields
}

ValidationError returns when validating a field or edge fails.

func (*ValidationError) Error 

func (e *ValidationError) Error() string

Error implements the error interface.

func (*ValidationError) Unwrap 

func (e *ValidationError) Unwrap() error

Unwrap implements the errors.Wrapper interface.

type Value 

type Value = ent.Value

ent aliases to avoid import conflicts in user's code.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.