ent/doc/md/predicates.md

id, title

id	title
predicates	Predicates

Field Predicates

• Bool:
  • =, !=
• Numeric:
  • =, !=, >, <, >=, <=,
  • IN, NOT IN
• Time:
  • =, !=, >, <, >=, <=
  • IN, NOT IN
• String:
  • =, !=, >, <, >=, <=
  • IN, NOT IN
  • Contains, HasPrefix, HasSuffix
  • ContainsFold, EqualFold (SQL specific)
• JSON
  • =, !=
  • =, !=, >, <, >=, <= on nested values (JSON path).
  • Contains on nested values (JSON path).
  • HasKey, Len<P>
• Optional fields:
  • IsNil, NotNil

Edge Predicates

• HasEdge. For example, for edge named owner of type Pet, use:

   client.Pet.
    	Query().
    	Where(pet.HasOwner()).
    	All(ctx)
  

• HasEdgeWith. Add list of predicates for edge predicate.

   client.Pet.
    	Query().
    	Where(pet.HasOwnerWith(user.Name("a8m"))).
    	All(ctx)
  

Negation (NOT)

client.Pet.
	Query().
	Where(pet.Not(pet.NameHasPrefix("Ari"))).
	All(ctx)

Disjunction (OR)

client.Pet.
	Query().
	Where(
		pet.Or(
			pet.HasOwner(),
			pet.Not(pet.HasFriends()),
		)
	).
	All(ctx)

Conjunction (AND)

client.Pet.
	Query().
	Where(
		pet.And(
			pet.HasOwner(),
			pet.Not(pet.HasFriends()),
		)
	).
	All(ctx)

Custom Predicates

Custom predicates can be useful if you want to write your own dialect-specific logic.

pets := client.Pet.
	Query().
	Where(predicate.Pet(func(s *sql.Selector) {
		s.Where(sql.InInts(pet.OwnerColumn, 1, 2, 3))
	})).
	AllX(ctx)

users := client.User.
	Query().
	Where(predicate.User(func(s *sql.Selector) {
		s.Where(sqljson.HasKey(user.FieldURL, sqljson.Path("Scheme")))
	})).
	AllX(ctx)

todos := client.Todo.Query().
    Where(func(s *sql.Selector) {
        t := sql.Table(user.Table)
        s.Where(
            sql.In(
                s.C(todo.FieldUserID),
                sql.Select(t.C(user.FieldID)).From(t).Where(sql.In(t.C(user.FieldName), names...)),
            ),
        )
    }).
    AllX(ctx)